Контекст и типы

MiniAppContext

Полный контекст, который хост передаёт MiniApp при handshake. Возвращается из app.init() и доступен через app.getContext().

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

MiniAppUser

number

обязательно

Внутренний идентификатор пользователя в Exode. Для неавторизованного посетителя (страница с опцией «Доступна без входа») — 0, остальные поля при этом пустые.

string | null

Публичный UUID пользователя.

string | null

Имя пользователя.

string | null

Фамилия пользователя.

object | null

Аватар: id и ссылки в трёх размерах — small, medium, maximum (каждая string | null).

string | null

Email пользователя.

string | null

Телефон пользователя.

string

обязательно

Роль: Student, Tutor, Parent и др.

string | null

Язык интерфейса: 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 означает, что Exode запущен внутри нативной оболочки (например, iOS/Android-приложение). В остальных случаях web.

school

Поле school — публичные данные школы, которые использует само приложение Exode (например, name, domain, preferenceSettings). SDK типизирует его как Record<string, unknown>: состав полей не зафиксирован контрактом, поэтому проверяйте наличие нужного поля перед использованием.

События хоста (MiniAppEventMap)

Отправляются хостом при изменении данных. MiniApp подписывается через app.on(event, handler).

Событие	Payload	Когда срабатывает
`theme:changed`	`MiniAppTheme`	Пользователь переключил тему
`user:updated`	`MiniAppUser`	Изменился профиль или сменился аккаунт
`school:updated`	`Record<string, unknown>`	Изменились данные школы
`config:updated`	`MiniAppConfig`	Смена размера окна, языка
`route:changed`	`{ path, params }`	Хост изменил маршрут; `path` — шаблон маршрута, например `/course/:courseId([0-9_A-Za-z]+)`
`context:updated`	`Partial<MiniAppContext>`	Частичное обновление контекста (зарезервировано: текущая версия хоста это событие не отправляет)
`visibility:changed`	`{ visible: boolean }`	Iframe стал видимым/невидимым

Событие context:updated применяется к внутреннему кэшу автоматически. Остальные события кэш app.getContext() не обновляют — см. Получение текущего контекста.

Команды MiniApp → хост (MiniAppCommandMap)

Вызываются через namespaces app.route и app.ui.

Команда	Payload	Метод SDK
`navigate`	`{ path, params? }` — `path` — шаблон маршрута	`app.route.navigate()`
`navigate:back`	—	`app.route.back()`
`showSnackbar`	`{ message, type? }`	`app.ui.showSnackbar()`
`setTabbarVisible`	`{ visible }`	`app.ui.setTabbarVisible()`
`setHeaderVisible`	`{ visible }`	`app.ui.setHeaderVisible()` (на кастомных страницах пока без эффекта)
`minimize`	—	`app.ui.minimize()`
`close`	—	`app.ui.close()`

minimize сворачивает окно приложения и работает только для страниц с типом окна «Плавающее окно», «Панель справа» или «Во весь экран» (см. Кастомные страницы). Для типа «Страница» команда ничего не делает. Свёрнутое окно не выгружается: iframe живёт, состояние сохраняется, а приложение получает visibility:changed с visible: false.

BridgeMessage

Низкоуровневый формат сообщений postMessage. Обычно разработчику не нужен, но полезен при отладке.

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

Не отправляйте postMessage вручную. Все валидные взаимодействия идут через методы ExodeMiniApp — только они гарантируют корректный handshake, requestId и валидацию origin.

Импорт типов

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

// Platform отдельно не экспортируется:
type Platform = MiniAppContext['platform']

Обновлено: 2026-09-28 05:04 UTC

Начало работы

API Client

MiniApp

Контекст и типы

MiniAppContext

MiniAppUser

MiniAppTheme

MiniAppConfig

Platform

school

События хоста (MiniAppEventMap)

Команды MiniApp → хост (MiniAppCommandMap)

BridgeMessage

Импорт типов

​MiniAppContext

​MiniAppUser

​MiniAppTheme

​MiniAppConfig

​Platform

​school

​События хоста (MiniAppEventMap)

​Команды MiniApp → хост (MiniAppCommandMap)

​BridgeMessage

​Импорт типов

MiniAppContext

MiniAppUser

MiniAppTheme

MiniAppConfig

Platform

school

События хоста (MiniAppEventMap)

Команды MiniApp → хост (MiniAppCommandMap)

BridgeMessage

Импорт типов