cryptique-sdk 1.2.23 → 1.2.24

package/lib/types/index.d.ts

@@ -1,250 +1,284 @@
-/**
- * Cryptique Analytics SDK - TypeScript Definitions
- */
-
-export interface CryptiqueOptions {
-  siteId: string;
-  autoEvents?: boolean;
-  disabledPaths?: string[];
-  disabledEvents?: string[];
-}
-
-export interface AutoEventsConfig {
-  enabled: boolean;
-  disabledPaths: string[];
-  disabledEvents: string[];
-  availableEvents: string[];
-  currentPath: string;
-  shouldTrack: boolean;
-}
-
-export interface SessionData {
-  sessionId: string | null;
-  siteId: string;
-  userId: string | null;
-  startTime: string | null;
-  endTime: string | null;
-  lastActivity: number | null;
-  duration: number;
-  pagesViewed: number;
-  isBounce: boolean;
-  [key: string]: any;
-}
-
-export interface Interaction {
-  timestamp: string;
-  category: string;
-  originalCategory: string;
-  [key: string]: any;
-}
-
-export interface PeopleResult {
-  success: boolean;
-  error?: string;
-  [key: string]: any;
-}
-
-export interface PeopleManager {
-  /**
-   * Set custom properties (merge at top level)
-   */
-  set(properties: Record<string, any>): Promise<PeopleResult>;
-
-  /**
-   * Set custom properties only if they don't exist
-   */
-  setOnce(properties: Record<string, any>): Promise<PeopleResult>;
-
-  /**
-   * Remove custom properties
-   */
-  unset(properties: string | string[]): Promise<PeopleResult>;
-
-  /**
-   * Increment numeric properties
-   */
-  increment(properties: Record<string, number>): Promise<PeopleResult>;
-
-  /**
-   * Append values to list properties
-   */
-  append(properties: Record<string, any>): Promise<PeopleResult>;
-
-  /**
-   * Union values with list properties (add unique values)
-   */
-  union(properties: Record<string, any[]>): Promise<PeopleResult>;
-
-  /**
-   * Remove values from list properties
-   */
-  remove(properties: Record<string, any>): Promise<PeopleResult>;
-
-  /**
-   * Track a charge/revenue event
-   */
-  trackCharge(amount: number, properties?: Record<string, any>): Promise<PeopleResult>;
-
-  /**
-   * Clear all charges
-   */
-  clearCharges(): Promise<PeopleResult>;
-
-  /**
-   * Delete user and all associated data
-   */
-  deleteUser(): Promise<PeopleResult>;
-}
-
-export default class CryptiqueSDK {
-  /**
-   * Initialize the SDK programmatically
-   * Returns a Promise that resolves when the SDK is fully initialized
-   */
-  init(options: CryptiqueOptions): Promise<any>;
-
-  /**
-   * Get the SDK instance
-   */
-  getInstance(): any | null;
-
-  /**
-   * Wait for SDK to be fully initialized
-   */
-  ready(): Promise<void>;
-
-  /**
-   * Track a custom event
-   */
-  track(eventName: string, properties?: object, options?: object): Promise<void>;
-
-  /**
-   * Track a custom event (alias for track)
-   */
-  trackEvent(eventName: string, properties?: object, options?: object): Promise<void>;
-
-  /**
-   * Track an auto event
-   */
-  trackAutoEvent(eventName: string, autoEventData?: object, elementData?: object): Promise<void>;
-
-  /**
-   * Connect wallet
-   */
-  connectWallet(): Promise<string | null>;
-
-  /**
-   * Check if wallet is connected
-   */
-  isWalletConnected(): Promise<boolean>;
-
-  /**
-   * Update wallet info
-   */
-  updateWalletInfo(): Promise<any>;
-
-  /**
-   * Identify a user with a unique identifier
-   * Merges identities if the identifier already exists for another user
-   */
-  identify(identifyId: string): Promise<{ success: boolean; merged?: boolean; newUserId?: string; error?: string }>;
-
-  /**
-   * Set wallet address for current user
-   * Merges identities if wallet address already exists for another user
-   */
-  walletAddress(walletAddress: string): Promise<{ success: boolean; merged?: boolean; newUserId?: string; error?: string }>;
-
-  /**
-   * Reset user identity to anonymous
-   * Generates a new anonymous distinct_id and clears identification
-   */
-  reset(): Promise<{ success: boolean; distinctId?: string; error?: string }>;
-
-  /**
-   * Set tracking consent
-   */
-  setTrackingConsent(consent: boolean): void;
-
-  /**
-   * Get tracking consent
-   */
-  getTrackingConsent(): boolean;
-
-  /**
-   * Get session data
-   */
-  getSessionData(): SessionData;
-
-  /**
-   * Get chronological interactions
-   */
-  getChronologicalInteractions(): Interaction[];
-
-  /**
-   * Sort interactions chronologically (alias)
-   */
-  sortInteractionsChronologically(): Interaction[];
-
-  /**
-   * Enable auto events
-   */
-  enableAutoEvents(): void;
-
-  /**
-   * Disable auto events
-   */
-  disableAutoEvents(): void;
-
-  /**
-   * Set auto events disabled paths
-   */
-  setAutoEventsDisabledPaths(paths: string | string[]): void;
-
-  /**
-   * Disable specific auto events
-   */
-  disableAutoEvent(events: string | string[]): void;
-
-  /**
-   * Enable specific auto events
-   */
-  enableAutoEvent(events: string | string[]): void;
-
-  /**
-   * Set auto events disabled events
-   */
-  setAutoEventsDisabledEvents(events: string[]): void;
-
-  /**
-   * Get available auto events
-   */
-  getAvailableAutoEvents(): string[];
-
-  /**
-   * Get auto events configuration
-   */
-  getAutoEventsConfig(): AutoEventsConfig;
-
-  /**
-   * People manager for custom user properties
-   */
-  people: PeopleManager;
-
-  /**
-   * SDK version
-   */
-  version: string;
-
-  /**
-   * Site ID
-   */
-  siteId: string;
-
-  /**
-   * Session data
-   */
-  sessionData: SessionData;
-}
-
-export { CryptiqueSDK };
+/**
+ * Cryptique Analytics SDK - TypeScript Definitions
+ */
+
+export interface CryptiqueOptions {
+  siteId: string;
+  autoEvents?: boolean;
+  disabledPaths?: string[];
+  disabledEvents?: string[];
+}
+
+export interface AutoEventsConfig {
+  enabled: boolean;
+  disabledPaths: string[];
+  disabledEvents: string[];
+  availableEvents: string[];
+  currentPath: string;
+  shouldTrack: boolean;
+}
+
+export interface SessionData {
+  sessionId: string | null;
+  siteId: string;
+  userId: string | null;
+  startTime: string | null;
+  endTime: string | null;
+  lastActivity: number | null;
+  duration: number;
+  pagesViewed: number;
+  isBounce: boolean;
+  [key: string]: any;
+}
+
+export interface Interaction {
+  timestamp: string;
+  category: string;
+  originalCategory: string;
+  [key: string]: any;
+}
+
+export interface PeopleResult {
+  success: boolean;
+  error?: string;
+  [key: string]: any;
+}
+
+export interface PeopleManager {
+  /**
+   * Set custom properties (merge at top level)
+   */
+  set(properties: Record<string, any>): Promise<PeopleResult>;
+
+  /**
+   * Set custom properties only if they don't exist
+   */
+  setOnce(properties: Record<string, any>): Promise<PeopleResult>;
+
+  /**
+   * Remove custom properties
+   */
+  unset(keys: string | string[]): Promise<PeopleResult>;
+
+  /**
+   * Increment a numeric property by key
+   */
+  increment(key: string, amount?: number): Promise<PeopleResult>;
+
+  /**
+   * Append values to an array property
+   */
+  append(key: string, values: any[]): Promise<PeopleResult>;
+
+  /**
+   * Union values with an array property (deduplicate)
+   */
+  union(key: string, values: any[]): Promise<PeopleResult>;
+
+  /**
+   * Remove values from an array property
+   */
+  remove(key: string, values: any[]): Promise<PeopleResult>;
+
+  /**
+   * Track a charge/revenue event
+   */
+  trackCharge(amount: number, properties?: Record<string, any>): Promise<PeopleResult>;
+
+  /**
+   * Clear all charges
+   */
+  clearCharges(): Promise<PeopleResult>;
+
+  /**
+   * Delete user and all associated data
+   */
+  deleteUser(): Promise<PeopleResult>;
+}
+
+/**
+ * Returned by get_group(); profile calls hit the groups profile API.
+ */
+export interface GroupProfileRef {
+  set(properties: Record<string, any>): Promise<PeopleResult>;
+  set_once(properties: Record<string, any>): Promise<PeopleResult>;
+  union(listName: string, values: any[]): Promise<PeopleResult>;
+  remove(listName: string, value: any): Promise<PeopleResult>;
+  unset(property: string): Promise<PeopleResult>;
+  increment(property: string, value?: number): Promise<PeopleResult>;
+  append(property: string, value: any): Promise<PeopleResult>;
+  delete(): Promise<PeopleResult>;
+}
+
+export default class CryptiqueSDK {
+  /**
+   * Initialize the SDK programmatically
+   * Returns a Promise that resolves when the SDK is fully initialized
+   */
+  init(options: CryptiqueOptions): Promise<any>;
+
+  /**
+   * Get the SDK instance
+   */
+  getInstance(): any | null;
+
+  /**
+   * Wait for SDK to be fully initialized
+   */
+  ready(): Promise<void>;
+
+  /**
+   * Track a custom event
+   */
+  track(eventName: string, properties?: object, options?: object): Promise<void>;
+
+  /**
+   * Track a custom event (alias for track)
+   */
+  trackEvent(eventName: string, properties?: object, options?: object): Promise<void>;
+
+  /**
+   * Track an auto event
+   */
+  trackAutoEvent(eventName: string, autoEventData?: object, elementData?: object): Promise<void>;
+
+  /**
+   * Connect wallet
+   */
+  connectWallet(): Promise<string | null>;
+
+  /**
+   * Check if wallet is connected
+   */
+  isWalletConnected(): Promise<boolean>;
+
+  /**
+   * Update wallet info
+   */
+  updateWalletInfo(): Promise<any>;
+
+  /**
+   * Identify a user with a unique identifier
+   * Merges identities if the identifier already exists for another user
+   */
+  identify(identifyId: string): Promise<{ success: boolean; merged?: boolean; newUserId?: string; error?: string }>;
+
+  /**
+   * Set wallet address for current user
+   * Merges identities if wallet address already exists for another user
+   */
+  walletAddress(walletAddress: string): Promise<{ success: boolean; merged?: boolean; newUserId?: string; error?: string }>;
+
+  /**
+   * Reset user identity to anonymous
+   * Generates a new anonymous distinct_id and clears identification
+   */
+  reset(): Promise<{ success: boolean; distinctId?: string; error?: string }>;
+
+  /**
+   * Set tracking consent
+   */
+  setTrackingConsent(consent: boolean): void;
+
+  /**
+   * Get tracking consent
+   */
+  getTrackingConsent(): boolean;
+
+  /**
+   * Get session data
+   */
+  getSessionData(): SessionData;
+
+  /**
+   * Get chronological interactions
+   */
+  getChronologicalInteractions(): Interaction[];
+
+  /**
+   * Sort interactions chronologically (alias)
+   */
+  sortInteractionsChronologically(): Interaction[];
+
+  /**
+   * Enable auto events
+   */
+  enableAutoEvents(): void;
+
+  /**
+   * Disable auto events
+   */
+  disableAutoEvents(): void;
+
+  /**
+   * Set auto events disabled paths
+   */
+  setAutoEventsDisabledPaths(paths: string | string[]): void;
+
+  /**
+   * Disable specific auto events
+   */
+  disableAutoEvent(events: string | string[]): void;
+
+  /**
+   * Enable specific auto events
+   */
+  enableAutoEvent(events: string | string[]): void;
+
+  /**
+   * Set auto events disabled events
+   */
+  setAutoEventsDisabledEvents(events: string[]): void;
+
+  /**
+   * Get available auto events
+   */
+  getAvailableAutoEvents(): string[];
+
+  /**
+   * Get auto events configuration
+   */
+  getAutoEventsConfig(): AutoEventsConfig;
+
+  /**
+   * People manager for custom user properties
+   */
+  people: PeopleManager;
+
+  /**
+   * Set (overwrite) group membership for a key
+   */
+  set_group(groupKey: string, groupId: string | string[]): Promise<PeopleResult>;
+
+  /**
+   * Add a group id to a key without removing existing memberships
+   */
+  add_group(groupKey: string, groupId: string): Promise<PeopleResult>;
+
+  /**
+   * Remove a specific group id from a key
+   */
+  remove_group(groupKey: string, groupId: string): Promise<PeopleResult>;
+
+  /**
+   * Group profile operations for a specific (groupKey, groupId)
+   */
+  get_group(groupKey: string, groupId: string): GroupProfileRef;
+
+  /**
+   * SDK version
+   */
+  version: string;
+
+  /**
+   * Site ID
+   */
+  siteId: string;
+
+  /**
+   * Session data
+   */
+  sessionData: SessionData;
+}
+
+export { CryptiqueSDK };