cdp-lite-sdk 0.1.8 → 0.2.0

package/README.md

@@ -12,6 +12,8 @@
 - [Quick Start](#quick-start)
 - [Configuration](#configuration)
 - [Security Features](#security-features)
+- [ID Management](#id-management)
+- [User Tracking](#user-tracking)
 - [Core Methods](#core-methods)
 - [Advanced Usage](#advanced-usage)
 - [React Integration](#react-integration)
@@ -222,6 +224,133 @@ const cdp = new CdpLiteSdk({
 
 ---
 
+<h2 id="user-tracking">🆔 ID Management</h2>
+
+CDP Lite SDK manages **5 types of IDs** for comprehensive user tracking:
+
+### ID Types
+
+| ID | Description | Persistence | Usage |
+|----|-------------|-------------|-------|
+| **user_id** | User identifier | Persistent | Set on login |
+| **profile_id** | CDP profile ID | Persistent | From API response |
+| **anonymous_id** | Anonymous visitor | Persistent | Auto-generated |
+| **device_id** | Device identifier | Persistent | Cross-session tracking |
+| **session_id** | Session identifier | Per session | Single visit |
+
+### Profile ID Flow
+
+```javascript
+// 1. User logs in
+await cdp.identifyUser('user_123', {
+  email: 'user@example.com'
+});
+
+// 2. SDK calls /v1/profiles/track
+// Response: { profile_id: 137455779753893888 }
+
+// 3. Profile ID stored automatically
+console.log(cdp.getProfileId()); // 137455779753893888
+
+// 4. All events include profile_id
+cdp.track('purchase', { amount: 100 });
+// Event includes: profile_id, device_id, session_id
+```
+
+### Get All IDs
+
+```javascript
+const ids = cdp.getUserIdentities();
+console.log(ids);
+// {
+//   user_id: 'user_123',
+//   profile_id: 137455779753893888,
+//   anonymous_id: '550e8400-...',
+//   device_id: '7a6f8b2e-...',
+//   session_id: 'abc12345-...'
+// }
+```
+
+### ID Methods
+
+```javascript
+// Get specific IDs
+cdp.getUserId()           // User ID
+cdp.getProfileId()        // Profile ID (from API)
+cdp.getDeviceId()         // Device ID (persistent)
+cdp.getSessionId()        // Session ID (per session)
+cdp.anonymousId           // Anonymous ID
+
+// Get all identities
+cdp.getUserIdentities()   // All IDs in one object
+```
+
+**📖 Complete Guide:** [IDS.md](IDS.md)
+
+
+---
+
+<h2 id="user-tracking">👤 User Tracking</h2>
+
+### MoEngage-like User API
+
+CDP Lite SDK provides MoEngage-compatible methods for user tracking:
+
+```javascript
+// Login/Identify user
+await cdp.identifyUser('user_123', {
+  full_name: 'John Doe',
+  email: 'john@example.com',
+  phone: '+84901234567'
+});
+
+// Update attributes with fluent API
+cdp
+  .add_first_name('John')
+  .add_last_name('Doe')
+  .add_email('john@example.com')
+  .add_mobile('+84901234567')
+  .add_gender('Male')
+  .add_birthday(new Date(1990, 0, 1));
+
+// Custom attributes
+cdp.add_user_attribute('membership_level', 'Gold');
+cdp.add_user_attributes({
+  loyalty_points: 1500,
+  vip_status: true
+});
+
+// Get user info
+const identities = cdp.getUserIdentities();
+const email = cdp.getUserAttribute('email');
+
+// Logout
+await cdp.destroy_session();
+```
+
+### Built-in User Methods
+
+| Method | Description |
+|--------|-------------|
+| `identifyUser(id, traits?)` | Login/identify user |
+| `add_first_name(value)` | Add first name |
+| `add_last_name(value)` | Add last name |
+| `add_user_name(value)` | Add full name |
+| `add_email(value)` | Add email |
+| `add_mobile(value)` | Add phone |
+| `add_gender(value)` | Add gender |
+| `add_birthday(value)` | Add date of birth |
+| `add_idcard(value)` | Add ID card |
+| `add_address(value)` | Add address |
+| `add_user_attribute(name, value)` | Add custom attribute |
+| `getUserIdentities()` | Get user identities |
+| `getUserAttribute(name)` | Get specific attribute |
+| `destroy_session()` | Logout user |
+
+**📖 Complete Guide:** [USER-TRACKING.md](USER-TRACKING.md)
+
+---
+
 <h2 id="core-methods">📚 Core Methods</h2>
 
 ### 1. Track Events
@@ -911,6 +1040,10 @@ MIT License - see LICENSE file for details
 ---
 
 ## 🤝 Support
+- 📖 [Full Documentation](README.md)
+- 🆔 [ID Management Guide](IDS.md)
+- 👤 [User Tracking Guide](USER_TRACKING.md)
+- 🔒 [Security Guide](SECURITY.md)
 - 📧 Email: vinv@vega.com.vn
 ---