@redacto.io/consent-sdk-react 10.4.0-beta.1 → 11.0.0-beta.3

package/dist/privacy-center.d.ts

@@ -1,6 +1,6 @@
 import * as React from 'react';
 import { ReactNode } from 'react';
-import { P as PrivacyCenterTheme } from './types-Bwtzvz4W.js';
+import { P as PrivacyCenterTheme } from './types-B8qroG0j.js';
 import * as _tanstack_react_query from '@tanstack/react-query';
 
 /**
@@ -32,12 +32,18 @@ type BaseRequest = {
 /**
  * Consent service client factory.
  * Creates a client instance with a specific base URL.
- * @param baseUrl - Consent server base URL (Python service, e.g. http://host/consent)
- * @param ledgerBaseUrl - Go ledger base URL (e.g. http://host:8090/consent-ledger).
- *   Used for user-consents reads/writes served from the ledger's `/public/...` paths.
- *   When omitted, those calls fall back to the legacy Python
- *   `/dsar/privacy-center` endpoints and payloads (pre-ledger behavior), so
- *   integrations without a deployed ledger keep working.
+ * @param baseUrl - API host, e.g. https://api.redacto.io (recommended): the
+ *   client reaches the consent server at `{baseUrl}/consent` and the ledger at
+ *   `{baseUrl}/consent-ledger`. The consent server URL (`…/consent`) still
+ *   works but is deprecated.
+ * @param ledgerBaseUrl - Deprecated. Go ledger base URL (e.g.
+ *   http://host:8090/consent-ledger). Read only when `baseUrl` is the
+ *   consent server URL, as in earlier releases; ignored when `baseUrl` is
+ *   the API host. There it is the ledger used for user-consents reads/writes
+ *   served from the ledger's `/public/...` paths; when omitted, those calls
+ *   fall back to the legacy Python `/dsar/privacy-center` endpoints and
+ *   payloads (pre-ledger behavior), so integrations without a deployed
+ *   ledger keep working.
  */
 declare function createConsentClient(baseUrl: string, ledgerBaseUrl?: string): {
     /**
@@ -244,12 +250,15 @@ type PrivacyCenterFooterLink = Readonly<{
     label: string;
     url: string;
 }>;
+type PrivacyCenterLogoAlign = 'auto' | 'left' | 'center' | 'right';
 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;
+    /** `"auto"` keeps the logo on the leading edge of the top bar. */
+    logo_align: PrivacyCenterLogoAlign;
     inherit_colors: boolean;
     primary_color: string | null;
     accent_color: string | null;
@@ -887,9 +896,25 @@ type PrivacyCenterEventHandlers = Readonly<{
     onSignOut?: (event: PrivacyCenterSignOutEvent) => void;
 }>;
 type RedactoPrivacyCenterProps = Readonly<{
+    /**
+     * API host, e.g. https://api.redacto.io (recommended). 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. Ignored when `baseUrl`
+     * is the API host. With the consent server URL, it is the ledger that serves
+     * user-consents; omit it there to use the legacy Python privacy-center
+     * consent endpoints.
+     */
     ledgerBaseUrl?: string;
-    slug: string;
+    /**
+     * @deprecated Ignored; will be removed in a future major release. Passing it
+     * logs a one-time warning. The organisation comes from the access token, or
+     * from `organisationUuid` and `workspaceUuid`.
+     */
+    slug?: string;
     /** JWT access token. Optional so sandbox mode (see `token`) can omit it. */
     accessToken?: string;
     /** JWT refresh token. Optional; used by the OTP-refresh loop in the JWT flow. */
@@ -913,13 +938,13 @@ type RedactoPrivacyCenterProps = Readonly<{
     ucic?: string;
     /**
      * 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`).
+     * token it also addresses the built-in sign-in, the published settings and
+     * the branding.
      */
     organisationUuid?: string;
     /**
      * 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`).
+     * a token it addresses the built-in sign-in, which needs it with `organisationUuid`.
      */
     workspaceUuid?: string;
     onError: (error: Error) => boolean;
@@ -947,7 +972,11 @@ type RedactoPrivacyCenterProps = Readonly<{
 }>;
 type PrivacyCenterLayoutProps = Readonly<{
     children: ReactNode;
-    slug: string;
+    /**
+     * @deprecated Ignored; will be removed in a future major release. Passing it
+     * logs a one-time warning. The organisation comes from the access token.
+     */
+    slug?: string;
     onBack?: 'back' | 'signout';
     /**
      * For custom compositions that render this layout directly. Omit it to
@@ -993,7 +1022,7 @@ type AuthProviderProps = Readonly<{
     organisationUuid?: string;
     /** Sandbox workspace UUID (replaces the JWT-decoded workspace). */
     workspaceUuid?: string;
-    /** Organisation slug — used to seed sandbox sessionStorage. */
+    /** @deprecated Ignored; will be removed in a future major release. */
     slug?: string;
     onError: (error: Error) => boolean;
 }>;
@@ -1009,20 +1038,34 @@ type AuthContextValue = Readonly<{
     restartSignIn: () => void;
 }>;
 type BaseUrlContextValue = Readonly<{
+    /** The consent server URL: `{apiHost}/consent` when given the API host, else `baseUrl` as passed. */
     baseUrl: string;
+    /** The ledger URL: `{apiHost}/consent-ledger` when given the API host, else `ledgerBaseUrl` as passed. */
     ledgerBaseUrl?: string;
     consentClient: ReturnType<typeof createConsentClient>;
+    /** The API host, when `baseUrl` was passed as one; undefined for the deprecated consent server URL. */
+    apiHost?: string;
 }>;
 
 declare const BaseUrlProvider: ({ children, baseUrl, ledgerBaseUrl, }: {
     children: ReactNode;
+    /**
+     * API host, e.g. https://api.redacto.io (recommended). 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. Ignored when `baseUrl`
+     * is the API host.
+     */
     ledgerBaseUrl?: string;
 }) => React.JSX.Element;
 declare const useBaseUrl: () => Readonly<{
     baseUrl: string;
     ledgerBaseUrl?: string;
     consentClient: ReturnType<typeof createConsentClient>;
+    apiHost?: string;
 }>;
 
 declare function createOtpServer(email: string, organizationId: string, workspaceId: string, consentClient?: ReturnType<typeof createConsentClient>): Promise<OtpResponse>;
@@ -1059,25 +1102,26 @@ declare const isJwtExpired: (token: string, bufferSeconds?: number) => boolean;
 /**
  * Check if user is authenticated in privacy center
  * User is considered authenticated if both access_token and email exist in sessionStorage
+ * @deprecated The slug is ignored; the parameter will be removed in a future major release.
  */
-declare const isUserAuthenticated: (expectedSlug: string) => boolean;
+declare const isUserAuthenticated: (_expectedSlug?: string) => boolean;
 /**
  * Get initial state for sign-in form visibility
  * Returns true if window is undefined (SSR) or user is not authenticated
- * @param slug - The organization slug to check authentication against
  * @returns true if sign-in form should be shown, false otherwise
+ * @deprecated The slug is ignored; the parameter will be removed in a future major release.
  */
-declare const getInitialState: (slug: string) => boolean;
+declare const getInitialState: (_slug?: string) => boolean;
 /**
  * Check authentication status and attempt token refresh if needed
  * This function checks if the user is authenticated, validates JWT expiration,
  * and attempts to refresh using the refresh token cookie if the token is expired or missing.
- * @param expectedSlug - The organization slug to verify against
+ * @param _expectedSlug - Deprecated and ignored: the session is scoped by `organizationId`.
  * @param organizationId - Optional organization ID (will be read from sessionStorage if not provided)
  * @param workspaceId - Optional workspace ID (will be read from sessionStorage if not provided)
  * @returns Promise<boolean> - true if authenticated with valid non-expired token, false otherwise
  */
-declare const checkAndRefreshAuth: (expectedSlug: string, organizationId?: string, workspaceId?: string, consentClient?: BaseUrlContextValue["consentClient"]) => Promise<boolean>;
+declare const checkAndRefreshAuth: (_expectedSlug: string, organizationId?: string, workspaceId?: string, consentClient?: BaseUrlContextValue["consentClient"]) => Promise<boolean>;
 /**
  * Compare two email addresses (case-insensitive, handles URL encoding)
  * @param email1 - First email (can be URL-encoded)
@@ -1098,11 +1142,11 @@ declare const signOutPrivacyCenter: () => void;
  *
  * @param organizationId - The organization UUID
  * @param workspaceId - The workspace UUID
- * @param slug - The organization slug for redirect
+ * @param _slug - Ignored; kept for call-site compatibility
  * @param authContext - Optional auth context values (accessToken, refreshToken, onError, updateTokens)
  * @returns Promise<string | null> - Valid access token or null if auth failed
  */
-declare const ensureValidToken: (organizationId?: string, workspaceId?: string, slug?: string, authContext?: {
+declare const ensureValidToken: (organizationId?: string, workspaceId?: string, _slug?: string, authContext?: {
     accessToken?: string;
     refreshToken?: string;
     onError?: (error: Error) => boolean;
@@ -1247,7 +1291,8 @@ declare const usePrivacyCenterSettings: () => ResolvedPrivacyCenterSettings;
 type PrivacyCenterSettingsProviderProps = Readonly<{
     children: ReactNode;
     baseUrl: string;
-    slug: string;
+    /** @deprecated Ignored; will be removed in a future major release. */
+    slug?: string;
     accessToken?: string;
     organisationUuid?: string;
     workspaceUuid?: string;
@@ -1260,6 +1305,6 @@ type PrivacyCenterSettingsProviderProps = Readonly<{
  * 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;
+declare const PrivacyCenterSettingsProvider: ({ children, baseUrl, 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 };