TutuHai

Открытая документация мини-приложений TutuHai

Интеграция SDK · API возможностей · Облачные данные · Авторизация · Публикация

Мини-приложения TutuHai — это лёгкие приложения, работающие внутри TutuHai. Разработчики загружают только фронтенд-пакет кода, размещаемый платформой; возможности взаимодействуют с TutuHai через SDK window.tt, без собственного бэкенда (бизнес-данные проходят через облачные данные TutuHai). Интеграция SDK · API возможностей · облачные данные · авторизация · публикация — всё на одной странице, с примерами, готовыми к копированию и запуску.

Создать мини-приложение в консоли 7 категорий · 26 тем · Нажмите заголовок, чтобы развернуть
Содержание · 26 тем

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

Возможности работы с данными

Беседы и многопользовательский режим

Файлы и облачный диск

Взаимодействие между приложениями

UI · окно · хост

Справочник

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

Введение

Мини-приложения TutuHai — это лёгкие приложения, работающие внутри TutuHai. Разработчики загружают только фронтенд-пакет кода, размещаемый платформой; возможности взаимодействуют с TutuHai через SDK window.tt, без собственного бэкенда (бизнес-данные проходят через облачные данные TutuHai).

Изоляция и безопасность: мини-приложения работают в изолированном iframe в песочнице на отдельном origin; сессия входа хоста никогда не попадает в мини-приложение. Для каждого вызова хост выдаёт кратковременный ограниченный токен, а бэкенд повторно проверяет права по возможностям (scope).

Быстрый старт
  1. В Консоли мини-приложений (/applets) нажмите «Создать», чтобы создать мини-приложение (имя + уникальный slug).
  2. Напишите одностраничный HTML (подключите SDK, вызывайте возможности через window.tt.*).
  3. Создайте версию → укажите запрашиваемые возможности → загрузите пакет кода (одностраничный HTML).
  4. Отправьте на проверку → администратор одобряет → публикация в продакшн в один клик.
  5. Пользователи находят/открывают его через поиск в «Обзоре», либо вы делитесь карточкой / копируете ссылку для прямого доступа.
Спецификация упаковки

Мини-приложения поддерживают две формы загрузки: ① одностраничный HTML-пакет (самодостаточный, точка входа = корень, самый простой); ② zip с результатом сборки реального фреймворка (папка dist/ из npm run build, с index.html + ресурсы в нескольких файлах — см. «Результат сборки фреймворка»). Перед загрузкой платформа выполняет проверку соответствия спецификации и оптимизацию.

Структура пакета (результат сборки)

your-applet/            # dev directory (any structure: src, components, assets…)
├─ src/ …               # your source (React / Vue / Svelte / vanilla)
└─ dist/index.html      # ★build output: single-file HTML (← upload this)
                        #   inlined CSS/JS, or referencing whitelisted CDNs; self-contained, no server

Пакет кода должен удовлетворять (проверяется автоматически при загрузке):

  • Точка входа: один HTML-файл с <!doctype html> и корневым <html>.
  • Адаптация под мобильные: обязательно наличие <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">.
  • SDK: подключите <script src="/applet-sdk.js"> (платформа перезаписывает его на абсолютный адрес хоста).
  • Самодостаточность: встраивайте CSS/JS; если нужны внешние скрипты, разрешены только SDK платформы + известные CDN фреймворков (unpkg / jsdelivr / cdnjs / esm.sh) — произвольные удалённые скрипты запрещены (безопасность). Изображения и другие медиа проходят через tt.uploadImage или CDN.
  • Размер: одностраничный HTML ≤ 1MB; многофайловый zip ≤ 8MB суммарно, ≤ 1MB на файл, ≤ 100 файлов; загружаемые изображения ≤ 4MB.
  • Данные: без собственного бэкенда — бизнес-данные проходят через облачные данные tt.cloud / tt.*storage.

📱🖥 Универсально для мобильных / десктопа (одна кодовая база, обе платформы)

Один и тот же пакет запускается в изолированном iframe внутри TutuHai; хост несёт его как на мобильных (полноэкранно), так и на десктопе (панель / можно развернуть на весь экран). Пишите одну универсальную кодовую базу с адаптивной вёрсткой: ① viewport-fit=cover + безопасные зоны env(safe-area-inset-*); ② оверлеи как нижние шторки (мобильные) ↔ по центру (десктоп, @media(min-width:480px)); ③ области касания ≥ 44px; ④ следуйте тёмной/светлой теме хоста (tt.onThemeChange / [data-theme]); ⑤ чистый DOM, без жёстко заданных ширин. Это обеспечивает единообразие работы и на телефоне, и на компьютере.

Результат сборки фреймворка (dist.zip)

Помимо одностраничного HTML, вы также можете загрузить результат сборки реального фреймворка — используйте React / Vue / Svelte / Angular / Solid / Astro / Next (статический экспорт) / vanilla… любой npm run build любого тулчейна, упакуйте папку dist/ в zip (с index.html + assets/*.js/css + шрифты/изображения) и загрузите для размещения.

Независимость от фреймворка: платформа распознаёт лишь один «универсальный контракт статического пакета» — точка входа index.html + относительные ссылки на ресурсы + SDK. Любой фреймворк, способный выдать статический dist, соответствующий этому контракту, поддерживается; приведённые ниже шаблоны — это лишь подобранные быстрые пути, а не предел поддержки.

Структура zip (результат сборки, корень zip = корень пакета)

myapp.zip
├─ index.html          # ★entry (zip root)
├─ manifest.json       # declares slug/name/version/scopes (see below)
└─ assets/
   ├─ index-*.js       # built JS (relative references)
   ├─ index-*.css
   └─ font/img…

Адаптация в три шага (работает для любого фреймворка):

  1. Задайте относительный base (рекомендуется, самый безопасный) — сделайте так, чтобы вывод ссылался на ресурсы по относительному пути (./assets/x.js, а не корне-абсолютный /assets/x.js), тогда размещение под /<slug>/ защищено от ошибок. (Base по умолчанию тоже работает: платформа автоматически перезаписывает корне-абсолютные статические ссылки в HTML/CSS и использует резервный вариант через Referer для корне-абсолютных ресурсов, генерируемых во время выполнения — таких как предзагрузки CSS при code-splitting; но при строгой Referrer-Policy / граничных случаях offline-prefetch Referer может отсутствовать и резервный вариант не сработает, поэтому относительный base безопаснее всего.)
  2. Добавьте манифест — положите manifest.json в статическую директорию (например, static/ во Vite/SvelteKit, public/ в большинстве фреймворков), чтобы после сборки он оказался в корне dist; либо опустите манифест и добавьте <meta name="tt:slug" content="…"> (плюс tt:name / tt:version / tt:scopes) в index.html как резервный вариант.
  3. Подключите SDK — двумя способами: ① установка через npm (рекомендуется, лучше всего для реальных шаблонов): после npm i @tutuhai/applet-sdk выполните import { tt } from '@tutuhai/applet-sdk' — он встраивается в вывод во время сборки, с типами TypeScript, без правок index.html; ② либо напишите <script src="/applet-sdk.js"> в index.html (платформа перезаписывает его на абсолютный адрес хоста) и используйте глобальный window.tt.

📦 npm SDK (протестировано с официальными шаблонами React / Vue / Svelte)

Создайте проект командой npm create vite@latest -- --template react-ts | vue-ts | svelte-ts, установите тот же @tutuhai/applet-sdk и сделайте import — реальный многофайловый исходный код, npm run build создаёт несколько чанков + одну точку входа index.html; упакуйте в zip и загрузите.

# 1) Create a project with an official scaffold
npm create vite@latest my-applet -- --template react-ts   # or vue-ts / svelte-ts

# 2) Install the SDK (same package for all three frameworks)
npm i @tutuhai/applet-sdk

# 3) import and use in your source (typed)
#    src/App.tsx / App.vue / App.svelte
import { tt } from '@tutuhai/applet-sdk';
tt.ready((ctx) => {
  tt.getProfile().then((me) => console.log('hi', me?.nickname));
});
await tt.cloud.add('notes', { text: 'hello' });   // cloud data, no backend of your own

# 4) vite.config: relative base; public/manifest.json declares slug/name/scopes
#    export default { base: './', plugins: [react()] }

# 5) official build → zip dist → upload
npm run build && cd dist && zip -r ../my-applet.zip .

Готовые к запуску примеры в репозитории: applets/frameworks/{react,vue,svelte} (три реальных проекта на официальных шаблонах, все import-ирующие один и тот же SDK-пакет). Исходный код SDK-пакета: applet-sdk/.

Поля manifest.json

{
  "slug": "myapp",              // ★required, globally unique, determines hosting path /myapp/
  "name": "My Mini-App",        // ★required, display name
  "version": "1.0.0",           // ★required, must increment on every upload
  "scopes": ["user.profile"],   // requested capabilities (see "Authorization model")
  "description": "One-line summary",  // optional, shown on discover/detail
  "icon": "icon.png",           // optional, relative path in the bundle (or change it in the console after upload)
  "display": "fullscreen",      // optional, default open mode: window (floating, default) | fullscreen
  "fileHandlers": [             // optional, declares "Open with" — which file kinds you can handle from a chat
    { "kinds": ["image"], "role": "editor", "label": "TutuEdit · Retouch" }
  ]
}
  • display: объявляет форму открытия на десктопе — для приложений типа canvas/whiteboard/редактор предпочтительнее fullscreen, для лёгких карточек/форм используйте значение по умолчанию window. Это лишь начальное значение; после публикации вы можете в любой момент изменить «Режим открытия» в консоли (консоль имеет приоритет). На мобильных всегда полноэкранно, независимо от этого поля. Если манифест опущен, в качестве резервного варианта работает <meta name="tt:display" content="fullscreen">.
  • fileHandlers: объявляет, какие виды файлов ваше мини-приложение может обрабатывать из чата — когда пользователь нажимает «Открыть с помощью» на файле в чате, мини-приложения, объявившие подходящий тип, появляются как кандидаты; нажатие на одно из них отправляет этот файл прямо в ваше мини-приложение (см. «Обработка файлов из чата»). Каждый элемент: kinds — одно из image / video / audio / pdf / office / text / any (можно несколько, any = любой файл); role — это editor (открыть в редакторе) или viewer (предпросмотр); label необязателен (≤20 символов, отображаемое имя кандидата). До 8 элементов. Ограничение совпадает с видимостью: private/self-use работает без проверки (появляется только в вашем собственном «Открыть с помощью»); public требует одобрения администратора, прежде чем станет действовать для всех.

Однострочная настройка «относительного base» для каждого фреймворка:

// Vite (React/Vue/Svelte/Solid/Preact/Lit…)
export default { base: './' }

// SvelteKit (client-side routing → base must = slug) — static export + base set to your slug (else routes 404)
import adapter from '@sveltejs/adapter-static';
export default { kit: {
  adapter: adapter({ fallback: 'index.html' }),
  paths: { base: '/your-slug', relative: true }
} };

// Astro — astro.config.mjs
export default { base: './', build: { assets: 'assets' } }

# Angular — set a relative base href at build time
ng build --base-href ./ --output-path dist

// Next.js (static export) — next.config.js
module.exports = { output: 'export', images: { unoptimized: true }, assetPrefix: './' }

// Nuxt 3 (static) — nuxt.config.ts
export default defineNuxtConfig({ app: { baseURL: './', cdnURL: './' }, ssr: false })

// Vue CLI / webpack — vue.config.js (or webpack output.publicPath)
module.exports = { publicPath: './' }

<!-- Vanilla / no build: just use relative paths -->
<script src="./app.js"></script>
<link rel="stylesheet" href="./style.css">

⚠ SPA с клиентской маршрутизацией (SvelteKit / React Router / Vue Router / Angular) Мини-приложения размещаются по подпути /<slug>/. SPA с клиентской маршрутизацией обязано задать свой «router base» равным вашему slug, иначе роутер фреймворка не сможет сопоставить текущий путь → 404 всей страницы (ресурсы загружаются, но маршрутизация сообщает «не найдено»). Задать только относительный base ресурсов недостаточно — это исправляет лишь URL-адреса ресурсов, а не маршрутизацию. По фреймворкам: SvelteKit kit.paths.base='/<slug>'; React Router <BrowserRouter basename="/<slug>">; Vue Router createWebHistory('/<slug>/'); Angular APP_BASE_HREF='/<slug>/'. (Приложения без клиентской маршрутизации — чистый рендеринг / одностраничный React без Router / vanilla — не затрагиваются.)

⚠ Проверка при загрузке При загрузке платформа выполняет «проверку соответствия контракту» для dist: точка входа / относительные пути / манифест / ссылка на SDK / лимиты / MIME проверяются по отдельности с встроенными подсказками. Суммарно ≤ 8MB, ≤ 1MB на файл, ≤ 100 файлов, только MIME из белого списка (html/css/js/json/изображения/шрифты/map/wasm). Сжимайте и подмножьте шрифты, чтобы уменьшить размер. Для тяжеловесных выводов фреймворков (например, tldraw / excalidraw с единым чанком >1MB), превышающих лимиты по умолчанию на файл/суммарно, попросите команду эксплуатации поднять лимиты «байт на файл» / «суммарно в распакованном виде» в админ-панели (изменяется на лету, действует сразу); разбиение manualChunks также может уложить vendor в лимит.

Минимальный пример

Полное, готовое к запуску мини-приложение — подключите SDK, прочитайте никнейм пользователя:

<!doctype html>
<html>
  <body>
    <div id="who">Loading…</div>
    <!-- Relative path — maintenance-free: survives domain changes/blocks (platform rewrites to the host's absolute URL) -->
    <script src="/applet-sdk.js"></script>
    <script>
      window.tt.ready(function () {
        window.tt.getProfile().then(function (me) {
          document.getElementById('who').textContent = 'Hi, ' + me.nickname;
        });
      });
    </script>
  </body>
</html>
Интеграция SDK

Подключите скрипт SDK в HTML вашего мини-приложения, затем используйте window.tt:

<!-- Include the SDK in your mini-app HTML. Use a relative path — don't hardcode a domain -->
<script src="/applet-sdk.js"></script>

Никогда не прописывайте домен хоста жёстко в вашем мини-приложении. Пишите относительный /applet-sdk.js (или любой origin-заглушку) — платформа перезаписывает URL скрипта SDK на текущий хост во время выдачи, когда ваше приложение работает в своём iframe. Поэтому даже если TutuHai сменит домен или домен окажется заблокирован, каждое опубликованное мини-приложение продолжает работать без изменения кода и без повторной публикации — оператор меняет одно значение конфигурации.

Колбэк готовности, контекст и тема/локаль:

// After ready you get the context (appId / granted scopes / deep-link path / query / theme / locale / whether inline)
window.tt.ready(function (ctx) {
  console.log(ctx.appId, ctx.scopes, ctx.path, ctx.query, ctx.theme, ctx.colorScheme, ctx.locale, ctx.inline);
});
window.tt.context();   // get the current context snapshot anytime (same as ready's ctx)

// Theme switching (fires live when the host toggles light/dark)
window.tt.onThemeChange(function (theme) {
  document.documentElement.setAttribute('data-theme', theme);
});

// Locale switching (synced with the host's i18n; fires live when the host changes language — same mechanism as theme)
window.tt.onLocaleChange(function (locale) {   // e.g. 'zh-CN' / 'en-US'
  document.documentElement.setAttribute('lang', locale);  // the SDK sets it already; you can also localize your own copy
});
Примеры для фреймворков

window.tt независим от фреймворка и работает напрямую во всех основных фреймворках (один файл, без сборки). Каждый пример включает обработку как успеха ✅, так и сбоя ❌ (отказ в авторизации / сетевая ошибка):

Vanilla JS

// No framework — vanilla DOM
window.tt.ready(function () {
  window.tt.getProfile()
    .then(function (me) {              // ✅ success
      document.getElementById('who').textContent = 'Hi, ' + me.nickname;
    })
    .catch(function (err) {            // ❌ failure (user denied authorization / network error)
      document.getElementById('who').textContent = 'Failed: ' + err.message;
    });
});

React

// React 18 + htm (no build)
const { useState, useEffect } = React;
function App() {
  const [me, setMe] = useState(null);
  const [err, setErr] = useState('');
  useEffect(() => {
    window.tt.ready(() =>
      window.tt.getProfile().then(setMe).catch((e) => setErr(e.message))
    );
  }, []);
  if (err) return html`<div>Failed: ${err}</div>`;      // ❌
  return html`<div>Hi ${me ? me.nickname : '…'}</div>`;  // ✅
}

Preact

// Preact + htm (no build)
const { useState, useEffect } = preactHooks;
function App() {
  const [me, setMe] = useState(null), [err, setErr] = useState('');
  useEffect(() => {
    window.tt.ready(() =>
      window.tt.getProfile().then(setMe).catch((e) => setErr(e.message))
    );
  }, []);
  return html`<div>${err ? 'Failed: ' + err : 'Hi ' + (me ? me.nickname : '…')}</div>`;
}

Vue 3

// Vue 3 (CDN)
const { createApp, ref, onMounted } = Vue;
createApp({
  setup() {
    const me = ref(null), err = ref('');
    onMounted(() => window.tt.ready(() =>
      window.tt.getProfile()
        .then((p) => (me.value = p))     // ✅
        .catch((e) => (err.value = e.message))  // ❌
    ));
    return { me, err };
  },
  template: `<div>{{ err ? 'Failed: ' + err : 'Hi ' + (me?.nickname ?? '…') }}</div>`
}).mount('#app');

Svelte

// Svelte (runtime compile)
let me = $state(null), err = $state('');
window.tt.ready(() =>
  window.tt.getProfile()
    .then((p) => (me = p))            // ✅
    .catch((e) => (err = e.message))  // ❌
);
// template: <div>{err ? 'Failed: ' + err : 'Hi ' + (me?.nickname ?? '…')}</div>

Solid

// SolidJS
import { createSignal, onMount } from 'solid-js';
function App() {
  const [me, setMe] = createSignal(null), [err, setErr] = createSignal('');
  onMount(() => window.tt.ready(() =>
    window.tt.getProfile().then(setMe).catch((e) => setErr(e.message))
  ));
  return <div>{err() ? 'Failed: ' + err() : 'Hi ' + (me()?.nickname ?? '…')}</div>;
}

Alpine.js

<!-- Alpine.js: declarative in HTML, zero build -->
<div x-data="{ me: null, err: '' }"
     x-init="window.tt.ready(() =>
       window.tt.getProfile()
         .then(p => me = p)              /* ✅ */
         .catch(e => err = e.message))"> <!-- ❌ -->
  <span x-text="err ? 'Failed: ' + err : 'Hi ' + (me?.nickname ?? '…')"></span>
</div>

Lit

// Lit (Web Components)
import { LitElement, html } from 'lit';
class MyApp extends LitElement {
  static properties = { me: {}, err: {} };
  connectedCallback() {
    super.connectedCallback();
    window.tt.ready(() =>
      window.tt.getProfile()
        .then((p) => (this.me = p))            // ✅
        .catch((e) => (this.err = e.message))  // ❌
    );
  }
  render() {
    return html`<div>${this.err ? 'Failed: ' + this.err : 'Hi ' + (this.me?.nickname ?? '…')}</div>`;
  }
}
customElements.define('my-app', MyApp);

jQuery

// jQuery
$(function () {
  window.tt.ready(function () {
    window.tt.getProfile()
      .then(function (me) { $('#who').text('Hi, ' + me.nickname); })      // ✅
      .catch(function (err) { $('#who').text('Failed: ' + err.message); }); // ❌
  });
});

Angular

// Angular (component)
@Component({ selector: 'app-root', template: `<div>{{ msg }}</div>` })
export class AppComponent implements OnInit {
  msg = 'Loading…';
  ngOnInit() {
    const tt = (window as any).tt;
    tt.ready(() =>
      tt.getProfile()
        .then((me: any) => (this.msg = 'Hi, ' + me.nickname))       // ✅
        .catch((e: any) => (this.msg = 'Failed: ' + e.message))     // ❌
    );
  }
}

Полные готовые к запуску примеры находятся в репозитории: applet-platform/samples/demo-react.html, demo-svelte.html, demo-vue.html.

Возможности работы с данными

Профиль пользователя · user.profile 
// Get the current user's profile (needs user.profile; on first call the host prompts for authorization as needed)
try {
  const me = await window.tt.getProfile();       // ✅ success
  console.log(me.userId, me.nickname, me.avatarUrl);
} catch (err) {                                   // ❌ failure
  // err.message: "User denied authorization" (tapped deny) / network error
  console.warn('Failed to get profile:', err.message);
}

// Profile changes (you or someone in the room changed nickname/avatar) → re-fetch and refresh display
window.tt.onProfileChange(() => refreshWhoUI());
Облачные данные · cloud.data

Размещаемые структурированные коллекции, позволяющие мини-приложению хранить бизнес-данные без собственного бэкенда. Три уровня видимости:

  • mine: чтение/запись только своих собственных документов (по умолчанию).
  • all: чтение/запись всего, только разработчик мини-приложения (владелец) — для «консоли продавца», чтобы видеть все заказы/заявки.
  • public: любой авторизованный пользователь может читать всё, имя коллекции должно начинаться с pub_ — для сообщества/маркетплейса/форума; запись и редактирование по-прежнему ограничены автором.
// Cloud data: no backend of your own, business data hosted by the TutuHai platform. All calls return a Promise — always handle failure.
try {
  // Create a document (owned by the current user)
  const { id } = await window.tt.cloud.add('orders', { items: cart, total: 68, status: 'pending' });
  // Idempotent upsert: create or update by docKey (most common for "one vote per person" / one record per user, avoids fetch-id-then-update)
  await window.tt.cloud.put('votes', me.userId, { choice: 'A' });
  // My documents
  const mine = await window.tt.cloud.list('orders', { scope: 'mine' });
  // Read one (by id; returns null if not found)
  const doc = await window.tt.cloud.get('orders', id);
  // All documents (developer/owner only, for the merchant console; regular users → 403)
  const all = await window.tt.cloud.list('orders', { scope: 'all' });
  // Public collection: name starts with pub_ → any logged-in user can read everything (community/marketplace)
  const posts = await window.tt.cloud.list('pub_posts', { scope: 'public' });
  // where equality filter (server filters on a single data field; on large collections it narrows by parent key to avoid child docs being cut off by the 200 cap)
  const votes = await window.tt.cloud.list('pub_votes', { scope: 'public', where: { pollId: id } });
  // Beyond 200 rows: listPage cursor pagination (mine/all; can take where), returns { docs, nextCursor }
  const pg = await window.tt.cloud.listPage('orders', { scope: 'mine', limit: 100, before: cursor });
  // Field-level update (owner or developer; patch merges with the original data)
  await window.tt.cloud.update('orders', id, { status: 'done' });
  // Delete a document (owner or developer; idempotent) — completes CRUD, no need to pile up soft-delete flags
  await window.tt.cloud.delete('orders', id);
} catch (err) {                                   // ❌ failure
  // Insufficient permission (403) / using public on a non-pub_ collection (400) / quota exceeded / network
  console.warn('Cloud data error:', err.message);
}

Каждая строка читается обратно как { id, ownerId, mine, data:{…your fields}, createdAt, updatedAt } — ваши поля все находятся в data (например, row.data.title).

KV-хранилище · storage.kv

Ключ-значение, изолированное для пары (мини-приложение, пользователь), удобно для небольшого приватного состояния вроде счётчиков отметок, черновиков и т. д. tt.cloudStorage (setItem/getItem/getKeys/removeItem) — это его алиас в стиле Telegram.

// Hosted KV (needs storage.kv): isolated per (mini-app, user), stores private state
try {
  await window.tt.setStorage('count', 3);
  const n = await window.tt.getStorage('count'); // 3 (returns null if absent)
  await window.tt.removeStorage('count');
  const keys = await window.tt.getStorageKeys();
} catch (err) {                                   // ❌ quota (≤64 keys / 8KB) / network
  console.warn('Storage failed:', err.message);
}

// Telegram-style alias (same as above, needs storage.kv):
await window.tt.cloudStorage.setItem('draft', 'unsent content');
const draft = await window.tt.cloudStorage.getItem('draft');   // returns null if absent
const ks = await window.tt.cloudStorage.getKeys();
await window.tt.cloudStorage.removeItem('draft');

Беседы и многопользовательский режим

Возможности бесед · im.share / im.send / im.read / media.upload

Всё взаимодействие с беседами TutuHai опосредуется хостом (пользователь активно выбирает беседу); мини-приложения не могут получить полный список бесед. im.read — это чувствительная возможность.

// Conversation capabilities are all host-mediated (the user actively picks a conversation); always handle "user cancelled" and failure.
try {
  // Share this mini-app's card to a conversation (needs im.share; if no conversation is passed the host shows a picker)
  await window.tt.shareToChat({ title: 'Come vote for lunch 🍜' });
  // Send a text notification to a conversation (needs im.send; the host shows a picker + preview, signed "via the X mini-app")
  await window.tt.sendMessage('Vote result: Lanzhou beef noodles win');
  // Read conversation messages (needs im.read, sensitive; the user picks a conversation each time, non-text is redacted)
  const r = await window.tt.readMessages({ limit: 30 });
  // Upload an image (needs media.upload; pass a dataURL, returns an absolute URL)
  const url = await window.tt.uploadImage(dataUrl);
} catch (err) {                                   // ❌ failure
  // "User cancelled" (picker/preview cancelled) / authorization denied / "Call timed out" / network
  console.warn('Capability call failed:', err.message);
}
Многопользовательские комнаты · im.room

Превратите «беседу» в комнату реального времени для мини-игр / совместной работы: создать/присоединиться к комнате, постоянные сообщения и сигналы реального времени внутри комнаты (синхронизация состояния, ≤2KB, эфемерные, не сохраняются). Хост передаёт кадры реального времени от вашего имени, JWT хоста никогда не попадает в мини-приложение; ограничено комнатами, созданными этим мини-приложением / беседами, в которые вас пригласили — оно не может касаться других приватных чатов пользователя.

// Multiplayer rooms (needs im.room): create/join/leave + in-room persistent messages + realtime signals (≤2KB, ephemeral, not persisted).
const { conversationId } = await window.tt.room.create({ title: 'Gomoku match' }); // create room, host auto-subscribes
await window.tt.room.join(conversationId);                 // idempotent join; host auto-subscribes to realtime frames
await window.tt.room.subscribe(conversationId);            // subscribe to an existing conversation's realtime frames (e.g. a group you were shared into)
await window.tt.room.send(conversationId, 'Game on!');     // persistent text (visible even without opening the mini-app)
window.tt.room.signal(conversationId, { type:'move', cell:4 }); // send a realtime signal (state sync)
window.tt.room.setTyping(conversationId, true);            // typing state (transient)
const members = await window.tt.room.members(conversationId);   // roster [{userId,nickname,avatarUrl,online,isOwner}]
const past = await window.tt.room.history(conversationId, { limit: 50 }); // hydrate on reconnect (ascending)
await window.tt.room.leave(conversationId);                // leave (empty rooms are auto-reclaimed)

// Realtime events (all under tt.room):
window.tt.room.onMessage((m) => appendMsg(m));      // new message {conversationId,id,senderId,senderName,kind,text,createdAt}
window.tt.room.onSignal((s) => applyMove(s.payload));// opponent's realtime action {conversationId,senderId,payload}
window.tt.room.onPresence((p) => refreshOnline(p)); // online/offline {userId,online}
window.tt.room.onTyping((t) => showTyping(t));       // typing {conversationId,userId,typing}
window.tt.room.onMember(() => reloadMembers());      // member joined/left {conversationId} → re-fetch members()
window.tt.room.onReconnect(() => rehydrate());       // dropped & reconnected → re-hydrate current state from history()/cloud

Восстановление состояния при переподключении: сигналы работают по принципу best-effort, и потеря кадров при разрыве соединения — это нормально. По событию onReconnect восстанавливайте итоговое состояние из room.history() или облачных данных — не полагайтесь на сигналы как на единственный источник истины.

Встроенные компоненты · как нативные компоненты · безопасны для приватности

Карточка, отправленная через shareToChat({inline:true}), отрисовывает интерактивный компонент прямо внутри пузыря чата (например, опрос, оценку); получатели работают с ним как с нативной функцией, не открывая плавающее окно. Мини-приложение отрисовывает компактный UI на основе ctx.inline; пузырь автоматически подстраивается под содержимое и в реальном времени перекрашивается вслед за светлой/тёмной темой хоста. Приватность: встроенный экземпляр получает лишь ограниченный токен «только cloud.data, без побочных эффектов» — он может читать публичные коллекции + записывать свои собственные документы, не может касаться чужих приватных данных и не запрашивает авторизацию.

// —— Inline components: make a mini-app interact right in the chat bubble like a native feature (polls/ratings/relays…) ——
// 1) Send an inline card to a conversation (needs im.share): recipients operate it in the bubble without opening the mini-app
await window.tt.shareToChat({ inline: true, query: { pollId }, title: 'Poll', height: 200 });

// 2) The mini-app renders two forms based on ctx.inline
window.tt.ready((ctx) => {
  if (ctx.inline) {
    renderCompact(ctx.query.pollId);   // inline: a compact "native-component-like" UI
    window.tt.reportHeight();          // report height (the SDK also auto-reports via ResizeObserver; the bubble auto-sizes to content)
    // When full functionality is needed, open the full page (floating/fullscreen) from the inline card:
    // openBtn.onclick = () => window.tt.openFullPage('/detail?pollId=' + ctx.query.pollId);
  } else {
    renderFull();                      // floating window: full creation UI
  }
});
// Privacy: an inline instance gets only a "cloud.data only, no side effects" restricted token — it can read public collections + write its own documents,
// can't touch others' private data; doesn't prompt for authorization or pollute the authorization list. Sensitive capabilities (upload/send/location) are unavailable inline.
// Dark/mobile: inline cards switch light/dark live with the host and auto-fit width — no extra work for the developer.
Поиск слов / перевод · text.lookup / text.provider

Всплывающее окно поиска слов само по себе является встроенной страницей «мини-приложения-провайдера» — его содержимое/функциональность полностью отрисовываются этим мини-приложением; хост лишь предоставляет выделение + позиционирование при наведении + гибкий SDK. Потребители (сделайте текст в вашем мини-приложении доступным для выделения): объявите text.lookup, ноль кода — при выделении текста прямо под выделением всплывает встроенная страница провайдера (текст сообщений чата тоже поддерживается). Провайдеры (создайте мини-приложение для поиска слов): объявите text.provider (предоставляется после проверки), встроенная страница получает слова через tt.text.onLookup и отрисовывает себя; какой провайдер активен — настраивается в админ-панели; если ни один не настроен/не авторизован, поиск слов отключён. Добавьте data-tt-no-lookup, чтобы исключить область.

// ── A. Make "text inside your mini-app" selectable for lookup (consumer, needs text.lookup) ──【zero code】
// After declaring "text.lookup" in the manifest, when a user selects text in your mini-app, a popover
// 【the provider mini-app's inline page】pops up right below the selection (auto dictionary/translation). Chat message text is also supported (host built-in).
// Tap blank/scroll/Esc to hide; operating inside the popover doesn't close it. No JS needed.
// Opt out: add data-tt-no-lookup to regions you don't want selectable; <input type=password> is auto-excluded.

// ── B. Build a "word-lookup provider mini-app" (provider, needs text.provider, granted after review) ──
// The provider page (inline mode) receives the selected text pushed by the host via onLookup (pushed initially + on every new word, stays resident without reload),
// and looks up/translates/renders it into any UI; you can use tt.text.lookup to call the built-in engine, or your own cloud.data dictionary.
tt.ready(function () {
  tt.text.onLookup(function (text) {          // host pushes the selected text
    tt.text.lookup(text).then(function (r) {  // r={kind:'dict'|'translate',...}
      render(r);                              // render into your own UI (auto-height)
    });
  });
});

// ── Escape hatch / flexible SDK primitives (available to any mini-app) ──
const r = await window.tt.text.lookup('lazy', { to:'en' });        // look up / translate on demand
window.tt.text.onSelect(function (sel){ /* {text, rect}; registering takes over, the default popover steps aside */ });
window.tt.openFloating({ path:'/detail', anchor: sel.rect, width:320, height:220 }); // open a floating window at the selection
window.tt.floating.moveTo(100, 200);  // the floating window's position/size are fully adjustable via the SDK: setRect/moveTo/resize/close

Файлы и облачный диск

Обработка файлов из чата · media.upload / im.share

Когда пользователь нажимает «Открыть с помощью» на изображении/файле в чате, он может выбрать ваше мини-приложение для его обработки — при условии, что вы объявили подходящий тип файла в fileHandlers в manifest.json (image/video/audio/pdf/office/text/any). После открытия: getContextFile() получает файл, readFile() забирает байты в рамках того же origin через хост (избегая CORS, так что вы можете анализировать изображения/аудио/видео/любой формат), затем после обработки uploadFile() + sendFileToChat() отправляет его обратно в беседу, либо saveFile() скачивает его — бесшовный процесс.

// —— Handling chat files: the user taps "Open with" on a file and picks your mini-app (must declare matching kinds in manifest.fileHandlers) ——
const f = window.tt.getContextFile();
// f = {url,name,mime,size,kind:'image'|'file',conversationId,messageId} or null (when opened standalone)
if (f) {
  const bytes = await window.tt.readFile(f.url);   // host fetches bytes same-origin (avoids iframe CORS; limited to this site's /uploads output)
  // bytes = {dataUrl, mime, name, size, url} — feed to <img>/<video>/<audio>/canvas to analyze any format
  imgEl.src = bytes.dataUrl;
}
// —— Process the output → send back to the conversation or download (needs media.upload / im.share) ——
const out = canvas.toDataURL('image/webp', 0.9);            // e.g. convert image to WebP
const up = await window.tt.uploadFile({ dataUrl: out, name: 'result.webp' });   // {url,name,size,mime} (≤20MB)
await window.tt.sendFileToChat({
  url: up.url, name: up.name, mime: up.mime, size: up.size,
  conversationId: f.conversationId    // pass it to send straight to the original conversation (skip the picker); omit it and the host shows a conversation picker
});
await window.tt.saveFile({ dataUrl: out, name: 'result.webp' });   // or: download locally (host downloads on your behalf)
Tutu Drive · tt.drive (нужен media.upload)

Выбирайте файлы из Tutu Drive или сохраняйте свой вывод на диск (опосредовано хостом: пользователь выбирает файлы по одному в пикере диска внутри страницы хоста; мини-приложение не держит токен диска). Отклоняется, когда диск недоступен / Tutu ID не федерирован — после .catch мини-приложение может откатиться к локальному uploadFile.

// Pick files from the drive (the user picks in the host's drive picker; returns [] on cancel):
const picked = await window.tt.drive.pick({ multiple: true, accept: 'image/*' });
// picked = [{ nodeId, name, size, mime, downloadUrl }]
for (const file of picked) {
  const bytes = await window.tt.readFile(file.downloadUrl);  // fetch bytes to analyze/display
  render(bytes.dataUrl);
}

// Save a file into the drive (pass this site's /uploads output absolutized as pullUrl, or a dataUrl directly):
const saved = await window.tt.drive.save({ pullUrl: up.url, name: 'export-result.png' });
// saved = { nodeId, name }

Взаимодействие между приложениями

Взаимодействие между приложениями · перетаскивание между приложениями · tt.link / tt.tray / tt.drag / tt.drop (авторизация не нужна)

Несколько мини-приложений могут быть открыты одновременно (сохраняются как комбо для открытия вместе в один клик, многооконные раскладки 2/3/4, закреплённая боковая панель — всё управляется хостом, код не нужен) и взаимодействовать посредством следующих возможностей:

  • tt.link: синхронизация событий/состояния в реальном времени с другими открытыми мини-приложениями (широковещательно или адресно, ≤2KB, ограничение частоты 25/с; сбрасывается при закрытии окна, не сохраняется, не между пользователями/беседами).
  • tt.tray: поднять содержимое в лоток хоста для его передачи, затем внедрить в другое мини-приложение или беседу.
  • tt.drag.start / tt.drag.bind: начать перетаскивание / привязать элемент как источник перетаскивания, который можно перетащить прямо в другое мини-приложение (нативный HTML5 drag-and-drop между мини-приложениями одного origin).
  • tt.drop.accept: всё мини-приложение может принимать дропы / внедрения из лотка.
  • tt.drop.zone: ★позволяет конкретному внутреннему элементу ощущать дроп (с подсветкой при наведении) и реагировать на него. У мини-приложения может быть несколько зон, каждая ощущает независимо.

Безопасность: url, обёрнутый в file, принимает только хэндлы /uploads/ этого сайта (получатель забирает байты через tt.readFile); поддельные кросс-origin внешние ссылки отбрасываются; у text/json/name у всех есть ограничения размера.

// —— ① Event/state sync tt.link (broadcast in realtime with "other open mini-apps"; drops on window close, not persisted, not cross-user/conversation) ——
tt.link.send({ type: 'color', color: '#ef4444' });        // broadcast to all linked mini-apps (≤2KB, rate-limited 25/s)
tt.link.sendTo(appId, { type: 'ping' });                  // send to a specific peer
tt.link.on((from, msg) => { /* from={appId,slug,name} */ apply(msg); });
const peers = await tt.link.peers();                      // the other linked mini-apps right now [{appId,slug,name}]

// —— ② Tray relay tt.tray (pick up → drop into another mini-app / conversation) ——
await tt.tray.put({ kind:'json', name:'color', data:{ color:'#ef4444' } }); // put into the host tray
const items = await tt.tray.list();                       // view the tray [parcel]
const p = await tt.tray.take(id);                         // take a parcel out
// parcel = { kind:'file'|'text'|'json', url?/text?/data?, name?, mime? }

// —— ③ Direct drag between apps 【drag source】tt.drag ——
tt.drag.start({ kind:'json', name:'color', data:{ color:'#ef4444' } }); // start a drag, returns {id}
tt.drag.bind(swatchEl, () => ({ kind:'json', name:'color', data:{ type:'color', color:'#ef4444' } }));
// getParcel() returns this drag's parcel; return null to not start. Between same-origin mini-apps it uses native HTML5 drag-and-drop with the browser's built-in ghost.

// —— ④ Receive 【whole window】tt.drop.accept ——
tt.drop.accept(['json','file'], (parcel) => { apply(parcel); }); // callback on drop anywhere in this window / tray injection

// —— ⑤ ★Receive 【element-level】tt.drop.zone ——
tt.drop.zone(slotEl, ['json','file'], {
  onEnter: () => slotEl.classList.add('hot'),    // drag into this element → only it highlights (internal elements sense independently)
  onOver:  () => {},                             // while hovering (do continuous feedback)
  onLeave: () => slotEl.classList.remove('hot'), // move out → clear highlight
  onDrop:  (parcel) => fill(slotEl, parcel),     // dropped on this element → only it receives and acts
});

UI · окно · хост

UI · окно · устройство (авторизация не нужна)

UI-возможности в стиле WeChat wx.* — хост отрисовывает настоящие тосты/диалоги/просмотрщики изображений, управляет капсульным окном мини-приложения и обращается к буферу обмена/вибрации/набору номера/геолокации/сети — вызываемые без запроса авторизации, что делает мини-приложение таким же мощным, как нативное приложение.

// —— Interaction feedback ——
window.tt.showToast({ title: 'Saved', icon: 'success' });   // icon: success|error|loading|none
window.tt.hideToast();
window.tt.showLoading({ title: 'Processing…' });            // pair with window.tt.hideLoading()
window.tt.hideLoading();
const { confirm } = await window.tt.showModal({ title: 'Confirm', content: 'Delete this?' });
const { tapIndex } = await window.tt.showActionSheet({ itemList: ['Camera', 'Album'] }); // rejects on cancel
// —— Window / system info ——
window.tt.setNavigationBarTitle({ title: 'My page' });      // change the mini-app capsule title
const info = await window.tt.getSystemInfo();               // {theme, platform, windowWidth, windowHeight, safeAreaInsets, appName, version}
// —— Device ——
await window.tt.setClipboardData({ data: 'copied text' });
const { data } = await window.tt.getClipboardData();
window.tt.vibrateShort();  window.tt.vibrateLong();          // haptic feedback
window.tt.makePhoneCall({ phoneNumber: '10086' });
// —— Media ——
window.tt.previewImage({ urls: [url1, url2], current: url1 }); // fullscreen image preview
// —— Location / external link / network ——
const loc = await window.tt.getLocation();                    // browser prompts for permission → {latitude, longitude, accuracy, speed}
window.tt.openLocation({ latitude: loc.latitude, longitude: loc.longitude, name: 'Store' }); // view on a map
window.tt.openLink({ url: 'https://example.com' });           // open in a new tab (http/https only)
const net = await window.tt.getNetworkType();                 // {isConnected, networkType: wifi|4g|...}
Плавающее окно · полноэкранный режим · брендинг

Управляйте окном мини-приложения: открывайте перетаскиваемое плавающее окно из встроенного режима/выделения, разворачивайте на весь экран / восстанавливайте, тонируйте капсулу хоста и слушайте изменения показа/размера.

// —— Floating window (open a draggable floating window from inline / a selection) ——
window.tt.openFloating({ path:'/detail', anchor: rect, x:100, y:120, width:320, height:220 });
window.tt.floating.setRect({ x, y, width, height });  // also moveTo(x,y) / resize(w,h) / close()
window.tt.openFullPage('/detail');                    // open the full page from an inline card (floating/fullscreen)

// —— Fullscreen / restore / close (desktop; mobile is already fullscreen) ——
window.tt.expand();  window.tt.collapse();  window.tt.close();
const dm = await window.tt.getDisplayMode();          // {maximized, mobile} — whether fullscreen / whether mobile
window.tt.onEvent('displayChanged', (p) => updateFullscreenChip(p.maximized)); // two-way sync with the host capsule's "fullscreen/restore"
window.tt.onEvent('viewportChanged', (p) => relayout(p.width, p.height));       // iframe size change → responsive re-layout

// —— Branding: tint the host capsule header/background ——
window.tt.setHeaderColor('#4f46e5');
window.tt.setBackgroundColor('#fdf6e3');
Кнопки хоста · тактильная отдача · в стиле Telegram (авторизация не нужна)

Мини-приложение управляет кнопками оболочки хоста и получает события их нажатия (двусторонне) — нижняя главная кнопка mainButton, кнопка «назад» в шапке backButton, тактильная отдача hapticFeedback. Это позволяет мини-приложению глубоко интегрироваться с UI хоста (а не быть изолированной страницей).

// MainButton (the host's big bottom button, controlled by the mini-app + receives clicks) — Telegram-style
window.tt.mainButton.setText('Submit order').show();  // chainable; setText/setParams/show/hide/enable/disable/showProgress/hideProgress
window.tt.mainButton.onClick(() => {                  // click callback (host → mini-app event); offClick to unbind
  window.tt.mainButton.showProgress();
  submit().finally(() => window.tt.mainButton.hideProgress());
});
// BackButton (the host header's back button)
window.tt.backButton.show();                           // show/hide/onClick/offClick
window.tt.backButton.onClick(() => history.back());
// Generic event listening (same as the onClick above)
window.tt.onEvent('mainButtonClicked', handler);
window.tt.onEvent('backButtonClicked', handler);
window.tt.offEvent('mainButtonClicked', handler);      // unbind
// HapticFeedback
window.tt.hapticFeedback.impactOccurred('light');      // light|medium|heavy|rigid|soft
window.tt.hapticFeedback.notificationOccurred('success'); // error|success|warning
window.tt.hapticFeedback.selectionChanged();
Тема · облачное хранилище · в стиле Telegram

colorScheme / themeParams держат цвета мини-приложения согласованными с хостом и переключаются со светлой/тёмной темой; locale синхронизируется с i18n хоста.

// —— Theme (consistent with the host's colors, switches with light/dark) ——
window.tt.colorScheme;          // 'light' | 'dark'
window.tt.themeParams;          // {bgColor,textColor,hintColor,linkColor,buttonColor,buttonTextColor,secondaryBgColor}
document.body.style.background = window.tt.themeParams.bgColor;   // use the host color, consistent with the host
window.tt.onEvent('themeChanged', () => {                        // fires when the host toggles light/dark (same as onThemeChange)
  applyTheme(window.tt.colorScheme, window.tt.themeParams);
});
// —— Locale i18n (synced with the host; the SDK already sets <html lang>) ——
window.tt.locale;               // e.g. 'zh-CN' / 'en-US'; same as tt.context().locale
window.tt.onLocaleChange((locale) => renderInLang(locale));      // or onEvent('localeChanged')

Справочник

Обработка ошибок

Каждый window.tt.* возвращает Promise и при сбое отклоняется с Error. Продакшн-мини-приложения обязаны использовать .catch / try-catch для каждого вызова. Частые err.message:

err.message Значение / рекомендуемая обработка
User denied authorization Запрос авторизации по требованию был отклонён → предложите повторить
User cancelled Выбор беседы/предпросмотр отменён → молчите
Call timed out Хост долго не отвечал (редко) → предложите повторить
Data too large / too many documents / too many storage items Превышена квота → сократите данные
public reads are limited to pub_-prefixed public collections Несоответствие имени коллекции → используйте префикс pub_
Forbidden (403) Не-разработчик использовал scope=all → нет прав
Network error / Failed to fetch Сетевой сбой → дружелюбное сообщение + повтор 
// Every tt.* returns a Promise and rejects an Error on failure; handle with .catch / try-catch.
window.tt.getProfile()
  .then((me) => { /* … */ })
  .catch((err) => {
    switch (err.message) {
      case 'User denied authorization': /* guide the user to retry authorization */ break;
      case 'User cancelled':            /* the user cancelled the conversation picker, stay silent */ break;
      case 'Call timed out':            /* the host was unresponsive for a long time (rare), prompt a retry */ break;
      default:                          /* quota / permission (403) / network, etc — give a friendly prompt */
    }
  });
Модель авторизации

Авторизация по требованию: открытие мини-приложения не требует предоставления всех прав заранее; хост запрашивает отдельный пункт только при первом вызове возможности (разрешить/отклонить). Пользователь может «доверять этому мини-приложению», чтобы предоставить всё сразу, или переключать пункты по отдельности и просматривать записи использования на странице настроек. Бэкенд по-прежнему повторно проверяет при каждом вызове (эшелонированная защита). Возможности UI/окна/устройства/темы/межприложенческие используются без авторизации.

Возможность (scope) Описание Чувствительная
user.profile Получить ваш никнейм и аватар —
cloud.data Облачные данные (коллекции; заказы/записи и т. д.) —
storage.kv Хранилище данных (KV) —
media.upload Загрузка изображений/файлов (включая диск tt.drive) —
im.share Поделиться карточкой в чат —
im.send Отправлять сообщения —
im.read Читать историю бесед Чувствительная
im.room Многопользовательские комнаты: отправлять/получать сообщения и читать чат комнаты от вашего имени Чувствительная
text.lookup Поиск слов/перевод (выделенный текст отправляется в сервис перевода) Чувствительная
text.provider Провайдер поиска (страница этого мини-приложения выступает всплывающим окном поиска/перевода) Чувствительная
Видимость
  • Публичное: появляется в «Обзоре» и поиске; любой может его найти.
  • Скрытое: нет в обзоре/поиске; доступно только через общую карточку или скопированную ссылку (deep link) — для распространения по приватным каналам без публичной засветки. Переключается в консоли в один клик.
  • Режим открытия (десктоп): «Режим открытия» в консоли переключает «плавающее (по умолчанию) / полноэкранное» — приложения типа canvas/whiteboard/редактор задают fullscreen, чтобы при открытии заполнить экран; лёгкие карточки/формы используют плавающее. Начальное значение также можно объявить в поле display в manifest.json. На мобильных всегда полноэкранно, независимо от этой настройки.
Версии и публикация

Модель версий: черновик → на проверке → готово → в эфире.

Все исторические версии сохраняются, с откатом в один клик к любой исторической версии (мгновенная замена активной версии). Отказы показывают причину в центре уведомлений.

Ограничения и квоты
  • Облачные данные: один документ ≤ 8KB, ≤ 500 документов на пару (мини-приложение, пользователь), list() ≤ 200 за раз (по новизне); используйте курсорную пагинацию listPage() (mine/all) для большего. Примечание: выполнение фронтенд-агрегации (подсчёт/усреднение) напрямую через list() недосчитает самую старую часть, когда коллекция превышает 200, и даст заниженный результат — для полных итогов используйте пагинацию listPage или примите приближение.
  • KV: одно значение ≤ 8KB, ≤ 64 ключей на пару (мини-приложение, пользователь).
  • Загружаемые изображения ≤ 4MB; загружаемые файлы ≤ 20MB; отправка сообщений ограничена по частоте (≤ 20 на пользователя в минуту); полезная нагрузка сигнала комнаты ≤ 2KB; одно сообщение tt.link ≤ 2KB, дросселируется 25/с.
  • Пакет кода — это одностраничный HTML (предпочитайте чистый рендеринг через DOM; избегайте innerHTML, чтобы предотвратить XSS).
  • Токены кратковременные (около 2 часов); хост незаметно обновляет их после истечения; вызовы возможностей повторно проверяются бэкендом.

Справочные примеры: applets/food (заказ, облачные данные) и applets/repair (заявки на ремонт) в репозитории — оба чисто фронтенд + облачные данные мини-приложения.