defineApplication. Deklaruje:
- 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í hooky (volitelné) — viz Logické funkce.
src/application-config.ts
- Pole
universalIdentifierjsou deterministické identifikátory, které vlastníte. Vygenerujte je jednou a zachovejte je stabilní napříč synchronizacemi. applicationVariablesse stanou proměnnými prostředí pro vaše funkce a frontendové komponenty. V logických funkcích (na straně serveru) jsou dostupné jakoprocess.env.VARIABLE_NAME. Ve frontendových komponentách použijtegetApplicationVariable('VARIABLE_NAME')ztwenty-sdk/front-component. Proměnné označené jakoisSecret: truejsou 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 zdefineApplication(). - Předinstalační a postinstalační funkce jsou při sestavení manifestu detekovány automaticky — není třeba na ně odkazovat v
defineApplication(). - Předávání
defaultRoleUniversalIdentifierexplicitně je stále podporováno kvůli zpětné kompatibilitě, ale je zastaralé ve prospěchdefineApplicationRole().
Výchozí role funkce
Role deklarovaná pomocídefineApplicationRole() určuje, k čemu mají přístup logické funkce a front-endové komponenty aplikace:
- Běhový token vložený jako
TWENTY_APP_ACCESS_TOKENje odvozen z této role. - 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í.
src/roles/default-role.ts. Úplnou referenci najdete v části Role a oprávnění.
Metadata tržiště
Pokud plánujete zveřejnit svou aplikaci, tato volitelná pole určují, jak se vaše aplikace zobrazuje v tržišti:| Pole | Popis |
|---|---|
author | Jméno autora nebo název společnosti |
category | Kategorie aplikace pro filtrování v tržišti |
logoUrl | Cesta k logu vaší aplikace (např. public/logo.png) |
screenshots | Pole cest ke snímkům obrazovky (např. public/screenshot-1.png) |
aboutDescription | Delší popis v Markdownu pro kartu “O aplikaci”. Pokud je vynecháno, tržiště použije README.md balíčku z npm |
websiteUrl | Odkaz na váš web |
termsUrl | Odkaz na podmínky služby |
emailSupport | E-mailová adresa podpory |
issueReportUrl | Odkaz na nástroj pro sledování problémů |