Configurația aplicației

• Identitate — identificator universal, nume de afișare, descriere.
• Permisiuni — sub ce rol rulează funcțiile logice și componentele front-end ale acesteia.
• Variabile (opțional) — perechi cheie–valoare expuse codului dvs. ca variabile de mediu.
• Hook-uri de pre-instalare / post-instalare / dezinstalare (opțional) — vedeți Funcții logice.

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

• Câmpurile universalIdentifier sunt ID-uri deterministe pe care le dețineți. Generați-le o singură dată și mențineți-le stabile între sincronizări.
• applicationVariables devin variabile de mediu pentru funcțiile și componentele front-end. În funcțiile de logică (server-side), acestea sunt disponibile ca process.env.VARIABLE_NAME. În componentele front-end, folosește getApplicationVariable('VARIABLE_NAME') din twenty-sdk/front-component. Variabilele marcate cu isSecret: true sunt injectate doar în funcțiile de logică. Componentele front-end primesc doar variabile non-secrete.
• Rolul implicit este detectat automat din fișierul de rol marcat cu defineApplicationRole() — nu este necesar să faci referire la el în defineApplication().
• Funcțiile de pre-instalare, post-instalare și dezinstalare sunt detectate automat în timpul construirii manifestului — nu este nevoie să faceți referire la ele în defineApplication().
• Transmiterea explicită a defaultRoleUniversalIdentifier este în continuare acceptată pentru compatibilitate retroactivă, dar este considerată învechită în favoarea defineApplicationRole().
• serverVariables sunt configurări și secrete la nivel de instanță (de ex. chei API). Spre deosebire de applicationVariables, ele nu declară nicio valoare în manifest — operatorul spațiului de lucru le completează din setările aplicației și sunt injectate în funcțiile de logică doar după ce au fost setate.
• Pentru a afișa o interfață de configurare personalizată în fila Settings a aplicației (în locul secțiunii implicite de configurare a variabilelor), declară un front component cu defineSettingsFrontComponent() într-un fișier separat. Este permis doar unul per aplicație. Secțiunile gestionate de sistem (auto-upgrade, App URL, connections) rămân întotdeauna vizibile.

​

Tipuri de variabile

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 }

​

Rol implicit pentru funcții

• Tokenul de runtime injectat ca TWENTY_APP_ACCESS_TOKEN este derivat din acest rol.
• Clientul API tipizat este restricționat la permisiunile acordate acelui rol.
• Respectați principiul celui mai mic privilegiu: declarați doar permisiunile de care au nevoie funcțiile.

​

Metadate pentru marketplace