data-connector — API

Config

src/api/api.ts

export interface Config {
  // Server
  server: string

  // App
  clientId: string
  clientSecret?: string

  // User
  accessToken?: string
  refreshToken?: string
}

StorageAdapter

src/api/storage.ts

export interface StorageAdapter {
  getItem(key: string): string | null
  setItem(key: string, value: string): void
  removeItem(key: string): void
}

InMemoryStorage

src/api/storage.ts

export class InMemoryStorage implements StorageAdapter {
  private store = new Map<string, string>()
  getItem(key: string) {
    return this.store.has(key) ? this.store.get(key)! : null
  }
  setItem(key: string, value: string) {
    this.store.set(key, value)
  }
  removeItem(key: string) {
    this.store.delete(key)
  }
}

SessionStorageAdapter

src/api/storage.ts

export class SessionStorageAdapter implements StorageAdapter {
  getItem(key: string) {
    if (typeof window === 'undefined' || !window.sessionStorage) return null
    return window.sessionStorage.getItem(key)
  }
  setItem(key: string, value: string) {
    if (typeof window === 'undefined' || !window.sessionStorage) return
    window.sessionStorage.setItem(key, value)
  }
  removeItem(key: string) {
    if (typeof window === 'undefined' || !window.sessionStorage) return
    window.sessionStorage.removeItem(key)
  }
}

createDefaultStorage

src/api/storage.ts

export function createDefaultStorage(): StorageAdapter

WebSocketMessage

src/api/websocket.ts

export interface WebSocketMessage {
  type: string
  [key: string]: any
}

WebSocketEventHandler

src/api/websocket.ts

export type WebSocketEventHandler = (message: WebSocketMessage) => void

Session

src/hooks/useMixIdSession.ts

export interface Session {
  id: string
  deviceInfo: any
  lastActivityAt: string
  createdAt: string
}

UseMixIdSessionOptions

src/hooks/useMixIdSession.ts

export interface UseMixIdSessionOptions {
  onSessionDeleted?: () => void
  onSessionExpired?: () => void
  onSessionInvalid?: () => void
  heartbeatInterval?: number
  checkSessionOnMount?: boolean
}

useMixIdSession

src/hooks/useMixIdSession.ts

export function useMixIdSession(options: UseMixIdSessionOptions = {})

MixIdSyncStatus

src/hooks/useMixIdStatus.ts

export type MixIdSyncStatus = 'connected-ws' | 'connected-rest' | 'disconnected' | 'checking'

UseMixIdStatusReturn

src/hooks/useMixIdStatus.ts

export interface UseMixIdStatusReturn {
  isConnected: boolean
  syncStatus: MixIdSyncStatus
  hasConfig: boolean
  refresh: () => void
}

useMixIdStatus

src/hooks/useMixIdStatus.ts

export function useMixIdStatus(): UseMixIdStatusReturn

UseMixIdSyncOptions

src/hooks/useMixIdSync.ts

export interface UseMixIdSyncOptions {
  dataTypes?: string[]
  onSettingsUpdate?: (settings: any) => void
  onDataUpdate?: (dataType: string, data: Record<string, any>) => void
  getLocalSettings?: () => any
  getLocalData?: (dataType: string) => Promise<Record<string, any>>
  saveLocalSettings?: (settings: any) => void | Promise<void>
  saveLocalData?: (dataType: string, data: Record<string, any>) => void | Promise<void>
  mergeStrategy?: 'remote-wins' | 'local-wins' | 'newer-wins'
}

useMixIdSync

src/hooks/useMixIdSync.ts

export function useMixIdSync(options: UseMixIdSyncOptions = {})

Notification

src/hooks/useNotifications.ts

export interface Notification {
  id: string
  appId: string | null
  title: string
  message: string
  type: string
  read: boolean
  createdAt: string
}

useNotifications

src/hooks/useNotifications.ts

export function useNotifications()