@tantainnovative/ndpr-toolkit 1.0.10 → 2.1.1

package/dist/useDPIA-FqPofFaV.d.mts

@@ -0,0 +1,94 @@
+import { a as DPIASection, b as DPIAResult, D as DPIAQuestion } from './dpia-vWfE_9bO.mjs';
+
+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 the NDPA 2023
+ */
+declare function useDPIA({ sections, initialAnswers, storageKey, useLocalStorage, onComplete }: UseDPIAOptions): UseDPIAReturn;
+
+export { useDPIA as u };

package/dist/useDSR-DAqqOBXb.d.ts

@@ -0,0 +1,74 @@
+import { D as DSRRequest, R as RequestType, c as RequestStatus } from './dsr-pQzQ3H1O.js';
+
+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 the NDPA
+ */
+declare function useDSR({ initialRequests, requestTypes, storageKey, useLocalStorage, onSubmit, onUpdate }: UseDSROptions): UseDSRReturn;
+
+export { useDSR as u };

package/dist/useDSR-OXM5Q9rf.d.mts

@@ -0,0 +1,74 @@
+import { D as DSRRequest, R as RequestType, c as RequestStatus } from './dsr-pQzQ3H1O.mjs';
+
+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 the NDPA
+ */
+declare function useDSR({ initialRequests, requestTypes, storageKey, useLocalStorage, onSubmit, onUpdate }: UseDSROptions): UseDSRReturn;
+
+export { useDSR as u };

package/dist/useLawfulBasis-DNQ8YszQ.d.mts

@@ -0,0 +1,68 @@
+import { P as ProcessingActivity, b as LawfulBasisSummary } from './lawful-basis-CWtvDG1x.mjs';
+import { c as LawfulBasisValidationResult } from './lawful-basis-D-oXFizg.mjs';
+
+interface UseLawfulBasisOptions {
+    /**
+     * Initial processing activities to load
+     */
+    initialActivities?: ProcessingActivity[];
+    /**
+     * Storage key for persisting activities
+     * @default "ndpr_lawful_basis_activities"
+     */
+    storageKey?: string;
+    /**
+     * Whether to use local storage to persist activities
+     * @default true
+     */
+    useLocalStorage?: boolean;
+    /**
+     * Callback when an activity is added
+     */
+    onAdd?: (activity: ProcessingActivity) => void;
+    /**
+     * Callback when an activity is updated
+     */
+    onUpdate?: (activity: ProcessingActivity) => void;
+    /**
+     * Callback when an activity is removed
+     */
+    onRemove?: (id: string) => void;
+}
+interface UseLawfulBasisReturn {
+    /**
+     * All processing activities
+     */
+    activities: ProcessingActivity[];
+    /**
+     * Add a new processing activity
+     */
+    addActivity: (activity: Omit<ProcessingActivity, 'id' | 'createdAt' | 'updatedAt'>) => ProcessingActivity;
+    /**
+     * Update an existing processing activity
+     */
+    updateActivity: (id: string, updates: Partial<ProcessingActivity>) => ProcessingActivity | null;
+    /**
+     * Remove a processing activity
+     */
+    removeActivity: (id: string) => void;
+    /**
+     * Get a specific processing activity by ID
+     */
+    getActivity: (id: string) => ProcessingActivity | null;
+    /**
+     * Get a summary of all lawful basis documentation
+     */
+    getSummary: () => LawfulBasisSummary;
+    /**
+     * Validate a processing activity
+     */
+    validateActivity: (activity: ProcessingActivity) => LawfulBasisValidationResult;
+}
+/**
+ * Hook for managing lawful basis documentation for processing activities
+ * in compliance with NDPA 2023 Section 25.
+ */
+declare function useLawfulBasis({ initialActivities, storageKey, useLocalStorage, onAdd, onUpdate, onRemove, }?: UseLawfulBasisOptions): UseLawfulBasisReturn;
+
+export { useLawfulBasis as u };

package/dist/useLawfulBasis-RILM_xsx.d.ts

@@ -0,0 +1,68 @@
+import { P as ProcessingActivity, b as LawfulBasisSummary } from './lawful-basis-CWtvDG1x.js';
+import { c as LawfulBasisValidationResult } from './lawful-basis-v04AhbK2.js';
+
+interface UseLawfulBasisOptions {
+    /**
+     * Initial processing activities to load
+     */
+    initialActivities?: ProcessingActivity[];
+    /**
+     * Storage key for persisting activities
+     * @default "ndpr_lawful_basis_activities"
+     */
+    storageKey?: string;
+    /**
+     * Whether to use local storage to persist activities
+     * @default true
+     */
+    useLocalStorage?: boolean;
+    /**
+     * Callback when an activity is added
+     */
+    onAdd?: (activity: ProcessingActivity) => void;
+    /**
+     * Callback when an activity is updated
+     */
+    onUpdate?: (activity: ProcessingActivity) => void;
+    /**
+     * Callback when an activity is removed
+     */
+    onRemove?: (id: string) => void;
+}
+interface UseLawfulBasisReturn {
+    /**
+     * All processing activities
+     */
+    activities: ProcessingActivity[];
+    /**
+     * Add a new processing activity
+     */
+    addActivity: (activity: Omit<ProcessingActivity, 'id' | 'createdAt' | 'updatedAt'>) => ProcessingActivity;
+    /**
+     * Update an existing processing activity
+     */
+    updateActivity: (id: string, updates: Partial<ProcessingActivity>) => ProcessingActivity | null;
+    /**
+     * Remove a processing activity
+     */
+    removeActivity: (id: string) => void;
+    /**
+     * Get a specific processing activity by ID
+     */
+    getActivity: (id: string) => ProcessingActivity | null;
+    /**
+     * Get a summary of all lawful basis documentation
+     */
+    getSummary: () => LawfulBasisSummary;
+    /**
+     * Validate a processing activity
+     */
+    validateActivity: (activity: ProcessingActivity) => LawfulBasisValidationResult;
+}
+/**
+ * Hook for managing lawful basis documentation for processing activities
+ * in compliance with NDPA 2023 Section 25.
+ */
+declare function useLawfulBasis({ initialActivities, storageKey, useLocalStorage, onAdd, onUpdate, onRemove, }?: UseLawfulBasisOptions): UseLawfulBasisReturn;
+
+export { useLawfulBasis as u };

package/dist/usePrivacyPolicy-CfySfBLS.d.ts

@@ -0,0 +1,89 @@
+import { a as PolicyTemplate, c as PrivacyPolicy, O as OrganizationInfo } from './privacy-Ca6te9Ir.js';
+
+interface UsePrivacyPolicyOptions {
+    /**
+     * Available policy templates
+     */
+    templates: PolicyTemplate[];
+    /**
+     * Initial policy data (if editing an existing policy)
+     */
+    initialPolicy?: PrivacyPolicy;
+    /**
+     * Storage key for policy data
+     * @default "ndpr_privacy_policy"
+     */
+    storageKey?: string;
+    /**
+     * Whether to use local storage to persist policy data
+     * @default true
+     */
+    useLocalStorage?: boolean;
+    /**
+     * Callback function called when a policy is generated
+     */
+    onGenerate?: (policy: PrivacyPolicy) => void;
+}
+interface UsePrivacyPolicyReturn {
+    /**
+     * Current policy data
+     */
+    policy: PrivacyPolicy | null;
+    /**
+     * Selected template
+     */
+    selectedTemplate: PolicyTemplate | null;
+    /**
+     * Organization information
+     */
+    organizationInfo: OrganizationInfo;
+    /**
+     * Select a template
+     */
+    selectTemplate: (templateId: string) => boolean;
+    /**
+     * Update organization information
+     */
+    updateOrganizationInfo: (updates: Partial<OrganizationInfo>) => void;
+    /**
+     * Toggle whether a section is included in the policy
+     */
+    toggleSection: (sectionId: string, included: boolean) => void;
+    /**
+     * Update section content
+     */
+    updateSectionContent: (sectionId: string, content: string) => void;
+    /**
+     * Update variable values
+     */
+    updateVariableValue: (variable: string, value: string) => void;
+    /**
+     * Generate the policy
+     */
+    generatePolicy: () => PrivacyPolicy;
+    /**
+     * Get the generated policy text
+     */
+    getPolicyText: () => {
+        fullText: string;
+        sectionTexts: Record<string, string>;
+        missingVariables: string[];
+    };
+    /**
+     * Reset the policy
+     */
+    resetPolicy: () => void;
+    /**
+     * Check if the policy is valid
+     */
+    isValid: () => {
+        valid: boolean;
+        errors: string[];
+    };
+}
+/**
+ * Hook for generating NDPA-compliant privacy policies
+ */
+declare function usePrivacyPolicy({ templates, initialPolicy, storageKey, useLocalStorage, onGenerate }: UsePrivacyPolicyOptions): UsePrivacyPolicyReturn;
+
+export { usePrivacyPolicy as u };

package/dist/usePrivacyPolicy-Dit2sFuV.d.mts

@@ -0,0 +1,89 @@
+import { a as PolicyTemplate, c as PrivacyPolicy, O as OrganizationInfo } from './privacy-Ca6te9Ir.mjs';
+
+interface UsePrivacyPolicyOptions {
+    /**
+     * Available policy templates
+     */
+    templates: PolicyTemplate[];
+    /**
+     * Initial policy data (if editing an existing policy)
+     */
+    initialPolicy?: PrivacyPolicy;
+    /**
+     * Storage key for policy data
+     * @default "ndpr_privacy_policy"
+     */
+    storageKey?: string;
+    /**
+     * Whether to use local storage to persist policy data
+     * @default true
+     */
+    useLocalStorage?: boolean;
+    /**
+     * Callback function called when a policy is generated
+     */
+    onGenerate?: (policy: PrivacyPolicy) => void;
+}
+interface UsePrivacyPolicyReturn {
+    /**
+     * Current policy data
+     */
+    policy: PrivacyPolicy | null;
+    /**
+     * Selected template
+     */
+    selectedTemplate: PolicyTemplate | null;
+    /**
+     * Organization information
+     */
+    organizationInfo: OrganizationInfo;
+    /**
+     * Select a template
+     */
+    selectTemplate: (templateId: string) => boolean;
+    /**
+     * Update organization information
+     */
+    updateOrganizationInfo: (updates: Partial<OrganizationInfo>) => void;
+    /**
+     * Toggle whether a section is included in the policy
+     */
+    toggleSection: (sectionId: string, included: boolean) => void;
+    /**
+     * Update section content
+     */
+    updateSectionContent: (sectionId: string, content: string) => void;
+    /**
+     * Update variable values
+     */
+    updateVariableValue: (variable: string, value: string) => void;
+    /**
+     * Generate the policy
+     */
+    generatePolicy: () => PrivacyPolicy;
+    /**
+     * Get the generated policy text
+     */
+    getPolicyText: () => {
+        fullText: string;
+        sectionTexts: Record<string, string>;
+        missingVariables: string[];
+    };
+    /**
+     * Reset the policy
+     */
+    resetPolicy: () => void;
+    /**
+     * Check if the policy is valid
+     */
+    isValid: () => {
+        valid: boolean;
+        errors: string[];
+    };
+}
+/**
+ * Hook for generating NDPA-compliant privacy policies
+ */
+declare function usePrivacyPolicy({ templates, initialPolicy, storageKey, useLocalStorage, onGenerate }: UsePrivacyPolicyOptions): UsePrivacyPolicyReturn;
+
+export { usePrivacyPolicy as u };

package/dist/useROPA-Bcs6cRdi.d.ts

@@ -0,0 +1,64 @@
+import { R as RecordOfProcessingActivities, P as ProcessingRecord, a as ROPASummary, b as ROPAComplianceGap } from './ropa-BebGfqKQ.js';
+
+interface UseROPAOptions {
+    /**
+     * Initial ROPA state
+     */
+    initialData: RecordOfProcessingActivities;
+    /**
+     * Callback when a record is added
+     */
+    onRecordAdd?: (record: ProcessingRecord) => void;
+    /**
+     * Callback when a record is updated
+     */
+    onRecordUpdate?: (id: string, updates: Partial<ProcessingRecord>) => void;
+    /**
+     * Callback when a record is archived
+     */
+    onRecordArchive?: (id: string) => void;
+}
+interface UseROPAReturn {
+    /**
+     * Current state of the Record of Processing Activities
+     */
+    ropa: RecordOfProcessingActivities;
+    /**
+     * Add a new processing record
+     */
+    addRecord: (record: ProcessingRecord) => void;
+    /**
+     * Update an existing processing record
+     */
+    updateRecord: (id: string, updates: Partial<ProcessingRecord>) => void;
+    /**
+     * Archive a processing record by setting its status to 'archived'
+     */
+    archiveRecord: (id: string) => void;
+    /**
+     * Get a single processing record by ID
+     */
+    getRecord: (id: string) => ProcessingRecord | undefined;
+    /**
+     * Get a summary of the ROPA including statistics
+     */
+    getSummary: () => ROPASummary;
+    /**
+     * Export the ROPA as a CSV string
+     */
+    exportCSV: () => string;
+    /**
+     * Identify compliance gaps across all records
+     */
+    getComplianceGaps: () => ROPAComplianceGap[];
+}
+/**
+ * Hook for managing a Record of Processing Activities (ROPA)
+ * in compliance with NDPA 2023 requirements.
+ *
+ * Provides state management and utility functions for maintaining
+ * a comprehensive register of all data processing activities.
+ */
+declare function useROPA({ initialData, onRecordAdd, onRecordUpdate, onRecordArchive, }: UseROPAOptions): UseROPAReturn;
+
+export { type UseROPAOptions as U, type UseROPAReturn as a, useROPA as u };

package/dist/useROPA-nmcSiUYv.d.mts

@@ -0,0 +1,64 @@
+import { R as RecordOfProcessingActivities, P as ProcessingRecord, a as ROPASummary, b as ROPAComplianceGap } from './ropa-Rb4dsFSz.mjs';
+
+interface UseROPAOptions {
+    /**
+     * Initial ROPA state
+     */
+    initialData: RecordOfProcessingActivities;
+    /**
+     * Callback when a record is added
+     */
+    onRecordAdd?: (record: ProcessingRecord) => void;
+    /**
+     * Callback when a record is updated
+     */
+    onRecordUpdate?: (id: string, updates: Partial<ProcessingRecord>) => void;
+    /**
+     * Callback when a record is archived
+     */
+    onRecordArchive?: (id: string) => void;
+}
+interface UseROPAReturn {
+    /**
+     * Current state of the Record of Processing Activities
+     */
+    ropa: RecordOfProcessingActivities;
+    /**
+     * Add a new processing record
+     */
+    addRecord: (record: ProcessingRecord) => void;
+    /**
+     * Update an existing processing record
+     */
+    updateRecord: (id: string, updates: Partial<ProcessingRecord>) => void;
+    /**
+     * Archive a processing record by setting its status to 'archived'
+     */
+    archiveRecord: (id: string) => void;
+    /**
+     * Get a single processing record by ID
+     */
+    getRecord: (id: string) => ProcessingRecord | undefined;
+    /**
+     * Get a summary of the ROPA including statistics
+     */
+    getSummary: () => ROPASummary;
+    /**
+     * Export the ROPA as a CSV string
+     */
+    exportCSV: () => string;
+    /**
+     * Identify compliance gaps across all records
+     */
+    getComplianceGaps: () => ROPAComplianceGap[];
+}
+/**
+ * Hook for managing a Record of Processing Activities (ROPA)
+ * in compliance with NDPA 2023 requirements.
+ *
+ * Provides state management and utility functions for maintaining
+ * a comprehensive register of all data processing activities.
+ */
+declare function useROPA({ initialData, onRecordAdd, onRecordUpdate, onRecordArchive, }: UseROPAOptions): UseROPAReturn;
+
+export { type UseROPAOptions as U, type UseROPAReturn as a, useROPA as u };