@redacto.io/consent-sdk-react 10.2.2-beta.2 → 10.3.0-beta.4

package/dist/index.d.mts

@@ -1,53 +1,336 @@
-import * as react from 'react';
-import react__default from 'react';
+import * as React from 'react';
+import React__default from 'react';
+import { A as AppearanceStyle, N as NoticeControlStyle, a as NoticeMobileLayout, b as NoticeDesktopPosition, c as NoticeBackdrop, d as NoticePhoneFooter, e as NoticeTextScale, f as NoticeAppearance } from './types-Bwtzvz4W.mjs';
 import { f as NoticeFontOptions } from './types-xaCyZUfo.mjs';
 
-type Settings$1 = {
-    button: {
-        /** Styles the "accept selected" button. */
-        accept: {
-            backgroundColor: string;
-            textColor: string;
-        };
-        /** Optional: the accept-all shortcut falls back to `accept` when unset. */
-        acceptAll?: {
-            backgroundColor: string;
-            textColor: string;
+/**
+ * Horizontal alignment of the brand logo in the notice header, chosen in the
+ * admin console and served on `active_config.logo_position`.
+ */
+type LogoPosition = "left" | "center" | "right";
+/**
+ * Which purposes the banner opens with already ticked, chosen in the admin
+ * console and served on `active_config.purpose_preselection`.
+ *
+ * The server applies no ticks itself — it only carries the choice. Deriving
+ * which purposes are mandatory (those holding a `required` + `enabled` data
+ * element) and applying the ticks is this SDK's job.
+ */
+type PurposePreselection = "NONE" | "MANDATORY" | "ALL";
+type PurposeSelection = {
+    selected: boolean;
+    /**
+     * ACTIVE | EXPIRED | WITHDRAW | DECLINED | INACTIVE.
+     *
+     * INACTIVE is the "no decision recorded" value, and it is the common case:
+     * both notice reads build this map over *every* purpose on the notice once
+     * the caller's identifier resolves to a known data principal, so an entry
+     * here does not by itself mean the subject has decided anything. Test it
+     * with `hasRecordedPurposeState`, not for truthiness.
+     */
+    status: string;
+    needs_reconsent: boolean;
+    /** Empty for a purpose absent from the principal's consent history. */
+    data_elements: Record<string, DataElementSelection>;
+};
+type DataElementSelection = {
+    selected: boolean;
+    enabled: boolean;
+    required: boolean;
+};
+type ConsentContent = {
+    code: number;
+    status: string;
+    detail: {
+        uuid: string;
+        name: string;
+        organisation_uuid: string;
+        workspace_uuid: string;
+        collection_point_uuids: string[];
+        collection_points: {
+            uuid: string;
+            organisation_uuid: string;
+            workspace_uuid: string;
+            name: string;
+            created_at: string;
+            updated_at: string;
+        }[];
+        active_config: {
+            uuid: string;
+            notice_uuid: string;
+            organisation_uuid: string;
+            workspace_uuid: string;
+            version: number;
+            status: string;
+            notice_text: string;
+            additional_text: string;
+            /**
+             * Optional: absent from an older consent-server. The notice falls back to
+             * the bundled English defaults in `constants.ts`.
+             */
+            accept_all_button_text?: string;
+            /** The "accept selected" slot — submits exactly what the user ticked. */
+            confirm_button_text: string;
+            decline_button_text: string;
+            logo_url: string;
+            privacy_policy_url: string;
+            privacy_center_url: string;
+            primary_color: string;
+            secondary_color: string;
+            font_preference: string;
+            /**
+             * Optional: absent from an older consent-server and from notices
+             * published before the field existed. Resolved via `resolveLogoPosition`,
+             * which falls back to "left".
+             */
+            logo_position?: LogoPosition;
+            /** Every product this notice covers. Absent from an older ledger. */
+            products?: NoticeProduct[];
+            /**
+             * Purpose uuids in render order, keyed by product uuid. A product with no
+             * entry renders in the order of `purposes` itself.
+             */
+            product_purpose_order?: Record<string, string[]>;
+            purposes: {
+                uuid: string;
+                /** Products this purpose applies to; absent or empty means all. */
+                product_uuids?: string[];
+                name: string;
+                description: string;
+                industries?: string;
+                data_elements: {
+                    uuid: string;
+                    name: string;
+                    description: string | null;
+                    industries?: string | null;
+                    enabled: boolean;
+                    required: boolean;
+                }[];
+            }[];
+            /**
+             * Optional: absent from an older consent-server and from notices
+             * published before the field existed. Resolved via
+             * `resolvePurposePreselection`, which falls back to "NONE" — nothing
+             * pre-ticked, the behaviour every notice had before this setting.
+             */
+            purpose_preselection?: PurposePreselection;
+            default_language: string;
+            supported_languages_and_translations: {
+                [key: string]: {
+                    notice_text: string;
+                    additional_text: string;
+                    accept_all_button_text?: string;
+                    confirm_button_text: string;
+                    decline_button_text: string;
+                    privacy_policy_prefix_text: string;
+                    privacy_policy_anchor_text: string;
+                    privacy_center_anchor_text?: string;
+                    purpose_section_heading: string;
+                    notice_banner_heading: string;
+                    data_elements: {
+                        [key: string]: string;
+                    };
+                    purposes: {
+                        [key: string]: string | {
+                            name: string;
+                            description: string;
+                        };
+                    };
+                    products?: {
+                        [key: string]: string | {
+                            name: string;
+                            description: string;
+                        };
+                    };
+                    dpo_info?: DpoInfoTranslation;
+                };
+            };
+            created_at: string;
+            updated_at: string;
+            deployed_at: string;
+            privacy_policy_prefix_text: string;
+            privacy_policy_anchor_text: string;
+            privacy_center_anchor_text?: string;
+            /** {product_uuid: url}, for notices whose products are separate entities. */
+            product_privacy_policies?: Record<string, string>;
+            purpose_section_heading: string;
+            notice_banner_heading: string;
+            dpo_info?: DpoInfo;
+            /**
+             * The look the admin set in the Redacto console: style, palette, radius,
+             * selection control and the talkback highlight. Empty (or absent on an
+             * older server) means classic, drawn from primary/secondary colour.
+             */
+            appearance?: NoticeAppearance;
         };
-        decline: {
-            backgroundColor: string;
-            textColor: string;
+        notice_type?: string;
+        compliance_requirement?: string;
+        is_minor?: boolean;
+        purpose_selections?: Record<string, PurposeSelection>;
+        /**
+         * `purpose_selections` keyed by product, then purpose. Absent when the
+         * ledger has nothing more to say than the flat map does -- a
+         * single-product notice, or before submit fan-out is on. A product missing
+         * from it has no state recorded against it; that is not a declined
+         * consent, so fall back to `purpose_selections` for it.
+         */
+        product_purpose_selections?: Record<string, Record<string, PurposeSelection>>;
+        reconsent_required?: boolean;
+        created_at: string;
+        updated_at: string;
+    };
+};
+type SettingsButtonColors = {
+    backgroundColor?: string;
+    textColor?: string;
+};
+/**
+ * The colours `settings` can set: the top-level palette, and the dark palette
+ * under `settings.darkPalette`. Colours are any CSS colour and are used as given.
+ */
+type SettingsPalette = {
+    button: {
+        /**
+         * The brand accent (checkboxes, switches, focus rings and Accept
+         * Selected's outline), and Accept All's colour when `acceptAll` is unset.
+         */
+        accept?: SettingsButtonColors;
+        /** The Accept All button; falls back to `accept`. */
+        acceptAll?: SettingsButtonColors;
+        /** The Accept Selected button itself. */
+        acceptSelected?: SettingsButtonColors;
+        decline?: SettingsButtonColors & {
+            borderColor?: string;
         };
-        language: {
-            backgroundColor: string;
-            textColor: string;
+        language?: {
+            backgroundColor?: string;
+            textColor?: string;
             selectedBackgroundColor?: string;
             selectedTextColor?: string;
         };
     };
     link: string;
+    backgroundColor?: string;
+    /** Raised surfaces: menus and panels, and the tint of the glass style. */
+    surfaceColor?: string;
+    headingColor?: string;
+    textColor?: string;
+    /** Descriptions and hints. */
+    mutedTextColor?: string;
+    borderColor?: string;
+    /** The page dim behind the notice. */
+    overlayColor?: string;
+    toggle?: {
+        onColor?: string;
+        offColor?: string;
+        knobColor?: string;
+    };
+    /** The element being read aloud by text-to-speech. */
+    ttsHighlight?: {
+        backgroundColor?: string;
+        textColor?: string;
+    };
+};
+/**
+ * Code-side styling for the notice. Everything here is optional and overrides,
+ * key by key, the appearance set in the Redacto console (`active_config.appearance`):
+ * host settings, then the console, then the notice's brand colours and the SDK
+ * defaults.
+ */
+type Settings = SettingsPalette & {
+    /**
+     * Visual style: `"classic"`, `"glass"`, `"minimal"` or `"soft"`. Unknown
+     * values are ignored and the console's style (else classic) applies.
+     */
+    theme?: AppearanceStyle;
     /**
      * Defaults to "checkbox". Applies to the purpose rows and the product
      * section headings, not to individual data elements.
      */
     selectionControl?: SelectionControlType;
+    /**
+     * How checkbox rows are drawn, in any style: `"checkbox"` or `"switch"`.
+     * Unset keeps checkboxes, in every style.
+     */
+    controlStyle?: NoticeControlStyle;
     /**
      * Asks "are you sure" before Accept All, Accept Selected or Decline submits.
      * Defaults to false, so the one-click path is unchanged.
      */
     confirmBeforeSubmit?: boolean;
     borderRadius?: string;
-    backgroundColor?: string;
-    headingColor?: string;
-    textColor?: string;
-    borderColor?: string;
+    /** Phones: `"modal"` (centred) or `"sheet"` (docked to the bottom edge). */
+    mobileLayout?: NoticeMobileLayout;
+    /** Wider screens: `"center"`, `"bottom-right"`, `"bottom-left"` or `"bottom-bar"`. */
+    desktopPosition?: NoticeDesktopPosition;
+    /** `"dim"` darkens the page behind the notice; `"none"` leaves it as is. */
+    backdrop?: NoticeBackdrop;
+    /** Collapse the notice text and the DPO block into disclosures. */
+    collapsibleSections?: boolean;
+    /** Phones: `"stacked"` buttons, or `"paired"` (Accept All over the other two). */
+    phoneFooter?: NoticePhoneFooter;
+    /** Follow the device's dark mode with `darkPalette` (else the console's). */
+    autoDark?: boolean;
+    darkPalette?: Partial<SettingsPalette>;
+    /** Desktop card width, any CSS length. */
+    maxWidth?: string;
+    /** Logo height, any CSS length. */
+    logoSize?: string;
+    /** `"sm"`, `"md"` or `"lg"`: scales every text size. */
+    textScale?: NoticeTextScale;
+    /** `false` turns entrances and transitions off. */
+    motion?: boolean;
+    /**
+     * CSS scoped to this notice. Target parts with `[data-redacto-part="…"]`;
+     * refused whole if it carries a disallowed token (`@import`, `javascript:`…).
+     */
+    customCss?: string;
     font?: string;
 };
+/** A product a notice covers. */
+type NoticeProduct = {
+    uuid: string;
+    name: string;
+    description?: string | null;
+    /**
+     * Whether the confirm gate must enforce this product's mandatory purposes.
+     * Resolved server-side from the caller's scope claim, not derived here.
+     *
+     * Optional because a consent server predating the field sends nothing, and
+     * absence is not `false`: see `serverMarksMandatoryProducts`, which keeps the
+     * pre-field gate rather than reading silence as "nothing is required".
+     */
+    mandatory?: boolean;
+};
 /**
  * How a visitor answers a purpose or a product section. Checkbox is the shipped
  * default and the only variant with a partly-ticked state to draw.
  */
 type SelectionControlType = "checkbox" | "radio" | "dropdown";
+type DpoInfo = {
+    grievance_text: string;
+    grievance_anchor_text: string;
+    grievance_url: string;
+    grievance_email: string;
+    grievance_email_connector_text?: string;
+    dp_board_text: string;
+    dp_board_anchor_text: string;
+    dp_board_url: string;
+    dpo_text: string;
+    dpo_anchor_text: string;
+    /** Not set by the console, which links the DPO by `dpo_email`. */
+    dpo_url?: string;
+    dpo_email?: string;
+};
+type DpoInfoTranslation = {
+    grievance_text?: string;
+    grievance_anchor_text?: string;
+    grievance_email_connector_text?: string;
+    dp_board_text?: string;
+    dp_board_anchor_text?: string;
+    dpo_text?: string;
+    dpo_anchor_text?: string;
+};
 /**
  * Error codes from guardian verification
  */
@@ -95,12 +378,32 @@ type Props$1 = Readonly<{
     workspaceUuid?: string;
     baseUrl?: string;
     ledgerBaseUrl?: string;
-    settings?: Partial<Settings$1>;
+    /**
+     * Optional code-side styling. The notice's look is set in the Redacto
+     * console (Display settings, Appearance); anything set here overrides the
+     * console for that key only.
+     */
+    settings?: Partial<Settings>;
     language?: string;
     blockUI?: boolean;
     onAccept: () => void;
     onDecline: () => void;
     onError?: (error: Error) => void;
+    /**
+     * Holds submission behind a one-time code. When `required`, the first accept
+     * locks the notice and reveals an inline code panel instead of submitting;
+     * the stashed accept runs once `onVerify` resolves ok.
+     */
+    otpGate?: {
+        required: boolean;
+        onVerify: (code: string) => Promise<{
+            ok: boolean;
+            message?: string;
+        }>;
+        title?: string;
+        description?: string;
+        submitLabel?: string;
+    };
     applicationId?: string;
     validateAgainst?: "all" | "required";
     digilockerMode?: "popup" | "redirect";
@@ -119,6 +422,19 @@ type Props$1 = Readonly<{
      */
     defaultOpenProducts?: string[];
 }>;
+type ColorScheme = "light" | "dark";
+type RedactoNoticePreviewProps = Readonly<{
+    /** The notice as the public read serves it, built from the console form. */
+    content: ConsentContent;
+    /** Draws the phone layout (bottom sheet, stacked footer) when true. */
+    isMobile?: boolean;
+    /**
+     * The device scheme to preview; `"dark"` shows the dark palette when the
+     * appearance turns automatic dark mode on. Unset follows the device.
+     */
+    colorScheme?: ColorScheme;
+    language?: string;
+}>;
 
 /**
  * Redacto Notice Consent Component
@@ -128,40 +444,7 @@ type Props$1 = Readonly<{
  * and needs-consent purposes.
  */
 
-/**
- * RedactoNoticeConsent
- *
- * Main consent management component that provides a comprehensive UI for users
- * to view and manage their consent preferences. Supports both initial consent
- * collection and reconsent flows.
- */
-declare const RedactoNoticeConsent: ({ noticeId, accessToken, refreshToken, token, email, mobile, ucic, organisationUuid, workspaceUuid, baseUrl, ledgerBaseUrl, language, blockUI, onAccept, onDecline, onError, settings, applicationId, validateAgainst, digilockerMode, digilockerCallbackUrl, includeFullyConsentedData, reviewModeButtonText, defaultOpenProducts, }: Props$1) => react__default.JSX.Element;
-
-type Settings = {
-    button: {
-        accept: {
-            backgroundColor: string;
-            textColor: string;
-        };
-        decline: {
-            backgroundColor: string;
-            textColor: string;
-        };
-        language: {
-            backgroundColor: string;
-            textColor: string;
-            selectedBackgroundColor?: string;
-            selectedTextColor?: string;
-        };
-    };
-    link: string;
-    borderRadius?: string;
-    backgroundColor?: string;
-    headingColor?: string;
-    textColor?: string;
-    borderColor?: string;
-    font?: string;
-};
+declare const RedactoNoticeConsent: (props: Props$1) => React__default.JSX.Element;
 
 type Props = Readonly<{
     org_uuid: string;
@@ -171,6 +454,10 @@ type Props = Readonly<{
     refreshToken?: string;
     baseUrl?: string;
     ledgerBaseUrl?: string;
+    /**
+     * Optional code-side styling; overrides the appearance set in the Redacto
+     * console, key by key. The widget uses the colours and font it draws with.
+     */
     settings?: Partial<Settings>;
     language?: string;
     onAccept?: () => void;
@@ -180,8 +467,8 @@ type Props = Readonly<{
     applicationId?: string;
 }>;
 
-declare const RedactoConsentInline: react.MemoExoticComponent<{
-    ({ org_uuid, workspace_uuid, notice_uuid, accessToken, baseUrl, ledgerBaseUrl, language, onAccept, onError, onValidationChange, settings, applicationId, }: Props): react.JSX.Element | null;
+declare const RedactoConsentInline: React.MemoExoticComponent<{
+    ({ org_uuid, workspace_uuid, notice_uuid, accessToken, baseUrl, ledgerBaseUrl, language, onAccept, onError, onValidationChange, settings, applicationId, }: Props): React.JSX.Element | null;
     displayName: string;
 }>;
 
@@ -205,6 +492,12 @@ type RedactoNoticeAssistedProps = {
     onDecline?: () => void;
     /** Called when the agent clicks "Proceed" on the confirmed screen. */
     onComplete?: () => void;
+    /**
+     * Optional code-side styling; overrides the appearance set in the Redacto
+     * console, key by key. The flow uses its accent, link and talkback
+     * highlight colours, and the font.
+     */
+    settings?: Partial<Settings>;
 };
 
 /**
@@ -221,7 +514,15 @@ type RedactoNoticeAssistedProps = {
  * submit, `onComplete` fires immediately with no confirmation screen (mirroring
  * RedactoNoticeConsent's `onAccept`). Steps: `notice` → `verify` (with `otpSent`).
  */
-declare const RedactoNoticeAssisted: ({ organisationUuid, workspaceUuid, noticeUuid, baseUrl, ledgerBaseUrl, onDecline, onComplete, }: RedactoNoticeAssistedProps) => react.JSX.Element;
+declare const RedactoNoticeAssisted: ({ organisationUuid, workspaceUuid, noticeUuid, baseUrl, ledgerBaseUrl, onDecline, onComplete, settings, }: RedactoNoticeAssistedProps) => React.JSX.Element;
+
+/**
+ * The notice exactly as the SDK draws it, from content the Redacto console
+ * builds out of its form, so the Display settings preview cannot drift from
+ * what visitors see. Nothing is fetched, submitted, played or focused, and the
+ * frame contains the notice's fixed-position overlay.
+ */
+declare const RedactoNoticePreview: ({ content, isMobile, colorScheme, language, }: RedactoNoticePreviewProps) => React.JSX.Element;
 
 /**
  * DigiLockerCallback Component
@@ -251,7 +552,7 @@ declare const RedactoNoticeAssisted: ({ organisationUuid, workspaceUuid, noticeU
  * - error_code: (if failed) Error code like GUARDIAN_UNDER_18, SESSION_EXPIRED, etc.
  */
 
-declare const DigiLockerCallback: react__default.FC<DigiLockerCallbackProps>;
+declare const DigiLockerCallback: React__default.FC<DigiLockerCallbackProps>;
 
 /**
  * Shared API error handling for the consent-sdk-react package.
@@ -287,4 +588,4 @@ declare class ApiError extends Error {
  */
 declare const configureNoticeFonts: (options: NoticeFontOptions) => void;
 
-export { ApiError, type ApiErrorCode, type ConsentFlowState, DigiLockerCallback, type DigiLockerCallbackProps, type GuardianVerificationErrorCode, NoticeFontOptions, RedactoNoticeAssisted, type RedactoNoticeAssistedProps, RedactoNoticeConsent, RedactoConsentInline as RedactoNoticeConsentInline, configureNoticeFonts };
+export { ApiError, type ApiErrorCode, type ConsentFlowState, DigiLockerCallback, type DigiLockerCallbackProps, type GuardianVerificationErrorCode, NoticeAppearance, NoticeFontOptions, RedactoNoticeAssisted, type RedactoNoticeAssistedProps, RedactoNoticeConsent, RedactoConsentInline as RedactoNoticeConsentInline, RedactoNoticePreview, type RedactoNoticePreviewProps, configureNoticeFonts };