Context and types

MiniAppContext

The full context the host passes to the MiniApp during the handshake. It is returned from app.init() and available via app.getContext().

interface MiniAppContext {
  user: MiniAppUser
  school: Record<string, unknown>
  theme: MiniAppTheme
  platform: Platform
  config: MiniAppConfig
}

MiniAppUser

number

required

The user’s internal ID in Exode. For an unauthenticated visitor (a page with the “Available without login” option) it is 0, and the other fields are empty.

string | null

The user’s public UUID.

string | null

The user’s first name.

string | null

The user’s last name.

object | null

Avatar: id and links in three sizes, small, medium, maximum (each string | null).

string | null

The user’s email.

string | null

The user’s phone number.

string

required

Role: Student, Tutor, Parent, etc.

string | null

Interface language: en, ru, uz, qa.

MiniAppTheme

interface MiniAppTheme {
  scheme: 'light' | 'dark'
}

MiniAppConfig

interface MiniAppConfig {
  isDesktop: boolean
  isMobile: boolean
  language: string
}

Platform

type Platform = 'web' | 'native'

native means Exode is running inside a native shell (for example, an iOS/Android app). Otherwise it is web.

school

The school field contains the school’s public data used by the Exode app itself (for example, name, domain, preferenceSettings). The SDK types it as Record<string, unknown>: the set of fields is not fixed by the contract, so check that the field you need is present before using it.

Host events (MiniAppEventMap)

Sent by the host when data changes. The MiniApp subscribes via app.on(event, handler).

Event	Payload	When it fires
`theme:changed`	`MiniAppTheme`	The user switched the theme
`user:updated`	`MiniAppUser`	The profile changed or the account was switched
`school:updated`	`Record<string, unknown>`	The school data changed
`config:updated`	`MiniAppConfig`	Window size or language changed
`route:changed`	`{ path, params }`	The host changed the route; `path` is the route template, for example `/course/:courseId([0-9_A-Za-z]+)`
`context:updated`	`Partial<MiniAppContext>`	Partial context update (reserved: the current host version does not send this event)
`visibility:changed`	`{ visible: boolean }`	The iframe became visible/hidden

The context:updated event is applied to the internal cache automatically. Other events do not update the app.getContext() cache; see Getting the current context.

MiniApp → host commands (MiniAppCommandMap)

Called via the app.route and app.ui namespaces.

Command	Payload	SDK method
`navigate`	`{ path, params? }` — `path` is the route template	`app.route.navigate()`
`navigate:back`	—	`app.route.back()`
`showSnackbar`	`{ message, type? }`	`app.ui.showSnackbar()`
`setTabbarVisible`	`{ visible }`	`app.ui.setTabbarVisible()`
`setHeaderVisible`	`{ visible }`	`app.ui.setHeaderVisible()` (no effect on custom pages yet)
`minimize`	—	`app.ui.minimize()`
`close`	—	`app.ui.close()`

minimize collapses the app window and works only for pages with the “Floating window”, “Side panel” or “Fullscreen” window type (see Custom pages). For the “Page” type the command does nothing. A collapsed window is not unloaded: the iframe stays alive, its state is preserved, and the app receives visibility:changed with visible: false.

BridgeMessage

The low-level postMessage message format. You usually do not need it, but it is useful for debugging.

interface BridgeMessage<T = unknown> {
  type: string
  requestId?: string
  payload?: T
  source: 'exode-host' | 'exode-miniapp'
}

Do not send postMessage manually. All valid interactions go through the ExodeMiniApp methods: only they guarantee a correct handshake, requestId and origin validation.

Importing types

import type {
  MiniAppContext,
  MiniAppUser,
  MiniAppTheme,
  MiniAppConfig,
  MiniAppEventMap,
  MiniAppCommandMap,
  BridgeMessage,
} from '@exode-team/sdk/miniapp'

// Platform is not exported separately:
type Platform = MiniAppContext['platform']

Updated: 2026-09-28 05:04 UTC

Getting started

API Client

MiniApp

MiniAppContext

MiniAppUser

MiniAppTheme

MiniAppConfig

Platform

school

Host events (MiniAppEventMap)

MiniApp → host commands (MiniAppCommandMap)

BridgeMessage

Importing types

​MiniAppContext

​MiniAppUser

​MiniAppTheme

​MiniAppConfig

​Platform

​school

​Host events (MiniAppEventMap)

​MiniApp → host commands (MiniAppCommandMap)

​BridgeMessage

​Importing types

MiniAppContext

MiniAppUser

MiniAppTheme

MiniAppConfig

Platform

school

Host events (MiniAppEventMap)

MiniApp → host commands (MiniAppCommandMap)

BridgeMessage

Importing types