@tantainnovative/ndpr-toolkit 3.4.1 → 3.5.1

package/dist/useCrossBorderTransfer-DvSq06lv.d.ts

@@ -1,78 +0,0 @@
-import { a as CrossBorderTransfer, C as CrossBorderSummary } from './cross-border-UyT00llA.js';
-import { a as TransferValidationResult } from './cross-border-Dy-U9Hu6.js';
-import { S as StorageAdapter } from './types-DK2CoKOC.js';
-
-interface UseCrossBorderTransferOptions {
-    /**
-     * Initial transfers to load
-     */
-    initialTransfers?: CrossBorderTransfer[];
-    /**
-     * Pluggable storage adapter. When provided, takes precedence over storageKey/useLocalStorage.
-     */
-    adapter?: StorageAdapter<CrossBorderTransfer[]>;
-    /**
-     * Storage key for transfer data
-     * @default "ndpr_cross_border_transfers"
-     * @deprecated Use adapter instead
-     */
-    storageKey?: string;
-    /**
-     * Whether to use local storage to persist transfers
-     * @default true
-     * @deprecated Use adapter instead
-     */
-    useLocalStorage?: boolean;
-    /**
-     * Callback function called when a transfer is added
-     */
-    onAdd?: (transfer: CrossBorderTransfer) => void;
-    /**
-     * Callback function called when a transfer is updated
-     */
-    onUpdate?: (transfer: CrossBorderTransfer) => void;
-    /**
-     * Callback function called when a transfer is removed
-     */
-    onRemove?: (id: string) => void;
-}
-interface UseCrossBorderTransferReturn {
-    /**
-     * All cross-border transfers
-     */
-    transfers: CrossBorderTransfer[];
-    /**
-     * Add a new cross-border transfer
-     */
-    addTransfer: (transfer: Omit<CrossBorderTransfer, 'id' | 'createdAt' | 'updatedAt'>) => CrossBorderTransfer;
-    /**
-     * Update an existing cross-border transfer
-     */
-    updateTransfer: (id: string, updates: Partial<CrossBorderTransfer>) => CrossBorderTransfer | null;
-    /**
-     * Remove a cross-border transfer
-     */
-    removeTransfer: (id: string) => void;
-    /**
-     * Get a cross-border transfer by ID
-     */
-    getTransfer: (id: string) => CrossBorderTransfer | null;
-    /**
-     * Get a compliance summary of all cross-border transfers
-     */
-    getSummary: () => CrossBorderSummary;
-    /**
-     * Validate a cross-border transfer
-     */
-    validateTransfer: (transfer: CrossBorderTransfer) => TransferValidationResult;
-    /**
-     * Whether the adapter is still loading data (relevant for async adapters)
-     */
-    isLoading: boolean;
-}
-/**
- * Hook for managing cross-border data transfers in compliance with NDPA Part VI (Sections 41-45)
- */
-declare function useCrossBorderTransfer({ initialTransfers, adapter, storageKey, useLocalStorage, onAdd, onUpdate, onRemove, }?: UseCrossBorderTransferOptions): UseCrossBorderTransferReturn;
-
-export { type UseCrossBorderTransferReturn as U, useCrossBorderTransfer as u };

package/dist/useDPIA-B6180UQn.d.mts

@@ -1,109 +0,0 @@
-import { c as DPIASection, a as DPIAResult, D as DPIAQuestion } from './dpia-c9GiiOq0.mjs';
-import { S as StorageAdapter } from './types-DK2CoKOC.mjs';
-
-/** Possible value types for a DPIA answer */
-type DPIAAnswerValue = string | number | boolean | string[];
-/** A map of question IDs to their answer values */
-type DPIAAnswerMap = Record<string, DPIAAnswerValue>;
-interface UseDPIAOptions {
-    /**
-     * Sections of the DPIA questionnaire
-     */
-    sections: DPIASection[];
-    /**
-     * Initial answers (if resuming a DPIA)
-     */
-    initialAnswers?: DPIAAnswerMap;
-    /**
-     * Pluggable storage adapter. When provided, takes precedence over storageKey/useLocalStorage.
-     */
-    adapter?: StorageAdapter<DPIAAnswerMap>;
-    /**
-     * Storage key for DPIA data
-     * @default "ndpr_dpia_data"
-     * @deprecated Use adapter instead
-     */
-    storageKey?: string;
-    /**
-     * Whether to use local storage to persist DPIA data
-     * @default true
-     * @deprecated Use adapter instead
-     */
-    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: DPIAAnswerMap;
-    /**
-     * Update an answer
-     */
-    updateAnswer: (questionId: string, value: DPIAAnswerValue) => 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;
-    /**
-     * Whether the adapter is still loading data (relevant for async adapters)
-     */
-    isLoading: boolean;
-}
-/**
- * Hook for conducting Data Protection Impact Assessments in compliance with the NDPA 2023
- */
-declare function useDPIA({ sections, initialAnswers, adapter, storageKey, useLocalStorage, onComplete, }: UseDPIAOptions): UseDPIAReturn;
-
-export { type UseDPIAReturn as U, useDPIA as u };

package/dist/useDPIA-CTqbNbww.d.ts

@@ -1,109 +0,0 @@
-import { c as DPIASection, a as DPIAResult, D as DPIAQuestion } from './dpia-c9GiiOq0.js';
-import { S as StorageAdapter } from './types-DK2CoKOC.js';
-
-/** Possible value types for a DPIA answer */
-type DPIAAnswerValue = string | number | boolean | string[];
-/** A map of question IDs to their answer values */
-type DPIAAnswerMap = Record<string, DPIAAnswerValue>;
-interface UseDPIAOptions {
-    /**
-     * Sections of the DPIA questionnaire
-     */
-    sections: DPIASection[];
-    /**
-     * Initial answers (if resuming a DPIA)
-     */
-    initialAnswers?: DPIAAnswerMap;
-    /**
-     * Pluggable storage adapter. When provided, takes precedence over storageKey/useLocalStorage.
-     */
-    adapter?: StorageAdapter<DPIAAnswerMap>;
-    /**
-     * Storage key for DPIA data
-     * @default "ndpr_dpia_data"
-     * @deprecated Use adapter instead
-     */
-    storageKey?: string;
-    /**
-     * Whether to use local storage to persist DPIA data
-     * @default true
-     * @deprecated Use adapter instead
-     */
-    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: DPIAAnswerMap;
-    /**
-     * Update an answer
-     */
-    updateAnswer: (questionId: string, value: DPIAAnswerValue) => 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;
-    /**
-     * Whether the adapter is still loading data (relevant for async adapters)
-     */
-    isLoading: boolean;
-}
-/**
- * Hook for conducting Data Protection Impact Assessments in compliance with the NDPA 2023
- */
-declare function useDPIA({ sections, initialAnswers, adapter, storageKey, useLocalStorage, onComplete, }: UseDPIAOptions): UseDPIAReturn;
-
-export { type UseDPIAReturn as U, useDPIA as u };

package/dist/useDSR-WvHk8_iu.d.mts

@@ -1,85 +0,0 @@
-import { D as DSRRequest, c as RequestType, R as RequestStatus } from './dsr-yKbqX531.mjs';
-import { S as StorageAdapter } from './types-DK2CoKOC.mjs';
-
-interface UseDSROptions {
-    /**
-     * Initial requests to load
-     */
-    initialRequests?: DSRRequest[];
-    /**
-     * Available request types
-     */
-    requestTypes: RequestType[];
-    /**
-     * Pluggable storage adapter. When provided, takes precedence over storageKey/useLocalStorage.
-     */
-    adapter?: StorageAdapter<DSRRequest[]>;
-    /**
-     * Storage key for requests
-     * @default "ndpr_dsr_requests"
-     * @deprecated Use adapter instead
-     */
-    storageKey?: string;
-    /**
-     * Whether to use local storage to persist requests
-     * @default true
-     * @deprecated Use adapter instead
-     */
-    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, unknown>;
-    /**
-     * Clear all requests
-     */
-    clearRequests: () => void;
-    /**
-     * Whether the adapter is still loading data (relevant for async adapters)
-     */
-    isLoading: boolean;
-}
-/**
- * Hook for managing Data Subject Requests in compliance with the NDPA
- */
-declare function useDSR({ initialRequests, requestTypes, adapter, storageKey, useLocalStorage, onSubmit, onUpdate, }: UseDSROptions): UseDSRReturn;
-
-export { type UseDSRReturn as U, useDSR as u };

package/dist/useDSR-wH4H6hSM.d.ts

@@ -1,85 +0,0 @@
-import { D as DSRRequest, c as RequestType, R as RequestStatus } from './dsr-yKbqX531.js';
-import { S as StorageAdapter } from './types-DK2CoKOC.js';
-
-interface UseDSROptions {
-    /**
-     * Initial requests to load
-     */
-    initialRequests?: DSRRequest[];
-    /**
-     * Available request types
-     */
-    requestTypes: RequestType[];
-    /**
-     * Pluggable storage adapter. When provided, takes precedence over storageKey/useLocalStorage.
-     */
-    adapter?: StorageAdapter<DSRRequest[]>;
-    /**
-     * Storage key for requests
-     * @default "ndpr_dsr_requests"
-     * @deprecated Use adapter instead
-     */
-    storageKey?: string;
-    /**
-     * Whether to use local storage to persist requests
-     * @default true
-     * @deprecated Use adapter instead
-     */
-    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, unknown>;
-    /**
-     * Clear all requests
-     */
-    clearRequests: () => void;
-    /**
-     * Whether the adapter is still loading data (relevant for async adapters)
-     */
-    isLoading: boolean;
-}
-/**
- * Hook for managing Data Subject Requests in compliance with the NDPA
- */
-declare function useDSR({ initialRequests, requestTypes, adapter, storageKey, useLocalStorage, onSubmit, onUpdate, }: UseDSROptions): UseDSRReturn;
-
-export { type UseDSRReturn as U, useDSR as u };

package/dist/useDefaultPrivacyPolicy-Cs2WQSYQ.d.mts

@@ -1,162 +0,0 @@
-import { c as PrivacyPolicy, a as PolicyTemplate, O as OrganizationInfo } from './privacy-Ca6te9Ir.mjs';
-import { S as StorageAdapter } from './types-DK2CoKOC.mjs';
-
-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 };