Объекты

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

enum PostCardStatus {
  DRAFT = 'DRAFT',
  SENT = 'SENT',
  DELIVERED = 'DELIVERED',
  RETURNED = 'RETURNED',
}

export default defineObject({
  universalIdentifier: '54b589ca-eeed-4950-a176-358418b85c05',
  nameSingular: 'postCard',
  namePlural: 'postCards',
  labelSingular: 'Post Card',
  labelPlural: 'Post Cards',
  description: 'A post card object',
  icon: 'IconMail',
  fields: [
    {
      universalIdentifier: '58a0a314-d7ea-4865-9850-7fb84e72f30b',
      name: 'content',
      type: FieldType.TEXT,
      label: 'Content',
      description: "Postcard's content",
      icon: 'IconAbc',
    },
    {
      universalIdentifier: 'c6aa31f3-da76-4ac6-889f-475e226009ac',
      name: 'recipientName',
      type: FieldType.FULL_NAME,
      label: 'Recipient name',
      icon: 'IconUser',
    },
    {
      universalIdentifier: '95045777-a0ad-49ec-98f9-22f9fc0c8266',
      name: 'recipientAddress',
      type: FieldType.ADDRESS,
      label: 'Recipient address',
      icon: 'IconHome',
    },
    {
      universalIdentifier: '87b675b8-dd8c-4448-b4ca-20e5a2234a1e',
      name: 'status',
      type: FieldType.SELECT,
      label: 'Status',
      icon: 'IconSend',
      defaultValue: `'${PostCardStatus.DRAFT}'`,
      options: [
        { value: PostCardStatus.DRAFT, label: 'Draft', position: 0, color: 'gray' },
        { value: PostCardStatus.SENT, label: 'Sent', position: 1, color: 'orange' },
        { value: PostCardStatus.DELIVERED, label: 'Delivered', position: 2, color: 'green' },
        { value: PostCardStatus.RETURNED, label: 'Returned', position: 3, color: 'orange' },
      ],
    },
    {
      universalIdentifier: 'e06abe72-5b44-4e7f-93be-afc185a3c433',
      name: 'deliveredAt',
      type: FieldType.DATE_TIME,
      label: 'Delivered at',
      icon: 'IconCheck',
      isNullable: true,
      defaultValue: null,
    },
  ],
});

​

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

• universalIdentifier должен быть уникальным и стабильным между развёртываниями.
• Каждому полю требуются name, type, label и собственный стабильный universalIdentifier.
• Массив fields необязателен — вы можете определять объекты без пользовательских полей.
• openRecordIn определяет, где открываются записи этого объекта при щелчке: ObjectOpenRecordIn.USER_CHOICE (по умолчанию, в соответствии с индивидуальными настройками каждого участника рабочего пространства в Settings → Experience), ObjectOpenRecordIn.SIDE_PANEL или ObjectOpenRecordIn.RECORD_PAGE. Закрепите его на RECORD_PAGE для записей, которым для полноценного использования нужна целая страница (как у рабочих процессов и дашбордов), или на SIDE_PANEL для записей, которые уместны только в виде быстрой боковой панели (как события календаря).
• writability определяет, кто в принципе может выполнять операции записи с записями объекта — до того, как начнут действовать разрешения ролей: MetadataWritability.OPEN (значение по умолчанию — решают роли рабочего пространства), MetadataWritability.APPLICATION (создавать, обновлять и удалять записи могут только собственные логические функции вашего приложения; используйте это для «конфигурационных» объектов, чьи записи задают поведение, чтобы участники рабочего пространства с широким доступом к записям не могли редактировать их через API) или MetadataWritability.SYSTEM (зарезервировано для данных, управляемых платформой). Операции чтения не затрагиваются — это ограничение применяется на стороне сервера, в отличие от isUIEditable, который лишь скрывает элементы интерфейса. Оно также существует на уровне отдельного поля, где может быть только более строгим, чем на уровне объекта.
• Встроенным полям, определённым здесь, не нужен objectUniversalIdentifier — он наследуется от родительского объекта. Используйте defineField(), чтобы добавить поля к объектам, которые вам не принадлежат.
• Вы можете сгенерировать заготовки новых объектов с помощью yarn twenty dev:add object, который проведёт вас через настройку названий, полей и связей. См. Architecture → Scaffolding entities.

​

Типы полей

​

Значения по умолчанию

• 'uuid' — генерирует UUID (для полей UUID)
• 'now' — текущая временная метка (для полей DATE_TIME)

​

Допустимость значения NULL

{
  universalIdentifier: 'b1a7c0de-1234-4f00-9abc-000000000000',
  name: 'reference',
  type: FieldType.TEXT,
  label: 'Reference',
  isNullable: false,
  defaultValue: "'N/A'",
}

​

Что дальше

• Свяжите этот объект с другими — см. Relations для двунаправленного шаблона связей.
• Добавляйте поля к объектам из других приложений — см. Extending Objects о defineField().
• Отображать этот объект в интерфейсе — см. пункты меню навигации, чтобы добавить пункт бокового меню; см. представления, чтобы добавить пользовательские настройки списков.