> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Coleção Templates

`templates` contém um documento por modelo na galeria de modelos. Os arquivos de um modelo (o zip do projeto e o PDF) não ficam aqui: eles são guardados no filestore em `template/<_id>/v/<version>/`. A coleção pertence ao módulo web `template-gallery` (`services/web/modules/template-gallery`). O esquema é o modelo Mongoose `Template` em `services/web/modules/template-gallery/app/src/models/Template.mjs`; a lógica fica em `services/web/modules/template-gallery/app/src/TemplateGalleryManager.mjs` e no `TemplateGalleryHelper.mjs` ao lado.

#### Campos

| Campo | Tipo | Significado | Origem |
| - | - | - | - |
| `_id` | ObjectId | Definido pelo Mongoose. Também é a pasta dos arquivos do modelo no filestore. | `TemplateGalleryHelper.mjs:148-150` |
| `name` | String | O título. Obrigatório, no máximo 150 caracteres. A publicação procura um modelo pelo nome, e a edição recusa um nome que outro modelo já tem, então os nomes continuam únicos sem índice. | `Template.mjs:7`, `TemplateGalleryHelper.mjs:50-52`, `TemplateGalleryManager.mjs:30-38,55` |
| `category` | String | O link da categoria, `/templates/<key>`, em que `<key>` é um dos valores de `OVERLEAF_TEMPLATE_CATEGORIES` ou `all`. Obrigatório. | `Template.mjs:8`, `services/web/modules/template-gallery/index.mjs:17-31`, `TemplateGalleryManager.mjs:206` |
| `descriptionMD` | String | A descrição como digitada, em Markdown. No máximo 4096 caracteres. Pesquisada pela galeria. | `Template.mjs:10`, `TemplateGalleryHelper.mjs:53-55`, `TemplateGalleryManager.mjs:207-212` |
| `description` | String | HTML gerado a partir de `descriptionMD` e sanitizado. Definido sempre que `descriptionMD` é definido. | `Template.mjs:9`, `TemplateGalleryHelper.mjs:224-228` |
| `authorMD` | String | O autor como digitado, em Markdown. No máximo 512 caracteres. Pesquisado pela galeria. | `Template.mjs:12`, `TemplateGalleryHelper.mjs:56-58` |
| `author` | String | HTML gerado a partir de `authorMD`, apenas links. Definido sempre que `authorMD` é definido. | `Template.mjs:11`, `TemplateGalleryHelper.mjs:229-232` |
| `license` | String | O texto de licença escolhido no formulário. Obrigatório, no máximo 512 caracteres. | `Template.mjs:13`, `TemplateGalleryHelper.mjs:59-61` |
| `mainFile` | String | O caminho do doc raiz do projeto de origem, sem a barra inicial. Obrigatório: um projeto sem doc raiz não pode ser publicado. | `Template.mjs:14`, `TemplateGalleryHelper.mjs:112-114` |
| `compiler` | String | O compilador do projeto de origem. Obrigatório. | `Template.mjs:15`, `TemplateGalleryHelper.mjs:122` |
| `imageName` | String | A imagem do TeX Live do projeto de origem. A página do modelo mostra apenas a última parte dela. | `Template.mjs:16`, `TemplateGalleryHelper.mjs:123`, `TemplateGalleryManager.mjs:249-253` |
| `language` | String | O idioma da verificação ortográfica do projeto de origem. Pode ser alterado no formulário de edição. | `Template.mjs:17`, `TemplateGalleryHelper.mjs:124` |
| `version` | Number | Começa em 1 e aumenta em um a cada vez que o modelo é publicado novamente com o mesmo nome. Os arquivos de cada versão ficam em `v/<version>/`. Obrigatório. | `Template.mjs:18`, `TemplateGalleryManager.mjs:74-79` |
| `owner` | ObjectId | O usuário que publicou o modelo pela primeira vez. Publicar novamente por cima mantém o proprietário. | `Template.mjs:19`, `TemplateGalleryManager.mjs:70-79` |
| `project_id` | ObjectId | O projeto a partir do qual ele foi publicado pela última vez. Atualizado a cada publicação. | `Template.mjs:20`, `TemplateGalleryManager.mjs:81-84` |
| `lastUpdated` | Date | Quando ele foi publicado ou editado pela última vez. Obrigatório, padrão agora. | `Template.mjs:21-27`, `TemplateGalleryHelper.mjs:125`, `TemplateGalleryManager.mjs:41` |
| `__v` | Number | A chave de versão do Mongoose. O esquema não a desativa. | Padrão do Mongoose |

#### Quem escreve

| Código | O que faz |
| - | - |
| `TemplateGalleryManager.mjs:53-97` (`createTemplateFromProject`) | `POST /template/new/:Project_id`. Copia as configurações do projeto (`TemplateGalleryHelper.mjs:94-134`), envia o zip e o PDF para o filestore e salva. Se o nome já estiver em uso, responde com um conflito, a menos que o cliente tenha pedido para sobrescrever: nesse caso atualiza esse modelo e aumenta sua `version`, depois exclui os arquivos da versão anterior. |
| `TemplateGalleryManager.mjs:21-47` (`editTemplate`) | `POST /template/:template_id/edit`. Atribui os campos enviados ao documento, gera novamente `description` e `author` e define `lastUpdated`. O formulário de edição envia os campos alterados entre `name`, `license`, `category`, `language`, `authorMD` e `descriptionMD` (`services/web/modules/template-gallery/frontend/js/pages/template/util/api.ts:22-29`). |
| `TemplateGalleryHelper.mjs:186-222` (`deleteTemplateAssets`) | `DELETE /template/:template_id/delete` exclui o documento e os arquivos da versão indicada (`TemplateGalleryManager.mjs:49-51`). |

Apenas os admins do site e o usuário em `OVERLEAF_TEMPLATES_USER_ID` podem chamar essas três rotas (`services/web/modules/template-gallery/app/src/Router.mjs:55-62,70-84`, `PermissionsMiddleware.mjs:8-19`).

#### Quem lê

| Código | O que faz |
| - | - |
| `TemplateGalleryManager.mjs:158-183` (`getTemplate`) | Encontra um modelo por `_id` ou `name` para a página do modelo e para `GET /api/template` (`services/web/modules/template-gallery/app/src/TemplateGalleryController.mjs:210-232`). Se `project_id` aponta para um projeto que não existe mais, a resposta o omite; o documento não é alterado. |
| `TemplateGalleryManager.mjs:190-236` (`getCategoryTemplates`) | `GET /api/templates`: uma página de uma categoria, pesquisada em `name`, `authorMD` e `descriptionMD`, ordenada por `lastUpdated` ou por `name` (sem diferenciar maiúsculas de minúsculas). |
| `TemplateGalleryHelper.mjs:64-80` (`canUserOverrideTemplate`) | Lê `owner` para nomear o proprietário na mensagem de conflito. |

#### Índices

| Nome | Chaves | Opções | Migração |
| - | - | - | - |
| `_id_` | `_id: 1` | | padrão |

O `autoIndex` do Mongoose está desativado (`services/web/app/src/infrastructure/Mongoose.mjs:7`). `tools/migrations/20190912145030_create_templates_indexes.mjs` (`project_id`, `user_id`, `name` únicos) é marcada com `server-pro` e `saas`, então não executa no CE, que executa apenas as migrações `server-ce` (`server-ce/init_scripts/900_run_web_migrations.sh`).

#### Notas

* O upstream trata `templates` como uma coleção obsoleta e a remove no próprio site (`tools/migrations/20241002180623_drop_unused_collections.mjs`, marcada com `saas`). No Ayakaleaf Pro, o módulo da galeria de modelos a usa.
* A ordenação por nome usa uma collation que não diferencia maiúsculas de minúsculas, e o comentário em `TemplateGalleryManager.mjs:186-188` observa que um índice de `name` precisaria da mesma. O CE não tem índice de `name`, então o Mongo ordena em memória.
* Excluir o projeto de origem ou o proprietário não exclui o modelo.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.