@ollaid/native-sso 2.8.2 → 2.8.3

package/docs/README.md

@@ -0,0 +1,66 @@
+# Native SSO Docs
+
+Version: `2.8.3`
+
+Docs courtes et pratiques pour `@ollaid/native-sso`.
+
+## Démarrage
+
+1. Lisez [Quick Start](./1_quick-start.md)
+2. Vérifiez le contrat backend dans [Backend Contract](./2_backend-contract.md)
+3. Vérifiez le stockage et la sécurité dans [Storage & Security](./3_storage-security.md)
+4. Vérifiez les webhooks dans [Webhooks](./4_webhooks.md)
+5. Si vous utilisez les APIs IAM Account server-to-server, lisez [IAM Account](./5_iam-account.md)
+6. Si vous utilisez les helpers avancés, lisez [Advanced Services](./6_advanced-services.md)
+7. Consultez les notes de migration dans [Migration Notes](./7_migration-notes.md)
+8. Pour la synchro bidirectionnelle des infos profil, lisez [Update Infos](./8_update_infos.md)
+9. Pour le flux de redirection mot de passe via backend SaaS, lisez [Password Magic Link](./9_password_magic_link.md)
+10. Pour la redirection après connexion et le flux `needs_access`, lisez [Login Redirect & Access Flow](./10_login-redirect.md)
+11. Pour la persistance des sessions, le refresh token et la résilience réseau, lisez [Session Refresh & Resilience](./11_session-refresh-resilience.md)
+12. Pour le détail du flux `needs_access` et du bypass `BYPASS=true`, lisez [Needs Access & Bypass](./12_login_mode.md)
+13. Pour la vérification finale des fonctionnalités critiques, lisez [Must Have Working](./13_must_have_working.md)
+14. Pour les variables d'environnement backend IAM SSO, lisez [Backend Env Key](./14_backend_env_key.md)
+
+## Principe
+
+- Le package chiffre les données de session au repos dans son storage.
+- Le frontend SaaS ne lit pas le storage directement.
+- Le frontend SaaS demande la session au package via `getSsoSessionSnapshot()`.
+- La déconnexion passe par `logout()`.
+- Les APIs IAM Account (`iamAccountService`) sont server-to-server uniquement.
+- Les helpers avancés (`mobilePasswordService`, `profileChangeService`, `profileMediaService`) sont documentés séparément.
+
+## Checklist SaaS
+
+- Fournir `redirectAfterLogin` sur `NativeSSOPage` si vous ne voulez pas rester sur la page SSO après connexion.
+- Fournir `redirectAfterLogout` si vous voulez une sortie vers une page métier.
+- Côté backend, renvoyer `needs_access` quand l'utilisateur est authentifié mais n'a pas encore accès à cette application.
+- Si le SaaS active `BYPASS=true`, le backend peut auto-créer l'accès et finaliser la connexion sans afficher le modal.
+- Ne pas appeler le callback final de redirection tant que `grantAccess()` n'a pas terminé, sauf si `BYPASS=true`.
+
+## Onboarding profil
+
+La modal `OnboardingModal` gère deux modes:
+
+- `missing`:
+  - `name`
+  - `image_url`
+  - `phone`
+  - `email`
+  - `address`
+  - `town`
+  - `country`
+- `edit`:
+  - nom complet
+  - photo de profil
+  - téléphone
+  - email
+  - adresse
+  - ville
+  - pays
+
+Le mode automatique piloté par `NativeSSOPage` ouvre la modal après le délai configuré si l’un de ces champs est manquant. Le modal reste scrollable à l’intérieur via le conteneur de contenu dédié.
+
+Quand vous ouvrez la modal depuis votre SaaS, utilisez `variant="edit"` pour afficher le formulaire complet éditable.
+
+Le changement de téléphone ou d’email ouvre un sous-flux OTP dans la même modal, avec une fermeture bloquée tant que le flux est en cours.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ollaid/native-sso",
-  "version": "2.8.2",
+  "version": "2.8.3",
   "description": "Package NPM fullstack pour l'authentification Native SSO Ollaid - Frontend-First (Link APIs & Refresh support)",
   "type": "module",
   "main": "dist/index.cjs",
@@ -14,11 +14,14 @@
     }
   },
   "files": [
-    "dist"
+    "dist",
+    "docs",
+    "scripts"
   ],
   "scripts": {
     "build": "vite build && tsc --emitDeclarationOnly --declaration --outDir dist",
-    "dev": "vite build --watch"
+    "dev": "vite build --watch",
+    "postinstall": "node ./scripts/copy-docs.mjs"
   },
   "peerDependencies": {
     "@capacitor/device": "^7.0.0 || ^8.0.0",

package/scripts/copy-docs.mjs

@@ -0,0 +1,36 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import process from 'node:process';
+import { fileURLToPath } from 'node:url';
+
+const packageRoot = path.dirname(fileURLToPath(import.meta.url));
+const docsSourceDir = path.resolve(packageRoot, '../docs');
+const projectRoot = process.env.INIT_CWD
+  ? path.resolve(process.env.INIT_CWD)
+  : process.cwd();
+const targetDir = path.resolve(projectRoot, 'docs/ollaid@sso_package');
+
+async function main() {
+  let entries;
+  try {
+    entries = await fs.readdir(docsSourceDir, { withFileTypes: true });
+  } catch {
+    return;
+  }
+
+  await fs.rm(targetDir, { recursive: true, force: true });
+  await fs.mkdir(targetDir, { recursive: true });
+
+  for (const entry of entries) {
+    if (!entry.isFile() || !entry.name.endsWith('.md')) continue;
+
+    const sourceFile = path.join(docsSourceDir, entry.name);
+    const targetFile = path.join(targetDir, entry.name);
+    await fs.copyFile(sourceFile, targetFile);
+  }
+}
+
+main().catch((error) => {
+  console.error('[ollaid-native-sso] doc copy failed:', error);
+  process.exitCode = 1;
+});