@c15t/backend/src/schema/audit-log/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 consent audit log entities.
 *
 * This defines the structure and validation rules for audit log entries:
 * - Required fields: entityType, entityId, actionType
 * - Optional fields: subjectId, ipAddress, changes, metadata
 * - Default current date/time for creation timestamp
 *
 * @example
 * ```typescript
 * const auditLogData = {
 *   id: 'log_w5qufx2a66m7xkn3ty',
 *   entityType: 'consent',
 *   entityId: 'cns_hadt8w7nngm7xmx2bn',
 *   actionType: 'update',
 *   subjectId: 'sub_x1pftyoufsm7xgo1kv',
 *   changes: { status: { from: 'active', to: 'withdrawn' } }
 * };
 *
 * // Validate and parse the audit log data
 * const validAuditLog = auditLogSchema.parse(auditLogData);
 * ```
 */
export const auditLogSchema = z.object({
	id: z.string(),
	entityType: z.string(),
	entityId: z.string(),
	actionType: z.string(),
	subjectId: z.string().optional(),
	ipAddress: z.string().optional(),
	userAgent: z.string().optional(),
	changes: z.record(z.string(), z.unknown()).optional(),
	metadata: z.record(z.string(), z.unknown()).optional(),
	createdAt: z.date().prefault(() => new Date()),
});

/**
 * Type definition for AuditLog
 *
 * This type represents the structure of a consent audit log entry
 * as defined by the auditLogSchema. It includes all fields
 * that are part of the audit log entity.
 */
export type AuditLog = z.infer<typeof auditLogSchema>;