Ana içeriğe atla

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.

Twenty uygulamaları, çalışma alanınızı özel nesneler, mantık, UI bileşenleri ve yapay zekâ yetenekleriyle genişleten TypeScript paketleridir. Tam korumalı alan ve izin kontrolleriyle Twenty platformunda çalışırlar.

Uygulamalar nasıl çalışır

Bir uygulama, twenty-sdk paketindeki defineEntity() işlevleri kullanılarak bildirilen varlıklar koleksiyonudur. SDK, bu bildirimleri derleme sırasında AST analiziyle algılar ve bir manifest üretir — uygulamanızın bir çalışma alanına neler eklediğinin eksiksiz bir açıklaması. Bu işlevler, derleme zamanında yapılandırmanızı doğrular ve IDE otomatik tamamlama ile tür güvenliği sağlar.
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
Dosya organizasyonu size kalmış. Varlık algılama AST tabanlıdır — dosyanın nerede bulunduğundan bağımsız olarak SDK export default defineEntity(...) çağrılarını bulur. Yukarıdaki klasör yapısı bir gelenektir, zorunluluk değildir.

Varlık türleri

VarlıkAmaçBelgeler
UygulamaUygulama kimliği, varsayılan rol, değişkenlerUygulama Yapılandırması
RolNesneler ve alanlar üzerindeki izin kümeleriRoller ve İzinler
NesneAlanlara sahip özel kayıt türleriNesneler
AlanDiğer uygulamalardaki nesnelere alan ekleyinNesneleri Genişletme
İlişkiNesneler arasındaki çift yönlü bağlantılarİlişkiler
Mantık İşleviTetikleyicilerle sunucu tarafı TypeScriptMantıksal İşlevler
BeceriYeniden kullanılabilir yapay zekâ temsilcisi yönergeleriBeceriler ve Temsilciler
TemsilciÖzel istemlere sahip yapay zekâ asistanlarıBeceriler ve Temsilciler
Bağlantı SağlayıcısıÜçüncü taraf API’ler için OAuth kimlik bilgileriBağlantılar
GörünümÖnceden yapılandırılmış kayıt listesi görünümleriGörünümler
Gezinme Menüsü ÖğesiÖzel kenar çubuğu öğeleriGezinme Menüsü Öğeleri
Sayfa DüzeniBir kaydın ayrıntı sayfasındaki sekmeler ve widget’larSayfa Düzenleri
Ön Uç BileşeniTwenty içinde korumalı alandaki React kullanıcı arayüzüÖn Uç Bileşenleri
Komut Menüsü ÖğesiHızlı işlemler ve Cmd+K girdileriKomut Menüsü Öğeleri

Korumalı alan

  • Mantık işlevleri sunucuda yalıtılmış Node.js işlemlerinde çalışır. Verilere yalnızca, kapsamı uygulamanın rol izinleriyle sınırlandırılmış tipli API istemcisi üzerinden erişirler.
  • Ön uç bileşenleri, Remote DOM kullanan Web Worker’larda çalışır — ana sayfadan yalıtılmıştır ancak yerel DOM öğelerini (iframe’ler değil) oluşturur. Twenty ile mesaj iletimi yapan bir ana makine API’si aracılığıyla iletişim kurarlar.
  • İzinler, API düzeyinde uygulanır. Çalışma zamanı belirteci (TWENTY_APP_ACCESS_TOKEN), defineApplication() içinde tanımlanan rolden türetilir.

Uygulama yaşam döngüsü

┌─────────────────────────────────────────────────────────┐
│ 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 — kaynak dosyalarınızı izler ve bağlı bir Twenty sunucusuna değişiklikleri canlı olarak senkronize eder. Şema değiştiğinde tipli API istemcisi otomatik olarak yeniden oluşturulur.
  • yarn twenty build — TypeScript’i derler, mantık işlevlerini ve ön uç bileşenlerini esbuild ile paketler ve bir manifest üretir.
  • Kurulum öncesi/sonrası kancaları — kurulum sırasında çalışan isteğe bağlı işlevler. Ayrıntılar için Kurulum Kancaları bölümüne bakın.

Sonraki adımlar

Yapılandırma

Uygulama kimliği, varsayılan rol ve kurulum kancaları.

Veri

Nesneler, alanlar ve çift yönlü ilişkiler.

Mantık

Mantık işlevleri, beceriler, temsilciler ve OAuth bağlantıları.

Düzen

Görünümler, gezinme, sayfa düzenleri, ön uç bileşenleri.

İşlemler

CLI, test, uzak depolar, CI ve uygulamanızı yayımlama.