@hed-hog/faq 0.0.274 → 0.0.276

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +34 -28
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -15,20 +15,18 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
15
15
 
16
16
  ## 3. Endpoints
17
17
 
18
- | Método | Path | Autenticação | Descrição |
19
- |--------|--------------|--------------|--------------------------------------------|
20
- | GET | `/faq` | Sim | Lista FAQs paginadas e filtradas por busca. |
21
- | GET | `/faq/stats` | Sim | Retorna estatísticas gerais das FAQs. |
22
- | GET | `/faq/:id` | Sim | Retorna FAQ específica por ID com traduções. |
23
- | POST | `/faq` | Sim | Cria uma nova FAQ com dados multilíngues. |
24
- | PATCH | `/faq/:id` | Sim | Atualiza FAQ existente parcialmente. |
25
- | DELETE | `/faq/:id` | Sim | Remove FAQ pelo ID. |
26
-
27
- ### Detalhes dos endpoints
18
+ | Método | Path | Autenticação | Descrição |
19
+ |--------|--------------|---------------------------------|--------------------------------------------|
20
+ | GET | `/faq` | Sim (roles `admin`, `admin-faq`) | Lista FAQs paginadas e filtradas por busca. |
21
+ | GET | `/faq/stats` | Sim (roles `admin`, `admin-faq`) | Retorna estatísticas gerais das FAQs. |
22
+ | GET | `/faq/:id` | Sim (roles `admin`, `admin-faq`) | Retorna FAQ específica por ID com traduções. |
23
+ | POST | `/faq` | Sim (roles `admin`, `admin-faq`) | Cria uma nova FAQ com dados multilíngues. |
24
+ | PATCH | `/faq/:id` | Sim (roles `admin`, `admin-faq`) | Atualiza FAQ existente parcialmente. |
25
+ | DELETE | `/faq/:id` | Sim (roles `admin`, `admin-faq`) | Remove FAQ pelo ID. |
28
26
 
29
27
  ---
30
28
 
31
- #### GET `/faq`
29
+ ### GET `/faq`
32
30
 
33
31
  - **Autenticação:** Requer role `admin` ou `admin-faq`.
34
32
  - **Query Params:**
@@ -66,7 +64,7 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
66
64
 
67
65
  ---
68
66
 
69
- #### GET `/faq/stats`
67
+ ### GET `/faq/stats`
70
68
 
71
69
  - **Autenticação:** Requer role `admin` ou `admin-faq`.
72
70
  - **Descrição:** Retorna estatísticas gerais, como total de FAQs cadastradas.
@@ -79,7 +77,7 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
79
77
 
80
78
  ---
81
79
 
82
- #### GET `/faq/:id`
80
+ ### GET `/faq/:id`
83
81
 
84
82
  - **Autenticação:** Requer role `admin` ou `admin-faq`.
85
83
  - **Parâmetros:**
@@ -102,7 +100,7 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
102
100
 
103
101
  ---
104
102
 
105
- #### POST `/faq`
103
+ ### POST `/faq`
106
104
 
107
105
  - **Autenticação:** Requer role `admin` ou `admin-faq`.
108
106
  - **Headers:**
@@ -117,13 +115,13 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
117
115
  }
118
116
  ```
119
117
  - **Descrição:** Cria uma nova FAQ com traduções.
120
- - **Resposta:** Objeto FAQ criado com dados multilíngues.
118
+ - **Resposta:** Objeto FAQ criado com dados multilíngues (igual ao GET `/faq/:id`).
121
119
  - **Erros comuns:**
122
120
  - 400 Bad Request: objeto `locale` inválido ou vazio.
123
121
 
124
122
  ---
125
123
 
126
- #### PATCH `/faq/:id`
124
+ ### PATCH `/faq/:id`
127
125
 
128
126
  - **Autenticação:** Requer role `admin` ou `admin-faq`.
129
127
  - **Parâmetros:**
@@ -139,14 +137,14 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
139
137
  }
140
138
  ```
141
139
  - **Descrição:** Atualiza parcialmente a FAQ, incluindo traduções.
142
- - **Resposta:** Objeto FAQ atualizado.
140
+ - **Resposta:** Objeto FAQ atualizado (igual ao GET `/faq/:id`).
143
141
  - **Erros comuns:**
144
142
  - 400 Bad Request: dados de localização inválidos.
145
143
  - 404 Not Found: FAQ não encontrada.
146
144
 
147
145
  ---
148
146
 
149
- #### DELETE `/faq/:id`
147
+ ### DELETE `/faq/:id`
150
148
 
151
149
  - **Autenticação:** Requer role `admin` ou `admin-faq`.
152
150
  - **Parâmetros:**
@@ -182,6 +180,7 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
182
180
  ```
183
181
 
184
182
  - `locale`: objeto obrigatório que deve conter pelo menos uma chave de idioma com `question` e `answer` como strings não vazias.
183
+ - Validação: o objeto `locale` não pode ser vazio, e cada idioma deve conter `question` e `answer` do tipo string.
185
184
 
186
185
  ### Resposta FAQ detalhada
187
186
 
@@ -200,8 +199,15 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
200
199
 
201
200
  ### Paginação (GET `/faq`)
202
201
 
203
- - Query params: `search`, `take`, `skip`
204
- - Resposta inclui `data`, `total`, `page`, `pageSize`, `prev`, `next`, `lastPage`.
202
+ - Query params: `search` (string opcional), `take` (number obrigatório), `skip` (number obrigatório).
203
+ - Resposta inclui:
204
+ - `data`: array de FAQs com traduções no locale solicitado.
205
+ - `total`: total de FAQs encontradas.
206
+ - `page`: página atual.
207
+ - `pageSize`: quantidade de itens por página.
208
+ - `prev`: página anterior ou null.
209
+ - `next`: próxima página ou null.
210
+ - `lastPage`: última página disponível.
205
211
 
206
212
  ## 6. Erros comuns
207
213
 
@@ -216,13 +222,13 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
216
222
 
217
223
  - **Finalidade:** Armazenar registros de FAQs.
218
224
  - **Colunas:**
219
- - `id` (PK): Identificador único.
220
- - `created_at`: Timestamp de criação.
221
- - `updated_at`: Timestamp de atualização.
225
+ - `id` (PK): Identificador único da FAQ.
226
+ - `created_at`: Timestamp de criação (automático).
227
+ - `updated_at`: Timestamp de atualização (automático).
222
228
  - **Defaults:** `created_at` e `updated_at` gerenciados automaticamente.
223
- - **Nulabilidade:** `id` não nulo, timestamps não nulos.
224
- - **Integridade:** PK em `id`.
225
- - **Índices:** Não especificado diretamente, mas PK garante índice.
229
+ - **Nulabilidade:** `id`, `created_at` e `updated_at` não nulos.
230
+ - **Integridade:** Chave primária em `id`.
231
+ - **Índices:** Índice primário em `id`.
226
232
 
227
233
  ### Tabela `faq_locale`
228
234
 
@@ -232,8 +238,8 @@ O módulo `@hed-hog/faq` é responsável pela gestão de FAQs (Frequently Asked
232
238
  - `locale_id` (FK): Referência para `locale.id`.
233
239
  - `question` (locale_varchar, 255): Pergunta traduzida.
234
240
  - `answer` (locale_text): Resposta traduzida.
235
- - `created_at`: Timestamp de criação.
236
- - `updated_at`: Timestamp de atualização.
241
+ - `created_at`: Timestamp de criação (automático).
242
+ - `updated_at`: Timestamp de atualização (automático).
237
243
  - **Defaults:** Timestamps automáticos.
238
244
  - **Nulabilidade:** `question` e `answer` não nulos para registros válidos.
239
245
  - **Integridade:** Chave única composta por `[faq_id, locale_id]`.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hed-hog/faq",
3
- "version": "0.0.274",
3
+ "version": "0.0.276",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "dependencies": {
@@ -9,11 +9,11 @@
9
9
  "@nestjs/core": "^11",
10
10
  "@nestjs/jwt": "^11",
11
11
  "@nestjs/mapped-types": "*",
12
- "@hed-hog/api-pagination": "0.0.6",
13
12
  "@hed-hog/api-locale": "0.0.13",
14
- "@hed-hog/core": "0.0.274",
15
- "@hed-hog/api": "0.0.4",
16
- "@hed-hog/api-prisma": "0.0.5"
13
+ "@hed-hog/api-prisma": "0.0.5",
14
+ "@hed-hog/api-pagination": "0.0.6",
15
+ "@hed-hog/core": "0.0.276",
16
+ "@hed-hog/api": "0.0.4"
17
17
  },
18
18
  "exports": {
19
19
  ".": {