@clianta/sdk 1.5.1 → 1.6.1

package/dist/angular.d.ts

@@ -1,33 +1,3 @@
-/**
- * Clianta SDK - CRM API Client
- * @see SDK_VERSION in core/config.ts
- */
-
-type InboundEventType = 'user.registered' | 'user.updated' | 'user.subscribed' | 'user.unsubscribed' | 'contact.created' | 'contact.updated' | 'purchase.completed';
-interface InboundEventPayload {
-    /** Event type (e.g. "user.registered") */
-    event: InboundEventType;
-    /** Contact data — at least email or phone is required */
-    contact: {
-        email?: string;
-        phone?: string;
-        firstName?: string;
-        lastName?: string;
-        company?: string;
-        jobTitle?: string;
-        tags?: string[];
-    };
-    /** Optional extra data stored as customFields on the contact */
-    data?: Record<string, unknown>;
-}
-interface InboundEventResult {
-    success: boolean;
-    contactCreated: boolean;
-    contactId?: string;
-    event: string;
-    error?: string;
-}
-
 /**
  * Clianta SDK - Type Definitions
  * @see SDK_VERSION in core/config.ts
@@ -37,10 +7,6 @@ interface CliantaConfig {
     projectId?: string;
     /** Backend API endpoint URL */
     apiEndpoint?: string;
-    /** Auth token for server-side API access (user JWT) */
-    authToken?: string;
-    /** Workspace API key for server-to-server access (use instead of authToken for external apps) */
-    apiKey?: string;
     /** Enable debug mode with verbose logging */
     debug?: boolean;
     /** Automatically track page views on load and navigation */
@@ -84,6 +50,63 @@ interface ConsentState {
     personalization?: boolean;
 }
 type EventType = 'page_view' | 'button_click' | 'form_view' | 'form_submit' | 'form_interaction' | 'scroll_depth' | 'engagement' | 'download' | 'exit_intent' | 'error' | 'performance' | 'time_on_page' | 'custom';
+interface TrackingEvent {
+    /** Workspace/project ID */
+    workspaceId: string;
+    /** Anonymous visitor identifier */
+    visitorId: string;
+    /** Session identifier */
+    sessionId: string;
+    /** Event type category */
+    eventType: EventType;
+    /** Human-readable event name */
+    eventName: string;
+    /** Current page URL */
+    url: string;
+    /** Referrer URL */
+    referrer?: string;
+    /** Event properties/metadata */
+    properties: Record<string, unknown>;
+    /** Device information */
+    device: DeviceInfo;
+    /** UTM parameters */
+    utm?: UTMParams;
+    /** ISO timestamp */
+    timestamp: string;
+    /** SDK version */
+    sdkVersion: string;
+}
+interface DeviceInfo {
+    userAgent: string;
+    screen: string;
+    language: string;
+    timezone?: string;
+}
+interface UTMParams {
+    utmSource?: string;
+    utmMedium?: string;
+    utmCampaign?: string;
+    utmTerm?: string;
+    utmContent?: string;
+}
+interface GroupTraits {
+    /** Company/account name */
+    name?: string;
+    /** Industry */
+    industry?: string;
+    /** Company size */
+    employees?: number;
+    /** Annual revenue */
+    revenue?: number;
+    /** Company website */
+    website?: string;
+    /** Company plan/tier */
+    plan?: string;
+    /** Additional custom properties */
+    [key: string]: unknown;
+}
+/** Event middleware function — intercept or transform events before they are sent */
+type MiddlewareFn = (event: TrackingEvent, next: () => void) => void;
 interface UserTraits {
     firstName?: string;
     lastName?: string;
@@ -119,24 +142,18 @@ interface TrackerCore {
     deleteData(): void;
     /** Get current consent state */
     getConsentState(): ConsentState;
-    /** Get the current visitor's profile from the CRM */
-    getVisitorProfile(): Promise<VisitorProfile | null>;
-    /** Get the current visitor's recent activity */
-    getVisitorActivity(options?: VisitorActivityOptions): Promise<{
-        data: VisitorActivity[];
-        pagination: {
-            page: number;
-            limit: number;
-            total: number;
-            pages: number;
-        };
-    } | null>;
-    /** Get a summarized journey timeline for the current visitor */
-    getVisitorTimeline(): Promise<VisitorTimeline | null>;
-    /** Get engagement metrics for the current visitor */
-    getVisitorEngagement(): Promise<EngagementMetrics | null>;
-    /** Send a server-side inbound event (requires apiKey in config) */
-    sendEvent(payload: InboundEventPayload): Promise<InboundEventResult>;
+    /** Associate the current visitor with a group (company/account) */
+    group(groupId: string, traits?: GroupTraits): void;
+    /** Merge two visitor identities (e.g., anonymous → logged-in) */
+    alias(newId: string, previousId?: string): Promise<boolean>;
+    /** Track a screen view (for mobile-first PWAs and SPAs) */
+    screen(name: string, properties?: Record<string, unknown>): void;
+    /** Register event middleware to intercept/transform events before sending */
+    use(middleware: MiddlewareFn): void;
+    /** Register a callback to be invoked when the SDK is fully initialized */
+    onReady(callback: () => void): void;
+    /** Check if the SDK is fully initialized and ready */
+    isReady(): boolean;
     /** Create or update a contact by email (upsert) */
     createContact(data: PublicContactData): Promise<PublicCrmResult>;
     /** Update an existing contact by ID (limited fields) */
@@ -148,76 +165,6 @@ interface TrackerCore {
     /** Create an opportunity (e.g., from "Request Demo" forms) */
     createOpportunity(data: PublicOpportunityData): Promise<PublicCrmResult>;
 }
-interface VisitorProfile {
-    visitorId: string;
-    contactId?: string;
-    email?: string;
-    firstName?: string;
-    lastName?: string;
-    company?: string;
-    jobTitle?: string;
-    phone?: string;
-    status?: string;
-    lifecycleStage?: string;
-    tags?: string[];
-    leadScore?: number;
-    firstSeen?: string;
-    lastSeen?: string;
-    sessionCount?: number;
-    pageViewCount?: number;
-    totalTimeSpent?: number;
-    customFields?: Record<string, unknown>;
-}
-interface VisitorActivity {
-    _id?: string;
-    eventType: string;
-    eventName: string;
-    url: string;
-    properties?: Record<string, unknown>;
-    timestamp: string;
-}
-interface VisitorTimeline {
-    visitorId: string;
-    contactId?: string;
-    firstSeen: string;
-    lastSeen: string;
-    totalSessions: number;
-    totalPageViews: number;
-    totalEvents: number;
-    totalTimeSpentSeconds: number;
-    averageSessionDurationSeconds: number;
-    topPages: Array<{
-        url: string;
-        views: number;
-        avgTimeSeconds?: number;
-    }>;
-    recentActivities: VisitorActivity[];
-    devices: Array<{
-        userAgent: string;
-        lastSeen: string;
-    }>;
-}
-interface EngagementMetrics {
-    visitorId: string;
-    totalTimeOnSiteSeconds: number;
-    averageSessionDurationSeconds: number;
-    totalPageViews: number;
-    totalSessions: number;
-    engagementScore: number;
-    bounceRate: number;
-    lastActiveAt: string;
-    topEvents: Array<{
-        eventType: string;
-        count: number;
-    }>;
-}
-interface VisitorActivityOptions {
-    page?: number;
-    limit?: number;
-    eventType?: string;
-    startDate?: string;
-    endDate?: string;
-}
 interface PublicContactData {
     email: string;
     firstName?: string;