@tantainnovative/ndpr-toolkit 2.4.0 → 2.4.1

package/dist/dsr.d.mts

@@ -1,5 +1,308 @@
-export { D as DSRDashboard, a as DSRDashboardClassNames, c as DSRRequestForm, d as DSRRequestFormClassNames, e as DSRTracker, f as DSRTrackerClassNames } from './dsr-BTT-Xd7H.mjs';
+import React from 'react';
+import { c as RequestType, D as DSRRequest, a as DSRStatus } from './dsr-Cm9lzWG7.mjs';
+export { b as DSRType, R as RequestStatus } from './dsr-Cm9lzWG7.mjs';
 export { u as useDSR } from './useDSR-YYZ6FYFs.mjs';
 export { f as formatDSRRequest } from './dsr-D_eTNc4S.mjs';
-export { D as DSRRequest, a as DSRStatus, b as DSRType, R as RequestStatus, c as RequestType } from './dsr-Cm9lzWG7.mjs';
-import 'react';
+
+/**
+ * Represents the data submitted by the DSR request form.
+ */
+interface DSRFormSubmission {
+    /** The selected request type identifier */
+    requestType: string;
+    /** Data subject personal information */
+    dataSubject: {
+        fullName: string;
+        email: string;
+        phone?: string;
+        identifierType: string;
+        identifierValue: string;
+    };
+    /** Additional information provided for the selected request type */
+    additionalInfo?: Record<string, any>;
+    /** Timestamp (ms) when the form was submitted */
+    submittedAt: number;
+}
+interface DSRRequestFormClassNames {
+    root?: string;
+    title?: string;
+    description?: string;
+    form?: string;
+    fieldGroup?: string;
+    label?: string;
+    input?: string;
+    select?: string;
+    textarea?: string;
+    submitButton?: string;
+    /** Alias for submitButton */
+    primaryButton?: string;
+    successMessage?: string;
+    /** Custom class applied when isSubmitting is true (e.g. a loading overlay) */
+    loadingOverlay?: string;
+}
+interface DSRRequestFormProps {
+    /**
+     * Array of request types that can be submitted
+     */
+    requestTypes: RequestType[];
+    /**
+     * Callback function called when form is submitted
+     */
+    onSubmit: (data: DSRFormSubmission) => void;
+    /**
+     * Callback function called when form validation fails
+     */
+    onValidationError?: (errors: Record<string, string>) => 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 Act (NDPA), Part IV, Sections 29-36."
+     */
+    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;
+    };
+    /**
+     * Object of CSS class overrides keyed by semantic section name.
+     */
+    classNames?: DSRRequestFormClassNames;
+    /**
+     * When true, all default Tailwind classes are removed so consumers
+     * can style from scratch using classNames.
+     */
+    unstyled?: boolean;
+    /**
+     * Whether the form is currently submitting.
+     * When true, the submit button is disabled and shows "Submitting..." text.
+     */
+    isSubmitting?: boolean;
+    /**
+     * Default values to pre-fill form fields.
+     * Useful for editing existing requests or pre-populating known data.
+     */
+    defaultValues?: Partial<DSRFormSubmission>;
+    /**
+     * 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;
+}
+/**
+ * Data Subject Request form component. Implements NDPA Part IV, Sections 29-36
+ * covering data subject rights including access, rectification, erasure, and portability.
+ */
+declare const DSRRequestForm: React.FC<DSRRequestFormProps>;
+
+interface DSRDashboardClassNames {
+    root?: string;
+    header?: string;
+    title?: string;
+    filters?: string;
+    requestList?: string;
+    requestItem?: string;
+    statusBadge?: string;
+    detailPanel?: string;
+}
+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 NDPA Part IV 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[];
+    /**
+     * Object of CSS class overrides keyed by semantic section name.
+     */
+    classNames?: DSRDashboardClassNames;
+    /**
+     * When true, all default Tailwind classes are removed so consumers
+     * can style from scratch using classNames.
+     */
+    unstyled?: boolean;
+}
+/**
+ * Data Subject Request dashboard component. Supports compliance with NDPA Part IV,
+ * providing tools to track, manage, and respond to data subject requests within required timeframes.
+ */
+declare const DSRDashboard: React.FC<DSRDashboardProps>;
+
+interface DSRTrackerClassNames {
+    root?: string;
+    header?: string;
+    title?: string;
+    stats?: string;
+    statCard?: string;
+    table?: string;
+    tableHeader?: string;
+    tableRow?: string;
+    statusBadge?: string;
+}
+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 as required by NDPA Part IV."
+     */
+    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;
+    /**
+     * Object of CSS class overrides keyed by semantic section name.
+     */
+    classNames?: DSRTrackerClassNames;
+    /**
+     * When true, all default Tailwind classes are removed so consumers
+     * can style from scratch using classNames.
+     */
+    unstyled?: boolean;
+}
+/**
+ * DSR tracking and analytics component. Supports compliance with NDPA Part IV,
+ * providing summary statistics, deadline tracking, and compliance metrics for data subject requests.
+ */
+declare const DSRTracker: React.FC<DSRTrackerProps>;
+
+export { DSRDashboard, type DSRDashboardClassNames, type DSRFormSubmission, DSRRequest, DSRRequestForm, type DSRRequestFormClassNames, DSRStatus, DSRTracker, type DSRTrackerClassNames, RequestType };

package/dist/dsr.d.ts

@@ -1,5 +1,308 @@
-export { D as DSRDashboard, a as DSRDashboardClassNames, c as DSRRequestForm, d as DSRRequestFormClassNames, e as DSRTracker, f as DSRTrackerClassNames } from './dsr-190YpijW.js';
+import React from 'react';
+import { c as RequestType, D as DSRRequest, a as DSRStatus } from './dsr-Cm9lzWG7.js';
+export { b as DSRType, R as RequestStatus } from './dsr-Cm9lzWG7.js';
 export { u as useDSR } from './useDSR-CYI7WCXr.js';
 export { f as formatDSRRequest } from './dsr-pNtVb1BK.js';
-export { D as DSRRequest, a as DSRStatus, b as DSRType, R as RequestStatus, c as RequestType } from './dsr-Cm9lzWG7.js';
-import 'react';
+
+/**
+ * Represents the data submitted by the DSR request form.
+ */
+interface DSRFormSubmission {
+    /** The selected request type identifier */
+    requestType: string;
+    /** Data subject personal information */
+    dataSubject: {
+        fullName: string;
+        email: string;
+        phone?: string;
+        identifierType: string;
+        identifierValue: string;
+    };
+    /** Additional information provided for the selected request type */
+    additionalInfo?: Record<string, any>;
+    /** Timestamp (ms) when the form was submitted */
+    submittedAt: number;
+}
+interface DSRRequestFormClassNames {
+    root?: string;
+    title?: string;
+    description?: string;
+    form?: string;
+    fieldGroup?: string;
+    label?: string;
+    input?: string;
+    select?: string;
+    textarea?: string;
+    submitButton?: string;
+    /** Alias for submitButton */
+    primaryButton?: string;
+    successMessage?: string;
+    /** Custom class applied when isSubmitting is true (e.g. a loading overlay) */
+    loadingOverlay?: string;
+}
+interface DSRRequestFormProps {
+    /**
+     * Array of request types that can be submitted
+     */
+    requestTypes: RequestType[];
+    /**
+     * Callback function called when form is submitted
+     */
+    onSubmit: (data: DSRFormSubmission) => void;
+    /**
+     * Callback function called when form validation fails
+     */
+    onValidationError?: (errors: Record<string, string>) => 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 Act (NDPA), Part IV, Sections 29-36."
+     */
+    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;
+    };
+    /**
+     * Object of CSS class overrides keyed by semantic section name.
+     */
+    classNames?: DSRRequestFormClassNames;
+    /**
+     * When true, all default Tailwind classes are removed so consumers
+     * can style from scratch using classNames.
+     */
+    unstyled?: boolean;
+    /**
+     * Whether the form is currently submitting.
+     * When true, the submit button is disabled and shows "Submitting..." text.
+     */
+    isSubmitting?: boolean;
+    /**
+     * Default values to pre-fill form fields.
+     * Useful for editing existing requests or pre-populating known data.
+     */
+    defaultValues?: Partial<DSRFormSubmission>;
+    /**
+     * 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;
+}
+/**
+ * Data Subject Request form component. Implements NDPA Part IV, Sections 29-36
+ * covering data subject rights including access, rectification, erasure, and portability.
+ */
+declare const DSRRequestForm: React.FC<DSRRequestFormProps>;
+
+interface DSRDashboardClassNames {
+    root?: string;
+    header?: string;
+    title?: string;
+    filters?: string;
+    requestList?: string;
+    requestItem?: string;
+    statusBadge?: string;
+    detailPanel?: string;
+}
+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 NDPA Part IV 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[];
+    /**
+     * Object of CSS class overrides keyed by semantic section name.
+     */
+    classNames?: DSRDashboardClassNames;
+    /**
+     * When true, all default Tailwind classes are removed so consumers
+     * can style from scratch using classNames.
+     */
+    unstyled?: boolean;
+}
+/**
+ * Data Subject Request dashboard component. Supports compliance with NDPA Part IV,
+ * providing tools to track, manage, and respond to data subject requests within required timeframes.
+ */
+declare const DSRDashboard: React.FC<DSRDashboardProps>;
+
+interface DSRTrackerClassNames {
+    root?: string;
+    header?: string;
+    title?: string;
+    stats?: string;
+    statCard?: string;
+    table?: string;
+    tableHeader?: string;
+    tableRow?: string;
+    statusBadge?: string;
+}
+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 as required by NDPA Part IV."
+     */
+    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;
+    /**
+     * Object of CSS class overrides keyed by semantic section name.
+     */
+    classNames?: DSRTrackerClassNames;
+    /**
+     * When true, all default Tailwind classes are removed so consumers
+     * can style from scratch using classNames.
+     */
+    unstyled?: boolean;
+}
+/**
+ * DSR tracking and analytics component. Supports compliance with NDPA Part IV,
+ * providing summary statistics, deadline tracking, and compliance metrics for data subject requests.
+ */
+declare const DSRTracker: React.FC<DSRTrackerProps>;
+
+export { DSRDashboard, type DSRDashboardClassNames, type DSRFormSubmission, DSRRequest, DSRRequestForm, type DSRRequestFormClassNames, DSRStatus, DSRTracker, type DSRTrackerClassNames, RequestType };

package/dist/index.d.mts

@@ -1,10 +1,10 @@
 export { ConsentAnalyticsEvent, ConsentBanner, ConsentBannerClassNames, ConsentManager, ConsentManagerClassNames, ConsentStorage, ConsentStorageClassNames, resolveClass } from './consent.mjs';
 export { C as ConsentOption, a as ConsentSettings, b as ConsentStorageOptions, L as LawfulBasisType } from './consent-CmVzqZUk.mjs';
-export { D as DSRDashboard, a as DSRDashboardClassNames, b as DSRFormSubmission, c as DSRRequestForm, d as DSRRequestFormClassNames, e as DSRTracker, f as DSRTrackerClassNames } from './dsr-BTT-Xd7H.mjs';
+export { DSRDashboard, DSRDashboardClassNames, DSRFormSubmission, DSRRequestForm, DSRRequestFormClassNames, DSRTracker, DSRTrackerClassNames } from './dsr.mjs';
 export { D as DSRRequest, a as DSRStatus, b as DSRType, R as RequestStatus, c as RequestType } from './dsr-Cm9lzWG7.mjs';
 export { DPIAQuestionnaire, DPIAQuestionnaireClassNames, DPIAReport, DPIAReportClassNames, StepIndicator, StepIndicatorClassNames } from './dpia.mjs';
 export { D as DPIAQuestion, a as DPIAResult, b as DPIARisk, c as DPIASection } from './dpia-5OQVA1R_.mjs';
-export { B as BreachFormSubmission, 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 { BreachFormSubmission, BreachNotificationManager, BreachNotificationManagerClassNames, BreachReportForm, BreachReportFormClassNames, BreachRiskAssessment, BreachRiskAssessmentClassNames, RegulatoryReportGenerator, RegulatoryReportGeneratorClassNames } from './breach.mjs';
 export { B as BreachCategory, a as BreachReport, N as NotificationRequirement, R as RegulatoryNotification, b as RiskAssessment } from './breach-Eu9byel8.mjs';
 export { P as PolicyExporter, a as PolicyExporterClassNames, b as PolicyGenerator, c as PolicyGeneratorClassNames, d as PolicyPreview, e as PolicyPreviewClassNames } from './policy-E0fXZkda.mjs';
 export { O as OrganizationInfo, P as PolicySection, a as PolicyTemplate, b as PolicyVariable, c as PrivacyPolicy } from './privacy-Ca6te9Ir.mjs';

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 export { ConsentAnalyticsEvent, ConsentBanner, ConsentBannerClassNames, ConsentManager, ConsentManagerClassNames, ConsentStorage, ConsentStorageClassNames, resolveClass } from './consent.js';
 export { C as ConsentOption, a as ConsentSettings, b as ConsentStorageOptions, L as LawfulBasisType } from './consent-CmVzqZUk.js';
-export { D as DSRDashboard, a as DSRDashboardClassNames, b as DSRFormSubmission, c as DSRRequestForm, d as DSRRequestFormClassNames, e as DSRTracker, f as DSRTrackerClassNames } from './dsr-190YpijW.js';
+export { DSRDashboard, DSRDashboardClassNames, DSRFormSubmission, DSRRequestForm, DSRRequestFormClassNames, DSRTracker, DSRTrackerClassNames } from './dsr.js';
 export { D as DSRRequest, a as DSRStatus, b as DSRType, R as RequestStatus, c as RequestType } from './dsr-Cm9lzWG7.js';
 export { DPIAQuestionnaire, DPIAQuestionnaireClassNames, DPIAReport, DPIAReportClassNames, StepIndicator, StepIndicatorClassNames } from './dpia.js';
 export { D as DPIAQuestion, a as DPIAResult, b as DPIARisk, c as DPIASection } from './dpia-5OQVA1R_.js';
-export { B as BreachFormSubmission, 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-ouXoVTWs.js';
+export { BreachFormSubmission, BreachNotificationManager, BreachNotificationManagerClassNames, BreachReportForm, BreachReportFormClassNames, BreachRiskAssessment, BreachRiskAssessmentClassNames, RegulatoryReportGenerator, RegulatoryReportGeneratorClassNames } from './breach.js';
 export { B as BreachCategory, a as BreachReport, N as NotificationRequirement, R as RegulatoryNotification, b as RiskAssessment } from './breach-Eu9byel8.js';
 export { P as PolicyExporter, a as PolicyExporterClassNames, b as PolicyGenerator, c as PolicyGeneratorClassNames, d as PolicyPreview, e as PolicyPreviewClassNames } from './policy-D2_jh5-T.js';
 export { O as OrganizationInfo, P as PolicySection, a as PolicyTemplate, b as PolicyVariable, c as PrivacyPolicy } from './privacy-Ca6te9Ir.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tantainnovative/ndpr-toolkit",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "private": false,
   "description": "Nigeria Data Protection Toolkit — enterprise-grade compliance components for the Nigeria Data Protection Act (NDPA) 2023",
   "keywords": [