@redacto.io/consent-sdk-react 10.3.1-beta.0 → 10.4.0-beta.1

package/dist/privacy-center.d.ts

@@ -53,9 +53,10 @@ declare function createConsentClient(baseUrl: string, ledgerBaseUrl?: string): {
         useSessionAuth?: boolean;
     }): Promise<unknown>;
     /**
-     * Create OTP (public)
+     * Create OTP (public). `to` is an email, or an E.164 number with
+     * `channel: "sms"`.
      */
-    createOtp(organisationId: string, workspaceId: string, email: string, options?: Omit<ApiFetchOptions, "getAuthToken">): Promise<unknown>;
+    createOtp(organisationId: string, workspaceId: string, email: string, options?: Omit<ApiFetchOptions, "getAuthToken">, channel?: "email" | "sms"): Promise<unknown>;
     /**
      * Verify OTP (public)
      *
@@ -218,6 +219,175 @@ declare function createConsentClient(baseUrl: string, ledgerBaseUrl?: string): {
     acknowledgeNotification(baseRequest: BaseRequest, notificationUuid: string, authToken?: string): Promise<NotificationActionResponse>;
 };
 
+/** Menu sections, keyed by the `InternalPage` each one opens. */
+type PrivacyCenterSectionKey = 'consent-manager' | 'form' | 'activity' | 'receipts' | 'notifications';
+/** Request types, keyed by the lower-case value a case is created with. */
+type PrivacyCenterRequestTypeKey = 'access' | 'correction' | 'erasure' | 'nomination' | 'grievance';
+type PrivacyCenterGrievanceCategory = 'consent_violation' | 'unlawful_processing' | 'data_breach';
+type PrivacyCenterSignInLayout = 'card' | 'split' | 'minimal';
+type PrivacyCenterSignInAlign = 'center' | 'left';
+type PrivacyCenterSignInBackground = 'gradient' | 'solid' | 'image';
+type PrivacyCenterSignInChannels = 'both' | 'email' | 'sms';
+type PrivacyCenterSection = Readonly<{
+    key: PrivacyCenterSectionKey;
+    /** `null` uses the built-in, translated label. */
+    label: string | null;
+    enabled: boolean;
+}>;
+type PrivacyCenterRequestType = Readonly<{
+    key: PrivacyCenterRequestTypeKey;
+    /** `null` uses the built-in, translated label. */
+    label: string | null;
+    enabled: boolean;
+}>;
+type PrivacyCenterFooterLink = Readonly<{
+    label: string;
+    url: string;
+}>;
+type PrivacyCenterBrandingSettings = Readonly<{
+    inherit_identity: boolean;
+    display_name: string | null;
+    logo_url: string | null;
+    /** 28–96 px; `null` keeps the built-in size. */
+    logo_height: number | null;
+    inherit_colors: boolean;
+    primary_color: string | null;
+    accent_color: string | null;
+    inherit_font: boolean;
+    font_family: string | null;
+    style: PrivacyCenterTheme;
+    /** 0–24 px; `null` keeps the built-in radii. */
+    corner_radius: number | null;
+}>;
+type PrivacyCenterSignInSettings = Readonly<{
+    layout: PrivacyCenterSignInLayout;
+    align: PrivacyCenterSignInAlign;
+    background_type: PrivacyCenterSignInBackground;
+    background_from: string;
+    background_to: string;
+    background_color: string;
+    background_image_url: string | null;
+    highlights: readonly string[];
+    show_logo: boolean;
+    title: string;
+    tagline: string | null;
+    heading: string;
+    description: string | null;
+    channels: PrivacyCenterSignInChannels;
+    default_country_code: string;
+    field_label: string | null;
+    placeholder: string | null;
+    help_text: string | null;
+    button_text: string;
+    show_notice_line: boolean;
+    notice_line: string | null;
+    show_support_link: boolean;
+    support_text: string;
+    support_link_text: string;
+    otp_heading: string;
+    otp_description: string | null;
+    otp_button_text: string;
+    otp_resend_text: string;
+}>;
+type PrivacyCenterPortalSettings = Readonly<{
+    sections: readonly PrivacyCenterSection[];
+    welcome_enabled: boolean;
+    welcome_title: string;
+    welcome_message: string;
+    request_types: readonly PrivacyCenterRequestType[];
+    grievance_categories: readonly PrivacyCenterGrievanceCategory[];
+    /** `null` asks the data principal, as today. */
+    revoke_consents_on_erasure: boolean | null;
+    /** `null` uses the built-in warning; a purpose's own message still wins. */
+    withdraw_warning: string | null;
+    /** `null` never signs out for inactivity. */
+    session_timeout_minutes: number | null;
+}>;
+type PrivacyCenterLanguageSettings = Readonly<{
+    enabled: readonly string[];
+    default: string;
+    auto_detect: boolean;
+    show_switcher: boolean;
+}>;
+type PrivacyCenterFooterSettings = Readonly<{
+    links: readonly PrivacyCenterFooterLink[];
+    show_privacy_policy: boolean;
+    show_contact: boolean;
+    copyright: string | null;
+    show_powered_by: boolean;
+}>;
+type PrivacyCenterSeoSettings = Readonly<{
+    page_title: string;
+    noindex: boolean;
+}>;
+type PrivacyCenterEmbedSettings = Readonly<{
+    allowed_origins: readonly string[];
+}>;
+/**
+ * The full Privacy Center settings, as published from the Redacto console and
+ * served by the public settings endpoint, with every field filled in.
+ */
+type ResolvedPrivacyCenterSettings = Readonly<{
+    schema_version: number;
+    branding: PrivacyCenterBrandingSettings;
+    sign_in: PrivacyCenterSignInSettings;
+    portal: PrivacyCenterPortalSettings;
+    languages: PrivacyCenterLanguageSettings;
+    footer: PrivacyCenterFooterSettings;
+    seo: PrivacyCenterSeoSettings;
+    custom_css: string | null;
+    embed: PrivacyCenterEmbedSettings;
+}>;
+/**
+ * Host overrides for `RedactoPrivacyCenter`'s `settings` prop. Each group is
+ * merged field by field over the published settings, so a host can change one
+ * value and keep the rest of what the console published.
+ */
+type PrivacyCenterSettings = Readonly<{
+    /**
+     * Visual style, kept as an alias for `branding.style`. `"classic"` (the
+     * default) is the standard look; `"glass"` is a frosted, sheet-based style.
+     * An unrecognised value falls back to classic.
+     */
+    theme?: PrivacyCenterTheme;
+    branding?: Partial<PrivacyCenterBrandingSettings>;
+    sign_in?: Partial<PrivacyCenterSignInSettings>;
+    portal?: Partial<PrivacyCenterPortalSettings>;
+    languages?: Partial<PrivacyCenterLanguageSettings>;
+    footer?: Partial<PrivacyCenterFooterSettings>;
+    seo?: Partial<PrivacyCenterSeoSettings>;
+    custom_css?: string | null;
+}>;
+/**
+ * Brand Identity details the public settings carry only when the published
+ * settings use them (a `{legal}` placeholder, the footer's privacy policy or
+ * contact lines). Each is null otherwise.
+ */
+type PrivacyCenterBrandContact = Readonly<{
+    legal_entity_name: string | null;
+    privacy_policy_url: string | null;
+    grievance_email: string | null;
+    grievance_url: string | null;
+    dp_board_url: string | null;
+}>;
+/** `detail` of `GET /public/organisations/{org}/privacy-center-settings/`. */
+type PublicPrivacyCenterSettingsResponse = Readonly<{
+    settings: unknown;
+    version: number;
+    published_at: string | null;
+    language: string;
+    /** Absent on servers that predate it. */
+    brand_contact?: unknown;
+}>;
+/** Values the `{brand}`-style tokens in custom copy resolve to. */
+type PlaceholderContext = Readonly<{
+    brand: string;
+    legal?: string | null;
+    year?: number;
+    contact?: string | null;
+    name?: string | null;
+}>;
+
 type InternalPage = 'consent-manager' | 'form' | 'activity' | 'case-details' | 'notifications' | 'receipts';
 interface NavigationContextType {
     currentPage: InternalPage;
@@ -310,6 +480,7 @@ type FormData = {
     purposes: RawPurposeWrapper[];
     direct_groups?: FormProductGroup[];
     nominated_groups?: FormProductGroup[];
+    enabled_request_types?: string[] | null;
 };
 type FormDataResponse = {
     code: number;
@@ -675,14 +846,45 @@ type SelectPrincipalResponse = Readonly<{
     refresh_token: string;
     expires_at?: string;
 }>;
-/** Presentation options for the Privacy Center, mirroring the notice's `settings`. */
-type PrivacyCenterSettings = Readonly<{
-    /**
-     * Visual style. `"classic"` (the default) is the standard look; `"glass"` is
-     * a frosted, sheet-based style. Both take their colours from workspace
-     * branding. An unrecognised value falls back to classic.
-     */
-    theme?: PrivacyCenterTheme;
+/** Passed to `onReady` once the first screen is on show. */
+type PrivacyCenterReadyEvent = Readonly<{
+    /** False when the built-in sign-in screen is what the visitor sees. */
+    signedIn: boolean;
+}>;
+/** Passed to `onConsentChange` after a consent was changed successfully. */
+type PrivacyCenterConsentChange = Readonly<{
+    /** `revoke` withdraws consent; `regrant` and `renew` give it again. */
+    action: ConsentAction;
+    purposeUuid: string;
+    productUuid: string | null;
+    /** The data elements the change covered; empty when it covered the whole purpose. */
+    dataElementUuids: readonly string[];
+    /** Set when the visitor acted on behalf of someone who nominated them. */
+    nominatorUuid: string | null;
+}>;
+/** Passed to `onRequestSubmit` after a data request (case) was created. */
+type PrivacyCenterRequestSubmission = Readonly<{
+    /** The human-readable case id shown to the visitor. */
+    caseId: string;
+    caseUuid: string;
+    requestType: PrivacyCenterRequestTypeKey;
+    /** The product the request is about; null for nomination and grievance. */
+    productUuid: string | null;
+}>;
+/**
+ * Why the visitor was signed out: they chose to (`user`), they were idle for
+ * the configured session timeout (`timeout`), or their session could no longer
+ * be refreshed (`session-expired`).
+ */
+type PrivacyCenterSignOutReason = 'user' | 'timeout' | 'session-expired';
+type PrivacyCenterSignOutEvent = Readonly<{
+    reason: PrivacyCenterSignOutReason;
+}>;
+type PrivacyCenterEventHandlers = Readonly<{
+    onReady?: (event: PrivacyCenterReadyEvent) => void;
+    onConsentChange?: (change: PrivacyCenterConsentChange) => void;
+    onRequestSubmit?: (request: PrivacyCenterRequestSubmission) => void;
+    onSignOut?: (event: PrivacyCenterSignOutEvent) => void;
 }>;
 type RedactoPrivacyCenterProps = Readonly<{
     baseUrl: string;
@@ -709,15 +911,39 @@ type RedactoPrivacyCenterProps = Readonly<{
      * customer code; optional third identifier alongside email/mobile.
      */
     ucic?: string;
-    /** Sandbox org UUID (replaces the JWT-decoded org in sandbox mode). */
+    /**
+     * Organisation UUID. Replaces the JWT-decoded org in sandbox mode; without a
+     * token it also addresses the built-in sign-in and the published settings
+     * (otherwise looked up from `slug`).
+     */
     organisationUuid?: string;
-    /** Sandbox workspace UUID (replaces the JWT-decoded workspace in sandbox mode). */
+    /**
+     * Workspace UUID. Replaces the JWT-decoded workspace in sandbox mode; without
+     * a token it addresses the built-in sign-in (otherwise looked up from `slug`).
+     */
     workspaceUuid?: string;
     onError: (error: Error) => boolean;
     initialPage?: InternalPage;
     onBack?: 'back' | 'signout';
-    /** Presentation options; see `PrivacyCenterSettings`. */
+    /**
+     * Overrides for the settings published from the Redacto console, merged
+     * field by field over them per group; see `PrivacyCenterSettings`.
+     */
     settings?: PrivacyCenterSettings;
+    /**
+     * With no token, show the built-in OTP sign-in screen. Off by default: with
+     * no token the Privacy Center keeps its loading state until the host passes
+     * one, so a token that arrives a moment late never flashes a sign-in.
+     */
+    builtInSignIn?: boolean;
+    /** Called once, when the first screen (sign-in or the Privacy Center) is on show. */
+    onReady?: (event: PrivacyCenterReadyEvent) => void;
+    /** Called after the visitor withdrew, re-granted or renewed a consent. */
+    onConsentChange?: (change: PrivacyCenterConsentChange) => void;
+    /** Called after the visitor submitted a data request. */
+    onRequestSubmit?: (request: PrivacyCenterRequestSubmission) => void;
+    /** Called when the visitor is signed out, with the reason. */
+    onSignOut?: (event: PrivacyCenterSignOutEvent) => void;
 }>;
 type PrivacyCenterLayoutProps = Readonly<{
     children: ReactNode;
@@ -730,7 +956,7 @@ type PrivacyCenterLayoutProps = Readonly<{
     settings?: PrivacyCenterSettings;
 }>;
 
-declare function RedactoPrivacyCenter({ baseUrl, ledgerBaseUrl, slug, accessToken, refreshToken, token, email, mobile, ucic, organisationUuid, workspaceUuid, onError, initialPage, onBack, settings, }: RedactoPrivacyCenterProps): React.JSX.Element;
+declare function RedactoPrivacyCenter({ baseUrl, ledgerBaseUrl, slug, accessToken, refreshToken, token, email, mobile, ucic, organisationUuid, workspaceUuid, onError, initialPage, onBack, settings, builtInSignIn, onReady, onConsentChange, onRequestSubmit, onSignOut, }: RedactoPrivacyCenterProps): React.JSX.Element;
 
 declare function PrivacyCenterLayout({ settings, ...props }: PrivacyCenterLayoutProps): React.JSX.Element;
 
@@ -777,6 +1003,10 @@ type AuthContextValue = Readonly<{
     onError: (error: Error) => boolean;
     updateTokens: (accessToken: string, refreshToken?: string) => void;
     sessionExpired: boolean;
+    /** Signs the visitor out (e.g. after inactivity) and shows the session-expired screen. */
+    expireSession: (reason: PrivacyCenterSignOutReason) => void;
+    /** Drops the session so the built-in sign-in screen shows again. */
+    restartSignIn: () => void;
 }>;
 type BaseUrlContextValue = Readonly<{
     baseUrl: string;
@@ -976,4 +1206,60 @@ declare const useAuth: () => AuthContextValue;
  */
 declare const injectPCStyles: () => void;
 
-export { type Activity, type ActivityBadgeStatus$1 as ActivityBadgeStatus, type ActivityDetail, type ActivityResponse, type ApiFetchOptions, type ApiResponse, type AuthContext, AuthProvider, type BaseRequest, BaseUrlProvider, type CaseHistoryDetail, type CaseHistoryResponse, type CaseRequest, type ConsentAction, type ConsentDataElement, type ConsentGroup, type ConsentHistoryStatusSummary, type ConsentModalRecord, ConsentStatusEnum, type CreateCaseResponse, type DataElement, type DisplayPurposeRow, type FetchOrgParams, type FormData, type FormDataResponse, type GrievanceOptions, type GrievanceTypeElement, GrievanceTypeEnum, type GrievanceValue, type GroupPurposesOut, type InternalPage, type ManageConsentParams, type ManageConsentResponse, NavigationProvider, type NominationData, type NominatorInfo, NotificationsPage, type OrganizationDetail, type OrganizationResponse, type OtpResponse, type OtpVerificationResponse, type Pagination, type PaginationMeta, PrivacyCenterActivityPage, PrivacyCenterCaseDetailsPage, PrivacyCenterConsentManagerPage, PrivacyCenterFormPage, PrivacyCenterHomePage, PrivacyCenterLayout, type PrivacyCenterSettings, PrivacyCenterTheme, type Purpose, type PurposeItem, type RawPurposeWrapper, RedactoPrivacyCenter, RequestTypeEnum, type TokenExchangeResponse, type UpdateCorrectionDataItem, type UpdatePurpose, type UpdateRequestDetails, type UserConsentDetail, type UserConsentResponse, type UserDataRequest, type Workspace, checkAndRefreshAuth, compareEmails, createCaseRequest, createConsentClient, createOtpServer as createOtp, decodeJwtToken, ensureValidToken, exchangeTokenServer as exchangeToken, fetchActivities, fetchCaseHistory, fetchGroupPurposes, fetchProducts, fetchUserConsents, formatActivityType, getActivityTypeStatus, getCookieValue, getFormData, getInitialState, injectPCStyles, isJwtExpired, isUserAuthenticated, manageConsent, setRefreshTokenCookie, signOutPrivacyCenter, useAuth, useBaseUrl, useCaseHistory, useInternalNavigation, verifyOtpServer as verifyOtp };
+/**
+ * Reproduces today's Privacy Center: with nothing published, every value here
+ * renders exactly what the SDK rendered before settings existed.
+ */
+declare const DEFAULT_PRIVACY_CENTER_SETTINGS: ResolvedPrivacyCenterSettings;
+
+/**
+ * The settings the Privacy Center renders with: the published payload (or
+ * nothing, when none was fetched) validated field by field, with the host's
+ * `settings` prop merged over each group. Anything missing or malformed takes
+ * the default, so a bad payload can never break the page or change it from
+ * today's look by accident.
+ */
+declare const resolvePrivacyCenterSettings: (published: unknown, overrides?: PrivacyCenterSettings | null) => ResolvedPrivacyCenterSettings;
+
+/**
+ * Fills `{brand}`, `{legal}`, `{year}`, `{contact}` and `{name}` in custom
+ * copy. `{legal}` falls back to the brand, and an empty value (no name known)
+ * collapses cleanly: "Welcome back, {name}!" reads "Welcome back!".
+ */
+declare const resolvePlaceholders: (text: string | null | undefined, context: PlaceholderContext) => string;
+
+/**
+ * The organisation's published Privacy Center settings, localised to
+ * `language`. Public and unauthenticated. Resolves to `null` on any failure
+ * (network, 4xx/5xx, an unexpected body) so callers keep today's defaults;
+ * never rejects. One request per organisation and language is shared for
+ * `SETTINGS_CACHE_TTL_MS`, so a later mount or language switch picks up a new
+ * publish; a failed one is forgotten so the next mount retries.
+ */
+declare const fetchPublicPrivacyCenterSettings: (baseUrl: string, organisationUuid: string, language: string) => Promise<PublicPrivacyCenterSettingsResponse | null>;
+
+declare const PRIVACY_CENTER_PARTS: readonly ["topbar", "nav", "nav-item", "welcome", "consent-card", "request-form", "button-primary", "footer", "signin-card"];
+type PrivacyCenterPart = (typeof PRIVACY_CENTER_PARTS)[number];
+
+/** The resolved settings; the defaults outside a `RedactoPrivacyCenter`. */
+declare const usePrivacyCenterSettings: () => ResolvedPrivacyCenterSettings;
+
+type PrivacyCenterSettingsProviderProps = Readonly<{
+    children: ReactNode;
+    baseUrl: string;
+    slug: string;
+    accessToken?: string;
+    organisationUuid?: string;
+    workspaceUuid?: string;
+    overrides?: PrivacyCenterSettings;
+    builtInSignIn?: boolean;
+}>;
+/**
+ * Fetches the organisation's published Privacy Center settings and refetches
+ * them in the visitor's language. Rendering never waits: children get the
+ * defaults (which reproduce the Privacy Center as it was before settings)
+ * until the published copy arrives, and keep them when the fetch fails.
+ */
+declare const PrivacyCenterSettingsProvider: ({ children, baseUrl, slug, accessToken, organisationUuid, workspaceUuid, overrides, builtInSignIn, }: PrivacyCenterSettingsProviderProps) => React.JSX.Element;
+
+export { type Activity, type ActivityBadgeStatus$1 as ActivityBadgeStatus, type ActivityDetail, type ActivityResponse, type ApiFetchOptions, type ApiResponse, type AuthContext, AuthProvider, type BaseRequest, BaseUrlProvider, type CaseHistoryDetail, type CaseHistoryResponse, type CaseRequest, type ConsentAction, type ConsentDataElement, type ConsentGroup, type ConsentHistoryStatusSummary, type ConsentModalRecord, ConsentStatusEnum, type CreateCaseResponse, DEFAULT_PRIVACY_CENTER_SETTINGS, type DataElement, type DisplayPurposeRow, type FetchOrgParams, type FormData, type FormDataResponse, type GrievanceOptions, type GrievanceTypeElement, GrievanceTypeEnum, type GrievanceValue, type GroupPurposesOut, type InternalPage, type ManageConsentParams, type ManageConsentResponse, NavigationProvider, type NominationData, type NominatorInfo, NotificationsPage, type OrganizationDetail, type OrganizationResponse, type OtpResponse, type OtpVerificationResponse, PRIVACY_CENTER_PARTS, type Pagination, type PaginationMeta, type PlaceholderContext, PrivacyCenterActivityPage, type PrivacyCenterBrandContact, type PrivacyCenterBrandingSettings, PrivacyCenterCaseDetailsPage, type PrivacyCenterConsentChange, PrivacyCenterConsentManagerPage, type PrivacyCenterEmbedSettings, type PrivacyCenterEventHandlers, type PrivacyCenterFooterLink, type PrivacyCenterFooterSettings, PrivacyCenterFormPage, type PrivacyCenterGrievanceCategory, PrivacyCenterHomePage, type PrivacyCenterLanguageSettings, PrivacyCenterLayout, type PrivacyCenterPart, type PrivacyCenterPortalSettings, type PrivacyCenterReadyEvent, type PrivacyCenterRequestSubmission, type PrivacyCenterRequestType, type PrivacyCenterRequestTypeKey, type PrivacyCenterSection, type PrivacyCenterSectionKey, type PrivacyCenterSeoSettings, type PrivacyCenterSettings, PrivacyCenterSettingsProvider, type PrivacyCenterSignInChannels, type PrivacyCenterSignInLayout, type PrivacyCenterSignInSettings, type PrivacyCenterSignOutEvent, type PrivacyCenterSignOutReason, PrivacyCenterTheme, type PublicPrivacyCenterSettingsResponse, type Purpose, type PurposeItem, type RawPurposeWrapper, RedactoPrivacyCenter, type RedactoPrivacyCenterProps, RequestTypeEnum, type ResolvedPrivacyCenterSettings, type TokenExchangeResponse, type UpdateCorrectionDataItem, type UpdatePurpose, type UpdateRequestDetails, type UserConsentDetail, type UserConsentResponse, type UserDataRequest, type Workspace, checkAndRefreshAuth, compareEmails, createCaseRequest, createConsentClient, createOtpServer as createOtp, decodeJwtToken, ensureValidToken, exchangeTokenServer as exchangeToken, fetchActivities, fetchCaseHistory, fetchGroupPurposes, fetchProducts, fetchPublicPrivacyCenterSettings, fetchUserConsents, formatActivityType, getActivityTypeStatus, getCookieValue, getFormData, getInitialState, injectPCStyles, isJwtExpired, isUserAuthenticated, manageConsent, resolvePlaceholders, resolvePrivacyCenterSettings, setRefreshTokenCookie, signOutPrivacyCenter, useAuth, useBaseUrl, useCaseHistory, useInternalNavigation, usePrivacyCenterSettings, verifyOtpServer as verifyOtp };