@tantainnovative/ndpr-toolkit 1.0.4 → 1.0.5

package/packages/ndpr-toolkit/src/utils/dpia.ts

@@ -0,0 +1,104 @@
+import { DPIAResult, DPIARisk } from '../types/dpia';
+
+/**
+ * Assesses the risk level of a DPIA based on the identified risks
+ * @param dpiaResult The DPIA result containing risks to assess
+ * @returns Assessment result with overall risk level and recommendations
+ */
+export function assessDPIARisk(dpiaResult: DPIAResult): {
+  overallRiskLevel: 'low' | 'medium' | 'high' | 'critical';
+  requiresConsultation: boolean;
+  canProceed: boolean;
+  recommendations: string[];
+} {
+  // Count risks by level
+  const riskCounts = {
+    low: 0,
+    medium: 0,
+    high: 0,
+    critical: 0
+  };
+  
+  // Calculate the highest risk score
+  let highestRiskScore = 0;
+  
+  // Track unmitigated high/critical risks
+  const unmitigatedHighRisks: DPIARisk[] = [];
+  
+  // Analyze each risk
+  dpiaResult.risks.forEach(risk => {
+    // Count by level
+    riskCounts[risk.level]++;
+    
+    // Track highest score
+    if (risk.score > highestRiskScore) {
+      highestRiskScore = risk.score;
+    }
+    
+    // Track unmitigated high/critical risks
+    if ((risk.level === 'high' || risk.level === 'critical') && !risk.mitigated) {
+      unmitigatedHighRisks.push(risk);
+    }
+  });
+  
+  // Determine overall risk level
+  let overallRiskLevel: 'low' | 'medium' | 'high' | 'critical';
+  
+  if (riskCounts.critical > 0) {
+    overallRiskLevel = 'critical';
+  } else if (riskCounts.high > 2 || (riskCounts.high > 0 && riskCounts.medium > 3)) {
+    overallRiskLevel = 'high';
+  } else if (riskCounts.high > 0 || riskCounts.medium > 1) {
+    overallRiskLevel = 'medium';
+  } else {
+    overallRiskLevel = 'low';
+  }
+  
+  // Determine if NITDA consultation is required
+  // Under NDPR, consultation is required for high-risk processing
+  const requiresConsultation = overallRiskLevel === 'high' || overallRiskLevel === 'critical';
+  
+  // Determine if processing can proceed
+  // Processing can proceed if all high/critical risks are mitigated
+  const canProceed = unmitigatedHighRisks.length === 0;
+  
+  // Generate recommendations
+  const recommendations: string[] = [];
+  
+  if (unmitigatedHighRisks.length > 0) {
+    recommendations.push(
+      `Mitigate the following high/critical risks before proceeding: ${
+        unmitigatedHighRisks.map(risk => risk.description).join(', ')
+      }`
+    );
+  }
+  
+  if (requiresConsultation) {
+    recommendations.push(
+      'Consult with NITDA before proceeding with this processing activity, as required by NDPR for high-risk processing.'
+    );
+  }
+  
+  if (riskCounts.medium > 0) {
+    recommendations.push(
+      'Implement additional safeguards to reduce medium-level risks where possible.'
+    );
+  }
+  
+  if (overallRiskLevel !== 'low') {
+    recommendations.push(
+      'Schedule a review of this DPIA in 6 months to reassess risks and effectiveness of mitigation measures.'
+    );
+  } else {
+    recommendations.push(
+      'Schedule a review of this DPIA in 12 months as part of regular compliance activities.'
+    );
+  }
+  
+  return {
+    overallRiskLevel,
+    requiresConsultation,
+    canProceed,
+    recommendations
+  };
+}

package/packages/ndpr-toolkit/src/utils/dsr.ts

@@ -0,0 +1,77 @@
+import { DSRRequest } from '../types/dsr';
+
+/**
+ * Formats a DSR request for display or submission
+ * @param request The DSR request to format
+ * @returns Formatted request data
+ */
+export function formatDSRRequest(request: DSRRequest): {
+  formattedRequest: Record<string, any>;
+  isValid: boolean;
+  validationErrors: string[];
+} {
+  const validationErrors: string[] = [];
+  
+  // Validate required fields
+  if (!request.id) {
+    validationErrors.push('Request ID is required');
+  }
+  
+  if (!request.type) {
+    validationErrors.push('Request type is required');
+  }
+  
+  if (!request.status) {
+    validationErrors.push('Request status is required');
+  }
+  
+  if (!request.createdAt) {
+    validationErrors.push('Creation timestamp is required');
+  }
+  
+  if (!request.subject?.name) {
+    validationErrors.push('Data subject name is required');
+  }
+  
+  if (!request.subject?.email) {
+    validationErrors.push('Data subject email is required');
+  }
+  
+  // Format the request for display or submission
+  const formattedRequest = {
+    requestId: request.id,
+    requestType: request.type,
+    status: request.status,
+    createdDate: new Date(request.createdAt).toISOString(),
+    lastUpdated: request.updatedAt ? new Date(request.updatedAt).toISOString() : undefined,
+    dueDate: request.dueDate 
+      ? new Date(request.dueDate).toISOString() 
+      : undefined,
+    dataSubject: {
+      name: request.subject.name,
+      email: request.subject.email,
+      phone: request.subject.phone || 'Not provided',
+      identifier: {
+        type: request.subject.identifierType || 'Not specified',
+        value: request.subject.identifierValue || 'Not provided'
+      }
+    },
+    additionalInformation: request.additionalInfo || {},
+    verificationStatus: request.verification 
+      ? `${request.verification.verified ? 'Verified' : 'Not verified'}${request.verification.method ? ` via ${request.verification.method}` : ''}`
+      : 'Pending verification',
+    attachments: request.attachments 
+      ? request.attachments.map(attachment => ({
+          name: attachment.name,
+          type: attachment.type,
+          addedOn: new Date(attachment.addedAt).toISOString()
+        }))
+      : []
+  };
+  
+  return {
+    formattedRequest,
+    isValid: validationErrors.length === 0,
+    validationErrors
+  };
+}

package/packages/ndpr-toolkit/src/utils/privacy.ts

@@ -0,0 +1,100 @@
+import { PolicySection, OrganizationInfo, PolicyVariable } from '../types/privacy';
+
+/**
+ * Generates policy text by replacing variables in a template with organization-specific values
+ * @param sectionsOrTemplate The policy sections or template string to generate text for
+ * @param organizationInfoOrVariables The organization information or variable map to use for replacement
+ * @returns The generated policy text or an object with the generated text and metadata
+ */
+export function generatePolicyText(
+  sectionsOrTemplate: PolicySection[] | string,
+  organizationInfoOrVariables: OrganizationInfo | Record<string, string>
+): string | {
+  fullText: string;
+  sectionTexts: Record<string, string>;
+  missingVariables: string[];
+} {
+  // Check if we're using the new API (template string and variable map)
+  if (typeof sectionsOrTemplate === 'string') {
+    const template = sectionsOrTemplate;
+    const variableMap = organizationInfoOrVariables as Record<string, string>;
+    
+    // Replace variables in the template
+    let result = template;
+    const variableRegex = /\{\{([^}]+)\}\}/g;
+    let match;
+    
+    // Find and replace all variables in the content
+    while ((match = variableRegex.exec(template)) !== null) {
+      const variable = match[1].trim();
+      const replacement = variableMap[variable] || '';
+      
+      // Replace the variable in the content
+      result = result.replace(
+        new RegExp(`\\{\\{\\s*${variable}\\s*\\}\\}`, 'g'), 
+        replacement
+      );
+    }
+    
+    return result;
+  } 
+  // Otherwise use the original API (sections array and organization info)
+  else {
+    const sections = sectionsOrTemplate;
+    const organizationInfo = organizationInfoOrVariables as OrganizationInfo;
+    const sectionTexts: Record<string, string> = {};
+    const missingVariables: string[] = [];
+    
+    // Process each section
+    sections
+      .filter(section => section.included)
+      .sort((a, b) => (a.order || 0) - (b.order || 0))
+      .forEach(section => {
+        // Use template if available, otherwise fall back to custom/default content
+        let content = section.template || section.customContent || section.defaultContent || '';
+        
+        // Replace variables in the content
+        const variableRegex = /\{\{([^}]+)\}\}/g;
+        let match;
+        
+        // Find all variables in the content
+        const contentVariables: string[] = [];
+        while ((match = variableRegex.exec(content)) !== null) {
+          contentVariables.push(match[1].trim());
+        }
+        
+        // Replace each variable with its value
+        contentVariables.forEach(variable => {
+          let replacement = '';
+          
+          // Check if the variable exists in organizationInfo
+          if (variable in organizationInfo) {
+            replacement = organizationInfo[variable as keyof OrganizationInfo] as string || '';
+          }
+          
+          // If replacement is empty, add to missing variables
+          if (!replacement) {
+            missingVariables.push(variable);
+          }
+          
+          // Replace the variable in the content
+          content = content.replace(
+            new RegExp(`\\{\\{\\s*${variable}\\s*\\}\\}`, 'g'), 
+            replacement
+          );
+        });
+        
+        // Store the processed section text
+        sectionTexts[section.id] = content;
+      });
+    
+    // Combine all sections into full text
+    const fullText = Object.values(sectionTexts).join('\n\n');
+    
+    return {
+      fullText,
+      sectionTexts,
+      missingVariables: Array.from(new Set(missingVariables)) // Remove duplicates
+    };
+  }
+}

package/packages/ndpr-toolkit/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noFallthroughCasesInSwitch": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "react-jsx",
+    "declaration": true,
+    "declarationDir": "dist",
+    "outDir": "dist"
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts", "**/*.test.tsx"]
+}

package/postcss.config.mjs

@@ -0,0 +1,5 @@
+const config = {
+  plugins: ["@tailwindcss/postcss", "autoprefixer"],
+};
+
+export default config;

package/src/app/accessibility.css

@@ -0,0 +1,70 @@
+/* Accessibility-focused styles with improved color contrast */
+
+/* Badge styles with WCAG AA compliant contrast ratios */
+.badge-success {
+  @apply bg-green-700 text-white dark:bg-green-600 dark:text-white;
+}
+
+.badge-warning {
+  @apply bg-amber-700 text-white dark:bg-amber-600 dark:text-white;
+}
+
+.badge-error {
+  @apply bg-red-700 text-white dark:bg-red-600 dark:text-white;
+}
+
+.badge-info {
+  @apply bg-blue-700 text-white dark:bg-blue-600 dark:text-white;
+}
+
+.badge-neutral {
+  @apply bg-gray-700 text-white dark:bg-gray-500 dark:text-white;
+}
+
+/* Text colors with improved contrast */
+.text-muted-accessible {
+  @apply text-gray-700 dark:text-gray-300;
+}
+
+.text-secondary-accessible {
+  @apply text-gray-600 dark:text-gray-400;
+}
+
+/* Focus indicators for better keyboard navigation */
+.focus-visible-ring {
+  @apply focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-offset-2 focus-visible:ring-blue-600 dark:focus-visible:ring-blue-400 focus-visible:ring-offset-background;
+}
+
+/* High contrast mode support */
+@media (prefers-contrast: high) {
+  .badge-success,
+  .badge-warning,
+  .badge-error,
+  .badge-info,
+  .badge-neutral {
+    @apply border-2 border-current;
+  }
+  
+  .text-muted-accessible {
+    @apply text-gray-900 dark:text-gray-100;
+  }
+}
+
+/* Ensure interactive elements have sufficient size */
+.interactive-target {
+  @apply min-h-[44px] min-w-[44px];
+}
+
+/* Skip link for keyboard navigation */
+.skip-link {
+  @apply sr-only focus:not-sr-only focus:absolute focus:top-4 focus:left-4 focus:z-50 focus:px-4 focus:py-2 focus:bg-blue-600 focus:text-white focus:rounded-md;
+}
+
+/* Aria live region styles */
+.aria-live-polite {
+  @apply sr-only;
+}
+
+[role="alert"] {
+  @apply font-medium;
+}

package/src/app/globals.css

@@ -0,0 +1,123 @@
+@import "tailwindcss";
+@import "tw-animate-css";
+@import "./accessibility.css";
+
+@custom-variant dark (&:is(.dark *));
+
+@theme inline {
+  --color-background: var(--background);
+  --color-foreground: var(--foreground);
+  --font-sans: var(--font-geist-sans);
+  --font-mono: var(--font-geist-mono);
+  --color-sidebar-ring: var(--sidebar-ring);
+  --color-sidebar-border: var(--sidebar-border);
+  --color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
+  --color-sidebar-accent: var(--sidebar-accent);
+  --color-sidebar-primary-foreground: var(--sidebar-primary-foreground);
+  --color-sidebar-primary: var(--sidebar-primary);
+  --color-sidebar-foreground: var(--sidebar-foreground);
+  --color-sidebar: var(--sidebar);
+  --color-chart-5: var(--chart-5);
+  --color-chart-4: var(--chart-4);
+  --color-chart-3: var(--chart-3);
+  --color-chart-2: var(--chart-2);
+  --color-chart-1: var(--chart-1);
+  --color-ring: var(--ring);
+  --color-input: var(--input);
+  --color-border: var(--border);
+  --color-destructive: var(--destructive);
+  --color-accent-foreground: var(--accent-foreground);
+  --color-accent: var(--accent);
+  --color-muted-foreground: var(--muted-foreground);
+  --color-muted: var(--muted);
+  --color-secondary-foreground: var(--secondary-foreground);
+  --color-secondary: var(--secondary);
+  --color-primary-foreground: var(--primary-foreground);
+  --color-primary: var(--primary);
+  --color-popover-foreground: var(--popover-foreground);
+  --color-popover: var(--popover);
+  --color-card-foreground: var(--card-foreground);
+  --color-card: var(--card);
+  --radius-sm: calc(var(--radius) - 4px);
+  --radius-md: calc(var(--radius) - 2px);
+  --radius-lg: var(--radius);
+  --radius-xl: calc(var(--radius) + 4px);
+}
+
+:root {
+  --radius: 0.625rem;
+  --background: oklch(1 0 0);
+  --foreground: oklch(0.13 0.028 261.692);
+  --card: oklch(1 0 0);
+  --card-foreground: oklch(0.13 0.028 261.692);
+  --popover: oklch(1 0 0);
+  --popover-foreground: oklch(0.13 0.028 261.692);
+  --primary: oklch(0.21 0.034 264.665);
+  --primary-foreground: oklch(0.985 0.002 247.839);
+  --secondary: oklch(0.967 0.003 264.542);
+  --secondary-foreground: oklch(0.21 0.034 264.665);
+  --muted: oklch(0.967 0.003 264.542);
+  --muted-foreground: oklch(0.551 0.027 264.364);
+  --accent: oklch(0.967 0.003 264.542);
+  --accent-foreground: oklch(0.21 0.034 264.665);
+  --destructive: oklch(0.577 0.245 27.325);
+  --border: oklch(0.928 0.006 264.531);
+  --input: oklch(0.928 0.006 264.531);
+  --ring: oklch(0.707 0.022 261.325);
+  --chart-1: oklch(0.646 0.222 41.116);
+  --chart-2: oklch(0.6 0.118 184.704);
+  --chart-3: oklch(0.398 0.07 227.392);
+  --chart-4: oklch(0.828 0.189 84.429);
+  --chart-5: oklch(0.769 0.188 70.08);
+  --sidebar: oklch(0.985 0.002 247.839);
+  --sidebar-foreground: oklch(0.13 0.028 261.692);
+  --sidebar-primary: oklch(0.21 0.034 264.665);
+  --sidebar-primary-foreground: oklch(0.985 0.002 247.839);
+  --sidebar-accent: oklch(0.967 0.003 264.542);
+  --sidebar-accent-foreground: oklch(0.21 0.034 264.665);
+  --sidebar-border: oklch(0.928 0.006 264.531);
+  --sidebar-ring: oklch(0.707 0.022 261.325);
+}
+
+.dark {
+  --background: oklch(0.13 0.028 261.692);
+  --foreground: oklch(0.985 0.002 247.839);
+  --card: oklch(0.21 0.034 264.665);
+  --card-foreground: oklch(0.985 0.002 247.839);
+  --popover: oklch(0.21 0.034 264.665);
+  --popover-foreground: oklch(0.985 0.002 247.839);
+  --primary: oklch(0.928 0.006 264.531);
+  --primary-foreground: oklch(0.21 0.034 264.665);
+  --secondary: oklch(0.278 0.033 256.848);
+  --secondary-foreground: oklch(0.985 0.002 247.839);
+  --muted: oklch(0.278 0.033 256.848);
+  --muted-foreground: oklch(0.707 0.022 261.325);
+  --accent: oklch(0.278 0.033 256.848);
+  --accent-foreground: oklch(0.985 0.002 247.839);
+  --destructive: oklch(0.704 0.191 22.216);
+  --border: oklch(1 0 0 / 10%);
+  --input: oklch(1 0 0 / 15%);
+  --ring: oklch(0.551 0.027 264.364);
+  --chart-1: oklch(0.488 0.243 264.376);
+  --chart-2: oklch(0.696 0.17 162.48);
+  --chart-3: oklch(0.769 0.188 70.08);
+  --chart-4: oklch(0.627 0.265 303.9);
+  --chart-5: oklch(0.645 0.246 16.439);
+  --sidebar: oklch(0.21 0.034 264.665);
+  --sidebar-foreground: oklch(0.985 0.002 247.839);
+  --sidebar-primary: oklch(0.488 0.243 264.376);
+  --sidebar-primary-foreground: oklch(0.985 0.002 247.839);
+  --sidebar-accent: oklch(0.278 0.033 256.848);
+  --sidebar-accent-foreground: oklch(0.985 0.002 247.839);
+  --sidebar-border: oklch(1 0 0 / 10%);
+  --sidebar-ring: oklch(0.551 0.027 264.364);
+}
+
+@layer base {
+  * {
+    @apply border-border outline-ring/50;
+  }
+  body {
+    @apply bg-background text-foreground;
+  }
+}

package/src/app/layout.tsx

@@ -0,0 +1,37 @@
+import type { Metadata } from "next";
+import { Geist, Geist_Mono } from "next/font/google";
+import { ErrorBoundary } from "@/components/ErrorBoundary";
+import "./globals.css";
+
+const geistSans = Geist({
+  variable: "--font-geist-sans",
+  subsets: ["latin"],
+});
+
+const geistMono = Geist_Mono({
+  variable: "--font-geist-mono",
+  subsets: ["latin"],
+});
+
+export const metadata: Metadata = {
+  title: "NDPR Toolkit - Nigerian Data Protection Compliance",
+  description: "Open-source toolkit for implementing NDPR and DPA compliant features in Nigerian applications",
+};
+
+export default function RootLayout({
+  children,
+}: Readonly<{
+  children: React.ReactNode;
+}>) {
+  return (
+    <html lang="en">
+      <body
+        className={`${geistSans.variable} ${geistMono.variable} antialiased`}
+      >
+        <ErrorBoundary>
+          {children}
+        </ErrorBoundary>
+      </body>
+    </html>
+  );
+}