i18n - docs translations (#20764)

Created by Github action Co-authored-by: github-actions <github-actions@twenty.com>
2026-05-20 13:21:44 +02:00
parent 00fad657f4
commit fb47e4497a
6 changed files with 678 additions and 24 deletions
@@ -13,8 +13,8 @@ icon: bolt

 ```ts src/logic-functions/createPostCard.logic-function.ts
 import { defineLogicFunction } from 'twenty-sdk/define';
-import type { DatabaseEventPayload, ObjectRecordCreateEvent, CronPayload, RoutePayload } from 'twenty-sdk/define';
-import { CoreApiClient, type Person } from 'twenty-client-sdk/core';
+import type { RoutePayload } from 'twenty-sdk/logic-function';
+import { CoreApiClient } from 'twenty-client-sdk/core';

 const handler = async (params: RoutePayload) => {
  const client = new CoreApiClient();
@@ -78,10 +78,10 @@ yarn twenty logs
 #### Полезная нагрузка триггера маршрута

 Когда триггер маршрута вызывает вашу логическую функцию, она получает объект `RoutePayload`, который соответствует [формату AWS HTTP API v2](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html).
-Импортируйте тип `RoutePayload` из `twenty-sdk`:
+Импортируйте тип `RoutePayload` из `twenty-sdk/logic-function`:

 ```ts
-import { defineLogicFunction, type RoutePayload } from 'twenty-sdk/define';
+import type { RoutePayload } from 'twenty-sdk/logic-function';

 const handler = async (event: RoutePayload) => {
  const { headers, queryStringParameters, pathParameters, body } = event;
@@ -140,6 +140,115 @@ const handler = async (event: RoutePayload) => {
 Имена заголовков приводятся к нижнему регистру. Обращайтесь к ним, используя ключи в нижнем регистре (например, `event.headers['content-type']`).
 </Note>

+#### Полезная нагрузка триггера события базы данных
+
+Когда триггер события базы данных вызывает вашу функцию логики, она получает по одному `DatabaseEventPayload` на каждую изменённую запись. Полезная нагрузка объединяет метаданные о рабочем пространстве-источнике и объекте с событием на уровне записи.
+
+```ts
+import type {
+  DatabaseEventPayload,
+  ObjectRecordCreateEvent,
+  ObjectRecordDestroyEvent,
+  ObjectRecordUpdateEvent,
+} from 'twenty-sdk/logic-function';
+
+type Person = {
+  id: string;
+  emails?: { primaryEmail?: string };
+};
+```
+
+Полезная нагрузка включает:
+
+| Свойство                                         | Описание                                                                                           |
+| ------------------------------------------------ | -------------------------------------------------------------------------------------------------- |
+| `name`                                           | Имя события, например `person.updated`.                                                            |
+| `workspaceId`                                    | Рабочее пространство, в котором произошло событие.                                                 |
+| `objectMetadata`                                 | Метаданные для объекта, который изменился.                                                         |
+| `recordId`                                       | Идентификатор измененной записи.                                                                   |
+| `userId`, `userWorkspaceId`, `workspaceMemberId` | Поля инициатора, если событие было вызвано пользователем рабочего пространства.                    |
+| `properties`                                     | Данные записи для события с `before`, `after`, `diff` и `updatedFields` в зависимости от операции. |
+
+| Событие            | Данные записи                                                                                                  |
+| ------------------ | -------------------------------------------------------------------------------------------------------------- |
+| `person.created`   | `event.properties.after`                                                                                       |
+| `person.updated`   | `event.properties.before`, `event.properties.after`, `event.properties.diff`, `event.properties.updatedFields` |
+| `person.destroyed` | `event.properties.before`                                                                                      |
+
+При логическом удалении `.deleted` имеет формат обновления, поскольку изменяется поле `deletedAt` записи.
+Для окончательного удаления используйте `.destroyed`.
+
+<Note>
+`databaseEventTriggerSettings.updatedFields` фильтрует, какие события обновления запускают функцию.
+`event.properties.updatedFields` указывает, какие поля фактически изменились в текущем событии.
+</Note>
+
+Пример события создания:
+
+```ts
+type PersonCreatedEvent = DatabaseEventPayload<
+  ObjectRecordCreateEvent<Person>
+>;
+
+const handler = async (event: PersonCreatedEvent) => {
+  const person = event.properties.after;
+
+  return {
+    personId: event.recordId,
+    email: person.emails?.primaryEmail,
+  };
+};
+```
+
+Пример события обновления:
+
+```ts
+type PersonUpdatedEvent = DatabaseEventPayload<
+  ObjectRecordUpdateEvent<Person>
+>;
+
+const handler = async (event: PersonUpdatedEvent) => {
+  const { before, after, diff, updatedFields } = event.properties;
+
+  return {
+    personId: event.recordId,
+    updatedFields,
+    previousEmail: before.emails?.primaryEmail,
+    currentEmail: after.emails?.primaryEmail,
+    emailDiff: diff.emails,
+  };
+};
+```
+
+Триггер только при обновлении email:
+
+```ts
+export default defineLogicFunction({
+  ...,
+  databaseEventTriggerSettings: {
+    eventName: 'person.updated',
+    updatedFields: ['emails'],
+  },
+});
+```
+
+Пример события уничтожения:
+
+```ts
+type PersonDestroyedEvent = DatabaseEventPayload<
+  ObjectRecordDestroyEvent<Person>
+>;
+
+const handler = async (event: PersonDestroyedEvent) => {
+  const personBeforeDestroy = event.properties.before;
+
+  return {
+    personId: event.recordId,
+    email: personBeforeDestroy.emails?.primaryEmail,
+  };
+};
+```
+
 #### Предоставление функции в качестве инструмента ИИ или действия рабочего процесса

 Функции логики могут быть представлены в двух интерфейсах, у каждого — свой триггер: