API Reference

new TeardownCore(options: TeardownCoreOptions)

interface Persona {
  user_id?: string;
  email?: string;
  name?: string;
}

interface Session {
  session_id: string;
  device_id: string;
  user_id: string;
  token: string;
}

type IdentifyState =
  | { type: 'unidentified' }
  | { type: 'identifying' }
  | { type: 'identified'; session: Session; version_info: VersionInfo };

interface SignOutOptions {
  // Additional properties to include in the sign out event
  properties?: Record<string, unknown>;
  // Wait for event to be sent before clearing state (default: true)
  waitForEvent?: boolean;
}

type VersionStatus =
  | { type: 'initializing' }
  | { type: 'checking' }
  | { type: 'up_to_date' }
  | { type: 'update_available'; releaseNotes?: string | null }
  | { type: 'update_recommended'; releaseNotes?: string | null }
  | { type: 'update_required'; releaseNotes?: string | null }
  | { type: 'disabled' };

interface EventPayload {
  /** Name of the event (e.g., "button_clicked", "page_viewed") */
  event_name: string;
  /** Type of event */
  event_type?: "action" | "screen_view" | "custom";
  /** Additional properties to attach to the event */
  properties?: Record<string, unknown>;
  /** ISO timestamp. Defaults to current time if not provided */
  timestamp?: string;
}

const { core } = useTeardown();

// Track a single event
await core.events.track({
  event_name: 'button_clicked',
  event_type: 'action',
  properties: { button_id: 'submit-form' }
});

// Track multiple events
await core.events.trackBatch([
  { event_name: 'page_viewed', event_type: 'screen_view', properties: { page: 'home' } },
  { event_name: 'cta_shown', event_type: 'action' }
]);

interface PermissionStatus {
  granted: boolean;
  canAskAgain: boolean;
}

interface PushNotification {
  title?: string;
  body?: string;
  data?: Record<string, unknown>;
}

interface DataMessage {
  data: Record<string, unknown>;
}

enum NotificationPlatformEnum {
  APNS = "APNS",  // Apple Push Notification Service
  FCM = "FCM",    // Firebase Cloud Messaging
  EXPO = "EXPO",  // Expo Push Notifications
}

const { core } = useTeardown();

if (core.notifications) {
  // Request permissions
  const status = await core.notifications.requestPermissions();

  // Get token for backend
  const token = await core.notifications.getToken();

  // Listen for foreground notifications
  const unsub = core.notifications.onNotificationReceived((notification) => {
    console.log('Notification:', notification.title);
  });

  // Cleanup
  unsub();
}

interface DeviceInfo {
  timestamp?: Date;
  os: OSInfo;
  hardware: HardwareInfo;
  application: ApplicationInfo;
  update: DeviceUpdateInfo | null;
  notifications?: NotificationsInfo;
}

interface SupportedStorage {
  preload(): void;
  getItem(key: string): string | null;
  setItem(key: string, value: string): void;
  removeItem(key: string): void;
  clear(): void;
  keys(): string[];
}

interface ApplicationInfo {
  version: string;
  build_number: number;
}

interface HardwareInfo {
  device_name: string;
  device_brand: string;
  device_type: string;
}

interface OSInfo {
  platform: DevicePlatformEnum;
  name: string;
  version: string;
}

enum DevicePlatformEnum {
  IOS = "IOS",
  ANDROID = "ANDROID",
  WEB = "WEB",
  WINDOWS = "WINDOWS",
  MACOS = "MACOS",
  LINUX = "LINUX",
  UNKNOWN = "UNKNOWN",
  // ... and more
}

type AsyncResult<T> =
  | { success: true; data: T }
  | { success: false; error: string };

const result = await core.identity.identify({ user_id: '123' });

if (result.success) {
  console.log(result.data.session_id);
} else {
  console.error(result.error);
}