Перейти к основному содержанию

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 — это пакеты TypeScript, которые расширяют ваше рабочее пространство пользовательскими объектами, логикой, компонентами интерфейса и возможностями ИИ. Они работают на платформе Twenty с полной изоляцией в песочнице и контролем прав доступа.

​
Как работают приложения

Приложение — это набор сущностей, объявленных с помощью функций defineEntity() из пакета twenty-sdk. SDK обнаруживает эти объявления посредством анализа AST на этапе сборки и формирует манифест — полное описание того, что ваше приложение добавляет в рабочее пространство. Эти функции проверяют вашу конфигурацию на этапе сборки и обеспечивают автодополнение в IDE и безопасность типов. 
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
Организация файлов — на ваше усмотрение. Обнаружение сущностей основано на AST — SDK находит вызовы export default defineEntity(...) независимо от расположения файла. Структура папок выше — это соглашение, а не требование.

​
Типы сущностей

СущностьНазначениеДокументация
ПриложениеИдентификация приложения, роль по умолчанию, переменныеКонфигурация приложения
РольНаборы прав для объектов и полейРоли и разрешения
ОбъектПользовательские типы записей с полямиОбъекты
ПолеДобавляйте поля к объектам из других приложенийРасширение объектов
СвязьДвунаправленные связи между объектамиСвязи
Логическая функцияСерверный TypeScript с триггерамиЛогические функции
НавыкПовторно используемые инструкции для ИИ-агентаНавыки и агенты
АгентИИ-агенты с пользовательскими промптамиНавыки и агенты
Провайдер подключенияУчётные данные OAuth для сторонних APIПодключения
ПредставлениеПреднастроенные представления списков записейПредставления
Пункт меню навигацииПользовательские элементы боковой панелиЭлементы меню навигации
Макет страницыВкладки и виджеты на странице сведений о записиМакеты страниц
Компонент фронтендаИзолированный в песочнице интерфейс React внутри TwentyКомпоненты фронтенда
Элемент меню командБыстрые действия и элементы Cmd+KЭлементы меню команд

​
Изоляция в песочнице

  • Логические функции выполняются в изолированных процессах Node.js на сервере. Они получают доступ к данным только через типизированный клиент API, ограниченный правами роли приложения.
  • Компоненты фронтенда запускаются в Web Workers с использованием Remote DOM — изолированы от основной страницы, но при этом рендерят нативные элементы DOM (не iframes). Они взаимодействуют с Twenty через хостовый API обмена сообщениями.
  • Права доступа применяются на уровне API. Токен времени выполнения (TWENTY_APP_ACCESS_TOKEN) выводится из роли, определённой в defineApplication().

​
Жизненный цикл приложения

┌─────────────────────────────────────────────────────────┐
│ 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 — следит за исходными файлами и синхронизирует изменения в реальном времени с подключённым сервером Twenty. Типизированный клиент API автоматически пересоздаётся при изменении схемы.
  • yarn twenty build — компилирует TypeScript, упаковывает логические функции и фронтенд-компоненты с помощью esbuild и формирует манифест.
  • Хуки до/после установки — необязательные функции, которые выполняются во время установки. См. раздел Install Hooks для подробностей.

​
Следующие шаги

Конфигурация

Идентификация приложения, роль по умолчанию и хуки установки.

Данные

Объекты, поля и двунаправленные связи.

Логика

Логические функции, навыки, агенты и OAuth-подключения.

Макет

Представления, навигация, макеты страниц, фронтенд-компоненты.

Операции

CLI, тестирование, удаленные окружения, CI и публикация вашего приложения.