> ## Documentation Index
> Fetch the complete documentation index at: https://docs.twenty.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 2. Создание документов

> Одна логическая функция, выставленная в качестве инструмента ИИ и действий рабочего процесса.

Теперь ядро: [логическая функция](/l/ru/developers/extend/apps/logic/logic-functions)
, загружающая шаблон и запись, заполняет плейсхолдеры, и сохраняет новый документ
.

Однажды мы напишем бизнес-логику как **обработчик**, а затем выявим его через
несколько триггеров. В этой главе выводятся две из них — **ИИ инструмент** и
**действие рабочего процесса**.

## Помощник рендеринга

Держите чистую логику в своем собственном файле, так что легко отсоединить тест. Это преобразует запись
в токены `{{dot.path}}` и подставляет их.

```ts filename="src/logic-functions/utils/render-template.ts" theme={null}
const PLACEHOLDER_PATTERN = /\{\{\s*([\w.]+)\s*\}\}/g;

export const renderTemplate = (body: string, values: Record<string, string>) => {
  const missingTokens = new Set<string>();
  const content = body.replace(PLACEHOLDER_PATTERN, (_m, token: string) => {
    const value = values[token];
    if (value === undefined || value === '') { missingTokens.add(token); return ''; }
    return value;
  });
  return { content, missingTokens: [...missingTokens] };
};
```

<Tip>
  Поскольку этот файл не имеет побочных эффектов, вы можете прочитать его быстрыми модульными тестами
  (`yarn test:unit`). См. раздел [Тестирование](/l/ru/developers/extend/apps/operations/testing).
</Tip>

## Обработчик

Обработчик использует [`CoreApiClient`](/l/ru/developers/extend/apps/logic/logic-functions)
для чтения и записи данных CRM. Он загружает шаблон, загружает целевую запись, заполняет
тело и создает `document`.

```ts filename="src/logic-functions/handlers/generate-document-handler.ts" theme={null}
import { CoreApiClient } from 'twenty-client-sdk/core';
import { loadRecordValues } from 'src/logic-functions/utils/load-record-values';
import { renderTemplate } from 'src/logic-functions/utils/render-template';

export const generateDocumentHandler = async (
  input: { templateId: string; recordId: string },
) => {
  const client = new CoreApiClient();

  // Use a filtered list query, not the singular lookup: the singular query
  // throws when nothing matches, which would become a 500 instead of a 404.
  const { documentTemplates } = await client.query({
    documentTemplates: {
      __args: { filter: { id: { eq: input.templateId } }, first: 1 },
      edges: { node: { id: true, name: true, body: true, target: true } },
    },
  });
  const documentTemplate = documentTemplates?.edges?.[0]?.node;
  if (!documentTemplate?.id) return { success: false, status: 404, message: 'Template not found.' };

  const record = await loadRecordValues(client, documentTemplate.target, input.recordId);
  if (!record.found) return { success: false, status: 404, message: 'Record not found.' };

  const { content, missingTokens } = renderTemplate(documentTemplate.body ?? '', record.values);

  const { createDocument } = await client.mutation({
    createDocument: {
      __args: { data: {
        name: `${documentTemplate.name} — ${record.displayName}`,
        content, status: 'GENERATED', templateId: documentTemplate.id,
      } },
      id: true, name: true,
    },
  });

  return { success: true, documentId: createDocument.id, content, missingTokens };
};
```

`loadRecordValues` запускает другой запрос для персона против компании и flattens
результат — см.
[`load-record-values.ts`](https://github.com/twentyhq/twenty/blob/main/packages/twenty-apps/examples/document-generator/src/logic-functions/utils/load-record-values.ts).

## Расскажите об этом как инструменте и действии рабочего процесса

Один "defineLogicFunction" может иметь несколько триггеров. Здесь `toolTriggerSettings`
делает его вызываемым агентами ИИ, а `workflowActionTriggerSettings` превращает его в
шаг в визуальном конструкторе рабочих процессов. Оба описывают свои входные данные схемой JSON.

```ts filename="src/logic-functions/generate-document.ts" theme={null}
import { defineLogicFunction } from 'twenty-sdk/define';
import { jsonSchemaToInputSchema } from 'twenty-sdk/logic-function';
import { GENERATE_DOCUMENT_LOGIC_FUNCTION_UNIVERSAL_IDENTIFIER } from 'src/constants/universal-identifiers';
import { generateDocumentHandler } from 'src/logic-functions/handlers/generate-document-handler';
import { generateDocumentInputSchema } from 'src/logic-functions/schemas/generate-document-input.schema';

export default defineLogicFunction({
  universalIdentifier: GENERATE_DOCUMENT_LOGIC_FUNCTION_UNIVERSAL_IDENTIFIER,
  name: 'generate-document',
  description: 'Generate a document from a template and a CRM record.',
  timeoutSeconds: 30,
  toolTriggerSettings: {
    inputSchema: generateDocumentInputSchema,
  },
  workflowActionTriggerSettings: {
    label: 'Generate Document',
    icon: 'IconFileText',
    inputSchema: jsonSchemaToInputSchema(generateDocumentInputSchema),
    outputSchema: [{ type: 'object', properties: {
      success: { type: 'boolean' }, documentId: { type: 'string' },
    } }],
  },
  handler: generateDocumentHandler,
});
```

Входная схема — это обычная схема JSON, описывающая `templateId` и `recordId` —
см. [`generate-document-input.schema.ts`](https://github.com/twentyhq/twenty/blob/main/packages/twenty-apps/examples/document-generator/src/logic-functions/schemas/generate-document-input.schema.ts).

## Предоставить доступ

Логические функции выполняются под ролью приложения. Ему нужно читать шаблоны и записи
и создавать документы, поэтому разрешите это в `src/roles/default-role.ts`:

```ts theme={null}
export default defineApplicationRole({
  universalIdentifier: DEFAULT_ROLE_UNIVERSAL_IDENTIFIER,
  label: 'Document Generator default role',
  canReadAllObjectRecords: true,
  canUpdateAllObjectRecords: true,
  canAccessAllTools: true,
  canBeAssignedToAgents: true,
  permissionFlagUniversalIdentifiers: [SystemPermissionFlag.UPLOAD_FILE],
});
```

`UPLOAD_FILE` позволяет функции загрузить сгенерированный PDF в следующем разделе.
Смотрите [Roles](/l/ru/developers/extend/apps/config/roles) для получения более четких разрешений.

## Прикрепить настоящий PDF-файл

Поля отображаемого текста полезны, но пользователи хотят иметь настоящий документ. Давайте сгенерируем
**PDF** и храним его в записи в качестве загружаемого файла.

Сначала поставьте объект `document` поле `FILES` для удержания PDF. Приложения загружают файлы
в **собственные** файловые поля, поэтому это поле определяет маршрут загрузки:

```ts filename="src/objects/document.object.ts" theme={null}
{
  universalIdentifier: DOCUMENT_FILE_FIELD_UNIVERSAL_IDENTIFIER,
  type: FieldType.FILES,
  name: 'file',
  label: 'File',
  icon: 'IconFileTypePdf',
  universalSettings: { maxNumberOfValues: 1 },
}
```

Введите, что PDF. Приложение — это настоящий проект Node, поэтому вы можете добавить любой нужный пакет
npm и импортировать его, как и где угодно ещё. Мы используем **[pdf-lib](https://pdf-lib.js.org/)**
для рисования PDF и **[marked](https://marked.js.org/)** для разбора тела Markdown
— CLI устанавливает их во время работы функции:

```bash filename="Terminal" theme={null}
yarn add pdf-lib marked
```

Полный помощник
[`generate-document-pdf.ts`](https://github.com/twentyhq/twenty/blob/main/packages/twenty-apps/examples/document-generator/src/logic-functions/utils/generate-document-pdf.ts).
Он анализирует Markdown в токены с `marked. exer`, затем расположите их с помощью
pdf-lib: настоящие заголовки, **черный**/*курсив* пробег, пуля и нумерованные списки,
blockquotes and rules — отполированный, многостраничный A4 рендеринг самого шаблона
вместо стенки текста.

<Frame caption="Сгенерированный PDF: реальная типография и форматирование разметки, отрисовка тела шаблона.">
  <img src="https://mintcdn.com/twenty/sqJBeTZq-W-RDBPU/images/docs/developers/extends/apps/document-generator/07b-generated-pdf.png?fit=max&auto=format&n=sqJBeTZq-W-RDBPU&q=85&s=ab29f3ed244aa424e850abe73f8c082d" alt="Отполированный, продаваемый файл PDF" width="1286" height="1200" data-path="images/docs/developers/extends/apps/document-generator/07b-generated-pdf.png" />
</Frame>

<Note>
  Встроенные шрифты pdf-lib используют кодировку WinAnsi, поэтому западноевропейские символы с диакритикой отображаются
  "из коробки"; вспомогательная функция отображает типографские кавычки и тире и отбрасывает символы, которые она
  не может закодировать. Отображение нелатинских скриптов (китайский, арабский, кириллица) означало бы
  встраивание шрифта Unicode.
</Note>

Затем загрузите его и сохраните ссылку на запись. `uploadFile` маршруты байт
в поле файлы, принадлежащее приложению; возвращается `id`, что вы сохраните:

```ts filename="src/logic-functions/handlers/generate-document-handler.ts" theme={null}
import { MetadataApiClient } from 'twenty-client-sdk/metadata';
import { generateDocumentPdf } from 'src/logic-functions/utils/generate-document-pdf';

const documentName = `${documentTemplate.name} — ${record.displayName}`;
const bytes = await generateDocumentPdf(documentName, content);
const fileName = 'proposal.pdf';

const uploaded = await new MetadataApiClient().uploadFile(
  Buffer.from(bytes),
  fileName,
  'application/pdf',
  DOCUMENT_FILE_FIELD_UNIVERSAL_IDENTIFIER,
);

await client.mutation({
  updateDocument: {
    __args: {
      id: documentId,
      data: { file: [{ fileId: uploaded.id, label: fileName }] },
    },
    id: true,
  },
});
```

Сгенерированный документ теперь поддерживает загрузку PDF:

<Frame caption="Сгенерированный PDF, хранится в поле File документа.">
  <img src="https://mintcdn.com/twenty/sqJBeTZq-W-RDBPU/images/docs/developers/extends/apps/document-generator/08-document-with-pdf.png?fit=max&auto=format&n=sqJBeTZq-W-RDBPU&q=85&s=afbc1091577e93482b71dcc0d73af110" alt="Документ записи с созданным PDF файлом" width="2880" height="1800" data-path="images/docs/developers/extends/apps/document-generator/08-document-with-pdf.png" />
</Frame>

<Note>
  `uploadFile` только цели **app-owned** полей файлов (поэтому для загрузки всегда требуется
  приложение, которое владеет полем и флаг роли `UPLOAD_FILE`). Поэтому PDF
  опирается на собственное поле `file` (`file`) — тот же шаблон, что и
  [call-recorder app](https://github.com/twentyhq/twenty/tree/main/packages/twenty-apps/public/call-recorder)
  используется для записей.
</Note>

**После этого шага:** у каждого сгенерированного документа есть реальный, загружаемый PDF. Но
ничего не может *вызвать* генератор из пользовательского интерфейса — для этого нам нужен HTTP маршрут.

<Card title="Далее: HTTP-маршруты →" icon="земля" href="/l/ru/developers/extend/apps/tutorials/document-generator/http-routes">
  Сервис функции по HTTP и рендеринг документов как веб-страниц.
</Card>
