Configuration de l'application

• Identité — identifiant universel, nom d’affichage, description.
• Autorisations — le rôle sous lequel s’exécutent ses fonctions logiques et ses composants front-end.
• Variables (facultatif) — paires clé–valeur exposées à votre code en tant que variables d’environnement.
• Hooks de pré-installation / post-installation (facultatif) — voir Fonctions logiques.

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,
    },
  },
});

• Les champs universalIdentifier sont des identifiants déterministes que vous contrôlez. Générez-les une fois et conservez-les stables entre les synchronisations.
• applicationVariables deviennent des variables d’environnement pour vos fonctions et vos composants front-end. Dans les fonctions logiques (côté serveur), elles sont disponibles sous process.env.VARIABLE_NAME. Dans les composants front-end, utilisez getApplicationVariable('VARIABLE_NAME') depuis twenty-sdk/front-component. Les variables marquées avec isSecret: true sont uniquement injectées dans les fonctions logiques. Les composants front-end ne reçoivent que des variables non secrètes.
• Le rôle par défaut est détecté automatiquement à partir du fichier de rôle marqué avec defineApplicationRole() — vous n’avez pas besoin d’y faire référence depuis defineApplication().
• Les fonctions de pré-installation et de post-installation sont détectées automatiquement lors de la construction du manifeste — vous n’avez pas besoin de les référencer dans defineApplication().
• Le passage explicite de defaultRoleUniversalIdentifier est toujours pris en charge pour des raisons de rétrocompatibilité, mais il est obsolète au profit de defineApplicationRole().
• serverVariables sont des configurations et des secrets au niveau de l’instance (par exemple des clés d’API). Contrairement à applicationVariables, ils ne déclarent aucune valeur dans le manifeste — l’opérateur de l’espace de travail les renseigne dans les paramètres de l’application, et ils sont injectés dans les fonctions logiques uniquement une fois définis.

​

Types de variables

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 }

​

Rôle de fonction par défaut

• Le jeton d’exécution injecté sous TWENTY_APP_ACCESS_TOKEN est dérivé de ce rôle.
• Le client d’API typé est limité aux autorisations accordées à ce rôle.
• Appliquez le principe du moindre privilège : déclarez uniquement les autorisations dont vos fonctions ont besoin.

​

Métadonnées de la marketplace