Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.twenty.com/llms.txt

Use this file to discover all available pages before exploring further.

Aplikace Twenty jsou balíčky TypeScriptu, které rozšiřují váš pracovní prostor o vlastní objekty, logiku, komponenty UI a funkce AI. Běží na platformě Twenty s plnou izolací (sandboxingem) a řízením oprávnění.

Jak aplikace fungují

Aplikace je kolekce entit deklarovaných pomocí funkcí defineEntity() z balíčku twenty-sdk. SDK tyto deklarace detekuje pomocí analýzy AST při sestavení a vytváří manifest — úplný popis toho, co vaše aplikace přidává do pracovního prostoru.
your-app/
├── src/
│   ├── application-config.ts    ← defineApplication (required, one per app)
│   ├── roles/                   ← defineRole
│   ├── objects/                 ← defineObject
│   ├── fields/                  ← defineField
│   ├── logic-functions/         ← defineLogicFunction
│   ├── front-components/        ← defineFrontComponent
│   ├── skills/                  ← defineSkill
│   ├── agents/                  ← defineAgent
│   ├── views/                   ← defineView
│   ├── navigation-menu-items/   ← defineNavigationMenuItem
│   └── page-layouts/            ← definePageLayout
├── public/                      ← Static assets (images, icons)
└── package.json
Uspořádání souborů je na vás. Detekce entit je založená na AST — SDK najde volání export default defineEntity(...) bez ohledu na to, kde se soubor nachází. Výše uvedená struktura složek je konvence, nikoli požadavek.

Typy entit

EntitaÚčelDokumentace
AplikaceIdentita aplikace, oprávnění, proměnnéDatový model
RoleSady oprávnění pro objekty a poleDatový model
ObjektVlastní datové tabulky s poliDatový model
PoleRozšíření existujících objektů, definice relacíDatový model
Logická funkceTypeScript na straně serveru se spouštěčiLogické funkce
Frontendová komponentaIzolované React UI na stránce TwentyFrontendové komponenty
DovednostZnovupoužitelné pokyny pro AI agentyDovednosti a agenti
AgentAI asistenti s vlastními promptyDovednosti a agenti
PohledPředkonfigurovaná zobrazení seznamu záznamůRozvržení
Položka navigační nabídkyVlastní položky postranního paneluRozvržení
Rozvržení stránkyVlastní karty a widgety na stránce záznamuRozvržení

Izolace (sandboxing)

  • Logické funkce běží v izolovaných procesech Node.js na serveru. K datům přistupují pouze prostřednictvím typovaného klienta API, a to v rozsahu oprávnění role aplikace.
  • Frontendové komponenty běží ve Web Workerech s využitím Remote DOM — jsou oddělené od hlavní stránky, ale vykreslují nativní prvky DOM (nikoli iframy). Komunikují s Twenty prostřednictvím hostitelského API pro předávání zpráv.
  • Oprávnění jsou vynucována na úrovni API. Běhový token (TWENTY_APP_ACCESS_TOKEN) je odvozen z role definované v defineApplication().

Životní cyklus aplikace

┌─────────────────────────────────────────────────────────┐
│ Development                                             │
│   npx create-twenty-app → yarn twenty dev (live sync)   │
├─────────────────────────────────────────────────────────┤
│ Build & Deploy                                          │
│   yarn twenty build → yarn twenty deploy                │
├─────────────────────────────────────────────────────────┤
│ Install flow                                            │
│   upload → [pre-install] → metadata migration →         │
│   generate SDK → [post-install]                         │
├─────────────────────────────────────────────────────────┤
│ Publish                                                 │
│   npm publish → appears in Twenty marketplace           │
└─────────────────────────────────────────────────────────┘
  • yarn twenty dev — sleduje vaše zdrojové soubory a průběžně synchronizuje změny s připojeným serverem Twenty. Typovaný klient API se při změně schématu automaticky znovu vygeneruje.
  • yarn twenty build — zkompiluje TypeScript, zabalí logické funkce a frontendové komponenty pomocí esbuild a vytvoří manifest.
  • Pre/post-install hooks — volitelné logické funkce, které běží během instalace. Podrobnosti najdete v Logických funkcích.

Další kroky

Datový model

Definujte objekty, pole, role a relace.

Logické funkce

Funkce na straně serveru s HTTP, cron a událostními spouštěči.

Frontendové komponenty

Izolované komponenty Reactu v uživatelském rozhraní Twenty.

Rozvržení

Pohledy, položky navigace a rozvržení stránek záznamů.

Dovednosti a agenti

AI dovednosti a agenti s vlastními prompty.

CLI a testování

Příkazy CLI, testování, prostředky, vzdálené zdroje a CI.

Publikování

Nasaďte na server nebo publikujte na tržišti.