@tantainnovative/ndpr-toolkit 1.0.2 → 1.0.3

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

@@ -1,64 +0,0 @@
-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

@@ -1,58 +0,0 @@
-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

@@ -1,74 +0,0 @@
-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

@@ -1,56 +0,0 @@
-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>;

package/dist/components/policy/PolicyExporter.d.ts

@@ -1,65 +0,0 @@
-import React from 'react';
-export interface PolicyExporterProps {
-    /**
-     * The policy content to export
-     */
-    content: string;
-    /**
-     * The policy title
-     */
-    title?: string;
-    /**
-     * The organization name to include in the exported policy
-     */
-    organizationName?: string;
-    /**
-     * The last updated date to include in the exported policy
-     */
-    lastUpdated?: Date;
-    /**
-     * Callback function called when the export is complete
-     */
-    onExportComplete?: (format: string, url: string) => void;
-    /**
-     * Title displayed on the exporter
-     * @default "Export Privacy Policy"
-     */
-    componentTitle?: string;
-    /**
-     * Description text displayed on the exporter
-     * @default "Export your NDPR-compliant privacy policy in various formats."
-     */
-    description?: string;
-    /**
-     * Custom CSS class for the exporter
-     */
-    className?: string;
-    /**
-     * Custom CSS class for the buttons
-     */
-    buttonClassName?: string;
-    /**
-     * Whether to show the export history
-     * @default true
-     */
-    showExportHistory?: boolean;
-    /**
-     * Whether to include the NDPR compliance notice in the exported policy
-     * @default true
-     */
-    includeComplianceNotice?: boolean;
-    /**
-     * Whether to include the organization logo in the exported policy
-     * @default false
-     */
-    includeLogo?: boolean;
-    /**
-     * URL of the organization logo
-     */
-    logoUrl?: string;
-    /**
-     * Custom CSS styles for the exported policy
-     */
-    customStyles?: string;
-}
-export declare const PolicyExporter: React.FC<PolicyExporterProps>;

package/dist/components/policy/PolicyGenerator.d.ts

@@ -1,54 +0,0 @@
-import React from 'react';
-import { PolicySection, PolicyVariable } from '../../types/privacy';
-export interface PolicyGeneratorProps {
-    /**
-     * List of policy sections
-     */
-    sections: PolicySection[];
-    /**
-     * List of policy variables
-     */
-    variables: PolicyVariable[];
-    /**
-     * Callback function called when the policy is generated
-     */
-    onGenerate: (policy: {
-        sections: PolicySection[];
-        variables: PolicyVariable[];
-        content: string;
-    }) => void;
-    /**
-     * Title displayed on the generator
-     * @default "NDPR Privacy Policy Generator"
-     */
-    title?: string;
-    /**
-     * Description text displayed on the generator
-     * @default "Generate an NDPR-compliant privacy policy for your organization."
-     */
-    description?: string;
-    /**
-     * Custom CSS class for the generator
-     */
-    className?: string;
-    /**
-     * Custom CSS class for the buttons
-     */
-    buttonClassName?: string;
-    /**
-     * Text for the generate button
-     * @default "Generate Policy"
-     */
-    generateButtonText?: string;
-    /**
-     * Whether to show a preview of the generated policy
-     * @default true
-     */
-    showPreview?: boolean;
-    /**
-     * Whether to allow editing the policy content
-     * @default true
-     */
-    allowEditing?: boolean;
-}
-export declare const PolicyGenerator: React.FC<PolicyGeneratorProps>;

package/dist/components/policy/PolicyPreview.d.ts

@@ -1,71 +0,0 @@
-import React from 'react';
-import { PolicySection, PolicyVariable } from '../../types/privacy';
-export interface PolicyPreviewProps {
-    /**
-     * The policy content to preview
-     */
-    content: string;
-    /**
-     * The policy sections
-     */
-    sections?: PolicySection[];
-    /**
-     * The policy variables
-     */
-    variables?: PolicyVariable[];
-    /**
-     * Callback function called when the policy is exported
-     */
-    onExport?: (format: 'pdf' | 'html' | 'markdown' | 'docx') => void;
-    /**
-     * Callback function called when the policy is edited
-     */
-    onEdit?: () => void;
-    /**
-     * Title displayed on the preview
-     * @default "Privacy Policy Preview"
-     */
-    title?: string;
-    /**
-     * Description text displayed on the preview
-     * @default "Preview your NDPR-compliant privacy policy before exporting."
-     */
-    description?: string;
-    /**
-     * Custom CSS class for the preview
-     */
-    className?: string;
-    /**
-     * Custom CSS class for the buttons
-     */
-    buttonClassName?: string;
-    /**
-     * Whether to show the export options
-     * @default true
-     */
-    showExportOptions?: boolean;
-    /**
-     * Whether to show the edit button
-     * @default true
-     */
-    showEditButton?: boolean;
-    /**
-     * Whether to show the table of contents
-     * @default true
-     */
-    showTableOfContents?: boolean;
-    /**
-     * Whether to show the policy metadata
-     * @default true
-     */
-    showMetadata?: boolean;
-    /**
-     * The organization name to display in the policy
-     */
-    organizationName?: string;
-    /**
-     * The last updated date to display in the policy
-     */
-    lastUpdated?: Date;
-}
-export declare const PolicyPreview: React.FC<PolicyPreviewProps>;

package/dist/hooks/useBreach.d.ts

@@ -1,97 +0,0 @@
-import { BreachReport, BreachCategory, RiskAssessment, NotificationRequirement, RegulatoryNotification } from '../types/breach';
-interface UseBreachOptions {
-    /**
-     * Available breach categories
-     */
-    categories: BreachCategory[];
-    /**
-     * Initial breach reports
-     */
-    initialReports?: BreachReport[];
-    /**
-     * Storage key for breach data
-     * @default "ndpr_breach_data"
-     */
-    storageKey?: string;
-    /**
-     * Whether to use local storage to persist breach data
-     * @default true
-     */
-    useLocalStorage?: boolean;
-    /**
-     * Callback function called when a breach is reported
-     */
-    onReport?: (report: BreachReport) => void;
-    /**
-     * Callback function called when a risk assessment is completed
-     */
-    onAssessment?: (assessment: RiskAssessment) => void;
-    /**
-     * Callback function called when a notification is sent
-     */
-    onNotification?: (notification: RegulatoryNotification) => void;
-}
-interface UseBreachReturn {
-    /**
-     * All breach reports
-     */
-    reports: BreachReport[];
-    /**
-     * All risk assessments
-     */
-    assessments: RiskAssessment[];
-    /**
-     * All regulatory notifications
-     */
-    notifications: RegulatoryNotification[];
-    /**
-     * Submit a new breach report
-     */
-    reportBreach: (reportData: Omit<BreachReport, 'id' | 'reportedAt'>) => BreachReport;
-    /**
-     * Update an existing breach report
-     */
-    updateReport: (id: string, updates: Partial<BreachReport>) => BreachReport | null;
-    /**
-     * Get a breach report by ID
-     */
-    getReport: (id: string) => BreachReport | null;
-    /**
-     * Conduct a risk assessment for a breach
-     */
-    assessRisk: (breachId: string, assessmentData: Omit<RiskAssessment, 'id' | 'breachId' | 'assessedAt'>) => RiskAssessment;
-    /**
-     * Get a risk assessment for a breach
-     */
-    getAssessment: (breachId: string) => RiskAssessment | null;
-    /**
-     * Calculate notification requirements based on a risk assessment
-     */
-    calculateNotificationRequirements: (breachId: string) => NotificationRequirement | null;
-    /**
-     * Send a regulatory notification
-     */
-    sendNotification: (breachId: string, notificationData: Omit<RegulatoryNotification, 'id' | 'breachId' | 'sentAt'>) => RegulatoryNotification;
-    /**
-     * Get a regulatory notification for a breach
-     */
-    getNotification: (breachId: string) => RegulatoryNotification | null;
-    /**
-     * Get breaches that require notification within the next X hours
-     */
-    getBreachesRequiringNotification: (hoursThreshold?: number) => Array<{
-        report: BreachReport;
-        assessment: RiskAssessment;
-        requirements: NotificationRequirement;
-        hoursRemaining: number;
-    }>;
-    /**
-     * Clear all breach data
-     */
-    clearBreachData: () => void;
-}
-/**
- * Hook for managing data breach notifications in compliance with NDPR
- */
-export declare function useBreach({ categories, initialReports, storageKey, useLocalStorage, onReport, onAssessment, onNotification }: UseBreachOptions): UseBreachReturn;
-export {};

package/dist/hooks/useConsent.d.ts

@@ -1,63 +0,0 @@
-import { ConsentOption, ConsentSettings, ConsentStorageOptions } from '../types/consent';
-interface UseConsentOptions {
-    /**
-     * Consent options to present to the user
-     */
-    options: ConsentOption[];
-    /**
-     * Storage options for consent settings
-     */
-    storageOptions?: ConsentStorageOptions;
-    /**
-     * Version of the consent form
-     * @default "1.0"
-     */
-    version?: string;
-    /**
-     * Callback function called when consent settings change
-     */
-    onChange?: (settings: ConsentSettings) => void;
-}
-interface UseConsentReturn {
-    /**
-     * Current consent settings
-     */
-    settings: ConsentSettings | null;
-    /**
-     * Whether consent has been given for a specific option
-     */
-    hasConsent: (optionId: string) => boolean;
-    /**
-     * Update consent settings
-     */
-    updateConsent: (consents: Record<string, boolean>) => void;
-    /**
-     * Accept all consent options
-     */
-    acceptAll: () => void;
-    /**
-     * Reject all non-required consent options
-     */
-    rejectAll: () => void;
-    /**
-     * Whether the consent banner should be shown
-     */
-    shouldShowBanner: boolean;
-    /**
-     * Whether consent settings are valid
-     */
-    isValid: boolean;
-    /**
-     * Validation errors (if any)
-     */
-    validationErrors: string[];
-    /**
-     * Reset consent settings (clear from storage)
-     */
-    resetConsent: () => void;
-}
-/**
- * Hook for managing user consent in compliance with NDPR
- */
-export declare function useConsent({ options, storageOptions, version, onChange }: UseConsentOptions): UseConsentReturn;
-export {};

package/dist/hooks/useDPIA.d.ts

@@ -1,92 +0,0 @@
-import { DPIAQuestion, DPIASection, DPIAResult } from '../types/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 declare function useDPIA({ sections, initialAnswers, storageKey, useLocalStorage, onComplete }: UseDPIAOptions): UseDPIAReturn;
-export {};