@quatrain/auth-firebase 1.1.22 → 1.1.24

package/README.md

@@ -1,94 +1,42 @@
 # @quatrain/auth-firebase
 
-An authentication adapter for Firebase Authentication. This package integrates Quatrain's auth system with Google's managed authentication service.
+The Firebase Authentication adapter for `@quatrain/auth`.
 
-## Features
+## Introduction
 
--  Implements the `@quatrain/auth` abstract adapter.
--  Supports email/password, social logins (Google, Facebook, etc.), and custom tokens.
--  Integrates with Firebase security rules.
--  Uses the `firebase-admin` SDK for server-side operations.
+Firebase Authentication provides backend services to authenticate users. This adapter implements the Quatrain Auth interface using the `firebase-admin` SDK to verify JWTs and manage users.
 
 ## Installation
 
 ```bash
 npm install @quatrain/auth-firebase firebase-admin
+# or
+yarn add @quatrain/auth-firebase firebase-admin
 ```
 
-## Usage
+## Configuration
 
-### Setup
+Register the adapter using your Firebase service account credentials.
 
 ```typescript
 import { Auth } from '@quatrain/auth'
 import { FirebaseAuthAdapter } from '@quatrain/auth-firebase'
 
-const adapter = new FirebaseAuthAdapter({
-   config: {
-      projectId: 'your-project-id',
-      // Other Firebase Admin SDK config
-      apiKey: 'your-api-key', // Required for token refresh
-   },
+const firebaseAuth = new FirebaseAuthAdapter({
+    config: {
+        projectId: 'your-project-id',
+        clientEmail: 'firebase-adminsdk-xxx@your-project-id.iam.gserviceaccount.com',
+        privateKey: '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n'
+    }
 })
-Auth.addProvider(adapter, 'default', true)
-```
-
-### Register a New User
-
-```typescript
-import { User } from '@quatrain/backend'
-
-const user = new User({
-   uid: 'unique-user-id',
-   _: {
-      name: 'John Doe',
-      email: 'john@example.com',
-      phone: '+1234567890',
-   },
-})
-
-const userId = await adapter.register(user, 'password123')
-console.log('User registered with ID:', userId)
-```
-
-### Verify Auth Token
-
-```typescript
-const decodedToken = await adapter.getAuthToken('firebase-id-token')
-console.log('Token verified for user:', decodedToken.uid)
-```
-
-### Update User Profile
 
-```typescript
-await adapter.update(user, {
-   email: 'newemail@example.com',
-   displayName: 'Jane Doe',
-   phoneNumber: '+0987654321',
-})
+Auth.addAdapter('firebase', firebaseAuth, true)
 ```
 
-### Delete User
+## Documentation
 
-```typescript
-await adapter.delete(user)
-console.log('User deleted')
-```
-
-### Refresh Token
+For concrete examples and usage guides, please refer to the [How-To Guide](HOWTO.md).
 
-```typescript
-const newTokens = await adapter.refreshToken(refreshToken)
-console.log('New access token:', newTokens.access_token)
-```
+## License
 
-> [!WARNING] > **Incomplete Implementation**
->
-> The following methods are currently not implemented (empty stubs):
->
-> -  `signup()` - Client-side sign in
-> -  `signout()` - Sign out user
-> -  `revokeAuthToken()` - Revoke tokens
-> -  `setCustomUserClaims()` - Set custom claims
->
-> These methods exist to satisfy the interface but do not perform any operations.
+AGPL-3.0-only

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quatrain/auth-firebase",
-  "version": "1.1.22",
+  "version": "1.1.24",
   "license": "AGPL-3.0-only",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,12 +13,12 @@
   ],
   "author": "Quatrain Développement SAS <developers@quatrain.com>",
   "peerDependencies": {
-    "@quatrain/core": "^1.1.48"
+    "@quatrain/core": "^1.1.49"
   },
   "dependencies": {
-    "@quatrain/auth": "^1.1.27",
-    "@quatrain/backend": "^1.1.33",
-    "@quatrain/core": "^1.1.48",
+    "@quatrain/auth": "^1.1.29",
+    "@quatrain/backend": "^1.1.34",
+    "@quatrain/core": "^1.1.49",
     "firebase-admin": "^13.0.1",
     "node-fetch-native": "^1.6.4"
   },