@tantainnovative/create-ndpr 0.4.0 → 0.5.0

package/templates/express-consent-route.ts

@@ -1,211 +1,362 @@
-/**
- * Express — Consent Router
- * Generated by create-ndpr for: {{ORG_NAME}}
- * DPO: {{DPO_EMAIL}}
- *
- * NDPA §25 (lawful basis) and §26 (right to withdraw consent).
- *
- * Routes:
- *   GET    /consent?subjectId=xxx  — Load the active consent record
- *   POST   /consent                — Save new consent (revokes previous)
- *   DELETE /consent?subjectId=xxx  — Revoke all active consent
- *
- * Usage:
- *   import { consentRouter } from './routes/consent';
- *   app.use('/api/consent', consentRouter);
- */
-
+/** Express — tenant-scoped consent router for {{ORG_NAME_COMMENT}}. */
 import { Router } from 'express';
+import { getNDPRContextProblem, resolveNDPRRequestContext } from '{{NDPR_CONTEXT_IMPORT}}';
 // {{#if ORM=prisma}}
-import { PrismaClient } from '@prisma/client';
-
+import { Prisma, PrismaClient } from '@prisma/client';
 const prisma = new PrismaClient();
 // {{/if}}
 // {{#if ORM=drizzle}}
-import { db } from '@/drizzle';
-import { consentRecords, complianceAuditLog } from '@/drizzle/ndpr-schema';
-import { eq, and, isNull, desc } from 'drizzle-orm';
+import { db } from '{{NDPR_DB_IMPORT}}';
+import { complianceAuditLog, consentRecords } from '{{NDPR_SCHEMA_IMPORT}}';
+import { and, desc, eq, isNull } from 'drizzle-orm';
 // {{/if}}
 // {{#if ORM=none}}
-// TODO ({{ORG_NAME}}): wire this to your persistent store of choice. The
-// in-memory map below is enough to develop against locally but DOES NOT
-// satisfy NDPA Section 44 (record-keeping) or the auditability NDPC asks
-// about. Replace `consentStore`/`auditLog` with your DB / KV / API.
-interface ConsentRecord {
-  id: string;
-  subjectId: string;
+// DEVELOPMENT ONLY: replace both stores with one durable transactional store.
+interface ConsentRow {
+  id: string; tenantId: string; subjectId: string; activeSubjectKey: string | null;
+  consents: Record<string, boolean>; version: string; method: string;
+  hasInteracted: boolean; lawfulBasis: string | null;
+  ipAddress: string | null; userAgent: string | null; clientTimestamp: Date;
+  createdAt: Date; revokedAt: Date | null;
+}
+const consentStore = new Map<string, ConsentRow>();
+const auditLog: Array<{
+  id: string; tenantId: string; action: string; entityId: string;
+  performedBy: string | null; at: Date;
+}> = [];
+// {{/if}}
+
+interface ConsentSettings {
   consents: Record<string, boolean>;
   version: string;
   method: string;
-  lawfulBasis: string | null;
-  ipAddress: string | null;
-  userAgent: string | null;
-  createdAt: Date;
-  revokedAt: Date | null;
+  hasInteracted: boolean;
+  lawfulBasis?: string;
+  timestamp: number;
 }
-const consentStore = new Map<string, ConsentRecord>();
-const auditLog: Array<{ id: string; module: string; action: string; entityId: string; at: Date }> = [];
-function newId() { return crypto.randomUUID(); }
-// {{/if}}
 
 export const consentRouter = Router();
 
-// GET /consent?subjectId=xxx
 consentRouter.get('/', async (req, res) => {
-  const { subjectId } = req.query;
-
-  if (!subjectId || typeof subjectId !== 'string') {
-    return res.status(400).json({ error: 'subjectId required' });
-  }
+  const context = await resolveNDPRRequestContext(req);
+  const problem = getNDPRContextProblem(context, 'subject');
+  if (problem) return res.status(problem.status).json({ error: problem.error });
+  const subjectId = context.subjectId as string;
 
   // {{#if ORM=prisma}}
   const record = await prisma.consentRecord.findFirst({
-    where: { subjectId, revokedAt: null },
+    where: { tenantId: context.tenantId, subjectId, revokedAt: null },
     orderBy: { createdAt: 'desc' },
   });
   // {{/if}}
   // {{#if ORM=drizzle}}
-  const [record] = await db
-    .select()
-    .from(consentRecords)
-    .where(and(eq(consentRecords.subjectId, subjectId), isNull(consentRecords.revokedAt)))
-    .orderBy(desc(consentRecords.createdAt))
-    .limit(1);
+  const [record] = await db.select().from(consentRecords).where(and(
+    eq(consentRecords.tenantId, context.tenantId),
+    eq(consentRecords.subjectId, subjectId),
+    isNull(consentRecords.revokedAt),
+  )).orderBy(desc(consentRecords.createdAt)).limit(1);
   // {{/if}}
   // {{#if ORM=none}}
   const record = [...consentStore.values()]
-    .filter((r) => r.subjectId === subjectId && r.revokedAt === null)
+    .filter((row) => row.tenantId === context.tenantId && row.subjectId === subjectId && row.revokedAt === null)
     .sort((a, b) => b.createdAt.getTime() - a.createdAt.getTime())[0] ?? null;
   // {{/if}}
-
-  return res.json(record);
+  return res.json(record ? toConsentSettings(record) : null);
 });
 
-// POST /consent
 consentRouter.post('/', async (req, res) => {
-  const { subjectId, consents, version, method, lawfulBasis } = req.body;
-
-  if (!subjectId || !consents || !version) {
-    return res.status(400).json({ error: 'subjectId, consents, and version are required' });
-  }
+  const context = await resolveNDPRRequestContext(req);
+  const problem = getNDPRContextProblem(context, 'subject');
+  if (problem) return res.status(problem.status).json({ error: problem.error });
+  const subjectId = context.subjectId as string;
+  const validationError = validateConsentBody(req.body);
+  if (validationError) return res.status(400).json({ error: validationError });
+  const value = req.body as Omit<ConsentSettings, 'method'> & { method?: string };
+  const input: ConsentSettings = { ...value, method: value.method ?? 'api' };
 
-  const ipAddress =
-    (req.headers['x-forwarded-for'] as string)?.split(',')[0].trim() ??
-    req.socket.remoteAddress ??
-    null;
-  const userAgent = req.headers['user-agent'] ?? null;
+  const forwarded = req.get('x-forwarded-for');
+  const ipAddress = forwarded?.split(',')[0]?.trim() || req.socket.remoteAddress || null;
+  const userAgent = req.get('user-agent') ?? null;
+  const tenantId = context.tenantId;
+  const clientTimestamp = new Date(input.timestamp);
+  const activeSubjectKey = JSON.stringify([tenantId, subjectId]);
 
   // {{#if ORM=prisma}}
-  // Revoke any previously active records (immutable-audit pattern — NDPA §44).
-  await prisma.consentRecord.updateMany({
-    where: { subjectId, revokedAt: null },
-    data: { revokedAt: new Date() },
-  });
-
-  const record = await prisma.consentRecord.create({
-    data: {
-      subjectId,
-      consents,
-      version,
-      method: method ?? 'api',
-      lawfulBasis: lawfulBasis ?? null,
-      ipAddress,
-      userAgent,
-    },
-  });
+  const transactionResult = await prisma.$transaction(async (tx) => {
+    const replay = await tx.consentRecord.findFirst({
+      where: {
+        tenantId,
+        subjectId,
+        clientTimestamp,
+        version: input.version,
+        method: input.method,
+      },
+      orderBy: { createdAt: 'desc' },
+    });
+    if (replay) {
+      return sameConsentMutation(replay, input)
+        ? { kind: 'record' as const, record: replay }
+        : { kind: 'collision' as const };
+    }
 
-  await prisma.complianceAuditLog.create({
-    data: {
-      module: 'consent',
-      action: 'created',
-      entityId: record.id,
-      entityType: 'ConsentRecord',
-      changes: { subjectId, version, consents },
-    },
+    await tx.consentRecord.updateMany({
+      where: { tenantId, subjectId, revokedAt: null },
+      data: { revokedAt: new Date(), activeSubjectKey: null },
+    });
+    const created = await tx.consentRecord.create({ data: {
+      tenantId, subjectId, activeSubjectKey, consents: input.consents,
+      version: input.version, method: input.method,
+      hasInteracted: input.hasInteracted, lawfulBasis: input.lawfulBasis ?? null,
+      ipAddress, userAgent, clientTimestamp,
+    } });
+    await tx.complianceAuditLog.create({ data: {
+      tenantId, module: 'consent', action: 'created', entityId: created.id,
+      entityType: 'ConsentRecord', performedBy: context.actorId,
+      changes: {
+        subjectId, version: input.version, method: input.method,
+        hasInteracted: input.hasInteracted,
+        consentCategories: Object.keys(input.consents),
+      },
+    } });
+    return { kind: 'record' as const, record: created };
+  }, {
+    isolationLevel: Prisma.TransactionIsolationLevel.Serializable,
+  }).catch((error: unknown) => {
+    if (isConcurrencyConflict(error)) return null;
+    throw error;
   });
+  if (!transactionResult) {
+    return res.status(409).json({
+      error: 'Concurrent consent update conflict; retry the same idempotent request.',
+    });
+  }
+  if (transactionResult.kind === 'collision') {
+    return res.status(409).json({
+      error: 'Idempotency collision: timestamp/version/method identify different consent data.',
+    });
+  }
+  const record = transactionResult.record;
   // {{/if}}
   // {{#if ORM=drizzle}}
-  await db.update(consentRecords).set({ revokedAt: new Date() }).where(and(eq(consentRecords.subjectId, subjectId), isNull(consentRecords.revokedAt)));
-
-  const [record] = await db.insert(consentRecords).values({
-    subjectId,
-    consents,
-    version,
-    method: method ?? 'api',
-    lawfulBasis: lawfulBasis ?? null,
-    ipAddress,
-    userAgent,
-  }).returning();
-
-  await db.insert(complianceAuditLog).values({
-    module: 'consent',
-    action: 'created',
-    entityId: record.id,
-    entityType: 'ConsentRecord',
-    changes: { subjectId, version, consents },
+  const transactionResult = await db.transaction(async (tx) => {
+    const [replay] = await tx.select().from(consentRecords).where(and(
+      eq(consentRecords.tenantId, tenantId),
+      eq(consentRecords.subjectId, subjectId),
+      eq(consentRecords.clientTimestamp, clientTimestamp),
+      eq(consentRecords.version, input.version),
+      eq(consentRecords.method, input.method),
+    )).orderBy(desc(consentRecords.createdAt)).limit(1);
+    if (replay) {
+      return sameConsentMutation(replay, input)
+        ? { kind: 'record' as const, record: replay }
+        : { kind: 'collision' as const };
+    }
+
+    await tx.update(consentRecords).set({
+      revokedAt: new Date(),
+      activeSubjectKey: null,
+    }).where(and(
+      eq(consentRecords.tenantId, tenantId),
+      eq(consentRecords.subjectId, subjectId),
+      isNull(consentRecords.revokedAt),
+    ));
+    const [created] = await tx.insert(consentRecords).values({
+      tenantId, subjectId, activeSubjectKey, consents: input.consents,
+      version: input.version, method: input.method,
+      hasInteracted: input.hasInteracted, lawfulBasis: input.lawfulBasis ?? null,
+      ipAddress, userAgent, clientTimestamp,
+    }).returning();
+    await tx.insert(complianceAuditLog).values({
+      tenantId, module: 'consent', action: 'created', entityId: created.id,
+      entityType: 'ConsentRecord', performedBy: context.actorId,
+      changes: {
+        subjectId, version: input.version, method: input.method,
+        hasInteracted: input.hasInteracted,
+        consentCategories: Object.keys(input.consents),
+      },
+    });
+    return { kind: 'record' as const, record: created };
+  }, { isolationLevel: 'serializable' }).catch((error: unknown) => {
+    if (isConcurrencyConflict(error)) return null;
+    throw error;
   });
+  if (!transactionResult) {
+    return res.status(409).json({
+      error: 'Concurrent consent update conflict; retry the same idempotent request.',
+    });
+  }
+  if (transactionResult.kind === 'collision') {
+    return res.status(409).json({
+      error: 'Idempotency collision: timestamp/version/method identify different consent data.',
+    });
+  }
+  const record = transactionResult.record;
   // {{/if}}
   // {{#if ORM=none}}
-  for (const r of consentStore.values()) {
-    if (r.subjectId === subjectId && r.revokedAt === null) r.revokedAt = new Date();
+  const replay = [...consentStore.values()].find((row) =>
+    row.tenantId === tenantId
+    && row.subjectId === subjectId
+    && row.clientTimestamp.getTime() === input.timestamp
+    && row.version === input.version
+    && row.method === input.method,
+  );
+  if (replay) {
+    if (!sameConsentMutation(replay, input)) {
+      return res.status(409).json({
+        error: 'Idempotency collision: timestamp/version/method identify different consent data.',
+      });
+    }
+    return res.status(201).json(toConsentSettings(replay));
+  }
+  const now = new Date();
+  for (const row of consentStore.values()) {
+    if (row.tenantId === tenantId && row.subjectId === subjectId && row.revokedAt === null) {
+      row.revokedAt = now;
+      row.activeSubjectKey = null;
+    }
   }
-  const record: ConsentRecord = {
-    id: newId(),
-    subjectId,
-    consents,
-    version,
-    method: method ?? 'api',
-    lawfulBasis: lawfulBasis ?? null,
-    ipAddress,
-    userAgent,
-    createdAt: new Date(),
-    revokedAt: null,
+  const record: ConsentRow = {
+    id: crypto.randomUUID(), tenantId, subjectId, activeSubjectKey,
+    consents: input.consents, version: input.version, method: input.method,
+    hasInteracted: input.hasInteracted, lawfulBasis: input.lawfulBasis ?? null,
+    ipAddress, userAgent, clientTimestamp, createdAt: now, revokedAt: null,
   };
   consentStore.set(record.id, record);
-  auditLog.push({ id: newId(), module: 'consent', action: 'created', entityId: record.id, at: new Date() });
+  auditLog.push({
+    id: crypto.randomUUID(), tenantId, action: 'created', entityId: record.id,
+    performedBy: context.actorId, at: now,
+  });
   // {{/if}}
-
-  return res.status(201).json(record);
+  return res.status(201).json(toConsentSettings(record));
 });
 
-// DELETE /consent?subjectId=xxx
 consentRouter.delete('/', async (req, res) => {
-  const { subjectId } = req.query;
-
-  if (!subjectId || typeof subjectId !== 'string') {
-    return res.status(400).json({ error: 'subjectId required' });
-  }
+  const context = await resolveNDPRRequestContext(req);
+  const problem = getNDPRContextProblem(context, 'subject');
+  if (problem) return res.status(problem.status).json({ error: problem.error });
+  const subjectId = context.subjectId as string;
+  const tenantId = context.tenantId;
+  const now = new Date();
 
   // {{#if ORM=prisma}}
-  await prisma.consentRecord.updateMany({
-    where: { subjectId, revokedAt: null },
-    data: { revokedAt: new Date() },
-  });
-
-  await prisma.complianceAuditLog.create({
-    data: {
-      module: 'consent',
-      action: 'revoked',
-      entityId: subjectId,
-      entityType: 'ConsentRecord',
-    },
+  const revoked = await prisma.$transaction(async (tx) => {
+    const result = await tx.consentRecord.updateMany({
+      where: { tenantId, subjectId, revokedAt: null },
+      data: { revokedAt: now, activeSubjectKey: null },
+    });
+    if (result.count > 0) {
+      await tx.complianceAuditLog.create({ data: {
+        tenantId, module: 'consent', action: 'revoked', entityId: subjectId,
+        entityType: 'ConsentRecord', performedBy: context.actorId,
+        changes: { subjectId, revokedRecords: result.count },
+      } });
+    }
+    return result.count;
   });
   // {{/if}}
   // {{#if ORM=drizzle}}
-  await db.update(consentRecords).set({ revokedAt: new Date() }).where(and(eq(consentRecords.subjectId, subjectId), isNull(consentRecords.revokedAt)));
-  await db.insert(complianceAuditLog).values({
-    module: 'consent',
-    action: 'revoked',
-    entityId: subjectId,
-    entityType: 'ConsentRecord',
+  const revoked = await db.transaction(async (tx) => {
+    const rows = await tx.update(consentRecords).set({
+      revokedAt: now,
+      activeSubjectKey: null,
+    }).where(and(
+      eq(consentRecords.tenantId, tenantId),
+      eq(consentRecords.subjectId, subjectId),
+      isNull(consentRecords.revokedAt),
+    )).returning({ id: consentRecords.id });
+    if (rows.length > 0) {
+      await tx.insert(complianceAuditLog).values({
+        tenantId, module: 'consent', action: 'revoked', entityId: subjectId,
+        entityType: 'ConsentRecord', performedBy: context.actorId,
+        changes: { subjectId, revokedRecords: rows.length },
+      });
+    }
+    return rows.length;
   });
   // {{/if}}
   // {{#if ORM=none}}
-  for (const r of consentStore.values()) {
-    if (r.subjectId === subjectId && r.revokedAt === null) r.revokedAt = new Date();
+  let revoked = 0;
+  for (const row of consentStore.values()) {
+    if (row.tenantId === tenantId && row.subjectId === subjectId && row.revokedAt === null) {
+      row.revokedAt = now;
+      row.activeSubjectKey = null;
+      revoked += 1;
+    }
+  }
+  if (revoked > 0) {
+    auditLog.push({
+      id: crypto.randomUUID(), tenantId, action: 'revoked', entityId: subjectId,
+      performedBy: context.actorId, at: now,
+    });
   }
-  auditLog.push({ id: newId(), module: 'consent', action: 'revoked', entityId: subjectId, at: new Date() });
   // {{/if}}
-
-  return res.json({ success: true });
+  return res.json({ success: true, revoked });
 });
+
+function validateConsentBody(body: unknown): string | null {
+  if (!body || typeof body !== 'object') return 'A JSON object is required';
+  const value = body as Record<string, unknown>;
+  if (!value.consents || typeof value.consents !== 'object' || Array.isArray(value.consents)) {
+    return 'consents must be an object';
+  }
+  if (Object.values(value.consents).some((consent) => typeof consent !== 'boolean')) {
+    return 'Every consent value must be boolean';
+  }
+  if (typeof value.version !== 'string' || !value.version.trim()) return 'version is required';
+  if (value.method !== undefined && (typeof value.method !== 'string' || !value.method.trim())) {
+    return 'method must be a non-empty string';
+  }
+  if (value.hasInteracted !== true && value.hasInteracted !== false) {
+    return 'hasInteracted must be boolean';
+  }
+  if (typeof value.timestamp !== 'number' || !Number.isSafeInteger(value.timestamp) || value.timestamp < 0
+      || !Number.isFinite(new Date(value.timestamp).getTime())) {
+    return 'timestamp must be a non-negative safe-integer epoch value within the valid Date range';
+  }
+  if (value.lawfulBasis !== undefined && typeof value.lawfulBasis !== 'string') {
+    return 'lawfulBasis must be a string';
+  }
+  return null;
+}
+
+function toConsentSettings(record: {
+  consents: unknown;
+  version: string;
+  method: string;
+  hasInteracted: boolean;
+  lawfulBasis: string | null;
+  clientTimestamp: Date | null;
+  createdAt: Date;
+}): ConsentSettings {
+  return {
+    consents: record.consents as Record<string, boolean>,
+    timestamp: record.clientTimestamp?.getTime() ?? record.createdAt.getTime(),
+    version: record.version,
+    method: record.method,
+    hasInteracted: record.hasInteracted,
+    lawfulBasis: record.lawfulBasis ?? undefined,
+  };
+}
+
+function sameConsentMutation(
+  record: { consents: unknown; hasInteracted: boolean; lawfulBasis: string | null },
+  input: ConsentSettings,
+): boolean {
+  const storedConsents = record.consents as Record<string, boolean>;
+  return JSON.stringify(sortedConsentEntries(storedConsents))
+      === JSON.stringify(sortedConsentEntries(input.consents))
+    && record.hasInteracted === input.hasInteracted
+    && (record.lawfulBasis ?? undefined) === input.lawfulBasis;
+}
+
+function sortedConsentEntries(consents: Record<string, boolean>) {
+  return Object.entries(consents).sort(([left], [right]) => left.localeCompare(right));
+}
+
+function isConcurrencyConflict(error: unknown): boolean {
+  if (!error || typeof error !== 'object') return false;
+  const candidate = error as { code?: unknown; cause?: unknown };
+  const code = typeof candidate.code === 'string' ? candidate.code : '';
+  if (['P2002', 'P2034', '23505', '40001', '40P01'].includes(code)) return true;
+  return candidate.cause !== error && isConcurrencyConflict(candidate.cause);
+}