@hed-hog/faq 0.0.273 → 0.0.275

package/README.md

@@ -17,12 +17,12 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
 
 | Método | Path         | Autenticação | Descrição                                  |
 |--------|--------------|--------------|--------------------------------------------|
-| GET    | `/faq`       | Sim          | Lista FAQs paginadas e filtradas por busca. |
-| GET    | `/faq/stats` | Sim          | Retorna estatísticas gerais das FAQs.      |
-| GET    | `/faq/:id`   | Sim          | Retorna FAQ específica por ID com traduções. |
-| POST   | `/faq`       | Sim          | Cria uma nova FAQ com dados multilíngues.  |
-| PATCH  | `/faq/:id`   | Sim          | Atualiza FAQ existente parcialmente.        |
-| DELETE | `/faq/:id`   | Sim          | Remove FAQ pelo ID.                          |
+| GET    | `/faq`       | Sim (roles `admin`, `admin-faq`) | Lista FAQs paginadas e filtradas por busca. |
+| GET    | `/faq/stats` | Sim (roles `admin`, `admin-faq`) | Retorna estatísticas gerais das FAQs.      |
+| GET    | `/faq/:id`   | Sim (roles `admin`, `admin-faq`) | Retorna FAQ específica por ID com traduções. |
+| POST   | `/faq`       | Sim (roles `admin`, `admin-faq`) | Cria uma nova FAQ com dados multilíngues.  |
+| PATCH  | `/faq/:id`   | Sim (roles `admin`, `admin-faq`) | Atualiza FAQ existente parcialmente.        |
+| DELETE | `/faq/:id`   | Sim (roles `admin`, `admin-faq`) | Remove FAQ pelo ID.                          |
 
 ### Detalhes dos endpoints
 
@@ -117,7 +117,7 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
   }
   ```
 - **Descrição:** Cria uma nova FAQ com traduções.
-- **Resposta:** Objeto FAQ criado com dados multilíngues.
+- **Resposta:** Objeto FAQ criado com dados multilíngues (igual ao GET `/faq/:id`).
 - **Erros comuns:**
   - 400 Bad Request: objeto `locale` inválido ou vazio.
 
@@ -139,7 +139,7 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
   }
   ```
 - **Descrição:** Atualiza parcialmente a FAQ, incluindo traduções.
-- **Resposta:** Objeto FAQ atualizado.
+- **Resposta:** Objeto FAQ atualizado (igual ao GET `/faq/:id`).
 - **Erros comuns:**
   - 400 Bad Request: dados de localização inválidos.
   - 404 Not Found: FAQ não encontrada.
@@ -182,6 +182,7 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
 ```
 
 - `locale`: objeto obrigatório que deve conter pelo menos uma chave de idioma com `question` e `answer` como strings não vazias.
+- Validação: o objeto `locale` não pode ser vazio, e cada idioma deve conter `question` e `answer` do tipo string.
 
 ### Resposta FAQ detalhada
 
@@ -200,8 +201,15 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
 
 ### Paginação (GET `/faq`)
 
-- Query params: `search`, `take`, `skip`
-- Resposta inclui `data`, `total`, `page`, `pageSize`, `prev`, `next`, `lastPage`.
+- Query params: `search` (string opcional), `take` (number obrigatório), `skip` (number obrigatório).
+- Resposta inclui:
+  - `data`: array de FAQs com traduções no locale solicitado.
+  - `total`: total de FAQs encontradas.
+  - `page`: página atual.
+  - `pageSize`: quantidade de itens por página.
+  - `prev`: página anterior ou null.
+  - `next`: próxima página ou null.
+  - `lastPage`: última página disponível.
 
 ## 6. Erros comuns
 
@@ -216,13 +224,13 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
 
 - **Finalidade:** Armazenar registros de FAQs.
 - **Colunas:**
-  - `id` (PK): Identificador único.
-  - `created_at`: Timestamp de criação.
-  - `updated_at`: Timestamp de atualização.
+  - `id` (PK): Identificador único da FAQ.
+  - `created_at`: Timestamp de criação (automático).
+  - `updated_at`: Timestamp de atualização (automático).
 - **Defaults:** `created_at` e `updated_at` gerenciados automaticamente.
-- **Nulabilidade:** `id` não nulo, timestamps não nulos.
-- **Integridade:** PK em `id`.
-- **Índices:** Não especificado diretamente, mas PK garante índice.
+- **Nulabilidade:** `id`, `created_at` e `updated_at` não nulos.
+- **Integridade:** Chave primária em `id`.
+- **Índices:** Índice primário em `id`.
 
 ### Tabela `faq_locale`
 
@@ -232,8 +240,8 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
   - `locale_id` (FK): Referência para `locale.id`.
   - `question` (locale_varchar, 255): Pergunta traduzida.
   - `answer` (locale_text): Resposta traduzida.
-  - `created_at`: Timestamp de criação.
-  - `updated_at`: Timestamp de atualização.
+  - `created_at`: Timestamp de criação (automático).
+  - `updated_at`: Timestamp de atualização (automático).
 - **Defaults:** Timestamps automáticos.
 - **Nulabilidade:** `question` e `answer` não nulos para registros válidos.
 - **Integridade:** Chave única composta por `[faq_id, locale_id]`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hed-hog/faq",
-  "version": "0.0.273",
+  "version": "0.0.275",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "dependencies": {
@@ -10,10 +10,10 @@
     "@nestjs/jwt": "^11",
     "@nestjs/mapped-types": "*",
     "@hed-hog/api-pagination": "0.0.6",
-    "@hed-hog/core": "0.0.273",
     "@hed-hog/api-prisma": "0.0.5",
+    "@hed-hog/api-locale": "0.0.13",
     "@hed-hog/api": "0.0.4",
-    "@hed-hog/api-locale": "0.0.13"
+    "@hed-hog/core": "0.0.275"
   },
   "exports": {
     ".": {