@outlit/core 1.4.3 → 1.5.0

package/dist/index.d.mts

@@ -18,29 +18,37 @@ interface BrowserTrackOptions {
     eventName: string;
     properties?: Record<string, string | number | boolean | null>;
 }
-interface BrowserIdentifyOptions {
+interface BrowserIdentifyOptions extends CustomerAttribution {
     email?: string;
+    /** Your system-owned user/contact ID. */
     userId?: string;
+    /** User/contact traits. */
     traits?: IdentifyTraits;
+    /** Customer/account-level traits. */
+    customerTraits?: CustomerTraits;
 }
 /**
- * Server identity - requires at least one of fingerprint, email, or userId.
- * This is validated at runtime to avoid complex union types that
- * cause TypeScript memory issues during type checking.
+ * Base server-side user identity.
+ * Track calls may use customerId without these fields.
+ * Identify calls still require email or userId at runtime.
+ * `customerId`-only track calls are valid immediately, but they stay provisional
+ * until the same customer/account/workspace later appears on identify() with
+ * the matching customerId and an email.
  *
  * - fingerprint: Device identifier for anonymous tracking (can be linked later)
  * - email: User's email address (definitive identity, resolves immediately)
- * - userId: App's internal user ID
+ * - userId: Your system-owned user/contact ID
  */
 interface ServerIdentity {
     fingerprint?: string;
     email?: string;
+    /** Your system-owned user/contact ID. */
     userId?: string;
 }
-/**
- * Customer-level traits that can be nested under `customer` in identify.
- * These are applied to the customer/account, not the individual user.
- */
+interface CustomerAttribution {
+    /** Your system-owned customer/account/workspace ID. */
+    customerId?: string;
+}
 interface CustomerTraits {
     /** Customer's billing plan */
     plan?: string;
@@ -48,33 +56,31 @@ interface CustomerTraits {
     [key: string]: string | number | boolean | null | undefined;
 }
 /**
- * Traits for identify calls, supporting both user-level
- * and nested customer-level properties.
+ * Traits for identify calls.
+ * These are user/contact traits, not customer/account traits.
  */
 interface IdentifyTraits {
-    /** Nested customer/account-level traits */
-    customer?: CustomerTraits;
     /** User-level traits */
-    [key: string]: string | number | boolean | null | CustomerTraits | undefined;
+    [key: string]: string | number | boolean | null | undefined;
 }
-interface ServerTrackOptions extends ServerIdentity {
+interface ServerTrackOptions extends ServerIdentity, CustomerAttribution {
     eventName: string;
     properties?: Record<string, string | number | boolean | null>;
     timestamp?: number;
 }
-interface ServerIdentifyOptions extends ServerIdentity {
+interface ServerIdentifyOptions extends ServerIdentity, CustomerAttribution {
     traits?: IdentifyTraits;
+    customerTraits?: CustomerTraits;
 }
 /**
  * Customer identity for SDK billing methods.
- * Domain is required as the primary identifier; additional identifiers are optional.
+ * Public billing calls should use `customerId`.
  */
-interface CustomerIdentifier {
-    /** Required: The customer's domain (e.g., "acme.com") */
-    domain: string;
-    /** Optional: Your internal customer ID */
-    customerId?: string;
-    /** Optional: Stripe customer ID (e.g., "cus_xxx") */
+interface CustomerIdentifier extends CustomerAttribution {
+    /**
+     * @deprecated Stripe customer identifier.
+     * Billing attribution should use `customerId` publicly.
+     */
     stripeCustomerId?: string;
 }
 interface BaseEvent {
@@ -99,11 +105,17 @@ interface IdentifyEvent extends BaseEvent {
     email?: string;
     userId?: string;
     fingerprint?: string;
+    customerId?: string;
+    customerTraits?: CustomerTraits;
     traits?: IdentifyTraits;
 }
 interface CustomEvent extends BaseEvent {
     type: "custom";
     eventName: string;
+    email?: string;
+    userId?: string;
+    fingerprint?: string;
+    customerId?: string;
     properties?: Record<string, string | number | boolean | null>;
 }
 interface CalendarEvent extends BaseEvent {
@@ -141,7 +153,6 @@ interface BillingEvent extends BaseEvent {
     /** Optional customer identifiers */
     customerId?: string;
     stripeCustomerId?: string;
-    domain?: string;
     /** Optional properties for context */
     properties?: Record<string, string | number | boolean | null>;
 }
@@ -149,10 +160,34 @@ type TrackerEvent = PageviewEvent | FormEvent | IdentifyEvent | CustomEvent | Ca
 /**
  * User identity for payload-level resolution.
  * Used by browser SDK when user is logged in (via setUser).
+ * Customer attribution is carried separately in `customerIdentity`.
  */
 interface PayloadUserIdentity {
     email?: string;
+    /** Your system-owned user/contact ID. */
     userId?: string;
+    /** User/contact traits. */
+    traits?: IdentifyTraits;
+    /**
+     * @deprecated Use payload-level `customerIdentity.customerId` instead.
+     * Kept for one compatibility window while callers migrate.
+     */
+    customerId?: string;
+    /**
+     * @deprecated Use payload-level `customerIdentity.customerTraits` instead.
+     * Kept for one compatibility window while callers migrate.
+     */
+    customerTraits?: CustomerTraits;
+}
+/**
+ * Customer identity for payload-level attribution.
+ * Used by browser SDK to attach account/workspace context to a batch.
+ * `customerId`-only attribution is valid and remains provisional until a later
+ * identify(email, customerId) call links that external account/workspace to a resolved customer.
+ */
+interface PayloadCustomerIdentity extends CustomerAttribution {
+    /** Customer/account traits. */
+    customerTraits?: CustomerTraits;
 }
 interface IngestPayload {
     visitorId?: string;
@@ -180,6 +215,12 @@ interface IngestPayload {
      * allowing immediate identity resolution for SPA/React apps.
      */
     userIdentity?: PayloadUserIdentity;
+    /**
+     * Customer/account identity for this batch of events.
+     * Used to attribute browser batches to a customer/workspace even when
+     * the customer fields are not present on every event.
+     */
+    customerIdentity?: PayloadCustomerIdentity;
 }
 interface IngestResponse {
     success: boolean;
@@ -193,88 +234,6 @@ declare const DEFAULT_API_HOST = "https://app.outlit.ai";
 
 declare const DEFAULT_DENIED_FORM_FIELDS: string[];
 
-/**
- * Extract UTM parameters from a URL.
- */
-declare function extractUtmParams(url: string): UtmParams | undefined;
-/**
- * Extract path from a URL.
- */
-declare function extractPathFromUrl(url: string): string;
-/**
- * Check if a field name should be denied (case-insensitive).
- */
-declare function isFieldDenied(fieldName: string, denylist: string[]): boolean;
-/**
- * Sanitize form fields by removing sensitive data.
- * Returns a new object with denied fields removed.
- */
-declare function sanitizeFormFields(fields: Record<string, string> | undefined, customDenylist?: string[]): Record<string, string> | undefined;
-/**
- * Validate that at least one identity field is provided.
- * Used by the server SDK to enforce identity requirements.
- *
- * Valid identities:
- * - fingerprint: Device identifier (for anonymous tracking, can be linked later)
- * - email: User's email (definitive identity)
- * - userId: App's internal user ID
- */
-declare function validateServerIdentity(fingerprint?: string, email?: string, userId?: string): void;
-/**
- * Validate that a string looks like a valid email address.
- */
-declare function isValidEmail(value: string): boolean;
-/**
- * Find an email value from form fields.
- *
- * Priority:
- * 1. Fields with input type="email" (if inputTypes map provided)
- * 2. Field names matching email patterns
- * 3. Any field with a value that looks like an email
- *
- * @param fields - Form field key-value pairs
- * @param inputTypes - Optional map of field names to input types
- * @returns The email value if found, undefined otherwise
- */
-declare function findEmailField(fields: Record<string, string>, inputTypes?: Map<string, string>): string | undefined;
-/**
- * Extract name fields from form data.
- *
- * Looks for:
- * - Full name fields (name, full_name, etc.)
- * - First name fields (first_name, fname, etc.)
- * - Last name fields (last_name, lname, etc.)
- *
- * If only first/last names are found, combines them into a full name.
- *
- * @param fields - Form field key-value pairs
- * @returns Object with name, firstName, and/or lastName if found
- */
-declare function findNameFields(fields: Record<string, string>): {
-    name?: string;
-    firstName?: string;
-    lastName?: string;
-};
-/**
- * Identity extracted from a form submission.
- */
-interface ExtractedIdentity {
-    email: string;
-    name?: string;
-    firstName?: string;
-    lastName?: string;
-}
-/**
- * Extract identity information (email + name) from form fields.
- *
- * Returns undefined if no valid email is found (email is required for identification).
- *
- * @param fields - Form field key-value pairs
- * @param inputTypes - Optional map of field names to input types
- * @returns Extracted identity with email and optional name fields, or undefined
- */
-declare function extractIdentityFromForm(fields: Record<string, string>, inputTypes?: Map<string, string>): ExtractedIdentity | undefined;
-
 interface BaseEventParams {
     url: string;
     referrer?: string;
@@ -301,6 +260,8 @@ declare function buildIdentifyEvent(params: BaseEventParams & {
     userId?: string;
     fingerprint?: string;
     traits?: IdentifyTraits;
+    customerId?: string;
+    customerTraits?: CustomerTraits;
 }): IdentifyEvent;
 /**
  * Build a custom event.
@@ -308,6 +269,10 @@ declare function buildIdentifyEvent(params: BaseEventParams & {
 declare function buildCustomEvent(params: BaseEventParams & {
     eventName: string;
     properties?: Record<string, string | number | boolean | null>;
+    email?: string;
+    userId?: string;
+    fingerprint?: string;
+    customerId?: string;
 }): CustomEvent;
 /**
  * Build a calendar booking event.
@@ -348,7 +313,6 @@ declare function buildBillingEvent(params: BaseEventParams & {
     status: BillingStatus;
     customerId?: string;
     stripeCustomerId?: string;
-    domain?: string;
     properties?: Record<string, string | number | boolean | null>;
 }): BillingEvent;
 /**
@@ -360,8 +324,11 @@ declare function buildBillingEvent(params: BaseEventParams & {
  * @param userIdentity - Optional user identity for immediate resolution (from setUser in SPA)
  * @param sessionId - Optional session ID for grouping events (browser SDK only)
  * @param fingerprint - Optional device identifier for server-side anonymous tracking
+ * @param customerIdentity - Optional customer identity for batch attribution. `customerId`-only
+ * batches are valid and remain provisional until a later identify(email, customerId) call
+ * links that external account/workspace to a resolved customer.
  */
-declare function buildIngestPayload(visitorId: string, source: SourceType, events: TrackerEvent[], userIdentity?: PayloadUserIdentity, sessionId?: string, fingerprint?: string): IngestPayload;
+declare function buildIngestPayload(visitorId: string, source: SourceType, events: TrackerEvent[], userIdentity?: PayloadUserIdentity, sessionId?: string, fingerprint?: string, customerIdentity?: PayloadCustomerIdentity): IngestPayload;
 /**
  * Maximum number of events in a single batch.
  */
@@ -371,4 +338,91 @@ declare const MAX_BATCH_SIZE = 100;
  */
 declare function batchEvents(events: TrackerEvent[]): TrackerEvent[][];
 
-export { type BillingEvent, type BillingStatus, type BrowserIdentifyOptions, type BrowserTrackOptions, type CalendarEvent, type CalendarProvider, type CustomEvent, type CustomerIdentifier, type CustomerTraits, DEFAULT_API_HOST, DEFAULT_DENIED_FORM_FIELDS, type EngagementEvent, type EventType, type ExplicitJourneyStage, type ExtractedIdentity, type FormEvent, type IdentifyEvent, type IdentifyTraits, type IngestPayload, type IngestResponse, MAX_BATCH_SIZE, type PageviewEvent, type PayloadUserIdentity, type ServerIdentifyOptions, type ServerIdentity, type ServerTrackOptions, type SourceType, type StageEvent, type TrackerConfig, type TrackerEvent, type UtmParams, batchEvents, buildBillingEvent, buildCalendarEvent, buildCustomEvent, buildEngagementEvent, buildFormEvent, buildIdentifyEvent, buildIngestPayload, buildPageviewEvent, buildStageEvent, extractIdentityFromForm, extractPathFromUrl, extractUtmParams, findEmailField, findNameFields, isFieldDenied, isValidEmail, sanitizeFormFields, validateServerIdentity };
+/**
+ * Extract UTM parameters from a URL.
+ */
+declare function extractUtmParams(url: string): UtmParams | undefined;
+/**
+ * Extract path from a URL.
+ */
+declare function extractPathFromUrl(url: string): string;
+/**
+ * Check if a field name should be denied (case-insensitive).
+ */
+declare function isFieldDenied(fieldName: string, denylist: string[]): boolean;
+/**
+ * Sanitize form fields by removing sensitive data.
+ * Returns a new object with denied fields removed.
+ */
+declare function sanitizeFormFields(fields: Record<string, string> | undefined, customDenylist?: string[]): Record<string, string> | undefined;
+/**
+ * Validate that at least one identity field is provided.
+ * Used by the server SDK to enforce identity requirements.
+ *
+ * Valid identities:
+ * - fingerprint: Device identifier (for anonymous tracking, can be linked later)
+ * - email: User's email (definitive identity)
+ * - userId: Your system-owned user/contact ID
+ * - customerId: Your system-owned customer/account/workspace ID
+ */
+declare function validateServerIdentity(fingerprint?: string, email?: string, userId?: string, customerId?: string): void;
+/**
+ * Validate that at least one customer identifier is provided for billing calls.
+ */
+declare function validateCustomerIdentity(customerId?: string, stripeCustomerId?: string): void;
+/**
+ * Validate that a string looks like a valid email address.
+ */
+declare function isValidEmail(value: string): boolean;
+/**
+ * Find an email value from form fields.
+ *
+ * Priority:
+ * 1. Fields with input type="email" (if inputTypes map provided)
+ * 2. Field names matching email patterns
+ * 3. Any field with a value that looks like an email
+ *
+ * @param fields - Form field key-value pairs
+ * @param inputTypes - Optional map of field names to input types
+ * @returns The email value if found, undefined otherwise
+ */
+declare function findEmailField(fields: Record<string, string>, inputTypes?: Map<string, string>): string | undefined;
+/**
+ * Extract name fields from form data.
+ *
+ * Looks for:
+ * - Full name fields (name, full_name, etc.)
+ * - First name fields (first_name, fname, etc.)
+ * - Last name fields (last_name, lname, etc.)
+ *
+ * If only first/last names are found, combines them into a full name.
+ *
+ * @param fields - Form field key-value pairs
+ * @returns Object with name, firstName, and/or lastName if found
+ */
+declare function findNameFields(fields: Record<string, string>): {
+    name?: string;
+    firstName?: string;
+    lastName?: string;
+};
+/**
+ * Identity extracted from a form submission.
+ */
+interface ExtractedIdentity {
+    email: string;
+    name?: string;
+    firstName?: string;
+    lastName?: string;
+}
+/**
+ * Extract identity information (email + name) from form fields.
+ *
+ * Returns undefined if no valid email is found (email is required for identification).
+ *
+ * @param fields - Form field key-value pairs
+ * @param inputTypes - Optional map of field names to input types
+ * @returns Extracted identity with email and optional name fields, or undefined
+ */
+declare function extractIdentityFromForm(fields: Record<string, string>, inputTypes?: Map<string, string>): ExtractedIdentity | undefined;
+
+export { type BillingEvent, type BillingStatus, type BrowserIdentifyOptions, type BrowserTrackOptions, type CalendarEvent, type CalendarProvider, type CustomEvent, type CustomerAttribution, type CustomerIdentifier, type CustomerTraits, DEFAULT_API_HOST, DEFAULT_DENIED_FORM_FIELDS, type EngagementEvent, type EventType, type ExplicitJourneyStage, type ExtractedIdentity, type FormEvent, type IdentifyEvent, type IdentifyTraits, type IngestPayload, type IngestResponse, MAX_BATCH_SIZE, type PageviewEvent, type PayloadCustomerIdentity, type PayloadUserIdentity, type ServerIdentifyOptions, type ServerIdentity, type ServerTrackOptions, type SourceType, type StageEvent, type TrackerConfig, type TrackerEvent, type UtmParams, batchEvents, buildBillingEvent, buildCalendarEvent, buildCustomEvent, buildEngagementEvent, buildFormEvent, buildIdentifyEvent, buildIngestPayload, buildPageviewEvent, buildStageEvent, extractIdentityFromForm, extractPathFromUrl, extractUtmParams, findEmailField, findNameFields, isFieldDenied, isValidEmail, sanitizeFormFields, validateCustomerIdentity, validateServerIdentity };