@redacto.io/consent-sdk-js 1.2.0-beta.0 → 2.0.1-beta.0

package/dist/redacto.d.mts

@@ -1,3 +1,28 @@
+/** How checkbox rows are drawn: native checkboxes, or switches. */
+declare const NOTICE_CONTROL_STYLES: readonly ["checkbox", "switch"];
+/** Phones: a centred modal, or a sheet docked to the bottom edge. */
+declare const NOTICE_MOBILE_LAYOUTS: readonly ["modal", "sheet"];
+/** Where the notice sits on wider screens. */
+declare const NOTICE_DESKTOP_POSITIONS: readonly ["center", "bottom-right", "bottom-left", "bottom-bar"];
+/** The page behind the notice: dimmed with `colors.overlay`, or left as is. */
+declare const NOTICE_BACKDROPS: readonly ["dim", "none"];
+/** Phone footer: three stacked buttons, or Accept All over the other two. */
+declare const NOTICE_PHONE_FOOTERS: readonly ["stacked", "paired"];
+declare const NOTICE_TEXT_SCALES: readonly ["sm", "md", "lg"];
+
+/**
+ * Surface and layout family a notice is drawn with, chosen in the Redacto
+ * console and served on `active_config.appearance.style`. Colours never come
+ * from the style: they come from the admin's palette, else the notice's brand.
+ */
+type AppearanceStyle = "classic" | "glass" | "minimal" | "soft";
+type NoticeControlStyle = (typeof NOTICE_CONTROL_STYLES)[number];
+type NoticeMobileLayout = (typeof NOTICE_MOBILE_LAYOUTS)[number];
+type NoticeDesktopPosition = (typeof NOTICE_DESKTOP_POSITIONS)[number];
+type NoticeBackdrop = (typeof NOTICE_BACKDROPS)[number];
+type NoticePhoneFooter = (typeof NOTICE_PHONE_FOOTERS)[number];
+type NoticeTextScale = (typeof NOTICE_TEXT_SCALES)[number];
+
 /**
  * Optional sandbox options shared by the SDK's public option shapes and the
  * internal API params. When `token` is set the call sends the single
@@ -23,38 +48,109 @@ type SandboxOptions = {
     workspaceUuid?: string;
 };
 type SelectionControlType = "checkbox" | "radio" | "dropdown";
-type Settings = {
+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: {
-        /** Styles the "accept selected" button. */
-        accept: {
-            backgroundColor: string;
-            textColor: string;
+        /**
+         * 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;
         };
-        /** Optional: the accept-all shortcut falls back to `accept` when unset. */
-        acceptAll?: {
-            backgroundColor: string;
-            textColor: 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;
-    font?: 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 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
+     * (and before the inline embed auto-submits). Defaults to false.
+     */
     confirmBeforeSubmit?: boolean;
+    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 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;
 };
 
 type ModalOptions = SandboxOptions & {
@@ -76,8 +172,17 @@ type ModalOptions = SandboxOptions & {
      * customer code; optional third identifier alongside email/mobile.
      */
     ucic?: string;
+    /**
+     * The Redacto API host, e.g. `https://api.redacto.io` (recommended): the SDK
+     * reaches the consent server and the ledger under it. The consent server URL
+     * (`…/consent`) still works but is deprecated. Omit it and requests go to the
+     * production API.
+     */
     baseUrl?: string;
-    /** Go ledger base URL — serves check-consent and the consent write; omit to use the legacy consent server. */
+    /**
+     * 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. Ignored when `baseUrl` is the API host.
+     */
     ledgerBaseUrl?: string;
     language?: string;
     blockUI?: boolean;
@@ -101,8 +206,17 @@ type InlineOptions = {
     notice_uuid: string;
     accessToken?: string;
     refreshToken?: string;
+    /**
+     * The Redacto API host, e.g. `https://api.redacto.io` (recommended): the SDK
+     * reaches the consent server and the ledger under it. The consent server URL
+     * (`…/consent`) still works but is deprecated. Omit it and requests go to the
+     * production API.
+     */
     baseUrl?: string;
-    /** Go ledger base URL — serves check-consent and the consent write; omit to use the legacy consent server. */
+    /**
+     * 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. Ignored when `baseUrl` is the API host.
+     */
     ledgerBaseUrl?: string;
     language?: string;
     onAccept?: () => void;
@@ -114,6 +228,11 @@ type InlineOptions = {
 };
 type DigiLockerCallbackOptions = {
     accessToken: string;
+    /**
+     * The Redacto API host, e.g. `https://api.redacto.io`; the consent server URL
+     * (`…/consent`) still works but is deprecated. Omit it to use the one the
+     * notice stored before redirecting to DigiLocker.
+     */
     baseUrl?: string;
     onSuccess?: (verificationReference: string) => void;
     onError?: (error: Error, errorCode?: string) => void;
@@ -134,8 +253,25 @@ type AssistedOptions = {
     organisationUuid: string;
     workspaceUuid: string;
     noticeUuid: string;
+    /**
+     * The Redacto API host, e.g. `https://api.redacto.io` (recommended): the SDK
+     * reaches the consent server and the ledger under it. The consent server URL
+     * (`…/consent`) still works but is deprecated. Omit it and requests go to the
+     * production API.
+     */
     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. Ignored when `baseUrl` is the API host.
+     */
     ledgerBaseUrl?: string;
+    /**
+     * Optional code-side styling. The notice looks as set in the Redacto console
+     * (Display settings, Appearance); anything set here overrides the console
+     * for that key only. Display only: the submission and its verification are
+     * unchanged.
+     */
+    settings?: Partial<Settings>;
     onDecline?: () => void;
     onComplete?: () => void;
     onError?: (error: Error) => void;
@@ -144,9 +280,15 @@ type AssistedOptions = {
 type PrivacyCenterOptions = {
     /** Element, or CSS selector for it, that the Privacy Center is mounted in. */
     target: string | HTMLElement;
-    /** The organisation's Privacy Center slug. Required unless `url` is given. */
+    /** The organisation's UUID. Required unless `url` is given. */
+    organisationUuid?: string;
+    /**
+     * @deprecated Pass `organisationUuid`. Still frames the hosted page for this
+     * slug when no `organisationUuid` is given, with a one-time console warning;
+     * will be removed in a future major release.
+     */
     slug?: string;
-    /** Full URL of the hosted Privacy Center, e.g. on a custom domain. Wins over `slug`. */
+    /** Full URL of the hosted Privacy Center, e.g. on a custom domain. Wins over `organisationUuid`. */
     url?: string;
     /** Where the hosted Privacy Center lives. Defaults to Redacto's production console. */
     origin?: string;

package/dist/redacto.d.ts

@@ -1,3 +1,28 @@
+/** How checkbox rows are drawn: native checkboxes, or switches. */
+declare const NOTICE_CONTROL_STYLES: readonly ["checkbox", "switch"];
+/** Phones: a centred modal, or a sheet docked to the bottom edge. */
+declare const NOTICE_MOBILE_LAYOUTS: readonly ["modal", "sheet"];
+/** Where the notice sits on wider screens. */
+declare const NOTICE_DESKTOP_POSITIONS: readonly ["center", "bottom-right", "bottom-left", "bottom-bar"];
+/** The page behind the notice: dimmed with `colors.overlay`, or left as is. */
+declare const NOTICE_BACKDROPS: readonly ["dim", "none"];
+/** Phone footer: three stacked buttons, or Accept All over the other two. */
+declare const NOTICE_PHONE_FOOTERS: readonly ["stacked", "paired"];
+declare const NOTICE_TEXT_SCALES: readonly ["sm", "md", "lg"];
+
+/**
+ * Surface and layout family a notice is drawn with, chosen in the Redacto
+ * console and served on `active_config.appearance.style`. Colours never come
+ * from the style: they come from the admin's palette, else the notice's brand.
+ */
+type AppearanceStyle = "classic" | "glass" | "minimal" | "soft";
+type NoticeControlStyle = (typeof NOTICE_CONTROL_STYLES)[number];
+type NoticeMobileLayout = (typeof NOTICE_MOBILE_LAYOUTS)[number];
+type NoticeDesktopPosition = (typeof NOTICE_DESKTOP_POSITIONS)[number];
+type NoticeBackdrop = (typeof NOTICE_BACKDROPS)[number];
+type NoticePhoneFooter = (typeof NOTICE_PHONE_FOOTERS)[number];
+type NoticeTextScale = (typeof NOTICE_TEXT_SCALES)[number];
+
 /**
  * Optional sandbox options shared by the SDK's public option shapes and the
  * internal API params. When `token` is set the call sends the single
@@ -23,38 +48,109 @@ type SandboxOptions = {
     workspaceUuid?: string;
 };
 type SelectionControlType = "checkbox" | "radio" | "dropdown";
-type Settings = {
+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: {
-        /** Styles the "accept selected" button. */
-        accept: {
-            backgroundColor: string;
-            textColor: string;
+        /**
+         * 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;
         };
-        /** Optional: the accept-all shortcut falls back to `accept` when unset. */
-        acceptAll?: {
-            backgroundColor: string;
-            textColor: 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;
-    font?: 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 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
+     * (and before the inline embed auto-submits). Defaults to false.
+     */
     confirmBeforeSubmit?: boolean;
+    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 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;
 };
 
 type ModalOptions = SandboxOptions & {
@@ -76,8 +172,17 @@ type ModalOptions = SandboxOptions & {
      * customer code; optional third identifier alongside email/mobile.
      */
     ucic?: string;
+    /**
+     * The Redacto API host, e.g. `https://api.redacto.io` (recommended): the SDK
+     * reaches the consent server and the ledger under it. The consent server URL
+     * (`…/consent`) still works but is deprecated. Omit it and requests go to the
+     * production API.
+     */
     baseUrl?: string;
-    /** Go ledger base URL — serves check-consent and the consent write; omit to use the legacy consent server. */
+    /**
+     * 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. Ignored when `baseUrl` is the API host.
+     */
     ledgerBaseUrl?: string;
     language?: string;
     blockUI?: boolean;
@@ -101,8 +206,17 @@ type InlineOptions = {
     notice_uuid: string;
     accessToken?: string;
     refreshToken?: string;
+    /**
+     * The Redacto API host, e.g. `https://api.redacto.io` (recommended): the SDK
+     * reaches the consent server and the ledger under it. The consent server URL
+     * (`…/consent`) still works but is deprecated. Omit it and requests go to the
+     * production API.
+     */
     baseUrl?: string;
-    /** Go ledger base URL — serves check-consent and the consent write; omit to use the legacy consent server. */
+    /**
+     * 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. Ignored when `baseUrl` is the API host.
+     */
     ledgerBaseUrl?: string;
     language?: string;
     onAccept?: () => void;
@@ -114,6 +228,11 @@ type InlineOptions = {
 };
 type DigiLockerCallbackOptions = {
     accessToken: string;
+    /**
+     * The Redacto API host, e.g. `https://api.redacto.io`; the consent server URL
+     * (`…/consent`) still works but is deprecated. Omit it to use the one the
+     * notice stored before redirecting to DigiLocker.
+     */
     baseUrl?: string;
     onSuccess?: (verificationReference: string) => void;
     onError?: (error: Error, errorCode?: string) => void;
@@ -134,8 +253,25 @@ type AssistedOptions = {
     organisationUuid: string;
     workspaceUuid: string;
     noticeUuid: string;
+    /**
+     * The Redacto API host, e.g. `https://api.redacto.io` (recommended): the SDK
+     * reaches the consent server and the ledger under it. The consent server URL
+     * (`…/consent`) still works but is deprecated. Omit it and requests go to the
+     * production API.
+     */
     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. Ignored when `baseUrl` is the API host.
+     */
     ledgerBaseUrl?: string;
+    /**
+     * Optional code-side styling. The notice looks as set in the Redacto console
+     * (Display settings, Appearance); anything set here overrides the console
+     * for that key only. Display only: the submission and its verification are
+     * unchanged.
+     */
+    settings?: Partial<Settings>;
     onDecline?: () => void;
     onComplete?: () => void;
     onError?: (error: Error) => void;
@@ -144,9 +280,15 @@ type AssistedOptions = {
 type PrivacyCenterOptions = {
     /** Element, or CSS selector for it, that the Privacy Center is mounted in. */
     target: string | HTMLElement;
-    /** The organisation's Privacy Center slug. Required unless `url` is given. */
+    /** The organisation's UUID. Required unless `url` is given. */
+    organisationUuid?: string;
+    /**
+     * @deprecated Pass `organisationUuid`. Still frames the hosted page for this
+     * slug when no `organisationUuid` is given, with a one-time console warning;
+     * will be removed in a future major release.
+     */
     slug?: string;
-    /** Full URL of the hosted Privacy Center, e.g. on a custom domain. Wins over `slug`. */
+    /** Full URL of the hosted Privacy Center, e.g. on a custom domain. Wins over `organisationUuid`. */
     url?: string;
     /** Where the hosted Privacy Center lives. Defaults to Redacto's production console. */
     origin?: string;