bypilot-business-signup-sdk 0.1.0-beta.1 → 0.1.0-beta.7

package/README.md

@@ -0,0 +1,198 @@
+# ByPilot Business Signup SDK
+
+**[🇹🇷 Türkçe](README.tr.md) | 🇺🇸 English**
+
+OAuth and Embedded Signup SDK for business accounts (WhatsApp, Instagram, Facebook, etc.)
+
+## 🚀 Installation
+
+```bash
+npm install bypilot-business-signup-sdk
+```
+
+## 📝 Quick Start
+
+### WhatsApp Provider
+
+```typescript
+import { WhatsAppProvider } from "bypilot-business-signup-sdk";
+
+// Initialize the provider
+const whatsapp = new WhatsAppProvider({
+  clientId: "your_meta_app_id",
+  configId: "your_embedded_signup_config_id",
+  redirectUri: window.location.origin,
+  storage: "localStorage", // or 'sessionStorage'
+  graphApiVersion: "v21.0", // optional
+  sdkVersion: "v21.0", // optional
+});
+
+// Login with popup
+try {
+  const result = await whatsapp.loginWithPopup();
+
+  if (result.success) {
+    console.log("Access Token:", result.token.accessToken);
+    console.log("Session Info:", result.sessionInfo);
+  }
+} catch (error) {
+  console.error("Login failed:", error);
+}
+
+// Get current session
+const token = whatsapp.getAccessToken();
+const isAuthenticated = whatsapp.isAuthenticated();
+
+// Logout
+whatsapp.logout();
+```
+
+## 🔧 Configuration
+
+### WhatsApp Provider Options
+
+| Option            | Type                                   | Required | Description                                   |
+| ----------------- | -------------------------------------- | -------- | --------------------------------------------- |
+| `clientId`        | string                                 | ✅       | Your Meta App ID                              |
+| `configId`        | string                                 | ✅       | Embedded Signup Configuration ID              |
+| `redirectUri`     | string                                 | ✅       | Redirect URI (must be registered in Meta App) |
+| `storage`         | `'localStorage'` \| `'sessionStorage'` | ❌       | Token storage type (default: `localStorage`)  |
+| `graphApiVersion` | string                                 | ❌       | Graph API version (default: `v21.0`)          |
+| `sdkVersion`      | string                                 | ❌       | Facebook SDK version (default: `v21.0`)       |
+
+## 📚 API Reference
+
+### WhatsAppProvider
+
+#### Methods
+
+##### `loginWithPopup(): Promise<AuthResult>`
+
+Opens a popup for WhatsApp Business authentication.
+
+**Returns:** Promise that resolves to an `AuthResult` object.
+
+##### `logout(): void`
+
+Clears stored tokens and session data.
+
+##### `getAccessToken(): string | null`
+
+Returns the current access token or null if not authenticated.
+
+##### `isAuthenticated(): boolean`
+
+Returns true if user is currently authenticated.
+
+##### `getSessionInfoListener(callback: (info: WhatsAppSessionInfo) => void): () => void`
+
+Listens for session information updates.
+
+**Returns:** Unsubscribe function.
+
+#### Events
+
+The provider emits the following events:
+
+- `auth:start` - Authentication process started
+- `auth:success` - Authentication completed successfully
+- `auth:error` - Authentication failed
+- `auth:cancel` - User cancelled authentication
+
+```typescript
+// Listen to events
+const unsubscribe = whatsapp.on("auth:success", (result) => {
+  console.log("Authentication successful!", result);
+});
+
+// Don't forget to unsubscribe
+unsubscribe();
+```
+
+### Type Definitions
+
+#### AuthResult
+
+```typescript
+interface AuthResult {
+  success: boolean;
+  token?: {
+    accessToken: string;
+    expiresIn?: number;
+  };
+  sessionInfo?: WhatsAppSessionInfo;
+  error?: string;
+}
+```
+
+#### WhatsAppSessionInfo
+
+```typescript
+interface WhatsAppSessionInfo {
+  wabaId?: string; // WhatsApp Business Account ID
+  phoneNumberId?: string; // Phone Number ID
+  phoneNumber?: string; // Phone Number
+  businessId?: string; // Business Manager ID
+}
+```
+
+## 🏗️ Setup Guide
+
+### 1. Create Meta App
+
+1. Go to [Meta for Developers](https://developers.facebook.com/)
+2. Create a new app
+3. Add WhatsApp Business Platform product
+
+### 2. Configure Embedded Signup
+
+1. In your Meta app, go to WhatsApp → Configuration
+2. Set up Embedded Signup
+3. Add your domain to the allowlist
+4. Get your Configuration ID
+
+### 3. Set Redirect URI
+
+Add your redirect URI to your Meta app settings:
+
+- For development: `http://localhost:3000`
+- For production: `https://yourdomain.com`
+
+### 4. Implementation
+
+```typescript
+const whatsapp = new WhatsAppProvider({
+  clientId: "YOUR_META_APP_ID",
+  configId: "YOUR_CONFIG_ID",
+  redirectUri: window.location.origin,
+});
+```
+
+## 🔍 Error Handling
+
+```typescript
+try {
+  const result = await whatsapp.loginWithPopup();
+
+  if (!result.success) {
+    console.error("Authentication failed:", result.error);
+  }
+} catch (error) {
+  console.error("Unexpected error:", error);
+}
+```
+
+## 🎯 Browser Support
+
+- Chrome 80+
+- Firefox 74+
+- Safari 13.1+
+- Edge 80+
+
+## 📄 License
+
+MIT License - see [LICENSE](../LICENSE) for details.
+
+## 🤝 Contributing
+
+See the main [repository README](../README.md) for contribution guidelines.

package/README.tr.md

@@ -0,0 +1,198 @@
+# ByPilot Business Signup SDK
+
+**🇹🇷 Türkçe | [🇺🇸 English](README.md)**
+
+Business hesaplar için OAuth ve Embedded Signup SDK'sı (WhatsApp, Instagram, Facebook vb.)
+
+## 🚀 Kurulum
+
+```bash
+npm install bypilot-business-signup-sdk
+```
+
+## 📝 Hızlı Başlangıç
+
+### WhatsApp Provider
+
+```typescript
+import { WhatsAppProvider } from "bypilot-business-signup-sdk";
+
+// Provider'ı başlat
+const whatsapp = new WhatsAppProvider({
+  clientId: "meta_app_id_niz",
+  configId: "embedded_signup_config_id_niz",
+  redirectUri: window.location.origin,
+  storage: "localStorage", // veya 'sessionStorage'
+  graphApiVersion: "v21.0", // isteğe bağlı
+  sdkVersion: "v21.0", // isteğe bağlı
+});
+
+// Popup ile giriş yap
+try {
+  const result = await whatsapp.loginWithPopup();
+
+  if (result.success) {
+    console.log("Access Token:", result.token.accessToken);
+    console.log("Session Bilgisi:", result.sessionInfo);
+  }
+} catch (error) {
+  console.error("Giriş başarısız:", error);
+}
+
+// Mevcut session'ı al
+const token = whatsapp.getAccessToken();
+const isAuthenticated = whatsapp.isAuthenticated();
+
+// Çıkış yap
+whatsapp.logout();
+```
+
+## 🔧 Yapılandırma
+
+### WhatsApp Provider Seçenekleri
+
+| Seçenek           | Tip                                    | Gerekli | Açıklama                                        |
+| ----------------- | -------------------------------------- | ------- | ----------------------------------------------- |
+| `clientId`        | string                                 | ✅      | Meta App ID'niz                                 |
+| `configId`        | string                                 | ✅      | Embedded Signup Configuration ID                |
+| `redirectUri`     | string                                 | ✅      | Yönlendirme URI'si (Meta App'te kayıtlı olmalı) |
+| `storage`         | `'localStorage'` \| `'sessionStorage'` | ❌      | Token saklama türü (varsayılan: `localStorage`) |
+| `graphApiVersion` | string                                 | ❌      | Graph API versiyonu (varsayılan: `v21.0`)       |
+| `sdkVersion`      | string                                 | ❌      | Facebook SDK versiyonu (varsayılan: `v21.0`)    |
+
+## 📚 API Referansı
+
+### WhatsAppProvider
+
+#### Metodlar
+
+##### `loginWithPopup(): Promise<AuthResult>`
+
+WhatsApp Business kimlik doğrulama için popup açar.
+
+**Dönüş:** `AuthResult` nesnesine çözümlenen Promise.
+
+##### `logout(): void`
+
+Saklanan token'ları ve session verilerini temizler.
+
+##### `getAccessToken(): string | null`
+
+Mevcut access token'ı döndürür, kimlik doğrulanmamışsa null.
+
+##### `isAuthenticated(): boolean`
+
+Kullanıcı şu anda kimlik doğrulanmışsa true döndürür.
+
+##### `getSessionInfoListener(callback: (info: WhatsAppSessionInfo) => void): () => void`
+
+Session bilgisi güncellemelerini dinler.
+
+**Dönüş:** Abonelikten çıkma fonksiyonu.
+
+#### Olaylar
+
+Provider şu olayları yayar:
+
+- `auth:start` - Kimlik doğrulama süreci başlatıldı
+- `auth:success` - Kimlik doğrulama başarıyla tamamlandı
+- `auth:error` - Kimlik doğrulama başarısız
+- `auth:cancel` - Kullanıcı kimlik doğrulamayı iptal etti
+
+```typescript
+// Olayları dinle
+const unsubscribe = whatsapp.on("auth:success", (result) => {
+  console.log("Kimlik doğrulama başarılı!", result);
+});
+
+// Dinlemeyi durdurmayı unutmayın
+unsubscribe();
+```
+
+### Tip Tanımlamaları
+
+#### AuthResult
+
+```typescript
+interface AuthResult {
+  success: boolean;
+  token?: {
+    accessToken: string;
+    expiresIn?: number;
+  };
+  sessionInfo?: WhatsAppSessionInfo;
+  error?: string;
+}
+```
+
+#### WhatsAppSessionInfo
+
+```typescript
+interface WhatsAppSessionInfo {
+  wabaId?: string; // WhatsApp Business Account ID
+  phoneNumberId?: string; // Telefon Numarası ID
+  phoneNumber?: string; // Telefon Numarası
+  businessId?: string; // Business Manager ID
+}
+```
+
+## 🏗️ Kurulum Rehberi
+
+### 1. Meta App Oluştur
+
+1. [Meta for Developers](https://developers.facebook.com/)'a git
+2. Yeni bir app oluştur
+3. WhatsApp Business Platform ürününü ekle
+
+### 2. Embedded Signup Yapılandır
+
+1. Meta app'inde WhatsApp → Configuration'a git
+2. Embedded Signup'ı ayarla
+3. Domain'ini allowlist'e ekle
+4. Configuration ID'ni al
+
+### 3. Redirect URI Ayarla
+
+Meta app ayarlarına redirect URI'nizi ekleyin:
+
+- Geliştirme için: `http://localhost:3000`
+- Production için: `https://yourdomain.com`
+
+### 4. Uygulama
+
+```typescript
+const whatsapp = new WhatsAppProvider({
+  clientId: "META_APP_ID_NIZ",
+  configId: "CONFIG_ID_NIZ",
+  redirectUri: window.location.origin,
+});
+```
+
+## 🔍 Hata Yönetimi
+
+```typescript
+try {
+  const result = await whatsapp.loginWithPopup();
+
+  if (!result.success) {
+    console.error("Kimlik doğrulama başarısız:", result.error);
+  }
+} catch (error) {
+  console.error("Beklenmeyen hata:", error);
+}
+```
+
+## 🎯 Tarayıcı Desteği
+
+- Chrome 80+
+- Firefox 74+
+- Safari 13.1+
+- Edge 80+
+
+## 📄 Lisans
+
+MIT License - detaylar için [LICENSE](../LICENSE) dosyasına bakın.
+
+## 🤝 Katkıda Bulunma
+
+Katkı rehberi için ana [repository README](../README.md) dosyasına bakın.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bypilot-business-signup-sdk",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.7",
   "description": "Business hesaplar için OAuth ve Embedded Signup SDK'sı (WhatsApp, Instagram, Facebook vb.)",
   "author": "",
   "license": "MIT",
@@ -58,7 +58,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": ""
+    "url": "https://github.com/EmrullahAlku/bypilot-business-signup-sdk.git"
   },
   "engines": {
     "node": ">=18.0.0"