rn-swiftauth-sdk 1.0.0 → 1.0.1

package/README.md

@@ -2,7 +2,7 @@
 
 A production-ready React Native authentication SDK powered by Firebase. Built with TypeScript, offering both pre-built UI components and headless hooks for complete flexibility.
 
-[![npm version](https://img.shields.io/npm/v/swiftauth-sdk.svg)](https://www.npmjs.com/package/swiftauth-sdk)
+[![npm version](https://img.shields.io/npm/v/rn-swiftauth-sdk.svg)](https://www.npmjs.com/package/rn-swiftauth-sdk)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 ## ✨ Features
@@ -29,30 +29,18 @@ Ensure your environment meets these requirements:
 
 ### Step 1: Install the SDK
 
-Since SwiftAuth SDK is currently distributed as a source package, clone and link it locally:
+Install SwiftAuth SDK from npm:
 
 ```bash
-# Clone the repository
-git clone https://github.com/allcodez/Auth-SDK_Stage8
-
-# Navigate to SDK folder
-cd Auth-SDK_Stage8/swiftauth-sdk
-
-# Install dependencies and build
-npm install
-npm run build
+npm install rn-swiftauth-sdk
 ```
 
-### Step 2: Link to Your Project
-
-Navigate to your React Native/Expo project and install the SDK:
-
+**For Expo projects:**
 ```bash
-cd your-project-folder
-npm install ../path/to/Auth-SDK_Stage8/swiftauth-sdk
+npx expo install rn-swiftauth-sdk
 ```
 
-### Step 3: Install Required Dependencies
+### Step 2: Install Required Dependencies
 
 SwiftAuth requires these peer dependencies:
 
@@ -79,35 +67,17 @@ npm install @invertase/react-native-apple-authentication
 npx expo install @invertase/react-native-apple-authentication
 ```
 
-### Step 4: Metro Configuration (Important)
+### Step 3: Install Native Dependencies (Bare React Native only)
 
-Update your `metro.config.js` to resolve the SDK properly:
+If you're using Bare React Native (not Expo), install iOS CocoaPods:
 
-```javascript
-const { getDefaultConfig } = require('expo/metro-config');
-const path = require('path');
-
-const projectRoot = __dirname;
-const workspaceRoot = path.resolve(projectRoot, '../');
-
-const config = getDefaultConfig(projectRoot);
-
-config.watchFolders = [workspaceRoot];
-config.resolver.nodeModulesPaths = [
-  path.resolve(projectRoot, 'node_modules'),
-  path.resolve(workspaceRoot, 'node_modules'),
-];
-
-module.exports = config;
+```bash
+cd ios
+pod install
+cd ..
 ```
 
-### ⚠️ Troubleshooting "Duplicate React"
-
-If you encounter an "Invalid Hook Call" error:
-
-1. Build the SDK: `npm run build`
-2. Delete SDK's `node_modules`: `rm -rf node_modules` inside `swiftauth-sdk`
-3. Clear cache and restart: `npx expo start -c`
+That's it! You're ready to start using SwiftAuth SDK.
 
 ---
 
@@ -167,7 +137,7 @@ apply plugin: 'com.google.gms.google-services'
 
 1. In Firebase Console, register an **iOS app**
 2. Download `GoogleService-Info.plist`
-3. Place it in your project: `ios/YourAppName/GoogleService-Info.plist`
+3. Place it in your project root for Expo, or `ios/YourAppName/GoogleService-Info.plist` for Bare React Native
 
 **For Bare React Native:**
 - Drag `GoogleService-Info.plist` into your Xcode project
@@ -184,7 +154,7 @@ apply plugin: 'com.google.gms.google-services'
 }
 ```
 
-**Install CocoaPods (iOS only):**
+**Install CocoaPods (Bare React Native iOS only):**
 ```bash
 cd ios
 pod install
@@ -221,10 +191,10 @@ cd ..
 ### 5. Apple Sign-In Configuration (Optional, iOS only)
 
 1. Go to your [Apple Developer Account](https://developer.apple.com/)
-2. Enable **Sign in with Apple** capability
-3. Add the capability in Xcode: **Signing & Capabilities** > **+ Capability** > **Sign in with Apple**
+2. Enable **Sign in with Apple** capability for your App ID
+3. For Bare React Native: Add the capability in Xcode: **Signing & Capabilities** > **+ Capability** > **Sign in with Apple**
 
-**Update `app.json`:**
+**Update `app.json` for Expo:**
 ```json
 {
   "expo": {
@@ -245,7 +215,7 @@ cd ..
 // App.tsx
 import React from 'react';
 import { SafeAreaProvider } from 'react-native-safe-area-context';
-import { AuthProvider, AuthScreen, useAuth } from 'swiftauth-sdk';
+import { AuthProvider, AuthScreen, useAuth } from 'rn-swiftauth-sdk';
 
 // Your Firebase configuration
 const firebaseConfig = {
@@ -422,7 +392,7 @@ Build your own interface using the `useAuth()` hook:
 ```tsx
 import { useState } from 'react';
 import { View, TextInput, Button, Text } from 'react-native';
-import { useAuth } from 'swiftauth-sdk';
+import { useAuth } from 'rn-swiftauth-sdk';
 
 export const CustomLoginScreen = () => {
   const { signInWithEmail, error } = useAuth();
@@ -517,37 +487,143 @@ const config = {
 
 ---
 
-## 🧪 Testing
+## 🔌 Connecting to a Custom Backend
+
+The SwiftAuth SDK handles the complexity of authentication (Google, Apple, Email), but you likely have your own API for user data.
+
+The SDK exposes a secure Firebase ID Token (`user.token`) that you can send to your backend to identify the user.
+
+### 1. Frontend: Sending the Token
 
-Run the example app to test the SDK:
+In your React Native app, access the token from the `useAuth` hook and include it in the `Authorization` header of your API requests.
+
+```typescript
+import { useAuth } from 'rn-swiftauth-sdk';
+
+const UserProfile = () => {
+  const { user } = useAuth();
+
+  const fetchPrivateData = async () => {
+    if (!user?.token) return;
+
+    try {
+      const response = await fetch('https://your-api.com/profile', {
+        method: 'GET',
+        headers: {
+          'Content-Type': 'application/json',
+          // Send the token as a Bearer token
+          'Authorization': `Bearer ${user.token}`
+        }
+      });
+
+      const data = await response.json();
+      console.log('Secure Data:', data);
+    } catch (error) {
+      console.error('Request failed:', error);
+    }
+  };
+
+  return <Button title="Get Profile" onPress={fetchPrivateData} />;
+};
+```
+
+### 2. Backend: Verifying the Token
+
+Your backend must verify this token to ensure the request is legitimate. You can use the Firebase Admin SDK for this.
+
+**Example (Node.js / Express):**
+
+```javascript
+const admin = require('firebase-admin');
+const express = require('express');
+const app = express();
+
+// 1. Initialize Firebase Admin with your Service Account
+const serviceAccount = require('./path/to/serviceAccountKey.json');
+admin.initializeApp({
+  credential: admin.credential.cert(serviceAccount)
+});
+
+// 2. Middleware to Verify Token
+const verifyToken = async (req, res, next) => {
+  const authHeader = req.headers.authorization;
+  
+  if (!authHeader || !authHeader.startsWith('Bearer ')) {
+    return res.status(401).send('Unauthorized');
+  }
+
+  const idToken = authHeader.split('Bearer ')[1];
+
+  try {
+    // Decodes the token and checks signature
+    const decodedToken = await admin.auth().verifyIdToken(idToken);
+    
+    // Attach user info to request (uid, email, etc.)
+    req.user = decodedToken; 
+    next();
+  } catch (error) {
+    res.status(403).send('Invalid Token');
+  }
+};
+
+// 3. Protect Routes
+app.get('/profile', verifyToken, (req, res) => {
+  // Access user info securely
+  res.json({ message: `Hello ${req.user.email}, here is your private data.` });
+});
+```
+
+### Supported Backends
+
+This pattern works with any backend language that has a Firebase Admin SDK, including:
+
+- Node.js
+- Python
+- Go
+- Java
+- .NET
+
+---
+
+## 🧪 Example App
+
+Check out our example implementation:
 
 ```bash
-cd swiftauth-example
+# Clone the repository
+git clone https://github.com/allcodez/Auth-SDK_Stage8
+
+# Navigate to example app
+cd Auth-SDK_Stage8/swiftauth-example
+
+# Install dependencies
 npm install
+
+# Start the app
 npx expo start
 ```
 
 ---
 
-## 📖 Full Documentation
+## 📖 Additional Resources
 
-- [Installation Guide](./docs/installation.md)
-- [Getting Started](./docs/getting-started.md)
-- [API Reference](./docs/api-reference.md)
-- [Usage Examples](./docs/usage-examples.md)
-- [Error Codes](./docs/error-codes.md)
+- [Installation Guide](https://github.com/allcodez/Auth-SDK_Stage8/blob/main/docs/installation.md)
+- [Getting Started](https://github.com/allcodez/Auth-SDK_Stage8/blob/main/docs/getting-started.md)
+- [API Reference](https://github.com/allcodez/Auth-SDK_Stage8/blob/main/docs/api-reference.md)
+- [Usage Examples](https://github.com/allcodez/Auth-SDK_Stage8/blob/main/docs/usage-examples.md)
+- [Error Codes](https://github.com/allcodez/Auth-SDK_Stage8/blob/main/docs/error-codes.md)
 
 ---
 
 ## 🤝 Contributing
 
-We welcome contributions! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
+We welcome contributions! See [CONTRIBUTING.md](https://github.com/allcodez/Auth-SDK_Stage8/blob/main/CONTRIBUTING.md) for guidelines.
 
 ---
 
 ## 📄 License
 
-MIT License - see [LICENSE](./LICENSE) file for details.
+MIT License - see [LICENSE](https://github.com/allcodez/Auth-SDK_Stage8/blob/main/LICENSE) file for details.
 
 ---
 
@@ -556,6 +632,7 @@ MIT License - see [LICENSE](./LICENSE) file for details.
 - 📧 Email: support@swiftauth.dev
 - 🐛 Issues: [GitHub Issues](https://github.com/allcodez/Auth-SDK_Stage8/issues)
 - 💬 Discussions: [GitHub Discussions](https://github.com/allcodez/Auth-SDK_Stage8/discussions)
+- 📦 NPM Package: [rn-swiftauth-sdk](https://www.npmjs.com/package/rn-swiftauth-sdk)
 
 ---
 
@@ -567,7 +644,7 @@ MIT License - see [LICENSE](./LICENSE) file for details.
 - [ ] Multi-factor authentication (MFA)
 - [ ] Biometric authentication
 - [ ] Session refresh tokens
-- [ ] NPM package distribution
+- [x] NPM package distribution
 
 ---
 

package/contributors.md

@@ -0,0 +1,9 @@
+# 👥 Contributors
+
+A huge thank you to the team who built the SwiftAuth SDK!
+
+* 🛡️ **[@allcodez](https://github.com/allcodez)**
+* 🎨 **[@Peliah](https://github.com/Peliah)**
+* 🚀 **[@ukemeikot](https://github.com/ukemeikot)**
+
+Interested in contributing? Pull requests are welcome!

package/package.json

@@ -1,11 +1,12 @@
 {
     "name": "rn-swiftauth-sdk",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "files": [
         "dist",
-        "src"
+        "src",
+        "CONTRIBUTORS.md"
     ],
     "scripts": {
         "build": "tsc",
@@ -59,4 +60,4 @@
         "react-native-safe-area-context": "^5.6.2",
         "typescript": "^5.0.0"
     }
-}
+}