Documentazione aperta delle mini-app TutuHai

Integrazione SDK · API delle capacità · Dati cloud · Autorizzazione · Pubblicazione

Le mini-app TutuHai sono app leggere che girano dentro TutuHai. Gli sviluppatori caricano solo un bundle di codice frontend, ospitato dalla piattaforma; le funzionalità comunicano con TutuHai attraverso l'SDK window.tt, senza un backend proprio (i dati di business passano attraverso i dati cloud di TutuHai). Integrazione dell'SDK · API delle funzionalità · dati cloud · autorizzazione · pubblicazione — tutto su un'unica pagina, con esempi da copiare ed eseguire.

Crea un'applet nella console 7 categorie · 26 argomenti · Clicca un titolo per espandere

Indice · 26 argomenti

Per iniziare

Funzionalità sui dati

Conversazioni e multiplayer

File e cloud drive

Interazione tra app

UI · finestra · host

Riferimento

Indice

Per iniziare
Funzionalità sui dati
Conversazioni e multiplayer
File e cloud drive
Interazione tra app
UI · finestra · host
Riferimento

Per iniziare

Introduzione

Isolamento e sicurezza: le mini-app girano in un iframe sandbox su un'origine isolata; la sessione di login dell'host non entra mai nella mini-app. A ogni chiamata l'host rilascia un token di breve durata e con permessi limitati, e il backend ri-convalida in base alla funzionalità (scope).

Avvio rapido

Nella Console mini-app (/applets), clicca su "Nuovo" per creare una mini-app (nome + slug univoco).
Scrivi un HTML a file singolo (includi l'SDK, richiama le funzionalità tramite window.tt.*).
Crea una versione → indica le funzionalità richieste → carica il bundle di codice (HTML a file singolo).
Invia per la revisione → l'amministratore approva → pubblica in produzione con un clic.
Gli utenti la trovano/aprono tramite la ricerca "Scopri", oppure condividi una card / copia un link per l'accesso diretto.

Specifiche di pacchettizzazione

Le mini-app supportano due forme di caricamento: ① un bundle HTML a file singolo (autonomo, entry = root, il più semplice); ② uno zip dell'output di build di un framework reale (la cartella dist/ prodotta da npm run build, con index.html + asset su più file — vedi "Output di build di un framework"). La piattaforma esegue un controllo delle specifiche e un'ottimizzazione prima del caricamento.

Struttura del bundle (output di 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

Il bundle di codice deve soddisfare (verificato automaticamente al caricamento):

Entry: un unico file HTML con <!doctype html> e un root <html>.
Adattamento mobile: deve includere <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">.
SDK: includi <script src="/applet-sdk.js"> (la piattaforma lo riscrive nell'indirizzo assoluto dell'host).
Autonomo: CSS/JS inline; se hai bisogno di script esterni, sono ammessi solo l'SDK della piattaforma + i CDN di framework noti (unpkg / jsdelivr / cdnjs / esm.sh) — gli script remoti arbitrari sono vietati (sicurezza). Immagini e altri media passano attraverso tt.uploadImage o un CDN.
Dimensione: HTML a file singolo ≤ 1MB; zip multi-file ≤ 8MB totali, ≤ 1MB per file, ≤ 100 file; immagini caricate ≤ 4MB.
Dati: nessun backend proprio — i dati di business passano attraverso i dati cloud tt.cloud / tt.*storage.

📱🖥 Universale mobile / desktop (un'unica base di codice, entrambe le superfici)

Lo stesso bundle gira in un iframe isolato dentro TutuHai; l'host lo trasporta sia su mobile (a schermo intero) sia su desktop (pannello / può passare a schermo intero). Scrivi un'unica base di codice universale con un layout responsive: ① viewport-fit=cover + safe area env(safe-area-inset-*); ② overlay come bottom sheet (mobile) ↔ centrati (desktop, @media(min-width:480px)); ③ target touch ≥ 44px; ④ segui il tema scuro/chiaro dell'host (tt.onThemeChange / [data-theme]); ⑤ DOM puro, nessuna larghezza hard-coded. Così l'esperienza resta coerente sia su telefono sia su computer.

Output di build di un framework (dist.zip)

Oltre all'HTML a file singolo, puoi anche caricare l'output di build di un framework reale — usa React / Vue / Svelte / Angular / Solid / Astro / Next (static export) / vanilla… con npm run build di qualsiasi toolchain, comprimi in zip la cartella dist/ (con index.html + assets/*.js/css + font/immagini) e caricala per l'hosting.

Indipendente dal framework: la piattaforma riconosce un solo "contratto di bundle statico universale" — entry index.html + riferimenti agli asset relativi + SDK. Qualsiasi framework in grado di produrre un dist statico conforme a quel contratto è supportato; gli scaffold qui sotto sono solo scorciatoie curate, non il limite del supporto.

struttura zip (output di build, root dello zip = root del bundle)

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…

Adattamento in tre passi (funziona con qualsiasi framework):

Imposta una base relativa (consigliato, la scelta più sicura) — fai in modo che l'output faccia riferimento agli asset per percorso relativo (./assets/x.js invece del percorso root-assoluto /assets/x.js), così l'hosting sotto /<slug>/ è a prova di errore. (Anche la base predefinita funziona: la piattaforma riscrive automaticamente i riferimenti statici root-assoluti in HTML/CSS e usa un fallback tramite Referer per gli asset root-assoluti generati a runtime — come i preload di CSS ottenuti tramite code-split; ma in casi limite con Referrer-Policy restrittiva / prefetch offline il Referer può mancare e il fallback fallisce, quindi una base relativa è la più sicura.)
Aggiungi un manifest — metti manifest.json nella directory statica (ad es. la static/ di Vite/SvelteKit, la public/ della maggior parte dei framework) così che finisca nella root di dist dopo la build; oppure ometti il manifest e aggiungi <meta name="tt:slug" content="…"> (più tt:name / tt:version / tt:scopes) in index.html come fallback.
Includi l'SDK — in due modi: ① npm install (consigliato, ideale per scaffold reali): dopo npm i @tutuhai/applet-sdk, import { tt } from '@tutuhai/applet-sdk' — incluso nell'output al momento della build, con i tipi TypeScript, senza modifiche a index.html; ② oppure scrivi <script src="/applet-sdk.js"> in index.html (la piattaforma lo riscrive nell'indirizzo assoluto dell'host) e usa il globale window.tt.

📦 SDK npm (testato con gli scaffold ufficiali di React / Vue / Svelte)

Crea un progetto con npm create vite@latest -- --template react-ts | vue-ts | svelte-ts, installa lo stesso @tutuhai/applet-sdk e fai l'import — sorgente reale multi-file, npm run build produce più chunk + un unico entry index.html; comprimilo in zip e caricalo.

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

Esempi eseguibili nel repository: applets/frameworks/{react,vue,svelte} (tre progetti reali basati su scaffold ufficiali, tutti che fanno l'import dello stesso pacchetto SDK). Sorgente del pacchetto SDK: applet-sdk/.

campi di 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: dichiara la forma di apertura su desktop — per app di tipo canvas/lavagna/editor preferisci fullscreen, per card/form leggeri usa il valore predefinito window. È solo un valore iniziale; dopo la pubblicazione puoi cambiare la "Modalità di apertura" in qualsiasi momento dalla console (la console prevale). Su mobile è sempre a schermo intero, non influenzato da questo campo. Se il manifest viene omesso, <meta name="tt:display" content="fullscreen"> funziona come fallback.
fileHandlers: dichiara quali tipi di file la tua mini-app può gestire da una chat — quando un utente tocca "Apri con" su un file in chat, le mini-app che hanno dichiarato un tipo corrispondente compaiono come candidate; toccandone una si invia quel file direttamente nella tua mini-app (vedi "Gestione dei file della chat"). Ogni elemento: kinds è uno tra image / video / audio / pdf / office / text / any (più di uno ammesso, any = qualsiasi file); role è editor (apri in un editor) o viewer (anteprima); label opzionale (≤20 caratteri, il nome visualizzato del candidato). Fino a 8 elementi. Il gating segue la visibilità: private/self-use funziona senza revisione (compare solo nel tuo "Apri con"); public richiede l'approvazione dell'amministratore prima di avere effetto per tutti.

Configurazione della "base relativa" in una riga per ciascun 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">

⚠ SPA con routing lato client (SvelteKit / React Router / Vue Router / Angular) Le mini-app sono ospitate sotto il sottopercorso /<slug>/. Una SPA con routing lato client deve impostare la sua "base del router" sul tuo slug, altrimenti il router del framework non riesce a far corrispondere il percorso corrente → 404 di tutta la pagina (gli asset si caricano, ma il routing segnala "non trovato"). Impostare solo una base relativa per gli asset non basta — questo corregge solo gli URL degli asset, non il routing. Per framework: SvelteKit kit.paths.base='/<slug>'; React Router <BrowserRouter basename="/<slug>">; Vue Router createWebHistory('/<slug>/'); Angular APP_BASE_HREF='/<slug>/'. (Le app senza routing lato client — rendering puro / un singolo React senza Router / vanilla — non sono interessate.)

⚠ Controllo al caricamento Al caricamento la piattaforma esegue un "controllo del contratto" sul dist: entry / percorsi relativi / manifest / riferimento all'SDK / limiti / MIME vengono ciascuno convalidati con suggerimenti inline. Totale ≤ 8MB, ≤ 1MB per file, ≤ 100 file, solo MIME nella whitelist (html/css/js/json/immagini/font/map/wasm). Comprimi e crea subset dei font per contenere la dimensione. Per output di framework pesanti (ad es. tldraw / excalidraw con un singolo chunk >1MB) che superano i limiti predefiniti per file/totali, chiedi al team operativo di alzare i limiti "byte per file" / "totale non compresso" nel pannello di amministrazione (modificabili a runtime, effettivi immediatamente); anche suddividere i manualChunks può riportare i vendor sotto il limite.

Esempio minimo

Una mini-app completa ed eseguibile — includi l'SDK, leggi il nickname dell'utente:

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

Integrazione dell'SDK

Includi lo script dell'SDK nell'HTML della tua mini-app, poi usa 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>

Non inserire mai il dominio dell'host hard-coded nella tua mini-app. Scrivi il relativo /applet-sdk.js (o una qualsiasi origine segnaposto) — la piattaforma riscrive l'URL dello script dell'SDK nell'host corrente al momento del serving, quando la tua app gira nel suo iframe. Così anche se TutuHai cambia dominio, o un dominio viene bloccato, ogni mini-app pubblicata continua a funzionare senza modifiche al codice e senza ripubblicazione — un operatore cambia un solo valore di configurazione.

Callback ready, contesto e tema/lingua:

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

Esempi con i framework

window.tt è indipendente dal framework e funziona direttamente in tutti i framework mainstream (file singolo, senza build). Ogni esempio include la gestione sia del successo ✅ sia del fallimento ❌ (autorizzazione negata / errore di rete):

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

Esempi completi ed eseguibili sono nel repository: applet-platform/samples/demo-react.html, demo-svelte.html, demo-vue.html.

Funzionalità sui dati

Profilo utente · 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());

Dati cloud · cloud.data

Collezioni strutturate ospitate che permettono a una mini-app di persistere i dati di business senza un backend proprio. Tre livelli di visibilità:

mine: leggi/scrivi solo i tuoi documenti (predefinito).
all: leggi/scrivi tutto, solo lo sviluppatore della mini-app (owner) — per una "console commerciante" che vede tutti gli ordini/ticket.
public: qualsiasi utente autenticato può leggere tutto, il nome della collezione deve iniziare con pub_ — per community/marketplace/forum; le scritture e le modifiche restano limitate all'autore.

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

Ogni riga viene restituita in lettura come { id, ownerId, mine, data:{…your fields}, createdAt, updatedAt } — i tuoi campi sono tutti in data (ad es. row.data.title).

Archiviazione KV · storage.kv

Chiave-valore isolato per (mini-app, utente), utile per piccoli stati privati come conteggi di check-in, bozze, ecc. tt.cloudStorage (setItem/getItem/getKeys/removeItem) è il suo alias in stile 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');

Conversazioni e multiplayer

Funzionalità sulle conversazioni · im.share / im.send / im.read / media.upload

Ogni interazione con le conversazioni di TutuHai è mediata dall'host (l'utente sceglie attivamente una conversazione); le mini-app non possono ottenere l'elenco completo delle conversazioni. im.read è una funzionalità sensibile.

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

Stanze multiplayer · im.room

Trasforma una "conversazione" in una stanza in tempo reale per mini-giochi / collaborazione: crea/entra in una stanza, messaggi persistenti nella stanza e segnali in tempo reale (sincronizzazione dello stato, ≤2KB, effimeri, non persistiti). L'host fa da ponte per i frame in tempo reale al posto tuo, il JWT dell'host non entra mai nella mini-app; limitato alle stanze create da questa mini-app / alle conversazioni in cui sei stato condiviso — non può accedere alle altre chat private dell'utente.

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

Idratazione alla riconnessione: i segnali sono best-effort e la perdita di frame in caso di disconnessione è normale. Su onReconnect, ri-idrata lo stato finale da room.history() o dai dati cloud — non affidarti ai segnali come unica fonte di verità.

Componenti inline · simili a componenti nativi · rispettosi della privacy

Una card inviata con shareToChat({inline:true}) renderizza un componente interattivo direttamente dentro la bolla della chat (ad es. un sondaggio, una valutazione); i destinatari lo usano come una funzionalità nativa senza aprire una finestra fluttuante. La mini-app renderizza una UI compatta basata su ctx.inline; la bolla si ridimensiona automaticamente al contenuto e si ri-tematizza in tempo reale con il tema chiaro/scuro dell'host. Privacy: un'istanza inline riceve solo un token limitato "solo cloud.data, nessun effetto collaterale" — può leggere collezioni pubbliche + scrivere i propri documenti, non può accedere ai dati privati altrui e non richiede autorizzazione.

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

Ricerca parole / traduzione · text.lookup / text.provider

Il popover di ricerca parole è esso stesso la pagina inline di una "mini-app provider" — il suo contenuto/funzionalità è interamente renderizzato da quella mini-app; l'host fornisce solo la selezione + il posizionamento al passaggio del mouse + un SDK flessibile. Consumatori (rendere selezionabile il testo nella tua mini-app): dichiara text.lookup, zero codice — selezionando del testo compare la pagina inline del provider proprio sotto la selezione (è supportato anche il testo dei messaggi di chat). Provider (costruire una mini-app di ricerca parole): dichiara text.provider (concesso dopo la revisione), la pagina inline riceve le parole tramite tt.text.onLookup e si renderizza da sé; quale provider è attivo si configura nel pannello di amministrazione — se nessuno è configurato/autorizzato, la ricerca è disabilitata. Aggiungi data-tt-no-lookup per escludere una regione.

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

File e cloud drive

Gestione dei file della chat · media.upload / im.share

Quando un utente tocca "Apri con" su un'immagine/file in chat, può scegliere la tua mini-app per gestirlo — a patto che tu abbia dichiarato un tipo di file corrispondente nei fileHandlers di manifest.json (image/video/audio/pdf/office/text/any). Una volta aperto: getContextFile() ottiene il file, readFile() recupera i byte same-origin tramite l'host (evitando il CORS, così puoi analizzare immagini/audio/video/qualsiasi formato), poi dopo l'elaborazione uploadFile() + sendFileToChat() lo rinvia alla conversazione, oppure saveFile() lo scarica — un flusso senza interruzioni.

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

Preleva file da Tutu Drive, oppure salva il tuo output nel drive (mediato dall'host: l'utente sceglie i file uno alla volta nel selettore del drive dentro la pagina dell'host; la mini-app non detiene un token del drive). Viene rifiutato quando il drive non è raggiungibile / il Tutu ID non è federato — dopo .catch, la mini-app può ripiegare su un uploadFile locale.

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

Interazione tra app

Interazione tra app · trascinamento tra app · tt.link / tt.tray / tt.drag / tt.drop (nessuna autorizzazione necessaria)

Più mini-app possono essere aperte contemporaneamente (salvate come combo da aprire insieme con un clic, layout multi-finestra 2/3/4, una barra laterale ancorata — tutto gestito dall'host, senza codice), e interagire tramite le seguenti funzionalità:

tt.link: sincronizza eventi/stato in tempo reale con altre mini-app aperte (broadcast o mirato, ≤2KB, rate-limited 25/s; si perde alla chiusura della finestra, non persistito, non cross-utente/conversazione).
tt.tray: preleva contenuto nel tray dell'host per rilanciarlo, poi inseriscilo in un'altra mini-app o conversazione.
tt.drag.start / tt.drag.bind: avvia un trascinamento / vincola un elemento come sorgente di trascinamento che può essere trascinata direttamente in un'altra mini-app (drag-and-drop nativo HTML5 tra mini-app same-origin).
tt.drop.accept: l'intera mini-app può ricevere drop / iniezioni dal tray.
tt.drop.zone: ★fai in modo che un elemento interno specifico percepisca un drop (con feedback di evidenziazione al passaggio) e agisca di conseguenza. Una mini-app può avere più zone, ciascuna con percezione indipendente.

Sicurezza: un url incapsulato come file accetta solo gli handle /uploads/ di questo sito (il ricevente recupera i byte tramite tt.readFile); i link esterni cross-origin contraffatti vengono scartati; text/json/name hanno tutti limiti di dimensione.

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

UI · finestra · dispositivo (nessuna autorizzazione necessaria)

Funzionalità UI in stile WeChat wx.* — l'host renderizza veri toast/dialog/visualizzatori di immagini, controlla la finestra a capsula della mini-app e accede a clipboard/vibrazione/chiamate/posizione/rete — richiamabili senza richiedere autorizzazione, rendendo una mini-app potente quanto un'app nativa.

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

Finestra fluttuante · schermo intero · branding

Controlla la finestra della mini-app: apri una finestra fluttuante trascinabile da inline/una selezione, espandi a schermo intero / ripristina, colora la capsula dell'host e ascolta le modifiche di visibilità/dimensione.

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

Pulsanti dell'host · feedback aptico · stile Telegram (nessuna autorizzazione necessaria)

Una mini-app controlla i pulsanti della chrome dell'host e riceve i loro eventi di clic (bidirezionale) — il pulsante principale in basso mainButton, il pulsante indietro dell'header backButton, il feedback aptico hapticFeedback. Questo permette a una mini-app di integrarsi in profondità con la UI dell'host (invece di essere una pagina isolata).

// 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 · archiviazione cloud · stile Telegram

colorScheme / themeParams mantengono i colori della mini-app coerenti con l'host e li commutano con il tema chiaro/scuro; locale si sincronizza con l'i18n dell'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')

Riferimento

Gestione degli errori

Ogni window.tt.* restituisce una Promise e rigetta un Error in caso di fallimento. Le mini-app in produzione devono usare .catch / try-catch su ogni chiamata. err.message comuni:

err.message	Significato / gestione suggerita
`User denied authorization`	La richiesta di autorizzazione on-demand è stata negata → guida a riprovare
`User cancelled`	Il selettore/anteprima della conversazione è stato annullato → resta in silenzio
`Call timed out`	L'host non ha risposto per molto tempo (raro) → invita a riprovare
`Data too large / too many documents / too many storage items`	Quota superata → riduci i dati
`public reads are limited to pub_-prefixed public collections`	Nome della collezione non conforme → usa un prefisso pub_
`Forbidden (403)`	Un non sviluppatore ha usato scope=all → nessun permesso
`Network error / Failed to fetch`	Errore di rete → messaggio cortese + riprova

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

Modello di autorizzazione

Autorizzazione on-demand: aprire una mini-app non richiede di concedere tutti i permessi in anticipo; l'host chiede un singolo elemento solo quando una funzionalità viene richiamata per la prima volta (consenti/nega). L'utente può "fidarsi di questa mini-app" per concedere tutto in una volta, oppure attivare i singoli elementi individualmente e vedere i registri d'uso nella pagina delle impostazioni. Il backend ri-convalida comunque a ogni chiamata (difesa in profondità). Le funzionalità UI/finestra/dispositivo/tema/tra-app sono utilizzabili senza autorizzazione.

Funzionalità (scope)	Descrizione	Sensibile
`user.profile`	Ottieni il tuo nickname e avatar	—
`cloud.data`	Dati cloud (collezioni; ordini/record ecc.)	—
`storage.kv`	Archiviazione dati (KV)	—
`media.upload`	Carica immagini/file (incl. drive tt.drive)	—
`im.share`	Condividi una card in chat	—
`im.send`	Invia messaggi	—
`im.read`	Leggi la cronologia delle conversazioni	Sensibile
`im.room`	Stanze multiplayer: invia/ricevi messaggi e leggi la chat della stanza al posto tuo	Sensibile
`text.lookup`	Ricerca parole/traduzione (il testo selezionato viene inviato a un servizio di traduzione)	Sensibile
`text.provider`	Provider di ricerca (la pagina di questa mini-app funge da popover di ricerca/traduzione)	Sensibile

Visibilità

Pubblica: compare in "Scopri" e nella ricerca; chiunque può trovarla.
Non elencata: non in scopri/ricerca; raggiungibile solo tramite una card condivisa o un link copiato (deep link) — per la diffusione tra il traffico privato senza esposizione pubblica. Attivala nella console con un clic.
Modalità di apertura (desktop): la "Modalità di apertura" della console commuta tra "fluttuante (predefinita) / schermo intero" — le app di tipo canvas/lavagna/editor impostano fullscreen per riempire lo schermo all'apertura; le card/form leggeri usano la modalità fluttuante. Puoi anche dichiarare il valore iniziale nel campo display di manifest.json. Su mobile è sempre a schermo intero, non influenzato da questa impostazione.

Versioni e pubblicazione

Modello di versione: bozza → in revisione → pronta → live.

Tutte le versioni storiche vengono conservate, con rollback con un clic a qualsiasi versione storica (scambio istantaneo della versione live). I rifiuti mostrano il motivo nel centro notifiche.

Vincoli e quote

Dati cloud: singolo documento ≤ 8KB, ≤ 500 documenti per (mini-app, utente), list() ≤ 200 alla volta (dai più recenti); usa la paginazione a cursore listPage() (mine/all) per averne di più. Nota: fare aggregazione frontend (conteggi/medie) direttamente con list() sotto-conterà la parte più vecchia quando una collezione supera i 200 elementi e darà un risultato più basso — per i totali completi usa la paginazione listPage o accetta un'approssimazione.
KV: singolo valore ≤ 8KB, ≤ 64 chiavi per (mini-app, utente).
Immagini caricate ≤ 4MB; file caricati ≤ 20MB; l'invio di messaggi è rate-limited (≤ 20 per utente al minuto); payload dei segnali della stanza ≤ 2KB; singolo messaggio tt.link ≤ 2KB, throttled 25/s.
Il bundle di codice è un HTML a file singolo (preferisci il rendering DOM puro; evita innerHTML per prevenire XSS).
I token sono di breve durata (circa 2 ore); l'host li rinnova silenziosamente dopo la scadenza; le chiamate alle funzionalità vengono ri-convalidate dal backend.

Esempi di riferimento: le applets/food (ordinazione, dati cloud) e applets/repair (richieste di riparazione) del repository sono entrambe mini-app pure-frontend + dati cloud.