@sessionlens/sdk 0.2.0 → 0.2.1

package/README.md

@@ -45,6 +45,103 @@ sessionLens.sessionLensIdentify({
 sessionLens.sessionLensReset();
 ```
 
+### Advanced Usage with Custom Configuration
+
+```javascript
+import sessionLens from '@sessionlens/sdk';
+
+// Initialize with custom API configuration
+await sessionLens.sessionLensInit({
+  sdk_key: 'your-sdk-key-here',
+  user_id: 'user123',
+  org_id: 'org456',
+  api_base_url: 'https://dev-api.sessionlens.com/v1', // Custom API base URL
+  endpoints: {
+    events: '/custom/events/ingest',     // Custom events endpoint
+    identify: '/custom/user/identify',   // Custom identify endpoint
+    reset: '/custom/session/reset',      // Custom reset endpoint
+    validate: '/custom/org/validate'     // Custom validation endpoint
+  },
+  debug: true
+});
+
+// Track events with rich properties
+sessionLens.sessionLensTrack({
+  event_name: 'user_action',
+  properties: {
+    action_type: 'form_submit',
+    form_name: 'contact_form',
+    fields_completed: 5,
+    time_spent: 120, // seconds
+    user_segment: 'premium',
+    referrer: document.referrer,
+    user_agent: navigator.userAgent
+  },
+  timestamp: Date.now() // Optional: auto-generated if not provided
+});
+
+// Identify user with comprehensive properties
+sessionLens.sessionLensIdentify({
+  user_id: 'user123',
+  properties: {
+    email: 'user@example.com',
+    name: 'John Doe',
+    plan: 'premium',
+    company: 'Acme Corp',
+    signup_date: '2024-01-15',
+    last_login: new Date().toISOString(),
+    preferences: {
+      theme: 'dark',
+      language: 'en',
+      notifications: true
+    }
+  }
+});
+```
+
+### Environment-Specific Configuration
+
+```javascript
+import sessionLens from '@sessionlens/sdk';
+
+// Determine environment
+const environment = process.env.NODE_ENV || 'development';
+
+// Environment-specific configuration
+const configs = {
+  development: {
+    api_base_url: 'https://dev-api.sessionlens.com/v1',
+    debug: true
+  },
+  staging: {
+    api_base_url: 'https://staging-api.sessionlens.com/v1',
+    debug: true
+  },
+  production: {
+    api_base_url: 'https://api.sessionlens.com/v1',
+    debug: false
+  }
+};
+
+// Initialize with environment-specific config
+await sessionLens.sessionLensInit({
+  sdk_key: 'your-sdk-key-here',
+  user_id: 'user123',
+  org_id: 'org456',
+  ...configs[environment]
+});
+
+// Track environment info
+sessionLens.sessionLensTrack({
+  event_name: 'app_initialized',
+  properties: {
+    environment: environment,
+    version: '1.0.0',
+    timestamp: Date.now()
+  }
+});
+```
+
 ### React Integration
 
 ```jsx
@@ -86,6 +183,103 @@ function App() {
 }
 ```
 
+### React Integration with Custom Configuration
+
+```jsx
+import React from 'react';
+import { useSessionLens, useSessionLensTrack, useSessionLensIdentify } from '@sessionlens/sdk';
+
+function App() {
+  // Environment-specific configuration
+  const environment = process.env.NODE_ENV || 'development';
+  
+  const configs = {
+    development: {
+      api_base_url: 'https://dev-api.sessionlens.com/v1',
+      debug: true
+    },
+    staging: {
+      api_base_url: 'https://staging-api.sessionlens.com/v1',
+      debug: true
+    },
+    production: {
+      api_base_url: 'https://api.sessionlens.com/v1',
+      debug: false
+    }
+  };
+
+  // Initialize SDK with environment-specific config
+  useSessionLens({
+    sdk_key: 'your-sdk-key-here',
+    user_id: 'user123',
+    org_id: 'org456',
+    ...configs[environment]
+  });
+
+  const track = useSessionLensTrack();
+  const identify = useSessionLensIdentify();
+
+  const handlePageView = () => {
+    track({
+      event_name: 'page_view',
+      properties: {
+        page: window.location.pathname,
+        referrer: document.referrer,
+        environment: environment,
+        timestamp: Date.now()
+      }
+    });
+  };
+
+  const handleUserAction = (action, details) => {
+    track({
+      event_name: 'user_action',
+      properties: {
+        action_type: action,
+        ...details,
+        user_agent: navigator.userAgent,
+        screen_resolution: `${screen.width}x${screen.height}`
+      }
+    });
+  };
+
+  const handleUserLogin = (userData) => {
+    identify({
+      user_id: userData.id,
+      properties: {
+        email: userData.email,
+        name: userData.name,
+        login_method: userData.loginMethod,
+        last_login: new Date().toISOString(),
+        preferences: userData.preferences
+      }
+    });
+  };
+
+  // Track page view on component mount
+  React.useEffect(() => {
+    handlePageView();
+  }, []);
+
+  return (
+    <div>
+      <button onClick={() => handleUserAction('button_click', { button: 'header_cta' })}>
+        Track Event
+      </button>
+      <button onClick={() => handleUserLogin({ 
+        id: 'user123', 
+        email: 'user@example.com',
+        name: 'John Doe',
+        loginMethod: 'email',
+        preferences: { theme: 'dark' }
+      })}>
+        Identify User
+      </button>
+    </div>
+  );
+}
+```
+
 ## Configuration
 
 ### Runtime Configuration

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sessionlens/sdk",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "SessionLens SDK for analytics and event tracking",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",