Skip to main content

​
Требования

Node.js

≥ 18.0.0

TypeScript

≥ 5.7 (опционально, типы включены)

React

≥ 17 (только для miniapp/react)

​
Установка через npm

npm install @exode-team/sdk
React — опциональная peer-зависимость. Если проект не использует React, модуль miniapp/react не подтянет его и не попадёт в бандл.

​
Импорты

У пакета три subpath-экспорта — импортируйте только нужный: 
import { ExodeAPI }        from '@exode-team/sdk/api'
import { ExodeMiniApp }    from '@exode-team/sdk/miniapp'
import { useExodeUser }    from '@exode-team/sdk/miniapp/react'
Не импортируйте из корня (@exode-team/sdk) — корневой экспорт не определён, чтобы избежать случайной загрузки серверного и клиентского кода в одном бандле.

​
Подключение через CDN

Для статических страниц без сборки доступен IIFE-бандл MiniApp-модуля: 
<script src="https://cdn.exode.biz/sdk/v0.1.2/miniapp.global.js"></script>
После подключения глобальный объект ExodeMiniAppSDK становится доступен: 
<script>
  const app = new ExodeMiniAppSDK.ExodeMiniApp({ appId: 'my-app' })

  app.init().then((ctx) => {
    console.log('User:', ctx.user.firstName)
  })
</script>
В проде всегда фиксируйте версию (v0.1.2, v0.2.0 и т. д.). Тег latest обновляется автоматически и может внести ломающие изменения.

​
TypeScript

Типы поставляются вместе с пакетом, дополнительный @types/... не требуется. 
import type {
  ExodeAPIConfig,
  ExodeMiniAppConfig,
  MiniAppContext,
  MiniAppUser,
  Platform,
} from '@exode-team/sdk/miniapp'