@meet-sudo/sdk 0.1.0

package/README.md

@@ -0,0 +1,192 @@
+# @meet-sudo/sdk
+
+Official JavaScript SDK for MeetSudo - the unified customer platform with chat, analytics, and session replay.
+
+**[Documentation](https://@meet-sudo/sdk.com/docs)** | **[Website](https://@meet-sudo/sdk.com)** | **[Dashboard](https://@meet-sudo/sdk.com/login)**
+
+## Installation
+
+### npm / yarn / pnpm
+
+```bash
+npm install @meet-sudo/sdk
+# or
+yarn add @meet-sudo/sdk
+# or
+pnpm add @meet-sudo/sdk
+```
+
+### Script Tag (CDN)
+
+```html
+<script src="https://cdn.@meet-sudo/sdk.com/sdk/@meet-sudo/sdk.js"></script>
+```
+
+## Quick Start
+
+### ES Modules
+
+```javascript
+import { @meet-sudo/sdk } from '@meet-sudo/sdk';
+
+// Initialize with your API key
+await @meet-sudo/sdk.init({
+  apiKey: 'your-api-key'
+});
+
+// Track events
+@meet-sudo/sdk.track('button_clicked', { buttonId: 'signup' });
+
+// Identify users
+await @meet-sudo/sdk.identify('user-123', {
+  email: 'user@example.com',
+  name: 'John Doe'
+});
+```
+
+### Script Tag
+
+```html
+<script src="https://cdn.@meet-sudo/sdk.com/sdk/@meet-sudo/sdk.js"></script>
+<script>
+  MeetSudo.init({
+    apiKey: 'your-api-key'
+  }).then(function() {
+    MeetSudo.track('page_loaded');
+  });
+</script>
+```
+
+## API Reference
+
+### `init(config)`
+
+Initialize the SDK. Must be called before any other methods.
+
+```typescript
+interface MeetSudoConfig {
+  apiKey: string;           // Required: Your MeetSudo API key
+  apiUrl?: string;          // Optional: API URL (default: https://api.@meet-sudo/sdk.com)
+  widgetUrl?: string;       // Optional: Widget URL (default: https://widget.@meet-sudo/sdk.com)
+  disableChat?: boolean;    // Optional: Disable chat widget
+  disableReplay?: boolean;  // Optional: Disable session replay
+  disableEvents?: boolean;  // Optional: Disable event tracking
+  disableAutoPageView?: boolean; // Optional: Disable automatic page view tracking
+}
+```
+
+### `identify(userId, traits?)`
+
+Identify a user with their unique ID and optional traits.
+
+```javascript
+await @meet-sudo/sdk.identify('user-123', {
+  email: 'user@example.com',
+  name: 'John Doe',
+  plan: 'pro',
+  signupDate: '2024-01-15'
+});
+```
+
+### `track(eventName, properties?)`
+
+Track a custom event with optional properties.
+
+```javascript
+@meet-sudo/sdk.track('purchase_completed', {
+  orderId: 'ord-123',
+  amount: 99.99,
+  currency: 'USD'
+});
+```
+
+### `page(properties?)`
+
+Track a page view. Called automatically on init unless `disableAutoPageView` is set.
+
+```javascript
+@meet-sudo/sdk.page({
+  title: 'Product Page',
+  category: 'E-commerce'
+});
+```
+
+### `chat(action)`
+
+Control the chat widget programmatically.
+
+```javascript
+// Open the chat widget
+@meet-sudo/sdk.chat('open');
+
+// Close the chat widget
+@meet-sudo/sdk.chat('close');
+
+// Hide the chat widget
+@meet-sudo/sdk.chat('hide');
+
+// Show the chat widget
+@meet-sudo/sdk.chat('show');
+```
+
+### Helper Methods
+
+```javascript
+// Check if SDK is initialized
+@meet-sudo/sdk.isInitialized(); // boolean
+
+// Get anonymous ID
+@meet-sudo/sdk.getAnonymousId(); // string | null
+
+// Get customer ID (after identify)
+@meet-sudo/sdk.getCustomerId(); // string | null
+```
+
+## Features
+
+### Chat Widget
+
+The chat widget is automatically loaded if enabled in your MeetSudo dashboard. You can control it programmatically using the `chat()` method.
+
+### Event Tracking
+
+Events are batched and sent every 5 seconds for optimal performance. On page unload, any remaining events are sent using `keepalive` fetch.
+
+### Session Replay
+
+Session replay automatically captures user interactions for debugging and UX analysis. Sensitive inputs (passwords, credit cards) are automatically masked.
+
+To exclude specific elements from recording:
+
+```html
+<!-- Using class -->
+<div class="@meet-sudo/sdk-no-record">Sensitive content</div>
+
+<!-- Using data attribute -->
+<div data-@meet-sudo/sdk-no-record>Sensitive content</div>
+```
+
+## TypeScript
+
+Full TypeScript support is included. Types are exported from the main package:
+
+```typescript
+import type {
+  MeetSudoConfig,
+  UserTraits,
+  EventProperties,
+  PageProperties,
+  ChatAction
+} from '@meet-sudo/sdk';
+```
+
+## Browser Support
+
+- Chrome 60+
+- Firefox 55+
+- Safari 11+
+- Edge 79+
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,86 @@
+interface MeetSudoConfig {
+    /** Your MeetSudo API key */
+    apiKey: string;
+    /** API URL (defaults to https://api.meetsudo.com) */
+    apiUrl?: string;
+    /** Widget URL (defaults to https://widget.meetsudo.com) */
+    widgetUrl?: string;
+    /** Disable chat widget */
+    disableChat?: boolean;
+    /** Disable session replay */
+    disableReplay?: boolean;
+    /** Disable event tracking */
+    disableEvents?: boolean;
+    /** Disable automatic page view tracking */
+    disableAutoPageView?: boolean;
+}
+interface UserTraits {
+    email?: string;
+    name?: string;
+    [key: string]: string | number | boolean | undefined;
+}
+interface EventProperties {
+    [key: string]: string | number | boolean | null | undefined;
+}
+interface PageProperties {
+    url?: string;
+    title?: string;
+    referrer?: string;
+    [key: string]: string | number | boolean | null | undefined;
+}
+type ChatAction = "open" | "close" | "show" | "hide";
+
+declare class MeetSudo {
+    private state;
+    private config;
+    /**
+     * Initialize the MeetSudo SDK
+     */
+    init(config: MeetSudoConfig): Promise<void>;
+    /**
+     * Identify a user
+     */
+    identify(userId: string, traits?: UserTraits): Promise<void>;
+    /**
+     * Track a custom event
+     */
+    track(eventName: string, properties?: EventProperties): void;
+    /**
+     * Track a page view
+     */
+    page(properties?: PageProperties): void;
+    /**
+     * Control the chat widget
+     */
+    chat(action: ChatAction): void;
+    /**
+     * Check if SDK is initialized
+     */
+    isInitialized(): boolean;
+    /**
+     * Get the anonymous ID
+     */
+    getAnonymousId(): string | null;
+    /**
+     * Get the customer ID (after identify)
+     */
+    getCustomerId(): string | null;
+    private getAnonId;
+    private generateUUID;
+    private api;
+    private createIframe;
+    private flushEvents;
+    private shouldSampleReplay;
+    private startReplay;
+    private initRrweb;
+    private isSensitiveInput;
+    private flushReplayChunk;
+    private setupRageClickDetection;
+    private setupErrorCapture;
+    private setupEmailCapture;
+    private handleUnload;
+}
+
+declare const meetsudo: MeetSudo;
+
+export { type ChatAction, type EventProperties, MeetSudo, type MeetSudoConfig, type PageProperties, type UserTraits, meetsudo };

package/dist/index.d.ts

@@ -0,0 +1,86 @@
+interface MeetSudoConfig {
+    /** Your MeetSudo API key */
+    apiKey: string;
+    /** API URL (defaults to https://api.meetsudo.com) */
+    apiUrl?: string;
+    /** Widget URL (defaults to https://widget.meetsudo.com) */
+    widgetUrl?: string;
+    /** Disable chat widget */
+    disableChat?: boolean;
+    /** Disable session replay */
+    disableReplay?: boolean;
+    /** Disable event tracking */
+    disableEvents?: boolean;
+    /** Disable automatic page view tracking */
+    disableAutoPageView?: boolean;
+}
+interface UserTraits {
+    email?: string;
+    name?: string;
+    [key: string]: string | number | boolean | undefined;
+}
+interface EventProperties {
+    [key: string]: string | number | boolean | null | undefined;
+}
+interface PageProperties {
+    url?: string;
+    title?: string;
+    referrer?: string;
+    [key: string]: string | number | boolean | null | undefined;
+}
+type ChatAction = "open" | "close" | "show" | "hide";
+
+declare class MeetSudo {
+    private state;
+    private config;
+    /**
+     * Initialize the MeetSudo SDK
+     */
+    init(config: MeetSudoConfig): Promise<void>;
+    /**
+     * Identify a user
+     */
+    identify(userId: string, traits?: UserTraits): Promise<void>;
+    /**
+     * Track a custom event
+     */
+    track(eventName: string, properties?: EventProperties): void;
+    /**
+     * Track a page view
+     */
+    page(properties?: PageProperties): void;
+    /**
+     * Control the chat widget
+     */
+    chat(action: ChatAction): void;
+    /**
+     * Check if SDK is initialized
+     */
+    isInitialized(): boolean;
+    /**
+     * Get the anonymous ID
+     */
+    getAnonymousId(): string | null;
+    /**
+     * Get the customer ID (after identify)
+     */
+    getCustomerId(): string | null;
+    private getAnonId;
+    private generateUUID;
+    private api;
+    private createIframe;
+    private flushEvents;
+    private shouldSampleReplay;
+    private startReplay;
+    private initRrweb;
+    private isSensitiveInput;
+    private flushReplayChunk;
+    private setupRageClickDetection;
+    private setupErrorCapture;
+    private setupEmailCapture;
+    private handleUnload;
+}
+
+declare const meetsudo: MeetSudo;
+
+export { type ChatAction, type EventProperties, MeetSudo, type MeetSudoConfig, type PageProperties, type UserTraits, meetsudo };