Расширение объектов

​

Обзор

import { defineField, FieldType } from 'twenty-sdk/define';

export default defineField({
  universalIdentifier: 'f2a1b3c4-d5e6-7890-abcd-ef1234567890',
  objectUniversalIdentifier: '701aecb9-eb1c-4d84-9d94-b954b231b64b', // Company object
  name: 'loyaltyTier',
  type: FieldType.SELECT,
  label: 'Loyalty Tier',
  icon: 'IconStar',
  options: [
    { value: 'BRONZE', label: 'Bronze', position: 0, color: 'orange' },
    { value: 'SILVER', label: 'Silver', position: 1, color: 'gray' },
    { value: 'GOLD', label: 'Gold', position: 2, color: 'yellow' },
  ],
});

​

Основные моменты

• objectUniversalIdentifier определяет целевой объект. Для стандартных объектов Twenty импортируйте константу из twenty-sdk:
  import { STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS } from 'twenty-sdk/define';
  
  // STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.company.universalIdentifier
  // STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.person.universalIdentifier
  // STANDARD_OBJECT_UNIVERSAL_IDENTIFIERS.opportunity.universalIdentifier
  // …
  
• При определении полей непосредственно внутри defineObject() вам не нужен objectUniversalIdentifier — он наследуется от родительского объекта.
• defineField() — единственный способ добавить поля к объектам, которые вы не создавали с помощью defineObject().
• SELECT и MULTI_SELECT следуют тем же правилам проверки параметров и цветов, что и встроенные поля. Если цвет не указан или имеет значение null, по умолчанию используется gray; неподдерживаемые цвета отклоняются.
• Расположение файла зависит от вас. Принятое соглашение — src/fields/\<name>.field.ts, но CLI обнаруживает поля в любом месте внутри src/.
• isSearchable: true можно задать для defineField() с теми же ограничениями, что и для встроенных полей (целевой объект с возможностью поиска, тип поля, совместимый с текстом), чтобы записи целевого объекта можно было находить по значениям вашего поля с помощью полнотекстового поиска.
• isAuditLogged: false можно задать в defineField(), чтобы изменения поля не отображались на временной шкале целевой записи, что особенно важно для полей, которые ваше приложение переписывает по расписанию.
• Чтобы добавить вкладку в стандартную компоновку страницы (например, на страницу сведений о задаче или компании), используйте definePageLayoutTab с STANDARD_PAGE_LAYOUT_UNIVERSAL_IDENTIFIERS из twenty-sdk/define.

​

Добавление связи к существующему объекту