cryptique-sdk 1.0.0

package/lib/types/index.d.ts

@@ -0,0 +1,163 @@
+/**
+ * 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 default class CryptiqueSDK {
+  /**
+   * Initialize the SDK programmatically
+   */
+  init(options: CryptiqueOptions): Promise<any> | any;
+
+  /**
+   * Get the SDK instance
+   */
+  getInstance(): any | null;
+
+  /**
+   * 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>;
+
+  /**
+   * 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;
+
+  /**
+   * SDK version
+   */
+  version: string;
+
+  /**
+   * Site ID
+   */
+  siteId: string;
+
+  /**
+   * Session data
+   */
+  sessionData: SessionData;
+}
+
+export { CryptiqueSDK };