TutuHai

Documentação Aberta dos Mini-Apps do TutuHai

Integração do SDK · APIs de recursos · Dados na nuvem · Autorização · Publicação

Os mini-apps do TutuHai são aplicativos leves que rodam dentro do TutuHai. Os desenvolvedores enviam apenas um pacote de código frontend, hospedado pela plataforma; as funcionalidades se comunicam com o TutuHai através do SDK window.tt, sem nenhum backend próprio (os dados de negócio passam pelos dados na nuvem do TutuHai). Integração do SDK · APIs de funcionalidades · dados na nuvem · autorização · publicação — tudo em uma única página, com exemplos prontos para copiar e executar.

Criar um miniapp no console 7 categorias · 26 tópicos · Clique em um título para expandir
Sumário · 26 tópicos

Primeiros passos

Funcionalidades de dados

Conversas e multiplayer

Arquivos e drive na nuvem

Interação entre apps

UI · janela · host

Referência

Primeiros passos

Introdução

Os mini-apps do TutuHai são aplicativos leves que rodam dentro do TutuHai. Os desenvolvedores enviam apenas um pacote de código frontend, hospedado pela plataforma; as funcionalidades se comunicam com o TutuHai através do SDK window.tt, sem nenhum backend próprio (os dados de negócio passam pelos dados na nuvem do TutuHai).

Isolamento e segurança: os mini-apps rodam em um iframe em sandbox numa origem isolada; a sessão de login do host nunca entra no mini-app. A cada chamada é emitido pelo host um token de curta duração e com restrições, e o backend revalida por funcionalidade (scope).

Início rápido
  1. No Console de Mini-Apps (/applets), clique em "Novo" para criar um mini-app (nome + slug único).
  2. Escreva um HTML de arquivo único (inclua o SDK, chame as funcionalidades via window.tt.*).
  3. Crie uma versão → preencha as funcionalidades solicitadas → envie o pacote de código (HTML de arquivo único).
  4. Envie para revisão → o admin aprova → publique em produção com um clique.
  5. Os usuários encontram/abrem o app pela busca em "Descobrir", ou você compartilha um card / copia um link para acesso direto.
Especificação de empacotamento

Os mini-apps suportam duas formas de envio: ① um pacote HTML de arquivo único (autocontido, entrada = raiz, o mais simples); ② um zip com a saída de build de um framework real (o dist/ do npm run build, com index.html + assets em vários arquivos — veja "Saída de build de framework"). A plataforma executa uma verificação de especificação e uma otimização antes do envio.

Estrutura do pacote (saída de build)

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

O pacote de código deve satisfazer (verificado automaticamente no envio):

  • Entrada: um único arquivo HTML com <!doctype html> e um <html> raiz.
  • Ajuste para mobile: deve incluir <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">.
  • SDK: inclua <script src="/applet-sdk.js"> (a plataforma o reescreve para o endereço absoluto do host).
  • Autocontido: use CSS/JS inline; se precisar de scripts externos, apenas o SDK da plataforma + CDNs de frameworks conhecidos (unpkg / jsdelivr / cdnjs / esm.sh) são permitidos — scripts remotos arbitrários são proibidos (segurança). Imagens e outras mídias passam por tt.uploadImage ou por um CDN.
  • Tamanho: HTML de arquivo único ≤ 1MB; zip com múltiplos arquivos ≤ 8MB no total, ≤ 1MB por arquivo, ≤ 100 arquivos; imagens enviadas ≤ 4MB.
  • Dados: sem nenhum backend próprio — os dados de negócio passam pelos dados na nuvem tt.cloud / tt.*storage.

📱🖥 Universal para mobile / desktop (uma base de código, ambas as superfícies)

O mesmo pacote roda em um iframe isolado dentro do TutuHai; o host o exibe tanto em mobile (tela cheia) quanto em desktop (painel / pode ir para tela cheia). Escreva uma única base de código universal com um layout responsivo: ① viewport-fit=cover + áreas seguras env(safe-area-inset-*); ② overlays como bottom sheets (mobile) ↔ centralizados (desktop, @media(min-width:480px)); ③ alvos de toque ≥ 44px; ④ siga o tema escuro/claro do host (tt.onThemeChange / [data-theme]); ⑤ DOM puro, sem larguras fixas no código. Isso mantém a experiência consistente tanto no celular quanto no computador.

Saída de build de framework (dist.zip)

Além do HTML de arquivo único, você também pode enviar a saída de build de um framework real — use React / Vue / Svelte / Angular / Solid / Astro / Next (static export) / vanilla… o npm run build de qualquer toolchain, compacte o dist/ (com index.html + assets/*.js/css + fontes/imagens) e envie para ser hospedado.

Independente de framework: a plataforma reconhece apenas um "contrato universal de pacote estático" — entrada index.html + referências relativas de assets + SDK. Qualquer framework que produza um dist estático que atenda a esse contrato é suportado; os scaffolds abaixo são apenas atalhos selecionados, não o limite do suporte.

estrutura do zip (saída de build, raiz do zip = raiz do pacote)

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…

Adaptação em três passos (funciona para qualquer framework):

  1. Defina um base relativo (recomendado, o mais seguro) — faça a saída referenciar os assets por caminho relativo (./assets/x.js em vez do absoluto a partir da raiz /assets/x.js), para que hospedar em /<slug>/ seja infalível. (O base padrão também funciona: a plataforma reescreve automaticamente as referências estáticas absolutas a partir da raiz em HTML/CSS e usa um fallback por Referer para assets absolutos a partir da raiz gerados em tempo de execução — como preloads de CSS com code-split; mas em casos extremos de Referrer-Policy estrito / prefetch offline o Referer pode estar ausente e o fallback falha, então um base relativo é o mais seguro.)
  2. Adicione um manifest — coloque o manifest.json no diretório estático (por exemplo, o static/ do Vite/SvelteKit, o public/ da maioria dos frameworks) para que ele fique na raiz do dist após o build; ou omita o manifest e adicione <meta name="tt:slug" content="…"> (além de tt:name / tt:version / tt:scopes) no index.html como fallback.
  3. Inclua o SDK — de duas maneiras: ① npm install (recomendado, melhor para scaffolds reais): após npm i @tutuhai/applet-sdk, import { tt } from '@tutuhai/applet-sdk' — empacotado na saída em tempo de build, com tipos TypeScript, sem editar o index.html; ② ou escreva <script src="/applet-sdk.js"> no index.html (a plataforma o reescreve para o endereço absoluto do host) e use o global window.tt.

📦 SDK via npm (testado com os scaffolds oficiais de React / Vue / Svelte)

Crie um projeto com npm create vite@latest -- --template react-ts | vue-ts | svelte-ts, instale o mesmo @tutuhai/applet-sdk e faça o import dele — código-fonte real em vários arquivos, o npm run build produz vários chunks + um index.html de entrada; compacte e envie.

# 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 .

Exemplos executáveis no repositório: applets/frameworks/{react,vue,svelte} (três projetos reais com scaffold oficial, todos fazendo import do mesmo pacote do SDK). Código-fonte do pacote do SDK: applet-sdk/.

campos do 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: declara a forma de abertura no desktop — para apps de canvas/quadro branco/editor prefira fullscreen, para cards/formulários leves use o padrão window. É apenas um valor inicial; após a publicação você pode alterar o "Modo de abertura" a qualquer momento no console (o console prevalece). No mobile é sempre tela cheia, independentemente deste campo. Quando o manifest é omitido, <meta name="tt:display" content="fullscreen"> funciona como fallback.
  • fileHandlers: declara quais tipos de arquivo seu mini-app pode manipular a partir de um chat — quando um usuário toca em "Abrir com" em um arquivo no chat, os mini-apps que declararam um tipo correspondente aparecem como candidatos; ao tocar em um, esse arquivo é enviado diretamente para o seu mini-app (veja "Manipular arquivos do chat"). Cada item: kinds é um de image / video / audio / pdf / office / text / any (vários permitidos, any = qualquer arquivo); role é editor (abrir em um editor) ou viewer (pré-visualizar); label é opcional (≤20 caracteres, o nome de exibição do candidato). Até 8 itens. A liberação segue a visibilidade: private/self-use funciona sem revisão (aparece apenas no seu próprio "Abrir com"); public requer aprovação do admin antes de valer para todos.

Configuração de "base relativo" em uma linha, por framework:

// 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">

⚠ SPAs com roteamento no cliente (SvelteKit / React Router / Vue Router / Angular) Os mini-apps são hospedados sob o subcaminho /<slug>/. Uma SPA com roteamento no cliente precisa definir seu "base do roteador" como o seu slug, senão o roteador do framework não consegue corresponder ao caminho atual → 404 da página inteira (os assets carregam, mas o roteamento reporta "não encontrado"). Definir apenas um base relativo de assets não é suficiente — isso só corrige as URLs dos assets, não o roteamento. Por framework: SvelteKit kit.paths.base='/<slug>'; React Router <BrowserRouter basename="/<slug>">; Vue Router createWebHistory('/<slug>/'); Angular APP_BASE_HREF='/<slug>/'. (Apps sem roteamento no cliente — renderização pura / um React de página única sem Router / vanilla — não são afetados.)

⚠ Verificação no envio No envio a plataforma executa uma "verificação de contrato" no dist: entrada / caminhos relativos / manifest / referência ao SDK / limites / MIME são cada um validados com dicas inline. Total ≤ 8MB, ≤ 1MB por arquivo, ≤ 100 arquivos, apenas MIME na whitelist (html/css/js/json/imagens/fontes/map/wasm). Comprima e faça subset das fontes para manter o tamanho baixo. Para saídas de frameworks pesados (por exemplo, tldraw / excalidraw com um único chunk >1MB) que excedam os limites padrão por arquivo/total, peça à equipe de operações para elevar os limites de "bytes por arquivo" / "total descompactado" no painel de admin (alteráveis em tempo de execução, efetivos imediatamente); dividir com manualChunks também pode trazer o vendor para baixo do limite.

Exemplo mínimo

Um mini-app completo e executável — inclua o SDK, leia o apelido do usuário:

<!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>
Integração do SDK

Inclua o script do SDK no HTML do seu mini-app e então use 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>

Nunca fixe o domínio do host no código do seu mini-app. Escreva o caminho relativo /applet-sdk.js (ou qualquer origem de placeholder) — a plataforma reescreve a URL do script do SDK para o host atual, no momento de servir, quando seu app roda em seu iframe. Assim, mesmo que o TutuHai mude de domínio, ou que um domínio seja bloqueado, todo mini-app publicado continua funcionando sem mudança de código e sem republicação — um operador altera um único valor de configuração.

Callback de ready, contexto e tema/idioma:

// 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
});
Exemplos por framework

window.tt é independente de framework e funciona diretamente em todos os frameworks mais usados (arquivo único, sem build). Cada exemplo inclui o tratamento tanto de sucesso ✅ quanto de falha ❌ (autorização negada / erro de rede):

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))     // ❌
    );
  }
}

Exemplos completos e executáveis estão no repositório: applet-platform/samples/demo-react.html, demo-svelte.html, demo-vue.html.

Funcionalidades de dados

Perfil do usuário · 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());
Dados na nuvem · cloud.data

Coleções estruturadas hospedadas que permitem a um mini-app persistir dados de negócio sem nenhum backend próprio. Três níveis de visibilidade:

  • mine: ler/gravar apenas os seus próprios documentos (padrão).
  • all: ler/gravar tudo, apenas o desenvolvedor (dono) do mini-app — para um "console de comerciante" ver todos os pedidos/tickets.
  • public: qualquer usuário logado pode ler tudo, o nome da coleção deve começar com pub_ — para comunidade/marketplace/fórum; gravações e edições ainda são limitadas ao autor.
// 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);
}

Cada linha é lida de volta como { id, ownerId, mine, data:{…your fields}, createdAt, updatedAt } — seus campos ficam todos em data (por exemplo, row.data.title).

Armazenamento KV · storage.kv

Chave-valor isolado por (mini-app, usuário), bom para pequenos estados privados como contagens de check-in, rascunhos etc. tt.cloudStorage (setItem/getItem/getKeys/removeItem) é seu alias no estilo do 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');

Conversas e multiplayer

Funcionalidades de conversa · im.share / im.send / im.read / media.upload

Toda interação com as conversas do TutuHai é mediada pelo host (o usuário escolhe ativamente uma conversa); os mini-apps não conseguem obter a lista completa de conversas. im.read é uma funcionalidade sensível.

// 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);
}
Salas multiplayer · im.room

Transforme uma "conversa" em uma sala em tempo real para minijogos / colaboração: criar/entrar em uma sala, mensagens persistentes e sinais em tempo real dentro da sala (sincronização de estado, ≤2KB, efêmeros, não persistidos). O host faz a ponte dos frames em tempo real como você, o JWT do host nunca entra no mini-app; limitado às salas que este mini-app criou / às conversas em que você foi compartilhado — não pode tocar nos outros chats privados do usuário.

// 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

Hidratação na reconexão: os sinais são de melhor esforço e a perda de frames na desconexão é normal. No onReconnect, reidrate o estado final a partir de room.history() ou dos dados na nuvem — não dependa dos sinais como única fonte de verdade.

Componentes inline · semelhante a componente nativo · seguro para privacidade

Um card enviado com shareToChat({inline:true}) renderiza um componente interativo bem dentro do balão do chat (por exemplo, uma enquete, uma avaliação); os destinatários o operam como um recurso nativo, sem abrir uma janela flutuante. O mini-app renderiza uma UI compacta com base em ctx.inline; o balão se ajusta automaticamente ao conteúdo e reaplica o tema ao vivo conforme o claro/escuro do host. Privacidade: uma instância inline recebe apenas um token restrito de "cloud.data apenas, sem efeitos colaterais" — ela pode ler coleções públicas + gravar seus próprios documentos, não pode tocar nos dados privados de terceiros e não solicita autorização.

// —— 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.
Consulta de palavras / tradução · text.lookup / text.provider

O popover de consulta de palavras é ele próprio a página inline de um "mini-app provedor" — seu conteúdo/funcionalidade é todo renderizado por esse mini-app; o host apenas fornece a seleção + o posicionamento por hover + um SDK flexível. Consumidores (tornar o texto do seu próprio mini-app selecionável): declare text.lookup, zero código — selecionar texto abre a página inline do provedor logo abaixo da seleção (texto de mensagens de chat também é suportado). Provedores (construir um mini-app de consulta): declare text.provider (concedido após revisão), a página inline recebe as palavras via tt.text.onLookup e se renderiza; qual provedor está ativo é configurado no painel de admin — se nenhum estiver configurado/autorizado, a consulta fica desabilitada. Adicione data-tt-no-lookup para excluir uma região.

// ── 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

Arquivos e drive na nuvem

Manipular arquivos do chat · media.upload / im.share

Quando um usuário toca em "Abrir com" em uma imagem/arquivo no chat, ele pode escolher seu mini-app para manipulá-lo — desde que você tenha declarado um tipo de arquivo correspondente em fileHandlers do manifest.json (image/video/audio/pdf/office/text/any). Depois de aberto: getContextFile() obtém o arquivo, readFile() busca os bytes na mesma origem via host (evitando CORS, para que você possa analisar imagens/áudio/vídeo/qualquer formato), então, após o processamento, uploadFile() + sendFileToChat() o envia de volta para a conversa, ou saveFile() o baixa — um fluxo contínuo.

// —— 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 (precisa de media.upload)

Selecione arquivos do Tutu Drive, ou salve sua saída no drive (mediado pelo host: o usuário seleciona arquivos um de cada vez no seletor do drive dentro da página do host; o mini-app não detém um token do drive). Rejeita quando o drive está inacessível / o Tutu ID não está federado — após o .catch, o mini-app pode recorrer a um uploadFile local.

// 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 }

Interação entre apps

Interação entre apps · arrastar entre apps · tt.link / tt.tray / tt.drag / tt.drop (não requer autorização)

Vários mini-apps podem estar abertos ao mesmo tempo (salvos como um combo para abrir juntos com um clique, layouts multi-janela 2/3/4, uma barra lateral acoplada — tudo gerenciado pelo host, sem necessidade de código), e interagem pelas seguintes funcionalidades:

  • tt.link: sincroniza eventos/estado em tempo real com outros mini-apps abertos (broadcast ou direcionado, ≤2KB, com limite de taxa 25/s; descartado ao fechar a janela, não persistido, não entre usuários/conversas).
  • tt.tray: pega conteúdo na bandeja do host para retransmiti-lo, e então injeta em outro mini-app ou conversa.
  • tt.drag.start / tt.drag.bind: inicia um arraste / vincula um elemento como uma fonte de arraste que pode ser arrastada diretamente para outro mini-app (arrastar e soltar nativo do HTML5 entre mini-apps da mesma origem).
  • tt.drop.accept: o mini-app inteiro pode receber drops / injeções da bandeja.
  • tt.drop.zone: ★faz com que um elemento interno específico perceba um drop (com feedback de destaque no hover) e aja sobre ele. Um mini-app pode ter várias zonas, cada uma percebendo independentemente.

Segurança: uma url encapsulada como file só aceita handles do /uploads/ deste site (o receptor busca os bytes via tt.readFile); links externos de origem cruzada forjados são descartados; text/json/name têm todos limites de tamanho.

// —— ① 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 · janela · host

UI · janela · dispositivo (não requer autorização)

Funcionalidades de UI ao estilo wx.* do WeChat — o host renderiza toasts/diálogos/visualizadores de imagem reais, controla a janela em cápsula do mini-app e acessa área de transferência/vibração/discagem/localização/rede — chamáveis sem solicitar autorização, tornando um mini-app tão poderoso quanto um app nativo.

// —— 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|...}
Janela flutuante · tela cheia · branding

Controle a janela do mini-app: abra uma janela flutuante arrastável a partir de um inline/uma seleção, expanda para tela cheia / restaure, tingir a cápsula do host e escute mudanças de exibição/tamanho.

// —— 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');
Botões do host · haptics · estilo Telegram (não requer autorização)

Um mini-app controla os botões do chrome do host e recebe seus eventos de clique (bidirecional) — o botão principal inferior mainButton, o botão de voltar do cabeçalho backButton, os haptics hapticFeedback. Isso permite que um mini-app se integre profundamente à UI do host (em vez de ser uma página isolada).

// 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();
Tema · cloud storage · estilo Telegram

colorScheme / themeParams mantêm as cores do mini-app consistentes com o host e alternam com claro/escuro; locale sincroniza com a i18n do host.

// —— 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')

Referência

Tratamento de erros

Todo window.tt.* retorna uma Promise e rejeita com um Error em caso de falha. Os mini-apps de produção devem fazer .catch / try-catch em toda chamada. err.message comuns:

err.message Significado / tratamento sugerido
User denied authorization O aviso de autorização sob demanda foi negado → oriente uma nova tentativa
User cancelled O seletor/pré-visualização de conversa foi cancelado → permaneça em silêncio
Call timed out O host ficou sem resposta por muito tempo (raro) → sugira uma nova tentativa
Data too large / too many documents / too many storage items Cota excedida → reduza os dados
public reads are limited to pub_-prefixed public collections Incompatibilidade no nome da coleção → use um prefixo pub_
Forbidden (403) Um não desenvolvedor usou scope=all → sem permissão
Network error / Failed to fetch Falha de rede → aviso amigável + nova tentativa 
// 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 */
    }
  });
Modelo de autorização

Autorização sob demanda: abrir um mini-app não exige conceder todas as permissões de antemão; o host solicita um único item somente quando uma funcionalidade é chamada pela primeira vez (permitir/negar). O usuário pode "confiar neste mini-app" para conceder tudo de uma vez, ou alternar itens individualmente e ver os registros de uso na página de configurações. O backend ainda revalida a cada chamada (defesa em profundidade). As funcionalidades de UI/janela/dispositivo/tema/entre apps são utilizáveis sem autorização.

Funcionalidade (scope) Descrição Sensível
user.profile Obter seu apelido e avatar —
cloud.data Dados na nuvem (coleções; pedidos/registros etc.) —
storage.kv Armazenamento de dados (KV) —
media.upload Enviar imagens/arquivos (incl. drive tt.drive) —
im.share Compartilhar um card no chat —
im.send Enviar mensagens —
im.read Ler o histórico da conversa Sensível
im.room Salas multiplayer: enviar/receber mensagens e ler o chat da sala em seu nome Sensível
text.lookup Consulta de palavras/tradução (o texto selecionado é enviado a um serviço de tradução) Sensível
text.provider Provedor de consulta (a página deste mini-app atua como o popover de consulta/tradução) Sensível
Visibilidade
  • Público: aparece em "Descobrir" e na busca; qualquer um pode encontrá-lo.
  • Não listado: não aparece em descobrir/busca; acessível apenas por um card compartilhado ou link copiado (deep link) — para difusão em tráfego privado sem exposição pública. Alterne no console com um clique.
  • Modo de abertura (desktop): o "Modo de abertura" do console alterna entre "flutuante (padrão) / tela cheia" — apps de canvas/quadro branco/editor definem fullscreen para preencher a tela ao abrir; cards/formulários leves usam flutuante. Você também pode declarar o valor inicial no display do manifest.json. No mobile é sempre tela cheia, independentemente desta configuração.
Versões e publicação

Modelo de versão: rascunho → em revisão → pronta → ativa.

Todas as versões históricas são mantidas, com rollback em um clique para qualquer versão histórica (troca instantânea da versão ativa). As rejeições mostram o motivo na central de notificações.

Restrições e cotas
  • Dados na nuvem: documento único ≤ 8KB, ≤ 500 documentos por (mini-app, usuário), list() ≤ 200 por vez (dos mais novos); use paginação por cursor listPage() (mine/all) para mais. Observação: fazer agregação no frontend (contagem/média) diretamente com list() vai subcontar a parte mais antiga quando uma coleção ultrapassa 200 e dar um resultado baixo — para totais completos use a paginação com listPage ou aceite uma aproximação.
  • KV: valor único ≤ 8KB, ≤ 64 chaves por (mini-app, usuário).
  • Imagens enviadas ≤ 4MB; arquivos enviados ≤ 20MB; o envio de mensagens tem limite de taxa (≤ 20 por usuário por minuto); payload de sinal de sala ≤ 2KB; mensagem única do tt.link ≤ 2KB, limitado a 25/s.
  • O pacote de código é um HTML de arquivo único (prefira renderização em DOM puro; evite innerHTML para prevenir XSS).
  • Os tokens têm curta duração (cerca de 2 horas); o host os renova silenciosamente após a expiração; as chamadas de funcionalidade são revalidadas pelo backend.

Exemplos de referência: os applets/food (pedidos, dados na nuvem) e applets/repair (solicitações de reparo) do repositório são ambos mini-apps puramente frontend + dados na nuvem.