@tantainnovative/ndpr-toolkit 2.4.1 → 3.0.0

package/dist/consent.d.mts

@@ -1,310 +1,82 @@
-import React from 'react';
-import { C as ConsentOption, a as ConsentSettings, b as ConsentStorageOptions } from './consent-CmVzqZUk.mjs';
-export { L as LawfulBasisType } from './consent-CmVzqZUk.mjs';
-export { u as useConsent } from './useConsent-DOt2Njst.mjs';
+import { c as ConsentBannerProps } from './ConsentBanner-CDRT0o2k.mjs';
+export { C as ConsentAnalyticsEvent, a as ConsentBanner, b as ConsentBannerClassNames } from './ConsentBanner-CDRT0o2k.mjs';
+import { d as ConsentManagerProps, e as ConsentStorageProps } from './styling-uJLsBbER.mjs';
+export { C as ConsentManager, a as ConsentManagerClassNames, b as ConsentStorage, c as ConsentStorageClassNames, r as resolveClass } from './styling-uJLsBbER.mjs';
+export { u as useConsent } from './useConsent-DCNkIJHR.mjs';
 export { C as ConsentAuditEntry, a as appendAuditEntry, c as createAuditEntry, g as getAuditLog, v as validateConsent, b as validateConsentOptions } from './consent-audit-BdByjYlM.mjs';
+import { C as ConsentOption, a as ConsentSettings } from './consent-CmVzqZUk.mjs';
+export { b as ConsentStorageOptions, L as LawfulBasisType } from './consent-CmVzqZUk.mjs';
+import * as React$1 from 'react';
+import React__default from 'react';
+import { S as StorageAdapter } from './types-DK2CoKOC.mjs';
 
-interface ConsentAnalyticsEvent {
-    action: 'shown' | 'accepted_all' | 'rejected_all' | 'customized' | 'dismissed';
-    timestamp: number;
-    version: string;
-    categories?: Record<string, boolean>;
-}
-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;
-}
-interface ConsentBannerProps {
-    /**
-     * Array of consent options to display
-     */
-    options: ConsentOption[];
-    /**
-     * Callback function called when user saves their consent choices
-     */
-    onSave: (settings: ConsentSettings) => void;
-    /**
-     * Title displayed on the banner
-     * @default "We Value Your Privacy"
-     */
-    title?: string;
-    /**
-     * Description text displayed on the banner
-     * @default "We use cookies and similar technologies to provide our services and enhance your experience. Your consent is collected in accordance with NDPA Sections 25-26."
-     */
-    description?: string;
-    /**
-     * Text for the accept all button
-     * @default "Accept All"
-     */
-    acceptAllButtonText?: string;
-    /**
-     * Text for the reject all button
-     * @default "Reject All"
-     */
-    rejectAllButtonText?: string;
-    /**
-     * Text for the customize button
-     * @default "Customize"
-     */
-    customizeButtonText?: string;
-    /**
-     * Text for the save button
-     * @default "Save Preferences"
-     */
-    saveButtonText?: string;
-    /**
-     * Position of the banner.
-     * 'top', 'bottom', and 'center' render via a portal to document.body
-     * with fixed positioning so the banner overlays the page.
-     * 'inline' renders in the normal DOM tree without a portal.
-     * @default "bottom"
-     */
-    position?: 'top' | 'bottom' | 'center' | 'inline';
-    /**
-     * z-index applied to the fixed-position banner.
-     * Ignored when position is 'inline'.
-     * @default 9999
-     */
-    zIndex?: number;
-    /**
-     * Version of the consent form
-     * @default "1.0"
-     */
-    version?: string;
-    /**
-     * Whether to show the banner
-     * If not provided, the banner will be shown if no consent has been saved
-     */
-    show?: boolean;
-    /**
-     * Storage key for consent settings
-     * @default "ndpr_consent"
-     */
-    storageKey?: string;
-    /**
-     * Whether the banner manages its own localStorage persistence.
-     * Set to false when an external storage mechanism (e.g., ConsentStorage)
-     * is responsible for persisting consent settings under the same key.
-     * This avoids race conditions where two writers target the same storage key.
-     * @default true
-     */
-    manageStorage?: boolean;
-    /**
-     * Custom CSS class for the banner
-     */
+interface SaveButtonProps {
+    children?: React__default.ReactNode;
     className?: string;
-    /**
-     * Custom CSS class for the buttons
-     */
-    buttonClassName?: string;
-    /**
-     * Custom CSS class for the primary button
-     */
-    primaryButtonClassName?: string;
-    /**
-     * Custom CSS class for the secondary button
-     */
-    secondaryButtonClassName?: string;
-    /**
-     * Object of CSS class overrides keyed by semantic section name.
-     * Takes priority over buttonClassName / primaryButtonClassName / secondaryButtonClassName.
-     */
-    classNames?: ConsentBannerClassNames;
-    /**
-     * When true, all default Tailwind classes are removed so consumers
-     * can style from scratch using classNames.
-     */
     unstyled?: boolean;
-    /**
-     * Optional analytics callback fired on each user interaction.
-     * Called when the banner is shown, accepted, rejected, customized, or dismissed.
-     */
-    onAnalytics?: (event: ConsentAnalyticsEvent) => void;
+    consents?: Record<string, boolean>;
 }
-/**
- * Consent banner component. Implements NDPA Sections 25-26 consent requirements
- * for obtaining and managing data subject consent.
- */
-declare const ConsentBanner: React.FC<ConsentBannerProps>;
+declare const SaveButton: React__default.FC<SaveButtonProps>;
 
-interface ConsentManagerClassNames {
-    root?: string;
-    header?: string;
-    title?: string;
-    description?: string;
-    optionsList?: string;
-    optionItem?: string;
-    toggle?: string;
-    saveButton?: string;
-    resetButton?: string;
-    /** Alias for saveButton */
-    primaryButton?: string;
-    /** Alias for resetButton */
-    secondaryButton?: string;
-}
-interface ConsentManagerProps {
-    /**
-     * Array of consent options to display
-     */
-    options: ConsentOption[];
-    /**
-     * Current consent settings
-     */
-    settings?: ConsentSettings;
-    /**
-     * Callback function called when user saves their consent choices
-     */
-    onSave: (settings: ConsentSettings) => void;
-    /**
-     * Title displayed in the manager
-     * @default "Manage Your Privacy Settings"
-     */
-    title?: string;
-    /**
-     * Description text displayed in the manager
-     * @default "Update your consent preferences at any time. Required cookies cannot be disabled as they are necessary for the website to function. Consent management is provided in accordance with NDPA Sections 25-26."
-     */
-    description?: string;
-    /**
-     * Text for the save button
-     * @default "Save Preferences"
-     */
-    saveButtonText?: string;
-    /**
-     * Text for the reset button
-     * @default "Reset to Defaults"
-     */
-    resetButtonText?: string;
-    /**
-     * Version of the consent form
-     * @default "1.0"
-     */
-    version?: string;
-    /**
-     * Custom CSS class for the manager
-     */
+interface RejectButtonProps {
+    children?: React__default.ReactNode;
     className?: string;
-    /**
-     * Custom CSS class for the buttons
-     */
-    buttonClassName?: string;
-    /**
-     * Custom CSS class for the primary button
-     */
-    primaryButtonClassName?: string;
-    /**
-     * Custom CSS class for the secondary button
-     */
-    secondaryButtonClassName?: string;
-    /**
-     * Object of CSS class overrides keyed by semantic section name.
-     * Takes priority over buttonClassName / primaryButtonClassName / secondaryButtonClassName.
-     */
-    classNames?: ConsentManagerClassNames;
-    /**
-     * When true, all default Tailwind classes are removed so consumers
-     * can style from scratch using classNames.
-     */
     unstyled?: boolean;
-    /**
-     * Whether to show a success message after saving
-     * @default true
-     */
-    showSuccessMessage?: boolean;
-    /**
-     * Success message to display after saving
-     * @default "Your preferences have been saved."
-     */
-    successMessage?: string;
-    /**
-     * Duration to show the success message (in milliseconds)
-     * @default 3000
-     */
-    successMessageDuration?: number;
 }
-/**
- * Consent management component. Implements NDPA Sections 25-26 consent requirements,
- * allowing data subjects to review and update their consent preferences.
- */
-declare const ConsentManager: React.FC<ConsentManagerProps>;
+declare const RejectButton: React__default.FC<RejectButtonProps>;
 
-interface ConsentStorageClassNames {
-    root?: string;
+interface AcceptButtonProps {
+    children?: React__default.ReactNode;
+    className?: string;
+    unstyled?: boolean;
 }
-interface ConsentStorageProps {
-    /**
-     * Current consent settings
-     */
-    settings: ConsentSettings;
-    /**
-     * Storage options for consent settings
-     */
-    storageOptions?: ConsentStorageOptions;
-    /**
-     * Callback function called when settings are loaded from storage
-     */
-    onLoad?: (settings: ConsentSettings | null) => void;
-    /**
-     * Callback function called when settings are saved to storage
-     */
-    onSave?: (settings: ConsentSettings) => void;
-    /**
-     * Whether to automatically save settings to storage
-     * @default true
-     */
-    autoSave?: boolean;
-    /**
-     * Whether to automatically load settings from storage on mount
-     * @default true
-     */
-    autoLoad?: boolean;
-    /**
-     * Object of CSS class overrides keyed by semantic section name.
-     */
-    classNames?: ConsentStorageClassNames;
-    /**
-     * When true, all default classes are removed so consumers
-     * can style from scratch using classNames.
-     */
+declare const AcceptButton: React__default.FC<AcceptButtonProps>;
+
+interface OptionListProps {
+    classNames?: {
+        root?: string;
+        optionItem?: string;
+        optionCheckbox?: string;
+        optionLabel?: string;
+        optionDescription?: string;
+    };
     unstyled?: boolean;
-    /**
-     * Children to render
-     * Can be either React nodes or a render prop function that receives storage methods
-     */
-    children?: React.ReactNode | ((props: {
-        loadSettings: () => ConsentSettings | null;
-        saveSettings: (settings: ConsentSettings) => void;
-        clearSettings: () => void;
-        loaded: boolean;
-    }) => React.ReactNode);
 }
-declare const ConsentStorage: ({ settings, storageOptions, onLoad, onSave, autoSave, autoLoad, classNames, unstyled, children }: ConsentStorageProps) => React.ReactElement | null;
+declare const OptionList: React__default.FC<OptionListProps>;
+
+interface ConsentProviderProps {
+    options: ConsentOption[];
+    adapter?: StorageAdapter<ConsentSettings>;
+    version?: string;
+    onChange?: (settings: ConsentSettings) => void;
+    children: React__default.ReactNode;
+}
+declare const ConsentProvider: React__default.FC<ConsentProviderProps>;
+
+declare const Consent: {
+    Provider: React$1.FC<ConsentProviderProps>;
+    OptionList: React$1.FC<OptionListProps>;
+    AcceptButton: React$1.FC<AcceptButtonProps>;
+    RejectButton: React$1.FC<RejectButtonProps>;
+    SaveButton: React$1.FC<SaveButtonProps>;
+    Banner: React$1.FC<ConsentBannerProps>;
+    Settings: React$1.FC<ConsentManagerProps>;
+    Storage: ({ settings, storageOptions, onLoad, onSave, autoSave, autoLoad, classNames, unstyled, children }: ConsentStorageProps) => React.ReactElement | null;
+};
 
-/**
- * Resolves class names for a component section.
- * If unstyled is true, only the override class is used (or empty string).
- * If an override is provided, it fully REPLACES the default — no appending.
- * Otherwise the default class string is returned as-is.
- */
-declare function resolveClass(defaultClass: string, override?: string, unstyled?: boolean): string;
+interface ConsentContextValue {
+    options: ConsentOption[];
+    settings: ConsentSettings | null;
+    hasConsent: (optionId: string) => boolean;
+    updateConsent: (consents: Record<string, boolean>) => void;
+    acceptAll: () => void;
+    rejectAll: () => void;
+    shouldShowBanner: boolean;
+    isValid: boolean;
+    validationErrors: string[];
+    resetConsent: () => void;
+    isLoading: boolean;
+}
+declare function useConsentCompound(): ConsentContextValue;
 
-export { type ConsentAnalyticsEvent, ConsentBanner, type ConsentBannerClassNames, ConsentManager, type ConsentManagerClassNames, ConsentOption, ConsentSettings, ConsentStorage, type ConsentStorageClassNames, ConsentStorageOptions, resolveClass };
+export { Consent, AcceptButton as ConsentAcceptButton, ConsentOption, OptionList as ConsentOptionList, ConsentProvider, type ConsentProviderProps, RejectButton as ConsentRejectButton, SaveButton as ConsentSaveButton, ConsentSettings, StorageAdapter, useConsentCompound };