@redacto.io/consent-sdk-react-native 5.0.1-beta.1 → 6.0.0

package/dist/index.d.mts

@@ -1,36 +1,110 @@
 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 } from './types-BYp89x8C.mjs';
 
-type Settings$1 = {
+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 colour React Native paints and
+ * are used as given.
+ */
+type SettingsPalette = {
     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;
+        /**
+         * The brand accent (checkboxes, switches 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;
         };
-        decline: {
-            backgroundColor: string;
-            textColor: string;
-        };
-        language: {
-            backgroundColor: string;
-            textColor: string;
+        language?: {
+            backgroundColor?: string;
+            textColor?: string;
             selectedBackgroundColor?: string;
             selectedTextColor?: string;
         };
     };
     link: string;
-    borderRadius?: 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 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 purposes, product headings and 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-tap path is unchanged.
+     */
+    confirmBeforeSubmit?: boolean;
+    /** Corner radius, in px ("12" or "12px"). */
+    borderRadius?: 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 screen 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>;
+    /** Wide-screen card width, in px (a number, or "480" / "480px"). */
+    maxWidth?: string | number;
+    /** Logo height, in px (a number, or "40" / "40px"). */
+    logoSize?: string | number;
+    /** `"sm"`, `"md"` or `"lg"`: scales every text size. */
+    textScale?: NoticeTextScale;
+    /** `false` turns entrances and transitions off. */
+    motion?: boolean;
+    /** Web only: React Native has no CSS, so this is accepted and ignored. */
+    customCss?: string;
     font?: string;
 };
+type SelectionControlType = "checkbox" | "radio" | "dropdown";
 
 type Props$1 = Readonly<{
     noticeId: string;
@@ -62,48 +136,48 @@ type Props$1 = Readonly<{
     organisationUuid?: string;
     /** Sandbox workspace UUID (replaces the JWT-decoded workspace in sandbox mode). */
     workspaceUuid?: string;
+    /**
+     * API host, e.g. `https://api.redacto.io` (recommended). The SDK calls the
+     * consent server at `{host}/consent` and the ledger at `{host}/consent-ledger`.
+     * The consent server URL (`…/consent`) still works but is deprecated.
+     */
     baseUrl?: string;
-    /** Go ledger base URL — serves check-consent and the consent write; omit to use the legacy consent server. */
+    /**
+     * @deprecated Read only when `baseUrl` is the consent server URL
+     * (`…/consent`) or omitted, as in earlier releases: it is then the Go ledger
+     * base URL that serves check-consent and the consent write, and leaving it
+     * out keeps the legacy consent server. Ignored when `baseUrl` is the API host.
+     */
     ledgerBaseUrl?: string;
-    settings?: Partial<Settings$1>;
+    settings?: Partial<Settings>;
     language?: string;
     blockUI?: boolean;
     onAccept: () => void;
     onDecline: () => void;
     onError?: (error: Error) => void;
+    otpGate?: {
+        required: boolean;
+        onVerify: (code: string) => Promise<{
+            ok: boolean;
+            message?: string;
+        }>;
+        title?: string;
+        description?: string;
+        submitLabel?: string;
+    };
     applicationId?: string;
     validateAgainst?: "all" | "required";
     includeFullyConsentedData?: boolean;
+    /**
+     * The button shown when `includeFullyConsentedData` finds everything already
+     * consented; it calls `onAccept`. Defaults to "Continue".
+     */
     reviewModeButtonText?: string;
+    defaultOpenProducts?: string[];
 }>;
 
 declare const RedactoNoticeConsent: React__default.FC<Props$1>;
 
-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;
-};
-
 declare const RedactoConsentInline: React__default.NamedExoticComponent<Readonly<{
     org_uuid: string;
     workspace_uuid: string;
@@ -121,14 +195,54 @@ declare const RedactoConsentInline: React__default.NamedExoticComponent<Readonly
     applicationId?: string;
 }>>;
 
+type RedactoNoticeAssistedProps = Readonly<{
+    organisationUuid: string;
+    workspaceUuid: string;
+    noticeUuid: string;
+    /**
+     * API host, e.g. `https://api.redacto.io` (recommended). The SDK calls the
+     * consent server at `{host}/consent` and the ledger at `{host}/consent-ledger`.
+     * The consent server URL (`…/consent`) still works but is deprecated.
+     */
+    baseUrl?: string;
+    /**
+     * @deprecated Read only when `baseUrl` is the consent server URL
+     * (`…/consent`) or omitted, as in earlier releases: it is then the Go ledger
+     * base URL that serves check-consent and the consent write, and leaving it
+     * out keeps the legacy consent server. Ignored when `baseUrl` is the API host.
+     */
+    ledgerBaseUrl?: string;
+    defaultOpenProducts?: string[];
+    onDecline?: () => void;
+    onComplete?: () => void;
+    /**
+     * Optional code-side styling, display only: overrides the appearance set in
+     * the Redacto console, key by key. The submit payload, verification and
+     * gating are unchanged.
+     */
+    settings?: Partial<Settings>;
+}>;
+
+declare const RedactoNoticeAssisted: React__default.FC<RedactoNoticeAssistedProps>;
+
 type Props = Readonly<{
     org_uuid: string;
     workspace_uuid: string;
     notice_uuid: string;
     accessToken?: string;
     refreshToken?: string;
+    /**
+     * API host, e.g. `https://api.redacto.io` (recommended). The SDK calls the
+     * consent server at `{host}/consent` and the ledger at `{host}/consent-ledger`.
+     * The consent server URL (`…/consent`) still works but is deprecated.
+     */
     baseUrl?: string;
-    /** Go ledger base URL — serves check-consent and the consent write; omit to use the legacy consent server. */
+    /**
+     * @deprecated Read only when `baseUrl` is the consent server URL
+     * (`…/consent`) or omitted, as in earlier releases: it is then the Go ledger
+     * base URL that serves check-consent and the consent write, and leaving it
+     * out keeps the legacy consent server. Ignored when `baseUrl` is the API host.
+     */
     ledgerBaseUrl?: string;
     settings?: Partial<Settings>;
     language?: string;
@@ -139,4 +253,19 @@ type Props = Readonly<{
     applicationId?: string;
 }>;
 
-export { RedactoNoticeConsent, RedactoConsentInline as RedactoNoticeConsentInline, type Props as RedactoNoticeConsentInlineProps, type Props$1 as RedactoNoticeConsentProps, type Settings$1 as Settings };
+type ApiErrorCode = "INVALID_TOKEN" | "TOKEN_TENANT_MISMATCH" | "UNAUTHORIZED" | "USER_NOT_FOUND" | "USER_EMAIL_MISMATCH" | "USER_MOBILE_MISMATCH" | "USER_CONTACT_MISMATCH" | "NO_IDENTIFIER_PROVIDED" | "INVALID_PAYLOAD" | "VALIDATION_ERROR" | "NOTICE_NOT_FOUND" | "NOTICE_CONFIGURATION_NOT_FOUND" | "NOTICE_STILL_IN_DRAFT" | "CONSENT_ALREADY_PROVIDED" | "PURPOSE_NOT_FOUND" | "INVALID_PURPOSE" | "INVALID_DATA_ELEMENTS" | "MISSING_PURPOSE" | "MISSING_DATA_ELEMENTS" | "REQUIRED_DATA_ELEMENT_NOT_ENABLED" | "AUDIO_NOT_FOUND" | "INVALID_LANGUAGE" | "VERIFICATION_FAILED" | "VERIFICATION_EXPIRED" | "GUARDIAN_INFO_NOT_FOUND" | "GUARDIAN_SESSION_INVALID" | "SESSION_EXPIRED" | "INTERNAL_ERROR";
+type ApiErrorCodeLike = ApiErrorCode | (string & {});
+
+declare class ApiError extends Error {
+    readonly status: number;
+    readonly code?: ApiErrorCodeLike;
+    readonly shouldRequestNew?: boolean;
+    constructor(opts: {
+        status: number;
+        code?: ApiErrorCodeLike;
+        message: string;
+        shouldRequestNew?: boolean;
+    });
+}
+
+export { ApiError, type ApiErrorCode, RedactoNoticeAssisted, type RedactoNoticeAssistedProps, RedactoNoticeConsent, RedactoConsentInline as RedactoNoticeConsentInline, type Props as RedactoNoticeConsentInlineProps, type Props$1 as RedactoNoticeConsentProps, type Settings };

package/dist/index.d.ts

@@ -1,36 +1,110 @@
 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 } from './types-BYp89x8C.js';
 
-type Settings$1 = {
+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 colour React Native paints and
+ * are used as given.
+ */
+type SettingsPalette = {
     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;
+        /**
+         * The brand accent (checkboxes, switches 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;
         };
-        decline: {
-            backgroundColor: string;
-            textColor: string;
-        };
-        language: {
-            backgroundColor: string;
-            textColor: string;
+        language?: {
+            backgroundColor?: string;
+            textColor?: string;
             selectedBackgroundColor?: string;
             selectedTextColor?: string;
         };
     };
     link: string;
-    borderRadius?: 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 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 purposes, product headings and 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-tap path is unchanged.
+     */
+    confirmBeforeSubmit?: boolean;
+    /** Corner radius, in px ("12" or "12px"). */
+    borderRadius?: 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 screen 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>;
+    /** Wide-screen card width, in px (a number, or "480" / "480px"). */
+    maxWidth?: string | number;
+    /** Logo height, in px (a number, or "40" / "40px"). */
+    logoSize?: string | number;
+    /** `"sm"`, `"md"` or `"lg"`: scales every text size. */
+    textScale?: NoticeTextScale;
+    /** `false` turns entrances and transitions off. */
+    motion?: boolean;
+    /** Web only: React Native has no CSS, so this is accepted and ignored. */
+    customCss?: string;
     font?: string;
 };
+type SelectionControlType = "checkbox" | "radio" | "dropdown";
 
 type Props$1 = Readonly<{
     noticeId: string;
@@ -62,48 +136,48 @@ type Props$1 = Readonly<{
     organisationUuid?: string;
     /** Sandbox workspace UUID (replaces the JWT-decoded workspace in sandbox mode). */
     workspaceUuid?: string;
+    /**
+     * API host, e.g. `https://api.redacto.io` (recommended). The SDK calls the
+     * consent server at `{host}/consent` and the ledger at `{host}/consent-ledger`.
+     * The consent server URL (`…/consent`) still works but is deprecated.
+     */
     baseUrl?: string;
-    /** Go ledger base URL — serves check-consent and the consent write; omit to use the legacy consent server. */
+    /**
+     * @deprecated Read only when `baseUrl` is the consent server URL
+     * (`…/consent`) or omitted, as in earlier releases: it is then the Go ledger
+     * base URL that serves check-consent and the consent write, and leaving it
+     * out keeps the legacy consent server. Ignored when `baseUrl` is the API host.
+     */
     ledgerBaseUrl?: string;
-    settings?: Partial<Settings$1>;
+    settings?: Partial<Settings>;
     language?: string;
     blockUI?: boolean;
     onAccept: () => void;
     onDecline: () => void;
     onError?: (error: Error) => void;
+    otpGate?: {
+        required: boolean;
+        onVerify: (code: string) => Promise<{
+            ok: boolean;
+            message?: string;
+        }>;
+        title?: string;
+        description?: string;
+        submitLabel?: string;
+    };
     applicationId?: string;
     validateAgainst?: "all" | "required";
     includeFullyConsentedData?: boolean;
+    /**
+     * The button shown when `includeFullyConsentedData` finds everything already
+     * consented; it calls `onAccept`. Defaults to "Continue".
+     */
     reviewModeButtonText?: string;
+    defaultOpenProducts?: string[];
 }>;
 
 declare const RedactoNoticeConsent: React__default.FC<Props$1>;
 
-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;
-};
-
 declare const RedactoConsentInline: React__default.NamedExoticComponent<Readonly<{
     org_uuid: string;
     workspace_uuid: string;
@@ -121,14 +195,54 @@ declare const RedactoConsentInline: React__default.NamedExoticComponent<Readonly
     applicationId?: string;
 }>>;
 
+type RedactoNoticeAssistedProps = Readonly<{
+    organisationUuid: string;
+    workspaceUuid: string;
+    noticeUuid: string;
+    /**
+     * API host, e.g. `https://api.redacto.io` (recommended). The SDK calls the
+     * consent server at `{host}/consent` and the ledger at `{host}/consent-ledger`.
+     * The consent server URL (`…/consent`) still works but is deprecated.
+     */
+    baseUrl?: string;
+    /**
+     * @deprecated Read only when `baseUrl` is the consent server URL
+     * (`…/consent`) or omitted, as in earlier releases: it is then the Go ledger
+     * base URL that serves check-consent and the consent write, and leaving it
+     * out keeps the legacy consent server. Ignored when `baseUrl` is the API host.
+     */
+    ledgerBaseUrl?: string;
+    defaultOpenProducts?: string[];
+    onDecline?: () => void;
+    onComplete?: () => void;
+    /**
+     * Optional code-side styling, display only: overrides the appearance set in
+     * the Redacto console, key by key. The submit payload, verification and
+     * gating are unchanged.
+     */
+    settings?: Partial<Settings>;
+}>;
+
+declare const RedactoNoticeAssisted: React__default.FC<RedactoNoticeAssistedProps>;
+
 type Props = Readonly<{
     org_uuid: string;
     workspace_uuid: string;
     notice_uuid: string;
     accessToken?: string;
     refreshToken?: string;
+    /**
+     * API host, e.g. `https://api.redacto.io` (recommended). The SDK calls the
+     * consent server at `{host}/consent` and the ledger at `{host}/consent-ledger`.
+     * The consent server URL (`…/consent`) still works but is deprecated.
+     */
     baseUrl?: string;
-    /** Go ledger base URL — serves check-consent and the consent write; omit to use the legacy consent server. */
+    /**
+     * @deprecated Read only when `baseUrl` is the consent server URL
+     * (`…/consent`) or omitted, as in earlier releases: it is then the Go ledger
+     * base URL that serves check-consent and the consent write, and leaving it
+     * out keeps the legacy consent server. Ignored when `baseUrl` is the API host.
+     */
     ledgerBaseUrl?: string;
     settings?: Partial<Settings>;
     language?: string;
@@ -139,4 +253,19 @@ type Props = Readonly<{
     applicationId?: string;
 }>;
 
-export { RedactoNoticeConsent, RedactoConsentInline as RedactoNoticeConsentInline, type Props as RedactoNoticeConsentInlineProps, type Props$1 as RedactoNoticeConsentProps, type Settings$1 as Settings };
+type ApiErrorCode = "INVALID_TOKEN" | "TOKEN_TENANT_MISMATCH" | "UNAUTHORIZED" | "USER_NOT_FOUND" | "USER_EMAIL_MISMATCH" | "USER_MOBILE_MISMATCH" | "USER_CONTACT_MISMATCH" | "NO_IDENTIFIER_PROVIDED" | "INVALID_PAYLOAD" | "VALIDATION_ERROR" | "NOTICE_NOT_FOUND" | "NOTICE_CONFIGURATION_NOT_FOUND" | "NOTICE_STILL_IN_DRAFT" | "CONSENT_ALREADY_PROVIDED" | "PURPOSE_NOT_FOUND" | "INVALID_PURPOSE" | "INVALID_DATA_ELEMENTS" | "MISSING_PURPOSE" | "MISSING_DATA_ELEMENTS" | "REQUIRED_DATA_ELEMENT_NOT_ENABLED" | "AUDIO_NOT_FOUND" | "INVALID_LANGUAGE" | "VERIFICATION_FAILED" | "VERIFICATION_EXPIRED" | "GUARDIAN_INFO_NOT_FOUND" | "GUARDIAN_SESSION_INVALID" | "SESSION_EXPIRED" | "INTERNAL_ERROR";
+type ApiErrorCodeLike = ApiErrorCode | (string & {});
+
+declare class ApiError extends Error {
+    readonly status: number;
+    readonly code?: ApiErrorCodeLike;
+    readonly shouldRequestNew?: boolean;
+    constructor(opts: {
+        status: number;
+        code?: ApiErrorCodeLike;
+        message: string;
+        shouldRequestNew?: boolean;
+    });
+}
+
+export { ApiError, type ApiErrorCode, RedactoNoticeAssisted, type RedactoNoticeAssistedProps, RedactoNoticeConsent, RedactoConsentInline as RedactoNoticeConsentInline, type Props as RedactoNoticeConsentInlineProps, type Props$1 as RedactoNoticeConsentProps, type Settings };