@tantainnovative/ndpr-toolkit 1.0.4 → 1.0.6

package/dist/components/breach/BreachRiskAssessment.d.ts

@@ -0,0 +1,50 @@
+import React from 'react';
+import { BreachReport, RiskAssessment } from '../../types/breach';
+export interface BreachRiskAssessmentProps {
+    /**
+     * The breach data to assess
+     */
+    breachData: BreachReport;
+    /**
+     * Initial assessment data (if editing an existing assessment)
+     */
+    initialAssessment?: Partial<RiskAssessment>;
+    /**
+     * Callback function called when assessment is completed
+     */
+    onComplete: (assessment: RiskAssessment) => void;
+    /**
+     * Title displayed on the assessment form
+     * @default "Breach Risk Assessment"
+     */
+    title?: string;
+    /**
+     * Description text displayed on the assessment form
+     * @default "Assess the risk level of this data breach to determine notification requirements."
+     */
+    description?: string;
+    /**
+     * Text for the submit button
+     * @default "Complete Assessment"
+     */
+    submitButtonText?: string;
+    /**
+     * Custom CSS class for the form
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the submit button
+     */
+    buttonClassName?: string;
+    /**
+     * Whether to show the breach summary
+     * @default true
+     */
+    showBreachSummary?: boolean;
+    /**
+     * Whether to show notification requirements after assessment
+     * @default true
+     */
+    showNotificationRequirements?: boolean;
+}
+export declare const BreachRiskAssessment: React.FC<BreachRiskAssessmentProps>;

package/dist/components/breach/RegulatoryReportGenerator.d.ts

@@ -0,0 +1,94 @@
+import React from 'react';
+import { BreachReport, RiskAssessment, RegulatoryNotification } from '../../types/breach';
+export interface OrganizationInfo {
+    /**
+     * Name of the organization
+     */
+    name: string;
+    /**
+     * Registration number or business ID
+     */
+    registrationNumber?: string;
+    /**
+     * Physical address of the organization
+     */
+    address: string;
+    /**
+     * Website URL
+     */
+    website?: string;
+    /**
+     * Name of the Data Protection Officer
+     */
+    dpoName: string;
+    /**
+     * Email of the Data Protection Officer
+     */
+    dpoEmail: string;
+    /**
+     * Phone number of the Data Protection Officer
+     */
+    dpoPhone?: string;
+}
+export interface RegulatoryReportGeneratorProps {
+    /**
+     * The breach data to include in the report
+     */
+    breachData: BreachReport;
+    /**
+     * The risk assessment data
+     */
+    assessmentData?: RiskAssessment;
+    /**
+     * Organization information to include in the report
+     */
+    organizationInfo: OrganizationInfo;
+    /**
+     * Callback function called when the report is generated
+     */
+    onGenerate: (report: RegulatoryNotification) => void;
+    /**
+     * Title displayed on the generator form
+     * @default "Generate NITDA Notification Report"
+     */
+    title?: string;
+    /**
+     * Description text displayed on the generator form
+     * @default "Generate a report for submission to NITDA in compliance with the NDPR breach notification requirements."
+     */
+    description?: string;
+    /**
+     * Text for the generate button
+     * @default "Generate Report"
+     */
+    generateButtonText?: string;
+    /**
+     * Custom CSS class for the form
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the buttons
+     */
+    buttonClassName?: string;
+    /**
+     * Whether to show a preview of the generated report
+     * @default true
+     */
+    showPreview?: boolean;
+    /**
+     * Whether to allow editing the report content
+     * @default true
+     */
+    allowEditing?: boolean;
+    /**
+     * Whether to allow downloading the report
+     * @default true
+     */
+    allowDownload?: boolean;
+    /**
+     * Format for downloading the report
+     * @default "pdf"
+     */
+    downloadFormat?: 'pdf' | 'docx' | 'html';
+}
+export declare const RegulatoryReportGenerator: React.FC<RegulatoryReportGeneratorProps>;

package/dist/components/consent/ConsentBanner.d.ts

@@ -0,0 +1,79 @@
+import React from 'react';
+import { ConsentOption, ConsentSettings } from '../../types/consent';
+export interface ConsentBannerProps {
+    /**
+     * Array of consent options to display
+     */
+    options: ConsentOption[];
+    /**
+     * Callback function called when user saves their consent choices
+     */
+    onSave: (settings: ConsentSettings) => void;
+    /**
+     * Title displayed on the banner
+     * @default "We Value Your Privacy"
+     */
+    title?: string;
+    /**
+     * Description text displayed on the banner
+     * @default "We use cookies and similar technologies to provide our services and enhance your experience."
+     */
+    description?: string;
+    /**
+     * Text for the accept all button
+     * @default "Accept All"
+     */
+    acceptAllButtonText?: string;
+    /**
+     * Text for the reject all button
+     * @default "Reject All"
+     */
+    rejectAllButtonText?: string;
+    /**
+     * Text for the customize button
+     * @default "Customize"
+     */
+    customizeButtonText?: string;
+    /**
+     * Text for the save button
+     * @default "Save Preferences"
+     */
+    saveButtonText?: string;
+    /**
+     * Position of the banner
+     * @default "bottom"
+     */
+    position?: 'top' | 'bottom' | 'center';
+    /**
+     * Version of the consent form
+     * @default "1.0"
+     */
+    version?: string;
+    /**
+     * Whether to show the banner
+     * If not provided, the banner will be shown if no consent has been saved
+     */
+    show?: boolean;
+    /**
+     * Storage key for consent settings
+     * @default "ndpr_consent"
+     */
+    storageKey?: string;
+    /**
+     * Custom CSS class for the banner
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the buttons
+     */
+    buttonClassName?: string;
+    /**
+     * Custom CSS class for the primary button
+     */
+    primaryButtonClassName?: string;
+    /**
+     * Custom CSS class for the secondary button
+     */
+    secondaryButtonClassName?: string;
+}
+export declare const ConsentBanner: React.FC<ConsentBannerProps>;

package/dist/components/consent/ConsentManager.d.ts

@@ -0,0 +1,73 @@
+import React from 'react';
+import { ConsentOption, ConsentSettings } from '../../types/consent';
+export interface ConsentManagerProps {
+    /**
+     * Array of consent options to display
+     */
+    options: ConsentOption[];
+    /**
+     * Current consent settings
+     */
+    settings?: ConsentSettings;
+    /**
+     * Callback function called when user saves their consent choices
+     */
+    onSave: (settings: ConsentSettings) => void;
+    /**
+     * Title displayed in the manager
+     * @default "Manage Your Privacy Settings"
+     */
+    title?: string;
+    /**
+     * Description text displayed in the manager
+     * @default "Update your consent preferences at any time. Required cookies cannot be disabled as they are necessary for the website to function."
+     */
+    description?: string;
+    /**
+     * Text for the save button
+     * @default "Save Preferences"
+     */
+    saveButtonText?: string;
+    /**
+     * Text for the reset button
+     * @default "Reset to Defaults"
+     */
+    resetButtonText?: string;
+    /**
+     * Version of the consent form
+     * @default "1.0"
+     */
+    version?: string;
+    /**
+     * Custom CSS class for the manager
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the buttons
+     */
+    buttonClassName?: string;
+    /**
+     * Custom CSS class for the primary button
+     */
+    primaryButtonClassName?: string;
+    /**
+     * Custom CSS class for the secondary button
+     */
+    secondaryButtonClassName?: string;
+    /**
+     * Whether to show a success message after saving
+     * @default true
+     */
+    showSuccessMessage?: boolean;
+    /**
+     * Success message to display after saving
+     * @default "Your preferences have been saved."
+     */
+    successMessage?: string;
+    /**
+     * Duration to show the success message (in milliseconds)
+     * @default 3000
+     */
+    successMessageDuration?: number;
+}
+export declare const ConsentManager: React.FC<ConsentManagerProps>;

package/dist/components/consent/ConsentStorage.d.ts

@@ -0,0 +1,41 @@
+import React from 'react';
+import { ConsentSettings, ConsentStorageOptions } from '../../types/consent';
+export interface ConsentStorageProps {
+    /**
+     * Current consent settings
+     */
+    settings: ConsentSettings;
+    /**
+     * Storage options for consent settings
+     */
+    storageOptions?: ConsentStorageOptions;
+    /**
+     * Callback function called when settings are loaded from storage
+     */
+    onLoad?: (settings: ConsentSettings | null) => void;
+    /**
+     * Callback function called when settings are saved to storage
+     */
+    onSave?: (settings: ConsentSettings) => void;
+    /**
+     * Whether to automatically save settings to storage
+     * @default true
+     */
+    autoSave?: boolean;
+    /**
+     * Whether to automatically load settings from storage on mount
+     * @default true
+     */
+    autoLoad?: boolean;
+    /**
+     * Children to render
+     * Can be either React nodes or a render prop function that receives storage methods
+     */
+    children?: React.ReactNode | ((props: {
+        loadSettings: () => ConsentSettings | null;
+        saveSettings: (settings: ConsentSettings) => void;
+        clearSettings: () => void;
+        loaded: boolean;
+    }) => React.ReactNode);
+}
+export declare const ConsentStorage: ({ settings, storageOptions, onLoad, onSave, autoSave, autoLoad, children }: ConsentStorageProps) => React.ReactElement | null;

package/dist/components/dpia/DPIAQuestionnaire.d.ts

@@ -0,0 +1,70 @@
+import React from 'react';
+import { DPIASection } from '../../types/dpia';
+export interface DPIAQuestionnaireProps {
+    /**
+     * Sections of the DPIA questionnaire
+     */
+    sections: DPIASection[];
+    /**
+     * Current answers to the questionnaire
+     */
+    answers: Record<string, any>;
+    /**
+     * Callback function called when an answer is updated
+     */
+    onAnswerChange: (questionId: string, value: any) => void;
+    /**
+     * Current section index
+     */
+    currentSectionIndex: number;
+    /**
+     * Callback function called when user navigates to the next section
+     */
+    onNextSection?: () => void;
+    /**
+     * Callback function called when user navigates to the previous section
+     */
+    onPrevSection?: () => void;
+    /**
+     * Validation errors for the current section
+     */
+    validationErrors?: Record<string, string>;
+    /**
+     * Whether the questionnaire is in read-only mode
+     * @default false
+     */
+    readOnly?: boolean;
+    /**
+     * Custom CSS class for the questionnaire
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the buttons
+     */
+    buttonClassName?: string;
+    /**
+     * Text for the next button
+     * @default "Next"
+     */
+    nextButtonText?: string;
+    /**
+     * Text for the previous button
+     * @default "Previous"
+     */
+    prevButtonText?: string;
+    /**
+     * Text for the submit button (shown on the last section)
+     * @default "Submit"
+     */
+    submitButtonText?: string;
+    /**
+     * Whether to show a progress indicator
+     * @default true
+     */
+    showProgress?: boolean;
+    /**
+     * Current progress percentage (0-100)
+     */
+    progress?: number;
+}
+export declare const DPIAQuestionnaire: React.FC<DPIAQuestionnaireProps>;

package/dist/components/dpia/DPIAReport.d.ts

@@ -0,0 +1,40 @@
+import React from 'react';
+import { DPIAResult, DPIASection } from '../../types/dpia';
+export interface DPIAReportProps {
+    /**
+     * The DPIA result to display
+     */
+    result: DPIAResult;
+    /**
+     * The sections of the DPIA questionnaire
+     */
+    sections: DPIASection[];
+    /**
+     * Whether to show the full report or just a summary
+     * @default true
+     */
+    showFullReport?: boolean;
+    /**
+     * Whether to allow printing the report
+     * @default true
+     */
+    allowPrint?: boolean;
+    /**
+     * Whether to allow exporting the report as PDF
+     * @default true
+     */
+    allowExport?: boolean;
+    /**
+     * Callback function called when the report is exported
+     */
+    onExport?: (format: 'pdf' | 'docx' | 'html') => void;
+    /**
+     * Custom CSS class for the report container
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the buttons
+     */
+    buttonClassName?: string;
+}
+export declare const DPIAReport: React.FC<DPIAReportProps>;

package/dist/components/dpia/StepIndicator.d.ts

@@ -0,0 +1,64 @@
+import React from 'react';
+export interface Step {
+    /**
+     * Unique identifier for the step
+     */
+    id: string;
+    /**
+     * Display label for the step
+     */
+    label: string;
+    /**
+     * Optional description for the step
+     */
+    description?: string;
+    /**
+     * Whether the step is completed
+     */
+    completed: boolean;
+    /**
+     * Whether the step is the current active step
+     */
+    active: boolean;
+    /**
+     * Optional icon for the step
+     */
+    icon?: React.ReactNode;
+}
+export interface StepIndicatorProps {
+    /**
+     * Array of steps to display
+     */
+    steps: Step[];
+    /**
+     * Callback function called when a step is clicked
+     */
+    onStepClick?: (stepId: string) => void;
+    /**
+     * Whether the steps are clickable
+     * @default true
+     */
+    clickable?: boolean;
+    /**
+     * Orientation of the step indicator
+     * @default "horizontal"
+     */
+    orientation?: 'horizontal' | 'vertical';
+    /**
+     * Custom CSS class for the container
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the active step
+     */
+    activeStepClassName?: string;
+    /**
+     * Custom CSS class for completed steps
+     */
+    completedStepClassName?: string;
+    /**
+     * Custom CSS class for incomplete steps
+     */
+    incompleteStepClassName?: string;
+}
+export declare const StepIndicator: React.FC<StepIndicatorProps>;

package/dist/components/dsr/DSRDashboard.d.ts

@@ -0,0 +1,58 @@
+import React from 'react';
+import { DSRRequest, DSRStatus } from '../../types/dsr';
+export interface DSRDashboardProps {
+    /**
+     * List of DSR requests to display
+     */
+    requests: DSRRequest[];
+    /**
+     * Callback function called when a request is selected
+     */
+    onSelectRequest?: (requestId: string) => void;
+    /**
+     * Callback function called when a request status is updated
+     */
+    onUpdateStatus?: (requestId: string, status: DSRStatus) => void;
+    /**
+     * Callback function called when a request is assigned
+     */
+    onAssignRequest?: (requestId: string, assignee: string) => void;
+    /**
+     * Title displayed on the dashboard
+     * @default "Data Subject Request Dashboard"
+     */
+    title?: string;
+    /**
+     * Description text displayed on the dashboard
+     * @default "Track and manage data subject requests in compliance with NDPR requirements."
+     */
+    description?: string;
+    /**
+     * Custom CSS class for the dashboard
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the buttons
+     */
+    buttonClassName?: string;
+    /**
+     * Whether to show the request details
+     * @default true
+     */
+    showRequestDetails?: boolean;
+    /**
+     * Whether to show the request timeline
+     * @default true
+     */
+    showRequestTimeline?: boolean;
+    /**
+     * Whether to show the deadline alerts
+     * @default true
+     */
+    showDeadlineAlerts?: boolean;
+    /**
+     * List of possible assignees
+     */
+    assignees?: string[];
+}
+export declare const DSRDashboard: React.FC<DSRDashboardProps>;

package/dist/components/dsr/DSRRequestForm.d.ts

@@ -0,0 +1,74 @@
+import React from 'react';
+import { RequestType } from '../../types/dsr';
+export interface DSRRequestFormProps {
+    /**
+     * Array of request types that can be submitted
+     */
+    requestTypes: RequestType[];
+    /**
+     * Callback function called when form is submitted
+     */
+    onSubmit: (formData: any) => void;
+    /**
+     * Title displayed on the form
+     * @default "Submit a Data Subject Request"
+     */
+    title?: string;
+    /**
+     * Description text displayed on the form
+     * @default "Use this form to exercise your rights under the Nigeria Data Protection Regulation (NDPR)."
+     */
+    description?: string;
+    /**
+     * Text for the submit button
+     * @default "Submit Request"
+     */
+    submitButtonText?: string;
+    /**
+     * Custom CSS class for the form
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the submit button
+     */
+    buttonClassName?: string;
+    /**
+     * Whether to show a confirmation message after submission
+     * @default true
+     */
+    showConfirmation?: boolean;
+    /**
+     * Confirmation message to display after submission
+     * @default "Your request has been submitted successfully. You will receive a confirmation email shortly."
+     */
+    confirmationMessage?: string;
+    /**
+     * Whether to require identity verification
+     * @default true
+     */
+    requireIdentityVerification?: boolean;
+    /**
+     * Types of identifiers accepted for verification
+     * @default ["email", "account", "customer_id"]
+     */
+    identifierTypes?: Array<{
+        id: string;
+        label: string;
+    }>;
+    /**
+     * Whether to collect additional contact information
+     * @default true
+     */
+    collectAdditionalContact?: boolean;
+    /**
+     * Custom labels for form fields
+     */
+    labels?: {
+        name?: string;
+        email?: string;
+        requestType?: string;
+        description?: string;
+        submit?: string;
+    };
+}
+export declare const DSRRequestForm: React.FC<DSRRequestFormProps>;

package/dist/components/dsr/DSRTracker.d.ts

@@ -0,0 +1,56 @@
+import React from 'react';
+import { DSRRequest } from '../../types/dsr';
+export interface DSRTrackerProps {
+    /**
+     * List of DSR requests to track
+     */
+    requests: DSRRequest[];
+    /**
+     * Callback function called when a request is selected
+     */
+    onSelectRequest?: (requestId: string) => void;
+    /**
+     * Title displayed on the tracker
+     * @default "DSR Request Tracker"
+     */
+    title?: string;
+    /**
+     * Description text displayed on the tracker
+     * @default "Track the status and progress of data subject requests."
+     */
+    description?: string;
+    /**
+     * Custom CSS class for the tracker
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the buttons
+     */
+    buttonClassName?: string;
+    /**
+     * Whether to show the summary statistics
+     * @default true
+     */
+    showSummaryStats?: boolean;
+    /**
+     * Whether to show the request type breakdown
+     * @default true
+     */
+    showTypeBreakdown?: boolean;
+    /**
+     * Whether to show the status breakdown
+     * @default true
+     */
+    showStatusBreakdown?: boolean;
+    /**
+     * Whether to show the timeline chart
+     * @default true
+     */
+    showTimelineChart?: boolean;
+    /**
+     * Whether to show the overdue requests
+     * @default true
+     */
+    showOverdueRequests?: boolean;
+}
+export declare const DSRTracker: React.FC<DSRTrackerProps>;