@hexlet/frontend-blog-server 1.0.0 → 1.2.0

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.
package/README.md CHANGED
@@ -14,6 +14,8 @@ npx frontend-blog-server start -s ./dist # API и собранный SPA из
14
14
 
15
15
  С флагом `-s` сервер раздаёт сборку по `/` и API по `/api`, так что фронтенд и API живут на одном origin. На любой путь вне `/api` сервер отдаёт `index.html`, и клиентский роутинг работает при прямом заходе по адресу. Порт берётся из `-p`, затем из переменной `PORT`, иначе 8080.
16
16
 
17
+ Стартовые статьи по умолчанию на русском и английском. Переменная `SEED_LOCALE=es` включает испанский набор с теми же пользователями, категориями и порядком статей. Другое значение останавливает запуск с ошибкой.
18
+
17
19
  ## Контракт API
18
20
 
19
21
  ```bash
@@ -21,7 +23,17 @@ npx frontend-blog-server contract # openapi.yaml и main.tsp в ./contr
21
23
  npx frontend-blog-server contract api # в указанный каталог
22
24
  ```
23
25
 
24
- `openapi.yaml` описывает все эндпоинты, тела запросов и ответов и коды ошибок. Типы для фронтенда из него генерирует `openapi-typescript`.
26
+ `openapi.yaml` описывает все эндпоинты, тела запросов и ответов и коды ошибок.
27
+
28
+ ## Типы
29
+
30
+ Пакет отдаёт типы, сгенерированные из `openapi.yaml` утилитой `openapi-typescript`. Они подходят для `openapi-fetch` и для своей обёртки над `fetch`.
31
+
32
+ ```typescript
33
+ import type { components, paths } from "@hexlet/frontend-blog-server/schema";
34
+
35
+ type Article = components["schemas"]["Article"];
36
+ ```
25
37
 
26
38
  ## Сид
27
39
 
@@ -44,6 +56,6 @@ npx frontend-blog-server contract api # в указанный катало
44
56
  ```bash
45
57
  npm ci
46
58
  npm test # тесты API
47
- npm run gen:types # src/generated/api.ts из contract/openapi.yaml
59
+ npm run gen:types # src/generated/api.ts из contract/openapi.yaml, генератор идёт через npx с TypeScript 5
48
60
  cd contract && npm ci && npm run compile # openapi.yaml из main.tsp
49
61
  ```
package/dist/src/app.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import type { FastifyPluginAsync } from "fastify";
2
2
  export interface AppOptions {
3
3
  staticDir?: string;
4
+ seedLocale?: string;
4
5
  }
5
6
  declare const app: FastifyPluginAsync<AppOptions>;
6
7
  export default app;
package/dist/src/app.js CHANGED
@@ -3,6 +3,7 @@ import { resolve } from "node:path";
3
3
  import fastifyStatic from "@fastify/static";
4
4
  import { z } from "zod";
5
5
  import { createState, verifyPassword, } from "./state.js";
6
+ import { parseSeedLocale } from "./seed.js";
6
7
  const credentialsSchema = z.object({
7
8
  username: z
8
9
  .string()
@@ -34,7 +35,7 @@ const fail = (reply, status, code, message) => {
34
35
  };
35
36
  const issuesText = (error) => error.issues.map((issue) => issue.message).join("; ");
36
37
  const app = async (fastify, options) => {
37
- const state = createState();
38
+ const state = createState(parseSeedLocale(options.seedLocale ?? process.env.SEED_LOCALE));
38
39
  // Собранный SPA из опции плагина (тесты) или из SPA_DIR (CLI `start -s`). Фронтенд и API
39
40
  // живут на одном origin, поэтому CORS не нужен: в разработке запросы проксирует дев-сервер.
40
41
  const staticDir = options.staticDir ?? process.env.SPA_DIR;
@@ -5,5 +5,11 @@ export declare const seedCategories: {
5
5
  name: string;
6
6
  }[];
7
7
  type SeedArticle = [author: string, category: string, title: string, body: string];
8
- export declare const seedArticles: SeedArticle[];
8
+ export type SeedLocale = "ru" | "es";
9
+ export interface Seed {
10
+ articles: SeedArticle[];
11
+ welcomeThread: [question: string, answer: string];
12
+ }
13
+ export declare const seeds: Record<SeedLocale, Seed>;
14
+ export declare const parseSeedLocale: (value: string | undefined) => SeedLocale;
9
15
  export {};
package/dist/src/seed.js CHANGED
@@ -10,7 +10,7 @@ export const seedCategories = [
10
10
  { slug: "career", name: "Career" },
11
11
  { slug: "news", name: "News" },
12
12
  ];
13
- export const seedArticles = [
13
+ const ruArticles = [
14
14
  [
15
15
  "alice",
16
16
  "frontend",
@@ -187,3 +187,202 @@ export const seedArticles = [
187
187
  "Здесь пишут о **фронтенде**, бэкенде и карьере.\n\nЗарегистрируйтесь и опубликуйте первую статью.",
188
188
  ],
189
189
  ];
190
+ // Испанский сид для es-копии проекта: те же авторы, категории и порядок,
191
+ // поэтому приветственная статья тоже последняя.
192
+ const esArticles = [
193
+ [
194
+ "alice",
195
+ "frontend",
196
+ "Cómo funciona el DOM virtual",
197
+ "El DOM virtual es una **descripción** de la interfaz en memoria.\n\nLa biblioteca compara dos descripciones y cambia en el navegador solo la diferencia.",
198
+ ],
199
+ [
200
+ "bob",
201
+ "backend",
202
+ "Una API REST sin rodeos",
203
+ "Recurso, método y código de respuesta.\n\n- `GET` lee\n- `POST` crea\n- `DELETE` elimina",
204
+ ],
205
+ [
206
+ "carol",
207
+ "design",
208
+ "Por qué importa el espaciado",
209
+ "Un espaciado coherente hace que la página sea **legible**.\n\nElige una escala como 4, 8, 16, 32 y respétala.",
210
+ ],
211
+ [
212
+ "alice",
213
+ "devops",
214
+ "Tu primer Dockerfile",
215
+ 'La imagen se construye por capas.\n\n```dockerfile\nFROM node:22-slim\nWORKDIR /app\nCOPY . .\nRUN npm ci\nCMD ["npm", "start"]\n```',
216
+ ],
217
+ [
218
+ "bob",
219
+ "career",
220
+ "Cómo superar tu primera entrevista",
221
+ "Prepara una historia sobre **tu** proyecto.\n\nTe preguntarán por qué tomaste cada decisión.",
222
+ ],
223
+ [
224
+ "carol",
225
+ "news",
226
+ "TypeScript estrena un compilador nativo",
227
+ "El nuevo compilador está escrito en Go y es *mucho* más rápido en proyectos grandes.",
228
+ ],
229
+ [
230
+ "alice",
231
+ "frontend",
232
+ "CSS Grid en diez minutos",
233
+ "La cuadrícula se define en el contenedor.\n\n```css\n.layout {\n display: grid;\n grid-template-columns: 1fr 3fr;\n}\n```",
234
+ ],
235
+ [
236
+ "bob",
237
+ "backend",
238
+ "Patrones de paginación",
239
+ "La paginación por desplazamiento es simple. La paginación por cursor resiste las inserciones.\n\nEste blog usa `page` y `perPage`.",
240
+ ],
241
+ [
242
+ "carol",
243
+ "design",
244
+ "Color y contraste",
245
+ "El texto debe leerse sobre cualquier fondo.\n\nRevisa el contraste según [WCAG](https://www.w3.org/WAI/WCAG22/quickref/).",
246
+ ],
247
+ [
248
+ "alice",
249
+ "devops",
250
+ "Desplegar desde una imagen",
251
+ "Se construye una vez y se ejecuta en cualquier lugar.\n\nLa misma imagen corre en tu laptop, en CI y en producción.",
252
+ ],
253
+ [
254
+ "bob",
255
+ "career",
256
+ "Buenas prácticas en la revisión de código",
257
+ "Revisa el código, no a la persona.\n\n> Haz preguntas en lugar de dar órdenes.",
258
+ ],
259
+ [
260
+ "carol",
261
+ "news",
262
+ "Salió Node.js 26",
263
+ "La nueva versión estabilizó la **ejecución de TypeScript** sin compilación.",
264
+ ],
265
+ [
266
+ "alice",
267
+ "frontend",
268
+ "Formularios accesibles",
269
+ "Cada campo necesita un `label`.\n\nLos lectores de pantalla anuncian la etiqueta cuando el campo recibe el foco.",
270
+ ],
271
+ [
272
+ "bob",
273
+ "backend",
274
+ "Códigos de respuesta HTTP",
275
+ "- `200` todo bien\n- `401` hace falta iniciar sesión\n- `403` hay sesión, pero no permisos\n- `404` no se encontró nada",
276
+ ],
277
+ [
278
+ "carol",
279
+ "design",
280
+ "Fundamentos de tipografía",
281
+ "Usa como máximo **dos** tipografías.\n\nUna línea de 60 a 75 caracteres es la más cómoda de leer.",
282
+ ],
283
+ [
284
+ "alice",
285
+ "devops",
286
+ "Variables de entorno",
287
+ "La configuración de la aplicación llega desde el entorno.\n\nAsí una sola imagen funciona en local y en el hosting.",
288
+ ],
289
+ [
290
+ "bob",
291
+ "career",
292
+ "Proyectos personales que llaman la atención",
293
+ "Publica algo que la gente pueda abrir.\n\nUn enlace en vivo vale más que un README largo.",
294
+ ],
295
+ [
296
+ "carol",
297
+ "news",
298
+ "Se actualizó Vite",
299
+ "La compilación es más rápida y la configuración sigue igual.",
300
+ ],
301
+ [
302
+ "alice",
303
+ "frontend",
304
+ "Markdown en el navegador",
305
+ "Markdown se convierte en HTML en el cliente.\n\nNo olvides **sanear** el resultado antes de insertarlo en la página.",
306
+ ],
307
+ [
308
+ "bob",
309
+ "backend",
310
+ "Tokens frente a sesiones",
311
+ "Un token bearer viaja en el encabezado `Authorization`.\n\nEl servidor lo verifica en cada solicitud.",
312
+ ],
313
+ [
314
+ "carol",
315
+ "design",
316
+ "Estados vacíos",
317
+ "Una lista vacía también es una pantalla.\n\nSugiere al usuario qué hacer a continuación.",
318
+ ],
319
+ [
320
+ "alice",
321
+ "devops",
322
+ "Comprobaciones de salud",
323
+ "Un endpoint como `/api/health` le dice a la plataforma que la aplicación está viva.",
324
+ ],
325
+ [
326
+ "bob",
327
+ "career",
328
+ "Cómo leer una oferta de empleo",
329
+ "Los requisitos de una oferta son deseos.\n\nPostúlate si cumples más de la mitad.",
330
+ ],
331
+ [
332
+ "carol",
333
+ "news",
334
+ "Los navegadores incorporan la API Popover",
335
+ "Ya es posible hacer tooltips y menús sin bibliotecas de JavaScript.",
336
+ ],
337
+ [
338
+ "alice",
339
+ "frontend",
340
+ "El estado de un formulario",
341
+ "Un formulario guarda los valores, los errores y si se está enviando.\n\nNo permitas enviarlo dos veces.",
342
+ ],
343
+ [
344
+ "bob",
345
+ "backend",
346
+ "Solicitudes idempotentes",
347
+ "`PUT` y `DELETE` se pueden repetir sin riesgo.\n\nEl botón de me gusta de este blog depende de eso.",
348
+ ],
349
+ [
350
+ "carol",
351
+ "design",
352
+ "Íconos y etiquetas",
353
+ "Un ícono sin etiqueta no lo entiende todo el mundo.\n\nAgrega `aria-label` al menos para el lector de pantalla.",
354
+ ],
355
+ [
356
+ "alice",
357
+ "devops",
358
+ "Logs en producción",
359
+ "Escribe los logs en stdout.\n\nEl hosting los recoge y los muestra en su panel.",
360
+ ],
361
+ [
362
+ "bob",
363
+ "career",
364
+ "Aprender en público",
365
+ "Escribe sobre lo que aprendes.\n\nEste blog es un buen lugar para empezar.",
366
+ ],
367
+ [
368
+ "carol",
369
+ "news",
370
+ "Bienvenido al blog",
371
+ "Aquí se escribe sobre **frontend**, backend y carrera profesional.\n\nRegístrate y publica tu primer artículo.",
372
+ ],
373
+ ];
374
+ export const seeds = {
375
+ ru: { articles: ruArticles, welcomeThread: ["Отличный старт!", "Согласен, жду новых статей."] },
376
+ es: {
377
+ articles: esArticles,
378
+ welcomeThread: ["¡Gran comienzo!", "De acuerdo, espero más artículos."],
379
+ },
380
+ };
381
+ // Пустое значение даёт сид по умолчанию, опечатка роняет запуск, а не подменяет язык молча.
382
+ export const parseSeedLocale = (value) => {
383
+ if (!value)
384
+ return "ru";
385
+ if (value === "ru" || value === "es")
386
+ return value;
387
+ throw new Error(`SEED_LOCALE must be "ru" or "es", got "${value}"`);
388
+ };
@@ -1,4 +1,5 @@
1
1
  import type { components } from "./generated/api.js";
2
+ import { type SeedLocale } from "./seed.js";
2
3
  type Schemas = components["schemas"];
3
4
  export type User = Schemas["User"];
4
5
  export type Category = Schemas["Category"];
@@ -23,7 +24,7 @@ export interface StoredComment {
23
24
  createdAt: Date;
24
25
  }
25
26
  export declare const verifyPassword: (password: string, stored: string) => boolean;
26
- export declare const createState: () => {
27
+ export declare const createState: (locale?: SeedLocale) => {
27
28
  users: StoredUser[];
28
29
  tokens: Map<string, number>;
29
30
  categories: {
package/dist/src/state.js CHANGED
@@ -1,5 +1,5 @@
1
1
  import { randomBytes, randomUUID, scryptSync, timingSafeEqual } from "node:crypto";
2
- import { seedArticles, seedCategories, seedPassword, seedUsers } from "./seed.js";
2
+ import { seedCategories, seedPassword, seeds, seedUsers } from "./seed.js";
3
3
  const hashPassword = (password) => {
4
4
  const salt = randomBytes(16).toString("hex");
5
5
  return `${salt}:${scryptSync(password, salt, 32).toString("hex")}`;
@@ -8,7 +8,8 @@ export const verifyPassword = (password, stored) => {
8
8
  const [salt, hash] = stored.split(":");
9
9
  return timingSafeEqual(Buffer.from(hash, "hex"), scryptSync(password, salt, 32));
10
10
  };
11
- export const createState = () => {
11
+ export const createState = (locale = "ru") => {
12
+ const seed = seeds[locale];
12
13
  const users = [];
13
14
  const tokens = new Map();
14
15
  const categories = seedCategories.map((c, i) => ({ id: i + 1, ...c }));
@@ -56,14 +57,15 @@ export const createState = () => {
56
57
  addUser(username, seedPassword);
57
58
  // Сид старше любой новой статьи: по часу между статьями, самая новая час назад.
58
59
  const now = Date.now();
59
- seedArticles.forEach(([author, category, title, body], i) => {
60
+ seed.articles.forEach(([author, category, title, body], i) => {
60
61
  const authorId = users.find((u) => u.username === author).id;
61
62
  const categoryId = categories.find((c) => c.slug === category).id;
62
- addArticle(authorId, categoryId, title, body, new Date(now - (seedArticles.length - i) * 3_600_000));
63
+ addArticle(authorId, categoryId, title, body, new Date(now - (seed.articles.length - i) * 3_600_000));
63
64
  });
64
65
  const welcome = articles[articles.length - 1];
65
- const question = addComment(welcome.id, users[0].id, "Отличный старт!", null);
66
- addComment(welcome.id, users[1].id, "Согласен, жду новых статей.", question.id);
66
+ const [questionBody, answerBody] = seed.welcomeThread;
67
+ const question = addComment(welcome.id, users[0].id, questionBody, null);
68
+ addComment(welcome.id, users[1].id, answerBody, question.id);
67
69
  likes.add(`${welcome.id}:${users[0].id}`);
68
70
  likes.add(`${welcome.id}:${users[1].id}`);
69
71
  return {
package/package.json CHANGED
@@ -1,10 +1,21 @@
1
1
  {
2
2
  "name": "@hexlet/frontend-blog-server",
3
- "version": "1.0.0",
3
+ "version": "1.2.0",
4
4
  "description": "Hexlet-provided backend for the blog project. Implements the contract/ OpenAPI in-memory and serves a built SPA.",
5
5
  "type": "module",
6
6
  "main": "dist/src/app.js",
7
7
  "types": "dist/src/app.d.ts",
8
+ "exports": {
9
+ ".": {
10
+ "types": "./dist/src/app.d.ts",
11
+ "default": "./dist/src/app.js"
12
+ },
13
+ "./schema": {
14
+ "types": "./dist/src/generated/api.d.ts",
15
+ "default": "./dist/src/generated/api.js"
16
+ },
17
+ "./package.json": "./package.json"
18
+ },
8
19
  "bin": {
9
20
  "frontend-blog-server": "dist/bin/cli.js"
10
21
  },
@@ -22,7 +33,7 @@
22
33
  },
23
34
  "scripts": {
24
35
  "build": "tsc -p tsconfig.json",
25
- "gen:types": "openapi-typescript contract/openapi.yaml -o src/generated/api.ts && oxfmt src/generated/api.ts",
36
+ "gen:types": "npx -y -p typescript@5 -p openapi-typescript@7.13.0 openapi-typescript contract/openapi.yaml -o src/generated/api.ts && oxfmt src/generated/api.ts",
26
37
  "dev": "fastify start -w -l info -P -a 0.0.0.0 -p 8080 -i tsx src/app.ts",
27
38
  "start": "fastify start -l info -a 0.0.0.0 -p 8080 dist/src/app.js",
28
39
  "test": "vitest run",
@@ -41,12 +52,11 @@
41
52
  },
42
53
  "devDependencies": {
43
54
  "@types/node": "^26.6.5",
44
- "openapi-typescript": "^7.13.0",
45
55
  "oxfmt": "^0.75.0",
46
56
  "oxlint": "^1.90.0",
47
57
  "release-it": "^21.1.1",
48
58
  "tsx": "^4.23.15",
49
- "typescript": "^5.9.3",
59
+ "typescript": "^7.0.2",
50
60
  "vitest": "^5.0.5"
51
61
  }
52
62
  }