@tantainnovative/ndpr-toolkit 1.0.5 → 1.0.7

package/packages/ndpr-toolkit/src/hooks/useDPIA.ts

@@ -1,457 +0,0 @@
-import { useState, useEffect } from 'react';
-import { DPIAQuestion, DPIASection, DPIAResult, DPIARisk } from '../types/dpia';
-import { assessDPIARisk } from '../utils/dpia';
-
-interface UseDPIAOptions {
-  /**
-   * Sections of the DPIA questionnaire
-   */
-  sections: DPIASection[];
-  
-  /**
-   * Initial answers (if resuming a DPIA)
-   */
-  initialAnswers?: Record<string, any>;
-  
-  /**
-   * Storage key for DPIA data
-   * @default "ndpr_dpia_data"
-   */
-  storageKey?: string;
-  
-  /**
-   * Whether to use local storage to persist DPIA data
-   * @default true
-   */
-  useLocalStorage?: boolean;
-  
-  /**
-   * Callback function called when the DPIA is completed
-   */
-  onComplete?: (result: DPIAResult) => void;
-}
-
-interface UseDPIAReturn {
-  /**
-   * Current section index
-   */
-  currentSectionIndex: number;
-  
-  /**
-   * Current section
-   */
-  currentSection: DPIASection | null;
-  
-  /**
-   * All answers
-   */
-  answers: Record<string, any>;
-  
-  /**
-   * Update an answer
-   */
-  updateAnswer: (questionId: string, value: any) => void;
-  
-  /**
-   * Go to the next section
-   */
-  nextSection: () => boolean;
-  
-  /**
-   * Go to the previous section
-   */
-  prevSection: () => boolean;
-  
-  /**
-   * Go to a specific section
-   */
-  goToSection: (index: number) => boolean;
-  
-  /**
-   * Check if the current section is valid
-   */
-  isCurrentSectionValid: () => boolean;
-  
-  /**
-   * Get validation errors for the current section
-   */
-  getCurrentSectionErrors: () => Record<string, string>;
-  
-  /**
-   * Check if the DPIA is complete
-   */
-  isComplete: () => boolean;
-  
-  /**
-   * Complete the DPIA and generate a result
-   */
-  completeDPIA: (assessorInfo: { name: string; role: string; email: string; }, title: string, processingDescription: string) => DPIAResult;
-  
-  /**
-   * Get the visible questions for the current section
-   */
-  getVisibleQuestions: () => DPIAQuestion[];
-  
-  /**
-   * Reset the DPIA
-   */
-  resetDPIA: () => void;
-  
-  /**
-   * Progress percentage
-   */
-  progress: number;
-}
-
-/**
- * Hook for conducting Data Protection Impact Assessments in compliance with NDPR
- */
-export function useDPIA({
-  sections,
-  initialAnswers = {},
-  storageKey = "ndpr_dpia_data",
-  useLocalStorage = true,
-  onComplete
-}: UseDPIAOptions): UseDPIAReturn {
-  const [currentSectionIndex, setCurrentSectionIndex] = useState<number>(0);
-  const [answers, setAnswers] = useState<Record<string, any>>(initialAnswers);
-  
-  // Load DPIA data from storage on mount
-  useEffect(() => {
-    if (useLocalStorage && typeof window !== 'undefined') {
-      try {
-        const savedData = localStorage.getItem(storageKey);
-        if (savedData) {
-          const { answers: savedAnswers, sectionIndex } = JSON.parse(savedData);
-          setAnswers(savedAnswers || {});
-          setCurrentSectionIndex(sectionIndex || 0);
-        }
-      } catch (error) {
-        console.error('Error loading DPIA data:', error);
-      }
-    }
-  }, [storageKey, useLocalStorage]);
-  
-  // Save DPIA data to storage when it changes
-  useEffect(() => {
-    if (useLocalStorage && typeof window !== 'undefined') {
-      try {
-        localStorage.setItem(storageKey, JSON.stringify({
-          answers,
-          sectionIndex: currentSectionIndex
-        }));
-      } catch (error) {
-        console.error('Error saving DPIA data:', error);
-      }
-    }
-  }, [answers, currentSectionIndex, storageKey, useLocalStorage]);
-  
-  // Get the current section
-  const currentSection = sections[currentSectionIndex] || null;
-  
-  // Update an answer
-  const updateAnswer = (questionId: string, value: any) => {
-    setAnswers(prevAnswers => ({
-      ...prevAnswers,
-      [questionId]: value
-    }));
-  };
-  
-  // Check if a question should be shown based on its conditions
-  const shouldShowQuestion = (question: DPIAQuestion): boolean => {
-    if (!question.showWhen) {
-      return true;
-    }
-    
-    return question.showWhen.every(condition => {
-      const answer = answers[condition.questionId];
-      
-      switch (condition.operator) {
-        case 'equals':
-          return answer === condition.value;
-        case 'contains':
-          return Array.isArray(answer) ? answer.includes(condition.value) : false;
-        case 'greaterThan':
-          return typeof answer === 'number' ? answer > condition.value : false;
-        case 'lessThan':
-          return typeof answer === 'number' ? answer < condition.value : false;
-        default:
-          return true;
-      }
-    });
-  };
-  
-  // Get the visible questions for the current section
-  const getVisibleQuestions = (): DPIAQuestion[] => {
-    if (!currentSection) {
-      return [];
-    }
-    
-    return currentSection.questions.filter(shouldShowQuestion);
-  };
-  
-  // Check if the current section is valid
-  const isCurrentSectionValid = (): boolean => {
-    if (!currentSection) {
-      return false;
-    }
-    
-    const visibleQuestions = getVisibleQuestions();
-    
-    return visibleQuestions.every(question => {
-      if (!question.required) {
-        return true;
-      }
-      
-      const answer = answers[question.id];
-      
-      if (answer === undefined || answer === null) {
-        return false;
-      }
-      
-      if (typeof answer === 'string' && answer.trim() === '') {
-        return false;
-      }
-      
-      if (Array.isArray(answer) && answer.length === 0) {
-        return false;
-      }
-      
-      return true;
-    });
-  };
-  
-  // Get validation errors for the current section
-  const getCurrentSectionErrors = (): Record<string, string> => {
-    const errors: Record<string, string> = {};
-    
-    if (!currentSection) {
-      return errors;
-    }
-    
-    const visibleQuestions = getVisibleQuestions();
-    
-    visibleQuestions.forEach(question => {
-      if (!question.required) {
-        return;
-      }
-      
-      const answer = answers[question.id];
-      
-      if (answer === undefined || answer === null) {
-        errors[question.id] = 'This question is required';
-      } else if (typeof answer === 'string' && answer.trim() === '') {
-        errors[question.id] = 'This question is required';
-      } else if (Array.isArray(answer) && answer.length === 0) {
-        errors[question.id] = 'At least one option must be selected';
-      }
-    });
-    
-    return errors;
-  };
-  
-  // Go to the next section
-  const nextSection = (): boolean => {
-    if (!isCurrentSectionValid()) {
-      return false;
-    }
-    
-    if (currentSectionIndex < sections.length - 1) {
-      setCurrentSectionIndex(prevIndex => prevIndex + 1);
-      return true;
-    }
-    
-    return false;
-  };
-  
-  // Go to the previous section
-  const prevSection = (): boolean => {
-    if (currentSectionIndex > 0) {
-      setCurrentSectionIndex(prevIndex => prevIndex - 1);
-      return true;
-    }
-    
-    return false;
-  };
-  
-  // Go to a specific section
-  const goToSection = (index: number): boolean => {
-    if (index >= 0 && index < sections.length) {
-      setCurrentSectionIndex(index);
-      return true;
-    }
-    
-    return false;
-  };
-  
-  // Check if the DPIA is complete
-  const isComplete = (): boolean => {
-    return sections.every((section, index) => {
-      // Temporarily set the current section to check ifit&apos;s valid
-      setCurrentSectionIndex(index);
-      const valid = isCurrentSectionValid();
-      // Restore the current section
-      setCurrentSectionIndex(currentSectionIndex);
-      return valid;
-    });
-  };
-  
-  // Identify risks based on answers
-  const identifyRisks = (): DPIARisk[] => {
-    const risks: DPIARisk[] = [];
-    
-    // Check each question for risk indicators
-    sections.forEach(section => {
-      section.questions.forEach(question => {
-        const answer = answers[question.id];
-        
-        // Skip if no answer
-        if (answer === undefined || answer === null) {
-          return;
-        }
-        
-        // Check if the question has a risk level
-        if (question.riskLevel) {
-          // For select/radio/checkbox questions, check if the selected option has a risk level
-          if (['select', 'radio', 'checkbox'].includes(question.type) && question.options) {
-            const selectedOptions = Array.isArray(answer) ? answer : [answer];
-            
-            selectedOptions.forEach(selectedOption => {
-              const option = question.options?.find(opt => opt.value === selectedOption);
-              
-              if (option?.riskLevel) {
-                const riskLevel = option.riskLevel;
-                const likelihood = riskLevel === 'low' ? 1 : riskLevel === 'medium' ? 3 : 5;
-                const impact = riskLevel === 'low' ? 1 : riskLevel === 'medium' ? 3 : 5;
-                
-                risks.push({
-                  id: `risk_${risks.length + 1}`,
-                  description: `${question.text} - ${option.label}`,
-                  likelihood,
-                  impact,
-                  score: likelihood * impact,
-                  level: riskLevel,
-                  mitigated: false,
-                  relatedQuestionIds: [question.id]
-                });
-              }
-            });
-          } else {
-            // For other question types, use the question's risk level
-            const riskLevel = question.riskLevel;
-            const likelihood = riskLevel === 'low' ? 1 : riskLevel === 'medium' ? 3 : 5;
-            const impact = riskLevel === 'low' ? 1 : riskLevel === 'medium' ? 3 : 5;
-            
-            risks.push({
-              id: `risk_${risks.length + 1}`,
-              description: question.text,
-              likelihood,
-              impact,
-              score: likelihood * impact,
-              level: riskLevel,
-              mitigated: false,
-              relatedQuestionIds: [question.id]
-            });
-          }
-        }
-      });
-    });
-    
-    return risks;
-  };
-  
-  // Complete the DPIA and generate a result
-  const completeDPIA = (
-    assessorInfo: { name: string; role: string; email: string; },
-    title: string,
-    processingDescription: string
-  ): DPIAResult => {
-    const risks = identifyRisks();
-    
-    const result: DPIAResult = {
-      id: `dpia_${Date.now()}`,
-      title,
-      processingDescription,
-      startedAt: Date.now(),
-      completedAt: Date.now(),
-      assessor: assessorInfo,
-      answers,
-      risks,
-      overallRiskLevel: 'low',
-      canProceed: true,
-      conclusion: '',
-      version: '1.0'
-    };
-    
-    // Assess the risks
-    const assessment = assessDPIARisk(result);
-    
-    result.overallRiskLevel = assessment.overallRiskLevel;
-    result.canProceed = assessment.canProceed;
-    result.conclusion = assessment.canProceed
-      ? 'Based on the assessment, the processing can proceed with appropriate safeguards.'
-      : 'Based on the assessment, the processing should not proceed without further mitigation measures.';
-    result.recommendations = assessment.recommendations;
-    
-    if (onComplete) {
-      onComplete(result);
-    }
-    
-    return result;
-  };
-  
-  // Reset the DPIA
-  const resetDPIA = () => {
-    setAnswers({});
-    setCurrentSectionIndex(0);
-    
-    if (useLocalStorage && typeof window !== 'undefined') {
-      localStorage.removeItem(storageKey);
-    }
-  };
-  
-  // Calculate progress percentage
-  const progress = (() => {
-    let answeredQuestions = 0;
-    let totalRequiredQuestions = 0;
-    
-    sections.forEach(section => {
-      section.questions.forEach(question => {
-        if (question.required && shouldShowQuestion(question)) {
-          totalRequiredQuestions++;
-          
-          const answer = answers[question.id];
-          if (
-            answer !== undefined && 
-            answer !== null && 
-            !(typeof answer === 'string' && answer.trim() === '') &&
-            !(Array.isArray(answer) && answer.length === 0)
-          ) {
-            answeredQuestions++;
-          }
-        }
-      });
-    });
-    
-    return totalRequiredQuestions > 0 
-      ? Math.round((answeredQuestions / totalRequiredQuestions) * 100) 
-      : 0;
-  })();
-  
-  return {
-    currentSectionIndex,
-    currentSection,
-    answers,
-    updateAnswer,
-    nextSection,
-    prevSection,
-    goToSection,
-    isCurrentSectionValid,
-    getCurrentSectionErrors,
-    isComplete,
-    completeDPIA,
-    getVisibleQuestions,
-    resetDPIA,
-    progress
-  };
-}

package/packages/ndpr-toolkit/src/hooks/useDSR.ts

@@ -1,236 +0,0 @@
-import { useState, useEffect } from 'react';
-import { DSRRequest, RequestStatus, RequestType } from '../types/dsr';
-import { formatDSRRequest } from '../utils/dsr';
-
-interface UseDSROptions {
-  /**
-   * Initial requests to load
-   */
-  initialRequests?: DSRRequest[];
-  
-  /**
-   * Available request types
-   */
-  requestTypes: RequestType[];
-  
-  /**
-   * Storage key for requests
-   * @default "ndpr_dsr_requests"
-   */
-  storageKey?: string;
-  
-  /**
-   * Whether to use local storage to persist requests
-   * @default true
-   */
-  useLocalStorage?: boolean;
-  
-  /**
-   * Callback function called when a request is submitted
-   */
-  onSubmit?: (request: DSRRequest) => void;
-  
-  /**
-   * Callback function called when a request is updated
-   */
-  onUpdate?: (request: DSRRequest) => void;
-}
-
-interface UseDSRReturn {
-  /**
-   * All requests
-   */
-  requests: DSRRequest[];
-  
-  /**
-   * Submit a new request
-   */
-  submitRequest: (requestData: Omit<DSRRequest, 'id' | 'status' | 'submittedAt' | 'updatedAt' | 'estimatedCompletionDate'>) => DSRRequest;
-  
-  /**
-   * Update an existing request
-   */
-  updateRequest: (id: string, updates: Partial<DSRRequest>) => DSRRequest | null;
-  
-  /**
-   * Get a request by ID
-   */
-  getRequest: (id: string) => DSRRequest | null;
-  
-  /**
-   * Get requests by status
-   */
-  getRequestsByStatus: (status: RequestStatus) => DSRRequest[];
-  
-  /**
-   * Get requests by type
-   */
-  getRequestsByType: (type: string) => DSRRequest[];
-  
-  /**
-   * Get the request type definition by ID
-   */
-  getRequestType: (typeId: string) => RequestType | undefined;
-  
-  /**
-   * Format a request for display or submission
-   */
-  formatRequest: (request: DSRRequest) => Record<string, any>;
-  
-  /**
-   * Clear all requests
-   */
-  clearRequests: () => void;
-}
-
-/**
- * Hook for managing Data Subject Requests in compliance with NDPR
- */
-export function useDSR({
-  initialRequests = [],
-  requestTypes,
-  storageKey = "ndpr_dsr_requests",
-  useLocalStorage = true,
-  onSubmit,
-  onUpdate
-}: UseDSROptions): UseDSRReturn {
-  const [requests, setRequests] = useState<DSRRequest[]>(initialRequests);
-  
-  // Load requests from storage on mount
-  useEffect(() => {
-    if (useLocalStorage && typeof window !== 'undefined') {
-      try {
-        const savedRequests = localStorage.getItem(storageKey);
-        if (savedRequests) {
-          setRequests(JSON.parse(savedRequests));
-        }
-      } catch (error) {
-        console.error('Error loading DSR requests:', error);
-      }
-    }
-  }, [storageKey, useLocalStorage]);
-  
-  // Save requests to storage when they change
-  useEffect(() => {
-    if (useLocalStorage && typeof window !== 'undefined' && requests.length > 0) {
-      try {
-        localStorage.setItem(storageKey, JSON.stringify(requests));
-      } catch (error) {
-        console.error('Error saving DSR requests:', error);
-      }
-    }
-  }, [requests, storageKey, useLocalStorage]);
-  
-  // Generate a unique ID
-  const generateId = (): string => {
-    return 'dsr_' + Date.now() + '_' + Math.random().toString(36).substr(2, 9);
-  };
-  
-  // Submit a new request
-  const submitRequest = (requestData: Omit<DSRRequest, 'id' | 'status' | 'submittedAt' | 'updatedAt' | 'estimatedCompletionDate'>): DSRRequest => {
-    // Find the request type to get the estimated completion time
-    const requestType = requestTypes.find(type => type.id === requestData.type);
-    const estimatedCompletionDays = requestType?.estimatedCompletionTime || 30; // Default to 30 days
-    
-    const now = Date.now();
-    const estimatedCompletionDate = now + (estimatedCompletionDays * 24 * 60 * 60 * 1000);
-    
-    // Extract any properties we want to override from requestData
-    const { createdAt, ...restRequestData } = requestData as any;
-    
-    const newRequest: DSRRequest = {
-      id: generateId(),
-      status: 'pending',
-      createdAt: now,
-      updatedAt: now,
-      dueDate: estimatedCompletionDate,
-      ...restRequestData
-    };
-    
-    setRequests(prevRequests => [...prevRequests, newRequest]);
-    
-    if (onSubmit) {
-      onSubmit(newRequest);
-    }
-    
-    return newRequest;
-  };
-  
-  // Update an existing request
-  const updateRequest = (id: string, updates: Partial<DSRRequest>): DSRRequest | null => {
-    let updatedRequest: DSRRequest | null = null;
-    
-    setRequests(prevRequests => {
-      const index = prevRequests.findIndex(request => request.id === id);
-      
-      if (index === -1) {
-        return prevRequests;
-      }
-      
-      const request = prevRequests[index];
-      updatedRequest = {
-        ...request,
-        ...updates,
-        updatedAt: Date.now()
-      };
-      
-      const newRequests = [...prevRequests];
-      newRequests[index] = updatedRequest as DSRRequest;
-      
-      return newRequests;
-    });
-    
-    if (updatedRequest && onUpdate) {
-      onUpdate(updatedRequest);
-    }
-    
-    return updatedRequest;
-  };
-  
-  // Get a request by ID
-  const getRequest = (id: string): DSRRequest | null => {
-    return requests.find(request => request.id === id) || null;
-  };
-  
-  // Get requests by status
-  const getRequestsByStatus = (status: RequestStatus): DSRRequest[] => {
-    return requests.filter(request => request.status === status);
-  };
-  
-  // Get requests by type
-  const getRequestsByType = (type: string): DSRRequest[] => {
-    return requests.filter(request => request.type === type);
-  };
-  
-  // Get the request type definition by ID
-  const getRequestType = (typeId: string): RequestType | undefined => {
-    return requestTypes.find(type => type.id === typeId);
-  };
-  
-  // Format a request for display or submission
-  const formatRequest = (request: DSRRequest): Record<string, any> => {
-    const { formattedRequest } = formatDSRRequest(request);
-    return formattedRequest;
-  };
-  
-  // Clear all requests
-  const clearRequests = () => {
-    setRequests([]);
-    
-    if (useLocalStorage && typeof window !== 'undefined') {
-      localStorage.removeItem(storageKey);
-    }
-  };
-  
-  return {
-    requests,
-    submitRequest,
-    updateRequest,
-    getRequest,
-    getRequestsByStatus,
-    getRequestsByType,
-    getRequestType,
-    formatRequest,
-    clearRequests
-  };
-}