アプリの仕組み
アプリは、twenty-sdk パッケージの defineEntity() 関数を使って宣言されたエンティティの集合です。 SDK はビルド時に AST 解析によってこれらの宣言を検出し、マニフェストを生成します—アプリがワークスペースに追加する内容を完全に記述したものです。 これらの関数はビルド時に設定を検証し、IDE の自動補完と型安全性を提供します。
ファイル構成は自由です。 エンティティの検出は AST ベースです—ファイルの場所に関係なく、SDK は
export default defineEntity(...) の呼び出しを見つけます。 上記のフォルダー構成は慣例であり、必須条件ではありません。エンティティタイプ
サンドボックス化
- ロジック関数は、サーバー上の分離された Node.js プロセスで実行されます。 データへのアクセスは型付き API クライアント経由に限定され、アプリのロール権限の範囲にスコープされます。
- フロントコンポーネントは Remote DOM を用いた Web Workers 内で実行されます—メインページからサンドボックス化されつつ、ネイティブの DOM 要素（iframe ではありません）をレンダリングします。 メッセージパッシング型のホスト API を介して Twenty と通信します。
- 権限は API レベルで強制されます。 実行時トークン（
TWENTY_APP_ACCESS_TOKEN）は、defineApplication()で定義されたロールに基づいて生成されます。
アプリのライフサイクル
yarn twenty dev— ソースファイルを監視し、接続された Twenty サーバーへ変更をライブ同期します。 スキーマが変更されると、型付き API クライアントは自動的に再生成されます。yarn twenty dev:build— TypeScript をコンパイルし、esbuild でロジック関数とフロントコンポーネントをバンドルして、マニフェストを生成します。- プリ/ポストインストールフック — インストール中に実行されるオプションの関数。 詳細は Install Hooks を参照してください。
次のステップ
設定
アプリの識別情報、デフォルトロール、およびインストールフック。
データ
オブジェクト、フィールド、および双方向リレーション。
ロジック
ロジック関数、スキル、エージェント、OAuth 接続。
レイアウト
ビュー、ナビゲーション、ページレイアウト、フロントコンポーネント。
オペレーション
CLI、テスト、リモート、CI、アプリの公開。