@tantainnovative/ndpr-toolkit 3.5.5 → 3.6.1

package/dist/presets-consent.d.ts

@@ -0,0 +1,139 @@
+import React__default from 'react';
+
+declare interface ConsentBannerClassNames {
+    root?: string;
+    container?: string;
+    title?: string;
+    description?: string;
+    optionsList?: string;
+    optionItem?: string;
+    optionCheckbox?: string;
+    optionLabel?: string;
+    optionDescription?: string;
+    buttonGroup?: string;
+    acceptButton?: string;
+    rejectButton?: string;
+    customizeButton?: string;
+    saveButton?: string;
+    customizePanel?: string;
+    selectAllButton?: string;
+    /** Alias for acceptButton */
+    primaryButton?: string;
+    /** Alias for rejectButton */
+    secondaryButton?: string;
+}
+
+/**
+ * Consent types aligned with NDPA 2023 Section 25-26
+ * Consent must be freely given, specific, informed, and unambiguous
+ */
+/**
+ * Represents a consent option that can be presented to users
+ */
+declare interface ConsentOption {
+    /** Unique identifier for the consent option */
+    id: string;
+    /** Display label for the consent option */
+    label: string;
+    /** Detailed description of what this consent option covers */
+    description: string;
+    /** Whether this consent option is required (cannot be declined) */
+    required: boolean;
+    /**
+     * The specific purpose for which data will be processed
+     * NDPA Section 25(2) requires consent to be specific to each purpose
+     */
+    purpose: string;
+    /**
+     * Default state of the consent option
+     * @default false
+     */
+    defaultValue?: boolean;
+    /**
+     * Categories of personal data covered by this consent option
+     */
+    dataCategories?: string[];
+}
+
+/**
+ * Represents the user's consent settings
+ */
+declare interface ConsentSettings {
+    /** Map of consent option IDs to boolean values indicating consent status */
+    consents: Record<string, boolean>;
+    /** Timestamp when consent was last updated */
+    timestamp: number;
+    /** Version of the consent form that was accepted */
+    version: string;
+    /** Method used to collect consent (e.g., "banner", "settings", "api") */
+    method: string;
+    /** Whether the user has actively made a choice (as opposed to default settings) */
+    hasInteracted: boolean;
+    /**
+     * The lawful basis under which processing is conducted
+     * Required by NDPA Section 25(1)
+     */
+    lawfulBasis?: LawfulBasisType;
+}
+
+/**
+ * Lawful basis for processing personal data per NDPA Section 25(1)
+ */
+declare type LawfulBasisType = 'consent' | 'contract' | 'legal_obligation' | 'vital_interests' | 'public_interest' | 'legitimate_interests';
+
+export declare const NDPRConsent: React__default.FC<NDPRConsentProps>;
+
+/**
+ * UX copy overrides for the NDPRConsent preset. Pass any subset to
+ * replace the default text without dropping to the lower-level
+ * `<ConsentBanner>` API. Strings you omit fall back to the toolkit
+ * defaults (which already cite NDPA Section 26).
+ *
+ * @example
+ *   <NDPRConsent copy={{
+ *     title: 'Cookie preferences',
+ *     description: 'Acme uses cookies to keep you signed in and improve our store.',
+ *     acceptAll: 'Allow all',
+ *     rejectAll: 'Only essentials',
+ *   }} />
+ */
+export declare interface NDPRConsentCopy {
+    /** Banner heading. Default: "We Value Your Privacy" */
+    title?: string;
+    /** Body paragraph under the heading. Default cites NDPA Section 26. */
+    description?: string;
+    /** Primary CTA — accepts all categories. Default: "Accept All" */
+    acceptAll?: string;
+    /** Secondary CTA — rejects all non-essential categories. Default: "Reject All" */
+    rejectAll?: string;
+    /** Tertiary CTA — opens the per-category controls. Default: "Customize" */
+    customize?: string;
+    /** Submit button on the per-category panel. Default: "Save Preferences" */
+    save?: string;
+}
+
+export declare interface NDPRConsentProps {
+    extraOptions?: ConsentOption[];
+    options?: ConsentOption[];
+    adapter?: StorageAdapter<ConsentSettings>;
+    position?: 'top' | 'bottom' | 'center' | 'inline';
+    classNames?: ConsentBannerClassNames;
+    unstyled?: boolean;
+    onSave?: (settings: ConsentSettings) => void;
+    /**
+     * UX copy overrides — see {@link NDPRConsentCopy}. Lets you brand the
+     * banner without dropping to the lower-level `<ConsentBanner>` API.
+     */
+    copy?: NDPRConsentCopy;
+}
+
+declare interface StorageAdapter<T = unknown> {
+    /** Load persisted data. Called once on hook mount. */
+    load(): T | null | Promise<T | null>;
+    /** Persist data. Called on every state change. */
+    save(data: T): void | Promise<void>;
+    /** Clear persisted data. Called on reset. */
+    remove(): void | Promise<void>;
+}
+
+export { }

package/dist/presets-consent.js

@@ -0,0 +1,2 @@
+"use client";
+'use strict';var chunkV3RYHNHN_js=require('./chunk-V3RYHNHN.js');require('./chunk-732C2EVN.js'),require('./chunk-L2VO3MEJ.js'),require('./chunk-AME4HJR4.js'),require('./chunk-RFPLZDIO.js');Object.defineProperty(exports,"NDPRConsent",{enumerable:true,get:function(){return chunkV3RYHNHN_js.a}});

package/dist/presets-consent.mjs

@@ -0,0 +1,2 @@
+"use client";
+export{a as NDPRConsent}from'./chunk-LTPSN2SU.mjs';import'./chunk-BFAX7JQA.mjs';import'./chunk-YTU4FNM2.mjs';import'./chunk-SFGW37LE.mjs';import'./chunk-ZJYULEER.mjs';

package/dist/presets-dsr.d.mts

@@ -0,0 +1,133 @@
+import React__default from 'react';
+
+/**
+ * Represents the data submitted by the DSR request form.
+ */
+declare 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, string | number | boolean | null>;
+    /** Timestamp (ms) when the form was submitted */
+    submittedAt: number;
+}
+
+declare 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;
+}
+
+export declare const NDPRSubjectRights: React__default.FC<NDPRSubjectRightsProps>;
+
+export declare interface NDPRSubjectRightsProps {
+    requestTypes?: RequestType[];
+    adapter?: StorageAdapter<DSRFormSubmission>;
+    classNames?: DSRRequestFormClassNames;
+    unstyled?: boolean;
+    onSubmit?: (data: DSRFormSubmission) => void;
+    /**
+     * Public-form mode. Use when the form should submit to your existing
+     * backend workflow instead of being state-managed by an adapter.
+     *
+     * When `submitTo` is set:
+     * - the form does NOT require an `adapter`
+     * - on submit, the toolkit POSTs the JSON-serialised `DSRFormSubmission`
+     *   to this URL (with `Content-Type: application/json`)
+     * - your `onSubmit` callback still fires (after the POST resolves)
+     * - submit failures are surfaced via `onSubmitError`
+     *
+     * For more control over headers, credentials, or retry behaviour, build
+     * an `apiAdapter` (which now supports CSRF, retry, and error hooks in
+     * 3.6.0) and pass that as `adapter` instead. `submitTo` is the
+     * fire-and-forget shortcut for public forms.
+     *
+     * @example
+     *   <NDPRSubjectRights submitTo="/api/dsr" />
+     */
+    submitTo?: string;
+    /**
+     * Fetch options for the `submitTo` POST. Useful for adding `credentials`
+     * (cookies/auth), `X-CSRF-Token`, or any other header your backend
+     * requires. Ignored unless `submitTo` is set.
+     *
+     * @default { credentials: 'same-origin' }
+     */
+    submitOptions?: {
+        headers?: Record<string, string> | (() => Record<string, string>);
+        credentials?: RequestCredentials;
+    };
+    /**
+     * Called when a `submitTo` POST fails (network error or non-2xx
+     * response). Receives the underlying error or Response.
+     */
+    onSubmitError?: (ctx: {
+        error?: unknown;
+        response?: Response;
+    }) => void;
+}
+
+/**
+ * Represents a type of data subject request (detailed configuration)
+ */
+declare interface RequestType {
+    /** Unique identifier for the request type */
+    id: string;
+    /** Display name for the request type */
+    name: string;
+    /** Description of what this request type entails */
+    description: string;
+    /**
+     * NDPA 2023 section reference for this right
+     * (e.g., "Section 34(1)(a)" for access, "Section 38" for portability).
+     * Used for display purposes only — verify the exact subsection with counsel.
+     */
+    ndpaSection?: string;
+    /**
+     * Estimated time to fulfill this type of request (in days)
+     * NDPA requires response within 30 days
+     */
+    estimatedCompletionTime: number;
+    /** Whether additional information is required for this request type */
+    requiresAdditionalInfo: boolean;
+    /** Custom fields required for this request type */
+    additionalFields?: Array<{
+        id: string;
+        label: string;
+        type: 'text' | 'textarea' | 'select' | 'checkbox' | 'file';
+        options?: string[];
+        required: boolean;
+        placeholder?: string;
+    }>;
+}
+
+declare interface StorageAdapter<T = unknown> {
+    /** Load persisted data. Called once on hook mount. */
+    load(): T | null | Promise<T | null>;
+    /** Persist data. Called on every state change. */
+    save(data: T): void | Promise<void>;
+    /** Clear persisted data. Called on reset. */
+    remove(): void | Promise<void>;
+}
+
+export { }

package/dist/presets-dsr.d.ts

@@ -0,0 +1,133 @@
+import React__default from 'react';
+
+/**
+ * Represents the data submitted by the DSR request form.
+ */
+declare 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, string | number | boolean | null>;
+    /** Timestamp (ms) when the form was submitted */
+    submittedAt: number;
+}
+
+declare 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;
+}
+
+export declare const NDPRSubjectRights: React__default.FC<NDPRSubjectRightsProps>;
+
+export declare interface NDPRSubjectRightsProps {
+    requestTypes?: RequestType[];
+    adapter?: StorageAdapter<DSRFormSubmission>;
+    classNames?: DSRRequestFormClassNames;
+    unstyled?: boolean;
+    onSubmit?: (data: DSRFormSubmission) => void;
+    /**
+     * Public-form mode. Use when the form should submit to your existing
+     * backend workflow instead of being state-managed by an adapter.
+     *
+     * When `submitTo` is set:
+     * - the form does NOT require an `adapter`
+     * - on submit, the toolkit POSTs the JSON-serialised `DSRFormSubmission`
+     *   to this URL (with `Content-Type: application/json`)
+     * - your `onSubmit` callback still fires (after the POST resolves)
+     * - submit failures are surfaced via `onSubmitError`
+     *
+     * For more control over headers, credentials, or retry behaviour, build
+     * an `apiAdapter` (which now supports CSRF, retry, and error hooks in
+     * 3.6.0) and pass that as `adapter` instead. `submitTo` is the
+     * fire-and-forget shortcut for public forms.
+     *
+     * @example
+     *   <NDPRSubjectRights submitTo="/api/dsr" />
+     */
+    submitTo?: string;
+    /**
+     * Fetch options for the `submitTo` POST. Useful for adding `credentials`
+     * (cookies/auth), `X-CSRF-Token`, or any other header your backend
+     * requires. Ignored unless `submitTo` is set.
+     *
+     * @default { credentials: 'same-origin' }
+     */
+    submitOptions?: {
+        headers?: Record<string, string> | (() => Record<string, string>);
+        credentials?: RequestCredentials;
+    };
+    /**
+     * Called when a `submitTo` POST fails (network error or non-2xx
+     * response). Receives the underlying error or Response.
+     */
+    onSubmitError?: (ctx: {
+        error?: unknown;
+        response?: Response;
+    }) => void;
+}
+
+/**
+ * Represents a type of data subject request (detailed configuration)
+ */
+declare interface RequestType {
+    /** Unique identifier for the request type */
+    id: string;
+    /** Display name for the request type */
+    name: string;
+    /** Description of what this request type entails */
+    description: string;
+    /**
+     * NDPA 2023 section reference for this right
+     * (e.g., "Section 34(1)(a)" for access, "Section 38" for portability).
+     * Used for display purposes only — verify the exact subsection with counsel.
+     */
+    ndpaSection?: string;
+    /**
+     * Estimated time to fulfill this type of request (in days)
+     * NDPA requires response within 30 days
+     */
+    estimatedCompletionTime: number;
+    /** Whether additional information is required for this request type */
+    requiresAdditionalInfo: boolean;
+    /** Custom fields required for this request type */
+    additionalFields?: Array<{
+        id: string;
+        label: string;
+        type: 'text' | 'textarea' | 'select' | 'checkbox' | 'file';
+        options?: string[];
+        required: boolean;
+        placeholder?: string;
+    }>;
+}
+
+declare interface StorageAdapter<T = unknown> {
+    /** Load persisted data. Called once on hook mount. */
+    load(): T | null | Promise<T | null>;
+    /** Persist data. Called on every state change. */
+    save(data: T): void | Promise<void>;
+    /** Clear persisted data. Called on reset. */
+    remove(): void | Promise<void>;
+}
+
+export { }

package/dist/presets-dsr.js

@@ -0,0 +1,2 @@
+"use client";
+'use strict';var chunkRXZFYBUJ_js=require('./chunk-RXZFYBUJ.js');require('./chunk-W47OSMT6.js'),require('./chunk-UXUMYP4L.js'),require('./chunk-AME4HJR4.js'),require('./chunk-RFPLZDIO.js');Object.defineProperty(exports,"NDPRSubjectRights",{enumerable:true,get:function(){return chunkRXZFYBUJ_js.a}});

package/dist/presets-dsr.mjs

@@ -0,0 +1,2 @@
+"use client";
+export{a as NDPRSubjectRights}from'./chunk-SJRIOZ4K.mjs';import'./chunk-XJO4DH3L.mjs';import'./chunk-EWVK45Z3.mjs';import'./chunk-SFGW37LE.mjs';import'./chunk-ZJYULEER.mjs';

package/dist/presets-policy.d.mts

@@ -0,0 +1,203 @@
+import React__default from 'react';
+
+/** A user-defined section added to the policy outside the generated ones. */
+declare interface CustomSection {
+    id: string;
+    title: string;
+    content: string;
+    order: number;
+    required: false;
+}
+
+/** A logical category of personal data the organisation may collect. */
+declare interface DataCategory {
+    /** Machine-readable identifier. */
+    id: string;
+    /** Human-readable label shown in the wizard. */
+    label: string;
+    /** Grouping for display and compliance checks. */
+    group: 'identity' | 'financial' | 'behavioral' | 'sensitive' | 'children';
+    /** Specific data points within this category. */
+    dataPoints: string[];
+    /** Whether this category is currently selected by the user. */
+    selected: boolean;
+}
+
+/**
+ * Policy engine types for the adaptive privacy policy generator.
+ * These types power the wizard-driven policy builder, compliance checker,
+ * and export functionality — all aligned with the NDPA 2023.
+ */
+
+/** Industry verticals with sector-specific compliance requirements. */
+declare type Industry = 'fintech' | 'healthcare' | 'ecommerce' | 'saas' | 'education' | 'government' | 'other';
+
+export declare const NDPRPrivacyPolicy: React__default.FC<NDPRPrivacyPolicyProps>;
+
+export declare interface NDPRPrivacyPolicyProps {
+    adapter?: StorageAdapter<PolicyDraft>;
+    onComplete?: (policy: PrivacyPolicy) => void;
+    classNames?: Record<string, string>;
+    unstyled?: boolean;
+}
+
+/**
+ * Represents organization information for a privacy policy
+ */
+declare interface OrganizationInfo {
+    /** Name of the organization */
+    name: string;
+    /** Website URL of the organization */
+    website: string;
+    /** Contact email for privacy inquiries */
+    privacyEmail: string;
+    /** Physical address of the organization */
+    address?: string;
+    /** Phone number for privacy inquiries */
+    privacyPhone?: string;
+    /** Name of the Data Protection Officer */
+    dpoName?: string;
+    /** Email of the Data Protection Officer */
+    dpoEmail?: string;
+    /** Industry or sector of the organization */
+    industry?: string;
+    /** NDPC registration number (if registered) */
+    ndpcRegistrationNumber?: string;
+}
+
+/** Organisation size tiers — affects complexity of generated language. */
+declare type OrgSize = 'startup' | 'midsize' | 'enterprise';
+
+/** Represents an in-progress policy being built in the wizard. */
+declare interface PolicyDraft {
+    /** Unique identifier for the draft. */
+    id: string;
+    /** The template context driving section generation. */
+    templateContext: TemplateContext;
+    /** Custom sections added by the user. */
+    customSections: CustomSection[];
+    /** Per-section content overrides keyed by section id. */
+    sectionOverrides: Record<string, string>;
+    /** Ordered list of section ids defining the final order. */
+    sectionOrder: string[];
+    /** Current wizard step (0-indexed). */
+    currentStep: number;
+    /** Timestamp of the last save. */
+    lastSavedAt: number;
+    /** The draft is always in "draft" status until finalised. */
+    status: 'draft';
+}
+
+/**
+ * Privacy policy types aligned with NDPA 2023
+ * Privacy policies must clearly inform data subjects of their rights under the NDPA
+ */
+/**
+ * Represents a section in a privacy policy
+ */
+declare interface PolicySection {
+    /** Unique identifier for the section */
+    id: string;
+    /** Title of the section */
+    title: string;
+    /** Description of the section */
+    description?: string;
+    /** Order of the section in the policy */
+    order?: number;
+    /** Whether the section is required by NDPA */
+    required: boolean;
+    /** Template text for the section */
+    template: string;
+    /**
+     * Default content for the section (legacy field)
+     * @deprecated Use template instead
+     */
+    defaultContent?: string;
+    /**
+     * Custom content for the section (overrides default content)
+     * @deprecated Use template instead
+     */
+    customContent?: string;
+    /** Whether the section is included in the policy */
+    included: boolean;
+    /** Variables that can be used in the section content */
+    variables?: string[];
+}
+
+/**
+ * Represents a generated privacy policy
+ */
+declare interface PrivacyPolicy {
+    /** Unique identifier for the policy */
+    id: string;
+    /** Title of the policy */
+    title: string;
+    /** Template used to generate the policy */
+    templateId: string;
+    /** Organization information */
+    organizationInfo: OrganizationInfo;
+    /** Sections of the policy */
+    sections: PolicySection[];
+    /** Values for the variables used in the policy */
+    variableValues: Record<string, string>;
+    /** Effective date of the policy */
+    effectiveDate: number;
+    /** Last updated date of the policy */
+    lastUpdated: number;
+    /** Version of the policy */
+    version: string;
+    /**
+     * Applicable legal frameworks
+     */
+    applicableFrameworks?: ('ndpa' | 'ndpr' | 'gdpr' | 'ccpa')[];
+}
+
+/** Lawful processing purposes recognised under the NDPA. */
+declare type ProcessingPurpose = 'service_delivery' | 'marketing' | 'analytics' | 'research' | 'legal_compliance' | 'fraud_prevention';
+
+declare interface StorageAdapter<T = unknown> {
+    /** Load persisted data. Called once on hook mount. */
+    load(): T | null | Promise<T | null>;
+    /** Persist data. Called on every state change. */
+    save(data: T): void | Promise<void>;
+    /** Clear persisted data. Called on reset. */
+    remove(): void | Promise<void>;
+}
+
+/** Full context used to generate an adaptive privacy policy. */
+declare interface TemplateContext {
+    /** Organisation details, extended with industry and size. */
+    org: OrganizationInfo & {
+        industry: Industry;
+        orgSize: OrgSize;
+        country: string;
+    };
+    /** Data categories the organisation collects. */
+    dataCategories: DataCategory[];
+    /** Processing purposes relevant to the organisation. */
+    purposes: ProcessingPurpose[];
+    /** Whether the organisation processes children's data. */
+    hasChildrenData: boolean;
+    /** Whether the organisation processes sensitive/special-category data. */
+    hasSensitiveData: boolean;
+    /** Whether the organisation processes financial data. */
+    hasFinancialData: boolean;
+    /** Whether data is transferred outside Nigeria. */
+    hasCrossBorderTransfer: boolean;
+    /** Whether automated decision-making or profiling is used. */
+    hasAutomatedDecisions: boolean;
+    /** Third-party processors that receive personal data. */
+    thirdPartyProcessors: ThirdPartyProcessor[];
+}
+
+/** A third-party entity that processes data on behalf of the organisation. */
+declare interface ThirdPartyProcessor {
+    /** Name of the third party. */
+    name: string;
+    /** Purpose of sharing data with this processor. */
+    purpose: string;
+    /** Country where the processor is located. */
+    country: string;
+}
+
+export { }