@redacto.io/consent-sdk-react 9.3.0 → 9.4.0-beta.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @redacto.io/consent-sdk-react@9.2.0 build /Users/sadanmianredacto/Developer/redacto/consent-sdk/packages/consent-sdk-react
+> @redacto.io/consent-sdk-react@9.3.0 build /Users/sadanmianredacto/Developer/redacto/consent-sdk/packages/consent-sdk-react
 > tsup
 
 CLI Building entry: {"index":"src/index.ts","privacy-center":"src/privacy-center.ts"}
@@ -10,16 +10,16 @@ CLI Target: es2019
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-CJS dist/index.js          237.00 KB
-CJS dist/privacy-center.js 2.16 MB
-CJS ⚡️ Build success in 59ms
+CJS dist/index.js          319.92 KB
+CJS dist/privacy-center.js 2.17 MB
+CJS ⚡️ Build success in 447ms
+ESM dist/index.mjs          306.43 KB
 ESM dist/chunk-6A665OPR.mjs 841.00 B
-ESM dist/index.mjs          226.91 KB
-ESM dist/privacy-center.mjs 2.12 MB
-ESM ⚡️ Build success in 65ms
+ESM dist/privacy-center.mjs 2.13 MB
+ESM ⚡️ Build success in 453ms
 DTS Build start
-DTS ⚡️ Build success in 2407ms
-DTS dist/index.d.mts          6.12 KB
+DTS ⚡️ Build success in 5383ms
+DTS dist/index.d.mts          7.72 KB
 DTS dist/privacy-center.d.mts 30.45 KB
-DTS dist/index.d.ts           6.12 KB
+DTS dist/index.d.ts           7.72 KB
 DTS dist/privacy-center.d.ts  30.45 KB

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @redacto.io/consent-sdk-react
 
+## 9.4.0-beta.0
+
+### Minor Changes
+
+- feat(consent-sdk-react): add RedactoNoticeAssisted (agent-assisted OTP consent) + starter loan demo
+
 ## 9.3.0
 
 ### Minor Changes

package/README.md

@@ -12,7 +12,7 @@ The package ships two import paths so consumers only pull in what they need:
 
 | Import path                                       | What you get                                                                                              |
 | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
-| `@redacto.io/consent-sdk-react`                   | Consent notice components: `RedactoNoticeConsent`, `RedactoNoticeConsentInline`, and `DigiLockerCallback` |
+| `@redacto.io/consent-sdk-react`                   | Consent notice components: `RedactoNoticeConsent`, `RedactoNoticeConsentInline`, `RedactoNoticeAssisted`, and `DigiLockerCallback` |
 | `@redacto.io/consent-sdk-react/privacy-center`    | Privacy Center: certified `RedactoPrivacyCenter`, composable pages, headless API client, hooks, contexts  |
 
 The notice entry point has minimal dependencies. The Privacy Center entry point depends on the optional peers listed under [Peer Dependencies](#peer-dependencies).
@@ -68,9 +68,14 @@ The SDK follows a client-server architecture pattern:
 
 - **Consent Notice Display**
   - Customizable consent notices
-  - Multiple display formats (modal popup, inline form)
+  - Multiple display formats (modal popup, inline form, assisted/OTP-verified)
   - Responsive design
 
+- **Assisted / OTP-Verified Consent**
+  - Agent-assisted collection for end-users with no app session or token
+  - Built-in identity verification via OTP (SMS or email)
+  - Optional text-to-speech narration of the notice
+
 - **Consent Collection**
   - User consent choices (accept, reject, manage preferences)
   - Granular consent management
@@ -338,6 +343,41 @@ The component automatically submits consent when all of the following conditions
 | `onError`            | `(error: Error) => void`     | No       | -       | Error handler callback                 |
 | `onValidationChange` | `(isValid: boolean) => void` | No       | -       | Callback when validation state changes |
 
+### `RedactoNoticeAssisted`
+
+A modal, agent-assisted consent widget for collecting consent from an end-user who has **no app session and no token** — for example, a support agent walking a customer through consent in person or over a call. It fetches the notice from the **public** notice endpoint using only the org/workspace/notice UUIDs, then proves the end-user's identity inline via a one-time passcode (OTP) before submitting consent. No backend token plumbing is required.
+
+**Key Characteristics:**
+
+- No tokens required to render or submit — identity is proven inline via OTP (unlike `RedactoNoticeConsent`, which needs tokens upfront, and `RedactoNoticeConsentInline`, which needs a token to submit)
+- Built-in end-user verification: 6-digit OTP over **SMS (`+91` mobile) or email**, with a 30-second resend timer
+- Language picker (English pinned first) plus optional **text-to-speech narration** of the notice
+- Purpose and data-element checkboxes with two-way binding; the **Confirm** CTA is gated until every required data element is selected
+- Self-contained modal that blocks the UI — the host only supplies the three UUIDs and reacts to `onDecline` / `onComplete`
+- Localized (English plus Indian languages) and accessible (dialog role, ARIA labelling, honors `prefers-reduced-motion`)
+- Best for: agent-assisted, in-person or remote consent collection where the end-user is not signed in
+
+**Props:**
+
+| Prop               | Type         | Required | Default                  | Description                                                            |
+| ------------------ | ------------ | -------- | ------------------------ | --------------------------------------------------------------------- |
+| `organisationUuid` | `string`     | Yes      | -                        | Organisation UUID (path segment of the public notice endpoint)        |
+| `workspaceUuid`    | `string`     | Yes      | -                        | Workspace UUID (path segment of the public notice endpoint)           |
+| `noticeUuid`       | `string`     | Yes      | -                        | Notice UUID to fetch and render                                       |
+| `baseUrl`          | `string`     | No       | Production consent API   | Base URL for the consent API                                          |
+| `onDecline`        | `() => void` | No       | Logs and resets the flow | Called when the agent/customer declines (host should unmount the modal) |
+| `onComplete`       | `() => void` | No       | Logs and resets the flow | Called when the agent clicks "Proceed" on the confirmed screen        |
+
+**Flow:**
+
+The component renders a single modal that progresses through three screens:
+
+1. **Notice** — the notice is shown with the language picker, optional audio narration, and purpose/data-element checkboxes. The agent makes selections; the **Confirm** button stays disabled until all required data elements are checked.
+2. **Verify (OTP)** — the end-user's contact is entered as either a `+91` **mobile** number (SMS) or an **email** address, and a 6-digit OTP is sent. The agent enters the code to verify; the code can be resent after a 30-second countdown.
+3. **Confirmed** — on successful verification the consent is submitted and a confirmation screen is shown. Clicking **Proceed** fires `onComplete`.
+
+Declining at any step fires `onDecline`. Both callbacks are optional; when omitted the component logs the outcome and resets to the notice screen.
+
 ## Usage Examples
 
 ### Example 1: Using `RedactoNoticeConsent` (Modal Popup)
@@ -587,9 +627,50 @@ function RegistrationForm() {
 }
 ```
 
+### Example 3: Using `RedactoNoticeAssisted` (Assisted / OTP-Verified)
+
+This example shows an agent-facing screen that collects consent from a customer who is not signed in. No tokens are fetched — the component renders straight from the three UUIDs and verifies the customer inline via OTP before submitting.
+
+```tsx
+import { useState } from "react";
+import { RedactoNoticeAssisted } from "@redacto.io/consent-sdk-react";
+
+const ORG_UUID = "your-organisation-uuid";
+const WORKSPACE_UUID = "your-workspace-uuid";
+const NOTICE_UUID = "your-notice-uuid";
+const BASE_URL = "https://api.redacto.io/consent"; // Optional: override the consent API
+
+export function AssistedConsent() {
+  const [open, setOpen] = useState(false);
+
+  return (
+    <>
+      <button onClick={() => setOpen(true)}>Start assisted consent</button>
+
+      {open && (
+        <RedactoNoticeAssisted
+          organisationUuid={ORG_UUID}
+          workspaceUuid={WORKSPACE_UUID}
+          noticeUuid={NOTICE_UUID}
+          baseUrl={BASE_URL}
+          // Fired when the agent/customer declines — unmount the modal.
+          onDecline={() => setOpen(false)}
+          // Fired after OTP verification + consent submission, when the agent
+          // clicks "Proceed" on the confirmed screen.
+          onComplete={() => {
+            console.log("consent recorded");
+            setOpen(false);
+          }}
+        />
+      )}
+    </>
+  );
+}
+```
+
 ### Custom Styling
 
-Both components support extensive styling customization:
+`RedactoNoticeConsent` and `RedactoNoticeConsentInline` support extensive styling customization via the `settings` prop. (`RedactoNoticeAssisted` does not take a `settings` prop — it themes itself from the notice's API configuration, such as primary/secondary colour and font.)
 
 ```tsx
 const customSettings = {
@@ -640,15 +721,15 @@ const customSettings = {
 
 ## Component Comparison
 
-| Feature                 | `RedactoNoticeConsent`                    | `RedactoNoticeConsentInline`                |
-| ----------------------- | ----------------------------------------- | ------------------------------------------- |
-| **Display Type**        | Modal popup overlay                       | Inline form component                       |
-| **Token Requirement**   | Required upfront                          | Optional (can load without)                 |
-| **Use Case**            | Initial consent, standalone flows         | Embedded in forms, multi-step processes     |
-| **Auto-Submit**         | No (user clicks accept/decline)           | Yes (when token provided + validated)       |
-| **Validation Callback** | No                                        | Yes (`onValidationChange`)                  |
-| **UI Blocking**         | Yes (by default)                          | No (inline)                                 |
-| **Props Required**      | `noticeId`, `accessToken`, `refreshToken` | `org_uuid`, `workspace_uuid`, `notice_uuid` |
+| Feature                 | `RedactoNoticeConsent`                    | `RedactoNoticeConsentInline`                | `RedactoNoticeAssisted`                          |
+| ----------------------- | ----------------------------------------- | ------------------------------------------- | ------------------------------------------------ |
+| **Display Type**        | Modal popup overlay                       | Inline form component                       | Modal popup overlay                              |
+| **Token Requirement**   | Required upfront                          | Optional (can load without)                 | None — identity proven inline via OTP            |
+| **Use Case**            | Initial consent, standalone flows         | Embedded in forms, multi-step processes     | Agent-assisted, in-person/remote collection      |
+| **Auto-Submit**         | No (user clicks accept/decline)           | Yes (when token provided + validated)       | No (submits after OTP verification)              |
+| **Validation Callback** | No                                        | Yes (`onValidationChange`)                  | No                                               |
+| **UI Blocking**         | Yes (by default)                          | No (inline)                                 | Yes                                              |
+| **Props Required**      | `noticeId`, `accessToken`, `refreshToken` | `org_uuid`, `workspace_uuid`, `notice_uuid` | `organisationUuid`, `workspaceUuid`, `noticeUuid` |
 
 ## Privacy Center
 

package/dist/index.d.mts

@@ -116,6 +116,42 @@ declare const RedactoConsentInline: react.MemoExoticComponent<{
     displayName: string;
 }>;
 
+/**
+ * Public props. The notice is fetched from the PUBLIC notice endpoint, so the
+ * organisation / workspace / notice UUIDs and base URL are supplied by the host
+ * (typically read from the frontend URL) — there is no auth token.
+ */
+type RedactoNoticeAssistedProps = {
+    /** Organisation UUID (path segment of the public notice endpoint). */
+    organisationUuid: string;
+    /** Workspace UUID (path segment of the public notice endpoint). */
+    workspaceUuid: string;
+    /** Notice UUID to fetch and render. */
+    noticeUuid: string;
+    /** API base URL (defaults to the production consent API). */
+    baseUrl?: string;
+    /** Called when the agent/customer declines (host should unmount the modal). */
+    onDecline?: () => void;
+    /** Called when the agent clicks "Proceed" on the confirmed screen. */
+    onComplete?: () => void;
+};
+
+/**
+ * RedactoNoticeAssisted — agent-assisted consent collection.
+ *
+ * Fetches a consent notice from the PUBLIC notice endpoint (org/workspace/notice
+ * UUIDs + baseUrl come from props — no auth) and renders it exactly like
+ * RedactoNoticeConsent: logo + title, language pill, privacy text, "Manage What You
+ * Share" accordion purposes, DPO footer, themed Confirm/Decline.
+ *
+ * Single progressive screen: the notice stays mounted throughout. Clicking the
+ * primary CTA reveals an inline mobile/OTP panel below the (now locked) notice and
+ * advances the CTA — Confirm → Send OTP → Confirm OTP. On successful verify +
+ * submit, `onComplete` fires immediately with no confirmation screen (mirroring
+ * RedactoNoticeConsent's `onAccept`). Steps: `notice` → `verify` (with `otpSent`).
+ */
+declare const RedactoNoticeAssisted: ({ organisationUuid, workspaceUuid, noticeUuid, baseUrl, onDecline, onComplete, }: RedactoNoticeAssistedProps) => react_jsx_runtime.JSX.Element;
+
 /**
  * DigiLockerCallback Component
  *
@@ -162,11 +198,13 @@ 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, type ConsentFlowState, DigiLockerCallback, type DigiLockerCallbackProps, type GuardianVerificationErrorCode, RedactoNoticeConsent, RedactoConsentInline as RedactoNoticeConsentInline };
+export { ApiError, type ApiErrorCode, type ConsentFlowState, DigiLockerCallback, type DigiLockerCallbackProps, type GuardianVerificationErrorCode, RedactoNoticeAssisted, type RedactoNoticeAssistedProps, RedactoNoticeConsent, RedactoConsentInline as RedactoNoticeConsentInline };

package/dist/index.d.ts

@@ -116,6 +116,42 @@ declare const RedactoConsentInline: react.MemoExoticComponent<{
     displayName: string;
 }>;
 
+/**
+ * Public props. The notice is fetched from the PUBLIC notice endpoint, so the
+ * organisation / workspace / notice UUIDs and base URL are supplied by the host
+ * (typically read from the frontend URL) — there is no auth token.
+ */
+type RedactoNoticeAssistedProps = {
+    /** Organisation UUID (path segment of the public notice endpoint). */
+    organisationUuid: string;
+    /** Workspace UUID (path segment of the public notice endpoint). */
+    workspaceUuid: string;
+    /** Notice UUID to fetch and render. */
+    noticeUuid: string;
+    /** API base URL (defaults to the production consent API). */
+    baseUrl?: string;
+    /** Called when the agent/customer declines (host should unmount the modal). */
+    onDecline?: () => void;
+    /** Called when the agent clicks "Proceed" on the confirmed screen. */
+    onComplete?: () => void;
+};
+
+/**
+ * RedactoNoticeAssisted — agent-assisted consent collection.
+ *
+ * Fetches a consent notice from the PUBLIC notice endpoint (org/workspace/notice
+ * UUIDs + baseUrl come from props — no auth) and renders it exactly like
+ * RedactoNoticeConsent: logo + title, language pill, privacy text, "Manage What You
+ * Share" accordion purposes, DPO footer, themed Confirm/Decline.
+ *
+ * Single progressive screen: the notice stays mounted throughout. Clicking the
+ * primary CTA reveals an inline mobile/OTP panel below the (now locked) notice and
+ * advances the CTA — Confirm → Send OTP → Confirm OTP. On successful verify +
+ * submit, `onComplete` fires immediately with no confirmation screen (mirroring
+ * RedactoNoticeConsent's `onAccept`). Steps: `notice` → `verify` (with `otpSent`).
+ */
+declare const RedactoNoticeAssisted: ({ organisationUuid, workspaceUuid, noticeUuid, baseUrl, onDecline, onComplete, }: RedactoNoticeAssistedProps) => react_jsx_runtime.JSX.Element;
+
 /**
  * DigiLockerCallback Component
  *
@@ -162,11 +198,13 @@ 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, type ConsentFlowState, DigiLockerCallback, type DigiLockerCallbackProps, type GuardianVerificationErrorCode, RedactoNoticeConsent, RedactoConsentInline as RedactoNoticeConsentInline };
+export { ApiError, type ApiErrorCode, type ConsentFlowState, DigiLockerCallback, type DigiLockerCallbackProps, type GuardianVerificationErrorCode, RedactoNoticeAssisted, type RedactoNoticeAssistedProps, RedactoNoticeConsent, RedactoConsentInline as RedactoNoticeConsentInline };