@tantainnovative/ndpr-toolkit 1.0.3 → 1.0.5

package/packages/ndpr-toolkit/dist/types/privacy.d.ts

@@ -0,0 +1,204 @@
+/**
+ * Represents a section in a privacy policy
+ */
+export interface PolicySection {
+    /**
+     * Unique identifier for the section
+     */
+    id: string;
+    /**
+     * Title of the section
+     */
+    title: string;
+    /**
+     * Description of the section
+     */
+    description?: string;
+    /**
+     * Order of the section in the policy
+     */
+    order?: number;
+    /**
+     * Whether the section is required by NDPR
+     */
+    required: boolean;
+    /**
+     * Template text for the section
+     */
+    template: string;
+    /**
+     * Default content for the section (legacy field)
+     * @deprecated Use template instead
+     */
+    defaultContent?: string;
+    /**
+     * Custom content for the section (overrides default content)
+     * @deprecated Use template instead
+     */
+    customContent?: string;
+    /**
+     * Whether the section is included in the policy
+     */
+    included: boolean;
+    /**
+     * Variables that can be used in the section content
+     */
+    variables?: string[];
+}
+/**
+ * Represents a privacy policy template
+ */
+export interface PolicyTemplate {
+    /**
+     * Unique identifier for the template
+     */
+    id: string;
+    /**
+     * Name of the template
+     */
+    name: string;
+    /**
+     * Description of the template
+     */
+    description: string;
+    /**
+     * Type of organization the template is designed for
+     */
+    organizationType: 'business' | 'nonprofit' | 'government' | 'educational';
+    /**
+     * Sections included in the template
+     */
+    sections: PolicySection[];
+    /**
+     * Variables used across the template
+     */
+    variables: Record<string, {
+        name: string;
+        description: string;
+        required: boolean;
+        defaultValue?: string;
+    }>;
+    /**
+     * Version of the template
+     */
+    version: string;
+    /**
+     * Last updated date of the template
+     */
+    lastUpdated: number;
+}
+/**
+ * Represents organization information for a privacy policy
+ */
+export interface OrganizationInfo {
+    /**
+     * Name of the organization
+     */
+    name: string;
+    /**
+     * Website URL of the organization
+     */
+    website: string;
+    /**
+     * Contact email for privacy inquiries
+     */
+    privacyEmail: string;
+    /**
+     * Physical address of the organization
+     */
+    address?: string;
+    /**
+     * Phone number for privacy inquiries
+     */
+    privacyPhone?: string;
+    /**
+     * Name of the Data Protection Officer (if applicable)
+     */
+    dpoName?: string;
+    /**
+     * Email of the Data Protection Officer (if applicable)
+     */
+    dpoEmail?: string;
+    /**
+     * Industry or sector of the organization
+     */
+    industry?: string;
+}
+/**
+ * Represents a variable in a privacy policy
+ */
+export interface PolicyVariable {
+    /**
+     * Unique identifier for the variable
+     */
+    id: string;
+    /**
+     * Name of the variable as it appears in the template
+     */
+    name: string;
+    /**
+     * Description of the variable
+     */
+    description: string;
+    /**
+     * Default value for the variable
+     */
+    defaultValue?: string;
+    /**
+     * Current value of the variable
+     */
+    value: string;
+    /**
+     * Type of input for the variable
+     */
+    inputType: 'text' | 'textarea' | 'email' | 'url' | 'date' | 'select';
+    /**
+     * Options for select inputs
+     */
+    options?: string[];
+    /**
+     * Whether the variable is required
+     */
+    required: boolean;
+}
+/**
+ * Represents a generated privacy policy
+ */
+export interface PrivacyPolicy {
+    /**
+     * Unique identifier for the policy
+     */
+    id: string;
+    /**
+     * Title of the policy
+     */
+    title: string;
+    /**
+     * Template used to generate the policy
+     */
+    templateId: string;
+    /**
+     * Organization information
+     */
+    organizationInfo: OrganizationInfo;
+    /**
+     * Sections of the policy
+     */
+    sections: PolicySection[];
+    /**
+     * Values for the variables used in the policy
+     */
+    variableValues: Record<string, string>;
+    /**
+     * Effective date of the policy
+     */
+    effectiveDate: number;
+    /**
+     * Last updated date of the policy
+     */
+    lastUpdated: number;
+    /**
+     * Version of the policy
+     */
+    version: string;
+}

package/packages/ndpr-toolkit/dist/utils/breach.d.ts

@@ -0,0 +1,14 @@
+import { BreachReport, RiskAssessment } from '../types/breach';
+/**
+ * Calculates the severity of a data breach based on various factors
+ * @param report The breach report
+ * @param assessment The risk assessment (if available)
+ * @returns The calculated severity and notification requirements
+ */
+export declare function calculateBreachSeverity(report: BreachReport, assessment?: RiskAssessment): {
+    severityLevel: 'low' | 'medium' | 'high' | 'critical';
+    notificationRequired: boolean;
+    urgentNotificationRequired: boolean;
+    timeframeHours: number;
+    justification: string;
+};

package/packages/ndpr-toolkit/dist/utils/consent.d.ts

@@ -0,0 +1,10 @@
+import { ConsentSettings } from '../types/consent';
+/**
+ * Validates consent settings to ensure they meet NDPR requirements
+ * @param settings The consent settings to validate
+ * @returns An object containing validation result and any error messages
+ */
+export declare function validateConsent(settings: ConsentSettings): {
+    valid: boolean;
+    errors: string[];
+};

package/packages/ndpr-toolkit/dist/utils/dpia.d.ts

@@ -0,0 +1,12 @@
+import { DPIAResult } 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 declare function assessDPIARisk(dpiaResult: DPIAResult): {
+    overallRiskLevel: 'low' | 'medium' | 'high' | 'critical';
+    requiresConsultation: boolean;
+    canProceed: boolean;
+    recommendations: string[];
+};

package/packages/ndpr-toolkit/dist/utils/dsr.d.ts

@@ -0,0 +1,11 @@
+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 declare function formatDSRRequest(request: DSRRequest): {
+    formattedRequest: Record<string, any>;
+    isValid: boolean;
+    validationErrors: string[];
+};

package/packages/ndpr-toolkit/dist/utils/privacy.d.ts

@@ -0,0 +1,12 @@
+import { PolicySection, OrganizationInfo } 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 declare function generatePolicyText(sectionsOrTemplate: PolicySection[] | string, organizationInfoOrVariables: OrganizationInfo | Record<string, string>): string | {
+    fullText: string;
+    sectionTexts: Record<string, string>;
+    missingVariables: string[];
+};

package/src/components/consent/ConsentBanner.tsx

@@ -1,11 +1,18 @@
-'use client';
+"use client";
 
-import { useState } from 'react';
-import { ConsentOption } from '@/types';
-import { Button } from '@/components/ui/Button';
-import { Checkbox } from '@/components/ui/Checkbox';
-import { Card, CardContent, CardFooter, CardHeader, CardTitle, CardDescription } from '@/components/ui/Card';
-import { Badge } from '@/components/ui/Badge';
+import { useState } from "react";
+import { ConsentOption } from "@/types";
+import { Button } from "@/components/ui/Button";
+import { Checkbox } from "@/components/ui/Checkbox";
+import {
+  Card,
+  CardContent,
+  CardFooter,
+  CardHeader,
+  CardTitle,
+  CardDescription,
+} from "@/components/ui/Card";
+import { Badge } from "@/components/ui/Badge";
 
 interface ConsentBannerProps {
   title?: string;
@@ -18,36 +25,42 @@ interface ConsentBannerProps {
 }
 
 export default function ConsentBanner({
-  title = 'Privacy Preferences',
-  description = 'We use cookies and similar technologies to provide certain features, enhance the user experience and deliver content that is relevant to your interests.',
-  privacyPolicyUrl = '/privacy-policy',
+  title = "Privacy Preferences",
+  description = "We use cookies and similar technologies to provide certain features, enhance the user experience and deliver content that is relevant to your interests.",
+  privacyPolicyUrl = "/privacy-policy",
   options,
   onSave,
-  className = '',
+  className = "",
 }: ConsentBannerProps) {
   const [consents, setConsents] = useState<Record<string, boolean>>(
-    options.reduce((acc, option) => {
-      acc[option.id] = option.defaultValue ?? false;
-      return acc;
-    }, {} as Record<string, boolean>)
+    options.reduce(
+      (acc, option) => {
+        acc[option.id] = option.defaultValue ?? false;
+        return acc;
+      },
+      {} as Record<string, boolean>,
+    ),
   );
 
   const handleToggle = (id: string) => {
-    const option = options.find(opt => opt.id === id);
+    const option = options.find((opt) => opt.id === id);
     if (option?.required) return;
-    
-    setConsents(prev => ({
+
+    setConsents((prev) => ({
       ...prev,
-      [id]: !prev[id]
+      [id]: !prev[id],
     }));
   };
 
   const handleAcceptAll = () => {
-    const allConsents = options.reduce((acc, option) => {
-      acc[option.id] = true;
-      return acc;
-    }, {} as Record<string, boolean>);
-    
+    const allConsents = options.reduce(
+      (acc, option) => {
+        acc[option.id] = true;
+        return acc;
+      },
+      {} as Record<string, boolean>,
+    );
+
     setConsents(allConsents);
     onSave(allConsents);
   };
@@ -57,17 +70,22 @@ export default function ConsentBanner({
   };
 
   const handleRejectAll = () => {
-    const rejectedConsents = options.reduce((acc, option) => {
-      acc[option.id] = option.required ? true : false;
-      return acc;
-    }, {} as Record<string, boolean>);
-    
+    const rejectedConsents = options.reduce(
+      (acc, option) => {
+        acc[option.id] = option.required ? true : false;
+        return acc;
+      },
+      {} as Record<string, boolean>,
+    );
+
     setConsents(rejectedConsents);
     onSave(rejectedConsents);
   };
 
   return (
-    <div className={`fixed inset-0 z-50 flex items-end sm:items-center justify-center p-4 bg-black/50 ${className}`}>
+    <div
+      className={`fixed inset-0 z-50 flex items-end sm:items-center justify-center p-4 bg-black/50 ${className}`}
+    >
       <Card className="w-full max-w-3xl max-h-[90vh] overflow-auto shadow-xl animate-in fade-in slide-in-from-bottom-5 duration-300">
         <CardHeader className="border-b border-gray-200 dark:border-gray-700">
           <div className="flex items-center justify-between">
@@ -75,25 +93,38 @@ export default function ConsentBanner({
               <CardTitle className="text-xl">{title}</CardTitle>
               <CardDescription className="mt-2">{description}</CardDescription>
             </div>
-            <Badge variant="primary" className="hidden sm:flex">Privacy Settings</Badge>
+            <Badge variant="primary" className="hidden sm:flex">
+              Privacy Settings
+            </Badge>
           </div>
-          <a 
-            href={privacyPolicyUrl} 
+          <a
+            href={privacyPolicyUrl}
             className="text-sm text-blue-600 dark:text-blue-400 hover:underline mt-2 inline-flex items-center"
           >
-            <svg className="w-4 h-4 mr-1" fill="none" stroke="currentColor" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg">
-              <path strokeLinecap="round" strokeLinejoin="round" strokeWidth={2} d="M13.828 10.172a4 4 0 00-5.656 0l-4 4a4 4 0 105.656 5.656l1.102-1.101m-.758-4.899a4 4 0 005.656 0l4-4a4 4 0 00-5.656-5.656l-1.1 1.1" />
+            <svg
+              className="w-4 h-4 mr-1"
+              fill="none"
+              stroke="currentColor"
+              viewBox="0 0 24 24"
+              xmlns="http://www.w3.org/2000/svg"
+            >
+              <path
+                strokeLinecap="round"
+                strokeLinejoin="round"
+                strokeWidth={2}
+                d="M13.828 10.172a4 4 0 00-5.656 0l-4 4a4 4 0 105.656 5.656l1.102-1.101m-.758-4.899a4 4 0 005.656 0l4-4a4 4 0 00-5.656-5.656l-1.1 1.1"
+              />
             </svg>
             View our Privacy Policy
           </a>
         </CardHeader>
-        
+
         <CardContent className="space-y-4 p-6">
           <div className="grid gap-4">
             {options.map((option) => (
-              <div 
-                key={option.id} 
-                className={`p-4 rounded-lg border ${consents[option.id] ? 'border-blue-200 bg-blue-50 dark:border-blue-800 dark:bg-blue-900/20' : 'border-gray-200 dark:border-gray-700'} transition-colors duration-200`}
+              <div
+                key={option.id}
+                className={`p-4 rounded-lg border ${consents[option.id] ? "border-blue-200 bg-blue-50 dark:border-blue-800 dark:bg-blue-900/20" : "border-gray-200 dark:border-gray-700"} transition-colors duration-200`}
               >
                 <div className="flex items-start">
                   <div className="flex-1">
@@ -102,7 +133,9 @@ export default function ConsentBanner({
                         {option.label}
                       </h3>
                       {option.required && (
-                        <Badge variant="secondary" className="ml-2 text-xs">Required</Badge>
+                        <Badge variant="secondary" className="ml-2 text-xs">
+                          Required
+                        </Badge>
                       )}
                     </div>
                     <p className="mt-1 text-sm text-gray-500 dark:text-gray-400">
@@ -122,30 +155,31 @@ export default function ConsentBanner({
             ))}
           </div>
         </CardContent>
-        
+
         <CardFooter className="flex flex-col sm:flex-row sm:justify-between border-t border-gray-200 dark:border-gray-700 p-6 bg-gray-50 dark:bg-gray-800">
           <div className="mb-4 sm:mb-0">
             <p className="text-xs text-gray-500 dark:text-gray-400">
-              You can change your preferences at any time by visiting your account settings.
+              You can change your preferences at any time by visiting your
+              account settings.
             </p>
           </div>
           <div className="flex flex-col sm:flex-row space-y-2 sm:space-y-0 sm:space-x-2">
-            <Button 
-              variant="outline" 
+            <Button
+              variant="outline"
               onClick={handleRejectAll}
               className="sm:order-1"
             >
               Reject All
             </Button>
-            <Button 
-              variant="secondary" 
+            <Button
+              variant="secondary"
               onClick={handleSave}
               className="sm:order-2"
             >
               Save Preferences
             </Button>
-            <Button 
-              variant="default" 
+            <Button
+              variant="default"
               onClick={handleAcceptAll}
               className="sm:order-3"
             >