Konfigurace aplikace

• Identita — univerzální identifikátor, zobrazovaný název, popis.
• Oprávnění — pod jakou rolí běží její logické funkce a frontendové komponenty.
• Proměnné (volitelné) — páry klíč–hodnota zpřístupněné vašemu kódu jako proměnné prostředí.
• Předinstalační / postinstalační / odinstalační hooky (volitelné) — viz Logické funkce.

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

• Pole universalIdentifier jsou deterministické identifikátory, které vlastníte. Vygenerujte je jednou a zachovejte je stabilní napříč synchronizacemi.
• applicationVariables se stanou proměnnými prostředí pro vaše funkce a frontendové komponenty. V logických funkcích (na straně serveru) jsou dostupné jako process.env.VARIABLE_NAME. Ve frontendových komponentách použijte getApplicationVariable('VARIABLE_NAME') z twenty-sdk/front-component. Proměnné označené jako isSecret: true jsou předávány pouze do logických funkcí. Frontendové komponenty přijímají pouze proměnné, které nejsou tajné.
• Výchozí role je automaticky detekována ze souboru role označeného pomocí defineApplicationRole() — není potřeba na ni odkazovat z defineApplication().
• Předinstalační, postinstalační a odinstalační funkce jsou při sestavení manifestu detekovány automaticky — není třeba na ně odkazovat v defineApplication().
• Předávání defaultRoleUniversalIdentifier explicitně je stále podporováno kvůli zpětné kompatibilitě, ale je zastaralé ve prospěch defineApplicationRole().
• serverVariables představují konfiguraci a tajné údaje vázané na instanci (např. klíče API). Na rozdíl od applicationVariables neuvádějí v manifestu žádnou hodnotu — operátor pracovního prostoru je vyplní v nastavení aplikace a do logických funkcí jsou injektovány až poté, co jsou nastaveny.
• Oba druhy proměnných přijímají isDeprecated: true. Použijte ji k vyřazení proměnné místo jejího smazání: ponechání deklarovaného klíče zachová uloženou hodnotu (jejím smazáním se zničí hodnota, kterou zadal uživatel) a proměnná se stále injektuje, takže ji váš kód může použít jako záložní hodnotu — process.env.NEW_API_KEY ?? process.env.API_KEY. Zastaralá proměnná zmizí z nastavení aplikace, jakmile nemá žádnou hodnotu, a nikdy se nezapočítává do kontroly konfigurace aplikace, takže isDeprecated má přednost před isRequired.
• Chcete-li vykreslit vlastní konfigurační uživatelské rozhraní na kartě Settings aplikace (namísto výchozí sekce pro konfiguraci proměnných), deklarujte frontovou komponentu pomocí defineSettingsFrontComponent() v jejím vlastním souboru. Na jednu aplikaci je povolena pouze jedna instance. Sekce spravované systémem (automatická aktualizace, App URL, připojení) zůstávají vždy viditelné.

​

Typy proměnných

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 }

​

Výchozí role funkce

• Běhové tokeny vložené do vašich logických funkcí jsou odvozeny z této role. Volání jednající jako osoba je dále omezeno tím, co tato osoba může dělat, takže nikdy nemůže překročit ani jedno z těchto oprávnění. Vizte Čí přístup volání používá.
• Typovaný klient API je omezen na oprávnění udělená této roli.
• Dodržujte princip nejmenších oprávnění: deklarujte pouze ta oprávnění, která vaše funkce potřebují.

​

Metadata tržiště