Конфигурация приложения

• Идентификация — универсальный идентификатор, отображаемое имя, описание.
• Разрешения — от имени какой роли выполняются его логические функции и фронтенд-компоненты.
• Переменные (необязательно) — пары ключ–значение, доступные вашему коду как переменные окружения.
• Хуки предустановки / постустановки / удаления (необязательно) — см. Логические функции.

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 — это детерминированные идентификаторы, которые принадлежат вам. Сгенерируйте их один раз и сохраняйте неизменными между синхронизациями.
• applicationVariables становятся переменными окружения для ваших функций и фронтенд-компонентов. В логических функциях (на стороне сервера) они доступны как process.env.VARIABLE_NAME. Во фронтенд-компонентах используйте getApplicationVariable('VARIABLE_NAME') из twenty-sdk/front-component. Переменные, помеченные как isSecret: true, внедряются только в логические функции. Фронтенд-компоненты получают только несекретные переменные.
• Роль по умолчанию автоматически определяется из файла роли, помеченного с помощью defineApplicationRole() — вам не нужно ссылаться на неё из defineApplication().
• Функции предустановки, постустановки и удаления обнаруживаются автоматически во время сборки манифеста — вам не нужно указывать их в defineApplication().
• Явная передача defaultRoleUniversalIdentifier по-прежнему поддерживается для обратной совместимости, но считается устаревшей и вместо неё рекомендуется использовать defineApplicationRole().
• serverVariables — это параметры конфигурации и секреты в области экземпляра (например, ключи API). В отличие от applicationVariables, значения для них не указываются в манифесте — оператор рабочего пространства заполняет их в настройках приложения, и они внедряются в логические функции только после того, как будут заданы.
• Оба типа переменных принимают isDeprecated: true. Используйте это, чтобы вывести переменную из обращения вместо её удаления: сохранение объявленного ключа сохраняет хранимое значение (удаление уничтожает значение, введённое пользователем), а переменная по-прежнему внедряется, поэтому код сможет обратиться к ней — process.env.NEW_API_KEY ?? process.env.API_KEY. Устаревшая переменная исчезает из настроек приложения, как только у неё больше нет значения, и никогда не учитывается при проверке конфигурации приложения, поэтому isDeprecated имеет приоритет над isRequired.
• Чтобы отобразить на вкладке Settings приложения пользовательский интерфейс настройки (вместо стандартного раздела настройки переменных), объявите фронтенд‑компонент с помощью defineSettingsFrontComponent() в отдельном файле. Для каждого приложения допускается только один такой компонент. Разделы, управляемые системой (автообновление, 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 }

​

Роль функции по умолчанию

• Токены времени выполнения, подставляемые в ваши функции логики, формируются из этой роли. Вызов, выполняемый от имени пользователя, дополнительно ограничен тем, что может делать этот пользователь, поэтому он никогда не может превышать ни один из них. См. Чей доступ использует вызов.
• Типизированный клиент API ограничен правами, предоставленными этой роли.
• Следуйте принципу наименьших привилегий: объявляйте только те разрешения, которые действительно нужны вашим функциям.

​

Метаданные маркетплейса