TypeScript types exported by the Wendung SDK reference

import type {
  AggregatePageviewPayload,
  Config,
  ConsentState,
  EventContext,
  EventRequestPayload,
  Identity,
  InitConfig,
  Payload,
  StepEvent,
} from '@wendung/sdk'

export type InitConfig = Pick<Config, 'apiKey'> &
  Partial<
    Pick<Config, 'endpoint' | 'flushInterval' | 'maxBatchSize' | 'trackPageviews' | 'debug'>
  > & {
    consent?: ConsentState
  }

export type ConsentState = 'pending' | 'granted' | 'denied'

export type Config = {
  apiKey: string
  endpoint: string
  flushInterval: number
  maxBatchSize: number
  trackPageviews: boolean | 'auto'
  debug?: boolean
}

export type Identity = {
  userId: string | null
  anonymousId?: string
  traits?: Record<string, unknown>
}

export type EventContext = {
  sdkName: '@wendung/sdk'
  sdkVersion: string
  pageUrl?: string
  referrer?: string
  pageTitle?: string
  screenWidth?: number
  screenHeight?: number
}

export type StepEvent = {
  id: string
  name: string
  properties?: Record<string, unknown>
  timestamp: string
  sessionId?: string
  identity?: Identity
  context?: EventContext
}

export type EventRequestPayload = {
  type: 'identity' | 'event'
  batchId: string
  sessionId: string
  identity: Identity
  events: StepEvent[]
  sentAt: string
  context: EventContext
}

export type Payload = EventRequestPayload

export type AggregatePageviewPayload = {
  type: 'event'
  collection: 'aggregate'
  batchId: string
  events: Pick<StepEvent, 'id' | 'name' | 'timestamp' | 'context'>[]
  sentAt: string
}