@redacto.io/consent-sdk-react-native 2.2.0 → 3.0.1-beta.0

package/README.md

@@ -47,8 +47,8 @@ pnpm add expo-audio
 
 The SDK never talks to Redacto with your CMS API key directly — your backend acts as a token broker. Obtain your **CMS-API-Key** from the Redacto Dashboard, store it in your backend's environment, and expose two endpoints to your mobile app:
 
-1. **Generate access token** — `POST /public/organisations/{org_uuid}/workspaces/{workspace_uuid}/tokens/generate-access-token`
-2. **Refresh access token** — `POST /consent/public/organisations/{org_uuid}/workspaces/{workspace_uuid}/tokens/refresh-token`
+1. **Generate access token** — `POST /public/organisations/{org_uuid}/workspaces/{workspace_uuid}/tokens/generate`
+2. **Refresh access token** — `POST /consent/public/organisations/{org_uuid}/workspaces/{workspace_uuid}/tokens/refresh`
 
 Both endpoints expect the `X-CMS-API-Key` header. Example (Express):
 
@@ -66,7 +66,7 @@ app.post("/api/consent/token", async (req, res) => {
   const { organisation_uuid, workspace_uuid, base_url } = req.query;
 
   const response = await axios.post(
-    `${base_url}/public/organisations/${organisation_uuid}/workspaces/${workspace_uuid}/tokens/generate-access-token`,
+    `${base_url}/public/organisations/${organisation_uuid}/workspaces/${workspace_uuid}/tokens/generate`,
     { email },
     { headers: { "X-CMS-API-Key": CMS_API_KEY } }
   );
@@ -78,7 +78,7 @@ app.post("/api/consent/refresh-token", async (req, res) => {
   const { refresh_token, organisation_uuid, workspace_uuid, base_url } = req.body;
 
   const response = await axios.post(
-    `${base_url}/consent/public/organisations/${organisation_uuid}/workspaces/${workspace_uuid}/tokens/refresh-token`,
+    `${base_url}/consent/public/organisations/${organisation_uuid}/workspaces/${workspace_uuid}/tokens/refresh`,
     { refresh_token },
     { headers: { "X-CMS-API-Key": CMS_API_KEY } }
   );
@@ -172,7 +172,7 @@ The Privacy Center is a separate entry point (`@redacto.io/consent-sdk-react-nat
 
 ### Certified UI
 
-`RedactoPrivacyCenter` renders the full Privacy Center experience with built-in navigation, auth, theming, and i18n.
+`RedactoPrivacyCenter` renders the full Privacy Center experience with built-in navigation, auth, theming, i18n, and an internal `QueryClientProvider`. You do **not** need to wrap it in your own React Query provider.
 
 ```tsx
 import { RedactoPrivacyCenter } from "@redacto.io/consent-sdk-react-native/privacy-center";
@@ -201,7 +201,7 @@ import { RedactoPrivacyCenter } from "@redacto.io/consent-sdk-react-native/priva
 | `refreshToken` | `string`                                                                      | ✓        | -                    | JWT refresh token                        |
 | `onError`      | `(error: Error) => boolean`                                                   | ✓        | -                    | Error handler; return `true` if handled  |
 | `theme`        | `"light" \| "dark"`                                                           |          | `"light"`            | Theme variant                            |
-| `initialPage`  | `"consent-manager" \| "form" \| "activity" \| "case-details"`                 |          | `"consent-manager"` | Page to render first                     |
+| `initialPage`  | `"consent-manager" \| "form" \| "activity" \| "receipts" \| "case-details"`   |          | `"consent-manager"` | Page to render first                     |
 | `onBack`       | `"back" \| "signout"`                                                         |          | -                    | Navbar back / signout control behaviour  |
 
 ### Composable Components
@@ -220,7 +220,17 @@ If you want to compose your own shell, import the screen-level building blocks i
 | `BottomTabBar`     | Bottom tab navigation                                  |
 | `Footer`           | Footer block                                           |
 
-These rely on the context providers (`AuthProvider`, `BaseUrlProvider`, `NavigationProvider`, `ThemeProvider`) — wrap them yourself if you compose the pages directly.
+These rely on the context providers (`AuthProvider`, `BaseUrlProvider`, `NavigationProvider`, `ThemeProvider`, and `QueryClientProvider` for React Query hooks) — wrap them yourself if you compose the pages directly.
+
+### Receipt downloads
+
+The **My Receipt** screen downloads PDFs via `expo-file-system` and opens the native share sheet via `expo-sharing`. Install both peers when using Privacy Center:
+
+```sh
+pnpm add expo-file-system expo-sharing
+```
+
+On Expo SDK 52+, the SDK uses the `expo-file-system/legacy` entry automatically; older Expo versions fall back to the main `expo-file-system` export.
 
 ### UI Primitives
 

package/dist/privacy-center.d.mts

@@ -166,6 +166,27 @@ type ConsentHistoryStatusSummary = {
     active_purposes: number;
     inactive_purposes: number;
 };
+type PurposeItem = {
+    purpose_uuid: string;
+    name: string;
+    description: string | null;
+    status: ConsentStatusEnum | string;
+    given_date: string | null;
+    valid_till: string | null;
+    method: string;
+    data_elements: ConsentDataElement[];
+    link_reason: string | null;
+};
+type ConsentGroup = {
+    product_uuid: string;
+    product_name: string;
+    product_description: string | null;
+    nominator: NominatorInfo | null;
+    total_purposes: number;
+    active_purposes: number;
+    purposes: PurposeItem[];
+    has_more_purposes: boolean;
+};
 type ProductConsentHistoryGroup = {
     product_uuid: string;
     product_name: string;
@@ -186,12 +207,16 @@ type Pagination = {
 type UserConsentDetail = {
     data?: UserConsent[];
     product_purpose_groups?: ProductConsentHistoryGroup[];
-    pagination: Pagination;
+    pagination?: Pagination;
     direct_product_groups?: ProductConsentHistoryGroup[];
     user_status?: 'ACTIVE' | 'TRANSFERRED' | null;
     nominated_purposes?: NominatedPurposesGroup[];
     nominators?: NominatorInfo[];
     status_summary?: ConsentHistoryStatusSummary | null;
+    direct?: ConsentGroup[];
+    nominated?: ConsentGroup[];
+    direct_pagination?: Pagination;
+    nominated_pagination?: Pagination;
 };
 declare enum ConsentStatusEnum {
     ACTIVE = "ACTIVE",
@@ -302,7 +327,7 @@ type CaseDetailsTab = Readonly<{
     label: string;
 }>;
 
-type InternalPage = 'consent-manager' | 'form' | 'activity' | 'case-details';
+type InternalPage = 'consent-manager' | 'form' | 'activity' | 'receipts' | 'case-details';
 interface NavigationContextType {
     currentPage: InternalPage;
     navigateTo: (page: InternalPage) => void;
@@ -427,7 +452,16 @@ declare function createConsentClient(baseUrl: string): {
     /**
      * Get user consents (privacy center)
      */
-    getUserConsents(baseRequest: BaseRequest, contact: string, offset?: number, limit?: number, search?: string, status?: string, product_uuid?: string, language?: string, authToken?: string, options?: Omit<ApiFetchOptions, "getAuthToken">): Promise<unknown>;
+    getUserConsents(baseRequest: BaseRequest, params: {
+        offset?: number;
+        limit?: number;
+        nominated_offset?: number;
+        nominated_limit?: number;
+        status?: string;
+        product_uuid?: string;
+        search?: string;
+        language?: string;
+    }, authToken?: string, options?: Omit<ApiFetchOptions, "getAuthToken">): Promise<unknown>;
     /**
      * Manage consent (privacy center) - revoke, regrant, or renew
      */
@@ -436,6 +470,26 @@ declare function createConsentClient(baseUrl: string): {
      * Get activities (privacy center)
      */
     getActivities(baseRequest: BaseRequest, offset?: number, limit?: number, language?: string, authToken?: string, options?: Omit<ApiFetchOptions, "getAuthToken">): Promise<unknown>;
+    /**
+     * Get receipts (privacy center)
+     */
+    getReceipts(baseRequest: BaseRequest, params: {
+        skip?: number;
+        limit?: number;
+        event_type?: string;
+        status?: string;
+        created_after?: string;
+        created_before?: string;
+        notice_uuid?: string;
+        language?: string;
+    }, authToken?: string, options?: Omit<ApiFetchOptions, "getAuthToken">): Promise<unknown>;
+    /**
+     * Download a single receipt as a PDF (privacy center).
+     * The endpoint returns raw `application/pdf` bytes (not the JSON envelope),
+     * so this bypasses `privacyCenterApiFetch` and returns a base64 string that
+     * the RN UI writes to a temp file to open/share. 404 => not found.
+     */
+    getReceiptPdf(baseRequest: BaseRequest, receiptUuid: string, authToken?: string): Promise<string>;
     /**
      * Get case history (privacy center)
      */
@@ -505,7 +559,21 @@ declare const fetchProducts: (organizationId: string, workspaceId: string, skip?
     name: string;
     description?: string;
 }> | null>;
-declare const fetchUserConsents: (organizationId: string, workspaceId: string, contact: string, offset?: number, limit?: number, search?: string, status?: string, product_uuid?: string, authContext?: AuthContext, consentClient?: BaseUrlContextValue["consentClient"], language?: string) => Promise<UserConsentDetail | null>;
+type FetchUserConsentsParams = {
+    organizationId: string;
+    workspaceId: string;
+    offset?: number;
+    limit?: number;
+    nominatedOffset?: number;
+    nominatedLimit?: number;
+    search?: string;
+    status?: string;
+    product_uuid?: string;
+    language?: string;
+    authContext?: AuthContext;
+    consentClient?: BaseUrlContextValue['consentClient'];
+};
+declare const fetchUserConsents: (params: FetchUserConsentsParams) => Promise<UserConsentDetail | null>;
 declare const manageConsent: ({ organizationId, workspaceId, purposeId, contact, action, authContext, consentClient, nominatorContact, dataElementUuids, }: {
     organizationId: string;
     workspaceId: string;

package/dist/privacy-center.d.ts

@@ -166,6 +166,27 @@ type ConsentHistoryStatusSummary = {
     active_purposes: number;
     inactive_purposes: number;
 };
+type PurposeItem = {
+    purpose_uuid: string;
+    name: string;
+    description: string | null;
+    status: ConsentStatusEnum | string;
+    given_date: string | null;
+    valid_till: string | null;
+    method: string;
+    data_elements: ConsentDataElement[];
+    link_reason: string | null;
+};
+type ConsentGroup = {
+    product_uuid: string;
+    product_name: string;
+    product_description: string | null;
+    nominator: NominatorInfo | null;
+    total_purposes: number;
+    active_purposes: number;
+    purposes: PurposeItem[];
+    has_more_purposes: boolean;
+};
 type ProductConsentHistoryGroup = {
     product_uuid: string;
     product_name: string;
@@ -186,12 +207,16 @@ type Pagination = {
 type UserConsentDetail = {
     data?: UserConsent[];
     product_purpose_groups?: ProductConsentHistoryGroup[];
-    pagination: Pagination;
+    pagination?: Pagination;
     direct_product_groups?: ProductConsentHistoryGroup[];
     user_status?: 'ACTIVE' | 'TRANSFERRED' | null;
     nominated_purposes?: NominatedPurposesGroup[];
     nominators?: NominatorInfo[];
     status_summary?: ConsentHistoryStatusSummary | null;
+    direct?: ConsentGroup[];
+    nominated?: ConsentGroup[];
+    direct_pagination?: Pagination;
+    nominated_pagination?: Pagination;
 };
 declare enum ConsentStatusEnum {
     ACTIVE = "ACTIVE",
@@ -302,7 +327,7 @@ type CaseDetailsTab = Readonly<{
     label: string;
 }>;
 
-type InternalPage = 'consent-manager' | 'form' | 'activity' | 'case-details';
+type InternalPage = 'consent-manager' | 'form' | 'activity' | 'receipts' | 'case-details';
 interface NavigationContextType {
     currentPage: InternalPage;
     navigateTo: (page: InternalPage) => void;
@@ -427,7 +452,16 @@ declare function createConsentClient(baseUrl: string): {
     /**
      * Get user consents (privacy center)
      */
-    getUserConsents(baseRequest: BaseRequest, contact: string, offset?: number, limit?: number, search?: string, status?: string, product_uuid?: string, language?: string, authToken?: string, options?: Omit<ApiFetchOptions, "getAuthToken">): Promise<unknown>;
+    getUserConsents(baseRequest: BaseRequest, params: {
+        offset?: number;
+        limit?: number;
+        nominated_offset?: number;
+        nominated_limit?: number;
+        status?: string;
+        product_uuid?: string;
+        search?: string;
+        language?: string;
+    }, authToken?: string, options?: Omit<ApiFetchOptions, "getAuthToken">): Promise<unknown>;
     /**
      * Manage consent (privacy center) - revoke, regrant, or renew
      */
@@ -436,6 +470,26 @@ declare function createConsentClient(baseUrl: string): {
      * Get activities (privacy center)
      */
     getActivities(baseRequest: BaseRequest, offset?: number, limit?: number, language?: string, authToken?: string, options?: Omit<ApiFetchOptions, "getAuthToken">): Promise<unknown>;
+    /**
+     * Get receipts (privacy center)
+     */
+    getReceipts(baseRequest: BaseRequest, params: {
+        skip?: number;
+        limit?: number;
+        event_type?: string;
+        status?: string;
+        created_after?: string;
+        created_before?: string;
+        notice_uuid?: string;
+        language?: string;
+    }, authToken?: string, options?: Omit<ApiFetchOptions, "getAuthToken">): Promise<unknown>;
+    /**
+     * Download a single receipt as a PDF (privacy center).
+     * The endpoint returns raw `application/pdf` bytes (not the JSON envelope),
+     * so this bypasses `privacyCenterApiFetch` and returns a base64 string that
+     * the RN UI writes to a temp file to open/share. 404 => not found.
+     */
+    getReceiptPdf(baseRequest: BaseRequest, receiptUuid: string, authToken?: string): Promise<string>;
     /**
      * Get case history (privacy center)
      */
@@ -505,7 +559,21 @@ declare const fetchProducts: (organizationId: string, workspaceId: string, skip?
     name: string;
     description?: string;
 }> | null>;
-declare const fetchUserConsents: (organizationId: string, workspaceId: string, contact: string, offset?: number, limit?: number, search?: string, status?: string, product_uuid?: string, authContext?: AuthContext, consentClient?: BaseUrlContextValue["consentClient"], language?: string) => Promise<UserConsentDetail | null>;
+type FetchUserConsentsParams = {
+    organizationId: string;
+    workspaceId: string;
+    offset?: number;
+    limit?: number;
+    nominatedOffset?: number;
+    nominatedLimit?: number;
+    search?: string;
+    status?: string;
+    product_uuid?: string;
+    language?: string;
+    authContext?: AuthContext;
+    consentClient?: BaseUrlContextValue['consentClient'];
+};
+declare const fetchUserConsents: (params: FetchUserConsentsParams) => Promise<UserConsentDetail | null>;
 declare const manageConsent: ({ organizationId, workspaceId, purposeId, contact, action, authContext, consentClient, nominatorContact, dataElementUuids, }: {
     organizationId: string;
     workspaceId: string;