@repo/schemas

Contrato de validación y tipos compartidos basado en Zod para el monorepo Nidus.

Índice

1. Función del package
2. Schemas disponibles
3. Tipos inferidos
4. Constantes de validación
5. Validación en runtime
6. Estructura de archivos
7. Lineamientos de desarrollo
8. Contribución y tests

1. Función del package

• Define esquemas de datos reutilizables con Zod.
• Comparte reglas de validación entre frontend (formularios) y backend (Firestore).
• Exporta tipos TypeScript inferidos desde los schemas.
• Evita inconsistencias de tipos entre módulos del monorepo.

2. Schemas disponibles

surveySchema

Valida el documento completo de una encuesta tal como se almacena en Firestore.

import { surveySchema } from '@repo/schemas';

const resultado = surveySchema.safeParse(data);
if (resultado.success) {
  console.log(resultado.data.email);
}

Campos:

surveyDataSchema

Array de surveySchema. Usado para validar colecciones completas retornadas por Firestore.

import { surveyDataSchema } from '@repo/schemas';

const encuestas = surveyDataSchema.parse(rawArray);

createSurveyDataSchema

Versión del schema sin los campos generados por el servidor (id, path, createdAt, updatedAt). Usado para validar el payload de creación de una nueva encuesta.

import { createSurveyDataSchema } from '@repo/schemas';

const input = createSurveyDataSchema.parse({
  name: 'Ana Rodríguez',
  email: 'ana@barrio.com',
  phone: '+5491187654321',
  role: 'Propietario',
  control_methods: ['WhatsApp', 'Papel / Cuaderno'],
  main_problem: 'Todo se maneja por WhatsApp y no hay registro.',
  neighborhood_size: '51-100',
  willingness_to_pay: 'Sí, bajo costo (menos de $3.000 por lote/mes)',
  willing_to_interview: 'Por ahora no',
});

Information del barrio

El schema infoSchema valida el agregado persistido en communities/{communityId}/info/data. Estos schemas y sus tipos se exportan desde @repo/schemas:

infoCreatedBySchema exige userId y un role de userRolesList. Los tipos IInfo, IInfoStandard, IInfoFaq, IInfoContact, ICreateInfo e IUpdateInfo se infieren desde los schemas; no duplicar interfaces persistidas en la app. La suite firestore/tests/info.schema.test.ts cubre estructura, arrays vacíos, campos requeridos, metadata opcional, email, rol y updates parciales.

3. Tipos inferidos

import type { SurveyData, SurveysData, CreateSurveyData } from '@repo/schemas';

// Documento completo de Firestore
type SurveyData = z.infer<typeof surveySchema>;

// Array de documentos
type SurveysData = z.infer<typeof surveyDataSchema>;

// Payload de creación (sin metadatos del servidor)
type CreateSurveyData = z.infer<typeof createSurveyDataSchema>;

4. Constantes de validación

Todas las constantes son arrays as const que alimentan los enums del schema y los <select> del formulario.

import {
  ROLE_OPTIONS,
  METHODS_OPTIONS,
  NEIGHBORHOOD_SIZE_OPTIONS,
  WILLINGNESS_TO_PAY_OPTIONS,
  WILLING_TO_INTERVIEW_OPTIONS,
} from '@repo/schemas';

5. Validación en runtime

// safeParse — no lanza, retorna { success, data } o { success, error }
const resultado = createSurveyDataSchema.safeParse(inputDelFormulario);
if (!resultado.success) {
  console.error(resultado.error.flatten());
}

// parse — lanza ZodError si falla
const encuesta = surveySchema.parse(docDeFirestore);

6. Estructura de archivos

7. Lineamientos de desarrollo

1. Todo schema nuevo debe representar una entidad o contrato reutilizable.
2. Exportar schemas y tipos desde index.ts.
3. Nombres semánticos: userSchema, expenseSchema, etc.
4. Definir infer types junto a cada schema para evitar sincronización manual.
5. Reutilizar composición Zod (omit, pick, extend) en lugar de duplicar reglas.
6. Testear edge-cases en validaciones críticas.

Agregar un nuevo schema

1. Crear el schema en el dominio correcto (firestore/, functions/ o shared/).
2. Exportar desde el barrel del dominio y desde index.ts.
3. Documentar campos y constantes en este README.
4. Escribir tests en firestore/tests/.

8. Contribución y tests

pnpm lint --filter @repo/schemas
pnpm build --filter @repo/schemas
pnpm type-check --filter @repo/schemas
pnpm test --filter @repo/schemas