アプリケーション設定

• Identity — ユニバーサル識別子、表示名、説明。
• Permissions — ロジック関数およびフロントコンポーネントがどのロールで実行されるか。
• Variables (optional) — コードから環境変数として利用できるキーと値のペア。
• プレインストール / ポストインストール / アンインストール フック (任意) — Logic Functions を参照してください。

import { defineApplication } from 'twenty-sdk/define';

export default defineApplication({
  universalIdentifier: '39783023-bcac-41e3-b0d2-ff1944d8465d',
  displayName: 'My Twenty App',
  description: 'My first Twenty app',
  applicationVariables: {
    DEFAULT_RECIPIENT_NAME: {
      universalIdentifier: '19e94e59-d4fe-4251-8981-b96d0a9f74de',
      description: 'Default recipient name for postcards',
      value: 'Jane Doe',
      isSecret: false,
    },
  },
});

• universalIdentifier フィールドは、あなたが所有する安定した ID です。 一度生成し、その後の同期でも安定して維持してください。
• applicationVariables は関数やフロントコンポーネントの環境変数になります。 ロジック関数（サーバーサイド）では、process.env.VARIABLE_NAME として利用できます。 フロントコンポーネントでは、twenty-sdk/front-component の getApplicationVariable('VARIABLE_NAME') を使用します。 isSecret: true が指定された変数は、ロジック関数にのみインジェクトされます。 フロントコンポーネントには、秘密ではない変数のみが渡されます。
• デフォルトのロールは、defineApplicationRole() でマークされたロールファイルから自動的に検出されます。defineApplication() から参照する必要はありません。
• プレインストール関数、ポストインストール関数、およびアンインストール関数は、マニフェストのビルド中に自動的に検出されるため、defineApplication() で参照する必要はありません。
• 後方互換性のために defaultRoleUniversalIdentifier を明示的に渡すことも依然としてサポートされていますが、defineApplicationRole() が推奨されるため、非推奨となっています。
• serverVariables はインスタンス単位の構成およびシークレット（例: API キー）です。 applicationVariables と異なり、マニフェスト内で値は宣言されません。ワークスペースのオペレーターがアプリの設定からそれらを入力し、設定された時点でのみロジック関数に注入されます。
• どちらの種類の変数も isDeprecated: true を受け付けます。 変数を削除する代わりに廃止するためにこれを使用します。キーの宣言を残しておくことで保存されている値が保持されます（削除するとオペレーターが入力した値は失われます）。また、その変数は依然としてインジェクトされるため、コードは process.env.NEW_API_KEY ?? process.env.API_KEY にフォールバックできます。 非推奨の変数は値がなくなるとアプリの設定から消え、アプリの構成チェックにも一切カウントされません。そのため、isDeprecated は isRequired より優先されます。
• アプリの Settings タブ内で（デフォルトの変数設定セクションの代わりに）カスタム設定 UI をレンダーするには、専用のファイル内で defineSettingsFrontComponent() を使用してフロントコンポーネントを宣言します。 アプリごとに 1 つのみ許可されています。 システム管理のセクション（自動アップグレード、App URL、接続）は常に表示されます。

​

変数の型

import { defineApplication, FieldType } from 'twenty-sdk/define';

export default defineApplication({
  // ...identity, role...
  applicationVariables: {
    MAX_POSTCARDS: {
      universalIdentifier: '5f4497e4-9030-4085-85eb-2c48b8d53713',
      description: 'Maximum postcards per batch',
      type: FieldType.NUMBER,
      value: 10,
    },
    DEFAULT_REGION: {
      universalIdentifier: '76c5c321-b6b6-46eb-b4fc-f9f04bb04227',
      description: 'Default shipping region',
      type: FieldType.SELECT,
      options: [
        { label: 'Europe', value: 'eu' },
        { label: 'United States', value: 'us' },
      ],
      value: 'eu',
    },
  },
});

const maxCards = Number(process.env.MAX_POSTCARDS); // "10" -> 10
const enabled = process.env.ENABLE_TRACKING === 'true'; // "true" -> true
const channels = JSON.parse(process.env.ENABLED_CHANNELS ?? '[]'); // '["email"]' -> ["email"]
const config = JSON.parse(process.env.PROVIDER_CONFIG ?? '{}'); // '{"retries":3}' -> { retries: 3 }

​

デフォルトの関数ロール

• TWENTY_APP_ACCESS_TOKEN として注入される実行時トークンは、このロールに基づいて生成されます。
• 型付き API クライアントは、そのロールに付与された権限に制限されます。
• 最小権限の原則に従い、関数に必要な権限のみを宣言してください。

​

マーケットプレイスのメタデータ