@tantainnovative/ndpr-toolkit 3.4.0 → 3.5.0

package/dist/useDefaultPrivacyPolicy-DkOqMg2e.d.ts

@@ -1,162 +0,0 @@
-import { c as PrivacyPolicy, a as PolicyTemplate, O as OrganizationInfo } from './privacy-Ca6te9Ir.js';
-import { S as StorageAdapter } from './types-DK2CoKOC.js';
-
-interface UsePrivacyPolicyOptions {
-    /**
-     * Available policy templates
-     */
-    templates: PolicyTemplate[];
-    /**
-     * Initial policy data (if editing an existing policy)
-     */
-    initialPolicy?: PrivacyPolicy;
-    /**
-     * Pluggable storage adapter. When provided, takes precedence over storageKey/useLocalStorage.
-     */
-    adapter?: StorageAdapter<PrivacyPolicy>;
-    /**
-     * Storage key for policy data
-     * @default "ndpr_privacy_policy"
-     * @deprecated Use adapter instead
-     */
-    storageKey?: string;
-    /**
-     * Whether to use local storage to persist policy data
-     * @default true
-     * @deprecated Use adapter instead
-     */
-    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 | null;
-    /**
-     * 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[];
-    };
-    /**
-     * Whether the adapter is still loading data (relevant for async adapters)
-     */
-    isLoading: boolean;
-}
-/**
- * Hook for generating NDPA-compliant privacy policies
- */
-declare function usePrivacyPolicy({ templates, initialPolicy, adapter, storageKey, useLocalStorage, onGenerate, }: UsePrivacyPolicyOptions): UsePrivacyPolicyReturn;
-
-interface UseDefaultPrivacyPolicyOptions {
-    /**
-     * Organisation information to pre-fill into the policy. When provided and
-     * `autoGenerate` is true (the default), the hook will auto-select the
-     * default template and generate a renderable policy on first commit, so
-     * `policy` is non-null on the first useful render.
-     */
-    orgInfo?: {
-        /** Organisation name (maps to `organizationInfo.name` and `orgName` variable) */
-        name?: string;
-        /** Privacy contact email (maps to `privacyEmail`) */
-        email?: string;
-        /** Organisation website URL */
-        website?: string;
-        /** Physical address */
-        address?: string;
-        /** Industry / sector descriptor */
-        industry?: string;
-        /** Data Protection Officer name */
-        dpoName?: string;
-        /** DPO email address */
-        dpoEmail?: string;
-    };
-    /**
-     * Whether the hook should auto-select the default template and generate
-     * the policy as soon as it's mounted with `orgInfo`. Set to false to
-     * retain manual control via `selectTemplate` / `generatePolicy`.
-     * @default true
-     */
-    autoGenerate?: boolean;
-    /**
-     * Storage key for policy data.
-     * @default "ndpr_privacy_policy"
-     */
-    storageKey?: string;
-    /**
-     * Whether to persist policy data in local storage.
-     * @default true
-     */
-    useLocalStorage?: boolean;
-    /**
-     * Pluggable storage adapter. When provided, takes precedence over
-     * storageKey/useLocalStorage.
-     */
-    adapter?: StorageAdapter<PrivacyPolicy>;
-}
-/**
- * Convenience wrapper around `usePrivacyPolicy`. With `orgInfo` provided
- * and `autoGenerate` enabled (default), `policy` is non-null on the first
- * post-load render — no manual `selectTemplate` / `generatePolicy` chaining
- * required.
- *
- * @example
- * ```tsx
- * const { policy } = useDefaultPrivacyPolicy({
- *   orgInfo: { name: 'Acme Ltd', email: 'privacy@acme.ng' }
- * });
- * return policy ? <PolicyPage policy={policy} /> : <Spinner />;
- * ```
- */
-declare function useDefaultPrivacyPolicy(options?: UseDefaultPrivacyPolicyOptions): UsePrivacyPolicyReturn;
-
-export { type UsePrivacyPolicyReturn as U, usePrivacyPolicy as a, useDefaultPrivacyPolicy as u };

package/dist/useLawfulBasis-CKJ-kw84.d.mts

@@ -1,79 +0,0 @@
-import { P as ProcessingActivity, a as LawfulBasisSummary } from './lawful-basis-Cv1VmDLn.mjs';
-import { a as LawfulBasisValidationResult } from './lawful-basis-C2eGaoHM.mjs';
-import { S as StorageAdapter } from './types-DK2CoKOC.mjs';
-
-interface UseLawfulBasisOptions {
-    /**
-     * Initial processing activities to load
-     */
-    initialActivities?: ProcessingActivity[];
-    /**
-     * Pluggable storage adapter. When provided, takes precedence over storageKey/useLocalStorage.
-     */
-    adapter?: StorageAdapter<ProcessingActivity[]>;
-    /**
-     * Storage key for persisting activities
-     * @default "ndpr_lawful_basis_activities"
-     * @deprecated Use adapter instead
-     */
-    storageKey?: string;
-    /**
-     * Whether to use local storage to persist activities
-     * @default true
-     * @deprecated Use adapter instead
-     */
-    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;
-    /**
-     * Whether the adapter is still loading data (relevant for async adapters)
-     */
-    isLoading: boolean;
-}
-/**
- * Hook for managing lawful basis documentation for processing activities
- * in compliance with NDPA 2023 Section 25.
- */
-declare function useLawfulBasis({ initialActivities, adapter, storageKey, useLocalStorage, onAdd, onUpdate, onRemove, }?: UseLawfulBasisOptions): UseLawfulBasisReturn;
-
-export { type UseLawfulBasisReturn as U, useLawfulBasis as u };

package/dist/useLawfulBasis-DFTmu1ca.d.ts

@@ -1,79 +0,0 @@
-import { P as ProcessingActivity, a as LawfulBasisSummary } from './lawful-basis-Cv1VmDLn.js';
-import { a as LawfulBasisValidationResult } from './lawful-basis-BEyI0kGg.js';
-import { S as StorageAdapter } from './types-DK2CoKOC.js';
-
-interface UseLawfulBasisOptions {
-    /**
-     * Initial processing activities to load
-     */
-    initialActivities?: ProcessingActivity[];
-    /**
-     * Pluggable storage adapter. When provided, takes precedence over storageKey/useLocalStorage.
-     */
-    adapter?: StorageAdapter<ProcessingActivity[]>;
-    /**
-     * Storage key for persisting activities
-     * @default "ndpr_lawful_basis_activities"
-     * @deprecated Use adapter instead
-     */
-    storageKey?: string;
-    /**
-     * Whether to use local storage to persist activities
-     * @default true
-     * @deprecated Use adapter instead
-     */
-    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;
-    /**
-     * Whether the adapter is still loading data (relevant for async adapters)
-     */
-    isLoading: boolean;
-}
-/**
- * Hook for managing lawful basis documentation for processing activities
- * in compliance with NDPA 2023 Section 25.
- */
-declare function useLawfulBasis({ initialActivities, adapter, storageKey, useLocalStorage, onAdd, onUpdate, onRemove, }?: UseLawfulBasisOptions): UseLawfulBasisReturn;
-
-export { type UseLawfulBasisReturn as U, useLawfulBasis as u };

package/dist/useROPA-BSSU1rfx.d.ts

@@ -1,76 +0,0 @@
-import { a as RecordOfProcessingActivities, P as ProcessingRecord, R as ROPASummary } from './ropa-BDTM06tr.js';
-import { R as ROPAComplianceGap } from './ropa-CyynscU6.js';
-import { S as StorageAdapter } from './types-DK2CoKOC.js';
-
-interface UseROPAOptions {
-    /**
-     * Initial ROPA state
-     */
-    initialData: RecordOfProcessingActivities;
-    /**
-     * Pluggable storage adapter. When provided, adapter data is loaded on mount
-     * and the ROPA is persisted after every mutation. Falls back to initialData
-     * when no adapter data is found.
-     */
-    adapter?: StorageAdapter<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[];
-    /**
-     * Whether the adapter is still loading data (relevant for async adapters)
-     */
-    isLoading: boolean;
-}
-/**
- * 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, adapter, onRecordAdd, onRecordUpdate, onRecordArchive, }: UseROPAOptions): UseROPAReturn;
-
-export { type UseROPAOptions as U, type UseROPAReturn as a, useROPA as u };

package/dist/useROPA-C2hjaBTz.d.mts

@@ -1,76 +0,0 @@
-import { a as RecordOfProcessingActivities, P as ProcessingRecord, R as ROPASummary } from './ropa-CFHuT7jE.mjs';
-import { R as ROPAComplianceGap } from './ropa-NIgxd8uP.mjs';
-import { S as StorageAdapter } from './types-DK2CoKOC.mjs';
-
-interface UseROPAOptions {
-    /**
-     * Initial ROPA state
-     */
-    initialData: RecordOfProcessingActivities;
-    /**
-     * Pluggable storage adapter. When provided, adapter data is loaded on mount
-     * and the ROPA is persisted after every mutation. Falls back to initialData
-     * when no adapter data is found.
-     */
-    adapter?: StorageAdapter<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[];
-    /**
-     * Whether the adapter is still loading data (relevant for async adapters)
-     */
-    isLoading: boolean;
-}
-/**
- * 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, adapter, onRecordAdd, onRecordUpdate, onRecordArchive, }: UseROPAOptions): UseROPAReturn;
-
-export { type UseROPAOptions as U, type UseROPAReturn as a, useROPA as u };