@c15t/backend/src/schema/domain/schema.ts

Consent policy engine and API for c15t. Powers the cookie banner, consent manager, and preferences centre. Webhooks, audit logs, storage adapters. Self host or use consent.io

import { z } from 'zod';

/**
 * Zod schema for validating domain entities.
 *
 * This defines the structure and validation rules for domain records:
 * - Required fields: name
 * - Optional fields: description, allowedOrigins
 * - Default value of true for isActive and isVerified
 * - Default current date/time for creation timestamp
 *
 * @example
 * ```typescript
 * const domainData = {
 *   id: 'dom_x1pftyoufsm7xgo1kv',
 *   name: 'example.com',
 *   description: 'Company website',
 *   allowedOrigins: ['https://app.example.com', 'https://admin.example.com']
 * };
 *
 * // Validate and parse the domain data
 * const validDomain = domainSchema.parse(domainData);
 * ```
 */
export const domainSchema = z.object({
	id: z.string(),
	name: z.string().min(1),
	description: z.string().optional(),
	allowedOrigins: z.array(z.string()).optional().prefault([]),
	isVerified: z.boolean().prefault(true),
	isActive: z.boolean().prefault(true),
	createdAt: z.date().prefault(() => new Date()),
	updatedAt: z.date().prefault(() => new Date()),
});

/**
 * Type definition for Domain
 *
 * This type represents the structure of a domain record
 * as defined by the domainSchema. It includes all fields
 * that are part of the domain entity.
 */
export type Domain = z.infer<typeof domainSchema>;