schemas/

Fuente única de verdad (SSOT) para la validación de datos, tipado y contratos de formularios de Edifiko. Todos los esquemas están construidos con Zod y organizados por dominio de negocio.

Arquitectura y convenciones

collections.ts

Archivo raíz con las utilidades compartidas por todos los módulos.

COLLECTION_PATHS

Builders de rutas de documentos Firestore, tipados con los nombres de colección de constants/firebase.constants.ts.

import { COLLECTION_PATHS } from '@/schemas/collections';

COLLECTION_PATHS.user('uid-123'); // → 'users/uid-123'
COLLECTION_PATHS.category('cat-456'); // → 'categories/cat-456'
COLLECTION_PATHS.material('mat-789'); // → 'materials/mat-789'
COLLECTION_PATHS.supplierCatalogItem('x'); // → 'supplier_catalog/x'
COLLECTION_PATHS.project('proj-1'); // → 'projects/proj-1'
COLLECTION_PATHS.projectMaterial('pm-1'); // → 'project_materials/pm-1'
COLLECTION_PATHS.quote('q-1'); // → 'quotes/q-1'
COLLECTION_PATHS.company('co-1'); // → 'companies/co-1'

baseDocumentSchema

Campos generados por Firestore, siempre presentes en documentos leídos de la BD. Se extiende con .extend() para crear los RecordSchema de cada módulo.

{
  id: z.string().min(1); // ID del documento
  path: z.string().min(1); // Ruta completa del documento
  createdAt: z.date();
  updatedAt: z.date();
}

Módulos implementados

users/

Colección Firestore: /users/{userId}

Roles disponibles: admin · architect_owner · architect_employee · supplier_owner · supplier_sales · supplier_logistics

categories/

Colección Firestore: /categories/{categoryId}
Este módulo gestiona la jerarquía completa de 3 niveles: Rubro → Categoría → Subcategoría.

Rubro (IGroup)

Categoría (ICategory)

Subcategoría (ISubcategory)

materials/

Colección Firestore: /materials/{materialId}

Campos de categorización desnormalizados:

Además del subcategoryId (FK), el schema almacena los nombres de los tres niveles de la jerarquía para evitar joins en lectura:

Unidades disponibles: unidad · bolsa · kg · tonelada · litro · metro · m2 · m3

Módulos pendientes (carpetas vacías)

Cómo agregar un nuevo schema

1. Crear la carpeta schemas/{dominio}/.
2. Crear {dominio}.schema.ts siguiendo el patrón:

import { z } from 'zod';
import { baseDocumentSchema } from '@/schemas/collections';

export const baseFooSchema = z.object({
  // campos de escritura (CREATE / UPDATE)
});
export type IFoo = z.infer<typeof baseFooSchema>;

export const fooSchema = z.object({
  ...baseFooSchema.shape,
  ...baseDocumentSchema.shape,
});
export type IFooRecord = z.infer<typeof fooSchema>;

export const createFooSchema = baseFooSchema;
export type ICreateFoo = z.infer<typeof createFooSchema>;

export const updateFooSchema = baseFooSchema.partial();
export type IUpdateFoo = z.infer<typeof updateFooSchema>;

1. Crear {dominio}.schema.test.ts con casos de éxito y fallo para cada campo.
2. Ejecutar pnpm test y pnpm lint para verificar.