@tantainnovative/ndpr-toolkit 2.1.2 → 2.4.0

package/dist/breach-yRiyyc4n.d.mts

@@ -0,0 +1,438 @@
+import React from 'react';
+import { B as BreachCategory, a as BreachReport, b as RiskAssessment, R as RegulatoryNotification } from './breach-Eu9byel8.mjs';
+import './useBreach-BBSoIcZO.mjs';
+import './breach-B_-6lDqS.mjs';
+
+/**
+ * Represents the data submitted by the breach report form.
+ */
+interface BreachFormSubmission {
+    /** Title/summary of the breach */
+    title: string;
+    /** Detailed description of the breach */
+    description: string;
+    /** Breach category identifier */
+    category: string;
+    /** Timestamp (ms) when the breach was discovered */
+    discoveredAt: number;
+    /** Timestamp (ms) when the breach occurred (if known) */
+    occurredAt?: number;
+    /** Timestamp (ms) when the form was submitted */
+    reportedAt: number;
+    /** Person reporting the breach */
+    reporter: {
+        name: string;
+        email: string;
+        department: string;
+        phone?: string;
+    };
+    /** Systems or applications affected by the breach */
+    affectedSystems: string[];
+    /** Types of data involved in the breach */
+    dataTypes: string[];
+    /** Estimated number of affected data subjects */
+    estimatedAffectedSubjects?: number;
+    /** Current status of the breach */
+    status: 'ongoing' | 'contained' | 'resolved';
+    /** Initial actions taken to address the breach */
+    initialActions?: string;
+    /** File attachments included with the report */
+    attachments: Array<{
+        name: string;
+        type: string;
+        size: number;
+        file: File;
+    }>;
+}
+interface BreachReportFormClassNames {
+    root?: string;
+    title?: string;
+    form?: string;
+    fieldGroup?: string;
+    label?: string;
+    input?: string;
+    select?: string;
+    textarea?: string;
+    submitButton?: string;
+    /** Alias for submitButton */
+    primaryButton?: string;
+    notice?: string;
+    /** Custom class applied when isSubmitting is true (e.g. a loading overlay) */
+    loadingOverlay?: string;
+}
+interface BreachReportFormProps {
+    /**
+     * Available breach categories
+     */
+    categories: BreachCategory[];
+    /**
+     * Callback function called when form is submitted
+     */
+    onSubmit: (data: BreachFormSubmission) => void;
+    /**
+     * Callback function called when form validation fails
+     */
+    onValidationError?: (errors: Record<string, string>) => void;
+    /**
+     * Title displayed on the form
+     * @default "Report a Data Breach"
+     */
+    title?: string;
+    /**
+     * Description text displayed on the form
+     * @default "Use this form to report a suspected or confirmed data breach in accordance with NDPA Section 40. All fields marked with * are required."
+     */
+    formDescription?: string;
+    /**
+     * Text for the submit button
+     * @default "Submit Report"
+     */
+    submitButtonText?: string;
+    /**
+     * Custom CSS class for the form
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the submit button
+     */
+    buttonClassName?: string;
+    /**
+     * Override class names for individual elements
+     */
+    classNames?: BreachReportFormClassNames;
+    /**
+     * Remove all default styles, only applying classNames overrides
+     */
+    unstyled?: boolean;
+    /**
+     * Whether the form is currently submitting.
+     * When true, the submit button is disabled and shows "Submitting..." text.
+     */
+    isSubmitting?: boolean;
+    /**
+     * Whether to show a confirmation message after submission
+     * @default true
+     */
+    showConfirmation?: boolean;
+    /**
+     * Confirmation message to display after submission
+     * @default "Your breach report has been submitted successfully. The data protection team has been notified."
+     */
+    confirmationMessage?: string;
+    /**
+     * Whether to allow file attachments
+     * @default true
+     */
+    allowAttachments?: boolean;
+    /**
+     * Maximum number of attachments allowed
+     * @default 5
+     */
+    maxAttachments?: number;
+    /**
+     * Maximum file size for attachments (in bytes)
+     * @default 5242880 (5MB)
+     */
+    maxFileSize?: number;
+    /**
+     * Allowed file types for attachments
+     * @default ['.pdf', '.jpg', '.jpeg', '.png', '.doc', '.docx', '.xls', '.xlsx', '.txt']
+     */
+    allowedFileTypes?: string[];
+    /**
+     * Default values to pre-fill form fields.
+     * Useful for editing existing breach reports or pre-populating known data.
+     */
+    defaultValues?: Partial<BreachFormSubmission>;
+    /**
+     * Callback fired when the form is reset via the Reset button.
+     * To fully remount the component (clearing all internal state),
+     * change the `key` prop from the parent.
+     */
+    onReset?: () => void;
+}
+/**
+ * Breach report form component. Implements NDPA Section 40 breach notification requirements,
+ * enabling organizations to document and report data breaches within the mandated 72-hour window.
+ */
+declare const BreachReportForm: React.FC<BreachReportFormProps>;
+
+interface BreachRiskAssessmentClassNames {
+    root?: string;
+    header?: string;
+    title?: string;
+    slider?: string;
+    riskBadge?: string;
+    riskScore?: string;
+    notificationStatus?: string;
+    submitButton?: string;
+    /** Alias for submitButton */
+    primaryButton?: string;
+}
+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 under NDPA Section 40."
+     */
+    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;
+    /**
+     * Override class names for individual elements
+     */
+    classNames?: BreachRiskAssessmentClassNames;
+    /**
+     * Remove all default styles, only applying classNames overrides
+     */
+    unstyled?: boolean;
+    /**
+     * Whether to show the breach summary
+     * @default true
+     */
+    showBreachSummary?: boolean;
+    /**
+     * Whether to show notification requirements after assessment
+     * @default true
+     */
+    showNotificationRequirements?: boolean;
+}
+/**
+ * Breach risk assessment component. Implements NDPA Section 40 requirements for assessing
+ * breach severity and determining whether NDPC notification is required within 72 hours.
+ */
+declare const BreachRiskAssessment: React.FC<BreachRiskAssessmentProps>;
+
+interface BreachNotificationManagerClassNames {
+    root?: string;
+    header?: string;
+    title?: string;
+    breachList?: string;
+    breachItem?: string;
+    statusBadge?: string;
+    timeline?: string;
+    timelineStep?: string;
+    detailPanel?: string;
+}
+interface BreachNotificationManagerProps {
+    /**
+     * List of breach reports to manage
+     */
+    breachReports: BreachReport[];
+    /**
+     * List of risk assessments
+     */
+    riskAssessments: RiskAssessment[];
+    /**
+     * List of regulatory notifications
+     */
+    regulatoryNotifications: RegulatoryNotification[];
+    /**
+     * Callback function called when a breach is selected
+     */
+    onSelectBreach?: (breachId: string) => void;
+    /**
+     * Callback function called when a risk assessment is requested
+     */
+    onRequestAssessment?: (breachId: string) => void;
+    /**
+     * Callback function called when a notification is requested
+     */
+    onRequestNotification?: (breachId: string) => void;
+    /**
+     * Title displayed on the manager
+     * @default "Breach Notification Manager"
+     */
+    title?: string;
+    /**
+     * Description text displayed on the manager
+     * @default "Manage data breach notifications and track compliance with NDPA Section 40 requirements."
+     */
+    description?: string;
+    /**
+     * Custom CSS class for the manager
+     */
+    className?: string;
+    /**
+     * Custom CSS class for the buttons
+     */
+    buttonClassName?: string;
+    /**
+     * Override class names for individual elements
+     */
+    classNames?: BreachNotificationManagerClassNames;
+    /**
+     * Remove all default styles, only applying classNames overrides
+     */
+    unstyled?: boolean;
+    /**
+     * Whether to show the breach details
+     * @default true
+     */
+    showBreachDetails?: boolean;
+    /**
+     * Whether to show the notification timeline
+     * @default true
+     */
+    showNotificationTimeline?: boolean;
+    /**
+     * Whether to show the deadline alerts
+     * @default true
+     */
+    showDeadlineAlerts?: boolean;
+}
+/**
+ * Breach notification management component. Implements NDPA Section 40 requirements for
+ * managing breach notifications, tracking 72-hour NDPC reporting deadlines, and coordinating
+ * data subject notifications.
+ */
+declare const BreachNotificationManager: React.FC<BreachNotificationManagerProps>;
+
+interface RegulatoryReportGeneratorClassNames {
+    root?: string;
+    header?: string;
+    title?: string;
+    reportPreview?: string;
+    field?: string;
+    fieldLabel?: string;
+    fieldValue?: string;
+    generateButton?: string;
+    /** Alias for generateButton */
+    primaryButton?: string;
+    downloadButton?: string;
+    /** Alias for downloadButton */
+    secondaryButton?: string;
+}
+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;
+}
+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 NDPC Notification Report"
+     */
+    title?: string;
+    /**
+     * Description text displayed on the generator form
+     * @default "Generate a report for submission to the NDPC in compliance with NDPA Section 40 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;
+    /**
+     * Override class names for individual elements
+     */
+    classNames?: RegulatoryReportGeneratorClassNames;
+    /**
+     * Remove all default styles, only applying classNames overrides
+     */
+    unstyled?: boolean;
+    /**
+     * 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';
+}
+/**
+ * Regulatory report generator component. Implements NDPA Section 40 requirements for
+ * generating formal breach notification reports for submission to the NDPC.
+ */
+declare const RegulatoryReportGenerator: React.FC<RegulatoryReportGeneratorProps>;
+
+export { type BreachFormSubmission as B, RegulatoryReportGenerator as R, BreachNotificationManager as a, type BreachNotificationManagerClassNames as b, BreachReportForm as c, type BreachReportFormClassNames as d, BreachRiskAssessment as e, type BreachRiskAssessmentClassNames as f, type RegulatoryReportGeneratorClassNames as g };

package/dist/breach.d.mts

@@ -1,275 +1,5 @@
-import React from 'react';
-import { a as BreachCategory, B as BreachReport, R as RiskAssessment, b as RegulatoryNotification } from './breach-BtFbDOmV.mjs';
-export { N as NotificationRequirement } from './breach-BtFbDOmV.mjs';
-export { u as useBreach } from './useBreach-WrZzJilM.mjs';
-export { c as calculateBreachSeverity } from './breach-6z0r-KuE.mjs';
-
-interface BreachReportFormProps {
-    /**
-     * Available breach categories
-     */
-    categories: BreachCategory[];
-    /**
-     * Callback function called when form is submitted
-     */
-    onSubmit: (formData: any) => void;
-    /**
-     * Title displayed on the form
-     * @default "Report a Data Breach"
-     */
-    title?: string;
-    /**
-     * Description text displayed on the form
-     * @default "Use this form to report a suspected or confirmed data breach. All fields marked with * are required."
-     */
-    formDescription?: string;
-    /**
-     * Text for the submit button
-     * @default "Submit Report"
-     */
-    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 breach report has been submitted successfully. The data protection team has been notified."
-     */
-    confirmationMessage?: string;
-    /**
-     * Whether to allow file attachments
-     * @default true
-     */
-    allowAttachments?: boolean;
-    /**
-     * Maximum number of attachments allowed
-     * @default 5
-     */
-    maxAttachments?: number;
-    /**
-     * Maximum file size for attachments (in bytes)
-     * @default 5242880 (5MB)
-     */
-    maxFileSize?: number;
-    /**
-     * Allowed file types for attachments
-     * @default ['.pdf', '.jpg', '.jpeg', '.png', '.doc', '.docx', '.xls', '.xlsx', '.txt']
-     */
-    allowedFileTypes?: string[];
-}
-declare const BreachReportForm: React.FC<BreachReportFormProps>;
-
-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;
-}
-declare const BreachRiskAssessment: React.FC<BreachRiskAssessmentProps>;
-
-interface BreachNotificationManagerProps {
-    /**
-     * List of breach reports to manage
-     */
-    breachReports: BreachReport[];
-    /**
-     * List of risk assessments
-     */
-    riskAssessments: RiskAssessment[];
-    /**
-     * List of regulatory notifications
-     */
-    regulatoryNotifications: RegulatoryNotification[];
-    /**
-     * Callback function called when a breach is selected
-     */
-    onSelectBreach?: (breachId: string) => void;
-    /**
-     * Callback function called when a risk assessment is requested
-     */
-    onRequestAssessment?: (breachId: string) => void;
-    /**
-     * Callback function called when a notification is requested
-     */
-    onRequestNotification?: (breachId: string) => void;
-    /**
-     * Title displayed on the manager
-     * @default "Breach Notification Manager"
-     */
-    title?: string;
-    /**
-     * Description text displayed on the manager
-     * @default "Manage data breach notifications and track compliance with NDPA requirements."
-     */
-    description?: string;
-    /**
-     * Custom CSS class for the manager
-     */
-    className?: string;
-    /**
-     * Custom CSS class for the buttons
-     */
-    buttonClassName?: string;
-    /**
-     * Whether to show the breach details
-     * @default true
-     */
-    showBreachDetails?: boolean;
-    /**
-     * Whether to show the notification timeline
-     * @default true
-     */
-    showNotificationTimeline?: boolean;
-    /**
-     * Whether to show the deadline alerts
-     * @default true
-     */
-    showDeadlineAlerts?: boolean;
-}
-declare const BreachNotificationManager: React.FC<BreachNotificationManagerProps>;
-
-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;
-}
-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 NDPC Notification Report"
-     */
-    title?: string;
-    /**
-     * Description text displayed on the generator form
-     * @default "Generate a report for submission to the NDPC in compliance with the NDPA 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';
-}
-declare const RegulatoryReportGenerator: React.FC<RegulatoryReportGeneratorProps>;
-
-export { BreachCategory, BreachNotificationManager, BreachReport, BreachReportForm, BreachRiskAssessment, RegulatoryNotification, RegulatoryReportGenerator, RiskAssessment };
+export { a as BreachNotificationManager, b as BreachNotificationManagerClassNames, c as BreachReportForm, d as BreachReportFormClassNames, e as BreachRiskAssessment, f as BreachRiskAssessmentClassNames, R as RegulatoryReportGenerator, g as RegulatoryReportGeneratorClassNames } from './breach-yRiyyc4n.mjs';
+export { u as useBreach } from './useBreach-BBSoIcZO.mjs';
+export { c as calculateBreachSeverity } from './breach-B_-6lDqS.mjs';
+export { B as BreachCategory, a as BreachReport, N as NotificationRequirement, R as RegulatoryNotification, b as RiskAssessment } from './breach-Eu9byel8.mjs';
+import 'react';