@redacto.io/consent-sdk-react 10.0.0-beta.11 → 10.0.0-beta.12

package/src/RedactoNoticeAssisted/api/index.ts

@@ -1,275 +0,0 @@
-import { parseApiError } from "../../shared/api-errors";
-import type {
-  ConsentContent,
-  CreateOtpDetail,
-  CreateOtpParams,
-  CreateOtpResponse,
-  FetchAssistedNoticeParams,
-  FetchAssistedTTSAudioUrlsParams,
-  SubmitAssistedConsentParams,
-  TTSAudioUrlsResponse,
-  VerifyOtpDetail,
-  VerifyOtpParams,
-  VerifyOtpResponse,
-} from "./types";
-
-const BASE_URL = "https://api.redacto.io/consent";
-
-/** Build the public org/workspace-scoped base path shared by every endpoint. */
-const publicScope = (
-  baseUrl: string | undefined,
-  organisationUuid: string,
-  workspaceUuid: string,
-) =>
-  `${baseUrl || BASE_URL}/public/organisations/${organisationUuid}/workspaces/${workspaceUuid}`;
-
-/**
- * Fetch a consent notice from the PUBLIC notice endpoint — no authentication.
- *
- * Same endpoint shape as RedactoNoticeConsent's `fetchConsentContent`, but the
- * organisation / workspace / notice UUIDs come from the caller (props) instead of a
- * JWT, and the request sends no Authorization header. Used to render the notice for
- * the agent-assisted flow.
- */
-export const fetchAssistedNotice = async ({
-  organisationUuid,
-  workspaceUuid,
-  noticeUuid,
-  baseUrl,
-  signal,
-}: FetchAssistedNoticeParams): Promise<ConsentContent> => {
-  if (!organisationUuid || !workspaceUuid || !noticeUuid) {
-    throw new Error(
-      "organisationUuid, workspaceUuid and noticeUuid are required",
-    );
-  }
-
-  const apiBaseUrl = baseUrl || BASE_URL;
-  // Public notice endpoint: org / workspace / notice UUIDs only — no query params.
-  const url = `${apiBaseUrl}/public/organisations/${organisationUuid}/workspaces/${workspaceUuid}/notices/get-notice/${noticeUuid}`;
-
-  const response = await fetch(url, {
-    method: "GET",
-    headers: {
-      accept: "application/json",
-    },
-    signal,
-  });
-
-  if (!response.ok) {
-    throw await parseApiError(
-      response,
-      "Could not load the consent notice. Please try again.",
-    );
-  }
-
-  return (await response.json()) as ConsentContent;
-};
-
-/**
- * Create an OTP and send it over the given channel — public, no auth.
- *
- * Returns the `detail` block; the caller keeps `detail.uuid` to pass to
- * {@link verifyOtp}.
- */
-export const createOtp = async ({
-  organisationUuid,
-  workspaceUuid,
-  to,
-  channel,
-  baseUrl,
-  signal,
-}: CreateOtpParams): Promise<CreateOtpDetail> => {
-  if (!organisationUuid || !workspaceUuid || !to) {
-    throw new Error("organisationUuid, workspaceUuid and to are required");
-  }
-
-  const url = `${publicScope(baseUrl, organisationUuid, workspaceUuid)}/otp/create`;
-
-  const response = await fetch(url, {
-    method: "POST",
-    headers: {
-      accept: "application/json",
-      "Content-Type": "application/json",
-    },
-    body: JSON.stringify({ to, channel }),
-    signal,
-  });
-
-  if (!response.ok) {
-    throw await parseApiError(
-      response,
-      "Could not send the OTP. Please try again.",
-    );
-  }
-
-  const data = (await response.json()) as CreateOtpResponse;
-  return data.detail;
-};
-
-/**
- * Verify an OTP — public, no auth. On success the `detail` block carries the
- * `access_token` used to submit the consent.
- */
-export const verifyOtp = async ({
-  organisationUuid,
-  workspaceUuid,
-  uuid,
-  otp,
-  purpose,
-  baseUrl,
-  signal,
-}: VerifyOtpParams): Promise<VerifyOtpDetail> => {
-  if (!organisationUuid || !workspaceUuid || !uuid || !otp) {
-    throw new Error("organisationUuid, workspaceUuid, uuid and otp are required");
-  }
-
-  const url = `${publicScope(baseUrl, organisationUuid, workspaceUuid)}/otp/verify`;
-
-  const response = await fetch(url, {
-    method: "POST",
-    headers: {
-      accept: "application/json",
-      "Content-Type": "application/json",
-    },
-    body: JSON.stringify({ uuid, otp, purpose }),
-    signal,
-  });
-
-  if (!response.ok) {
-    throw await parseApiError(
-      response,
-      "Could not verify the OTP. Please try again.",
-    );
-  }
-
-  const data = (await response.json()) as VerifyOtpResponse;
-  return data.detail;
-};
-
-/**
- * Submit the consent event using the access_token from {@link verifyOtp}.
- *
- * Mirrors RedactoNoticeConsent's `submitConsentEvent` payload (enabled-only data
- * elements, required forced selected, source "WEB"), but takes org/workspace from
- * props rather than decoding the JWT. Returns the parsed response body (or null) so
- * the caller can surface a reference id if the backend ever returns one.
- */
-export const submitAssistedConsent = async ({
-  accessToken,
-  organisationUuid,
-  workspaceUuid,
-  baseUrl,
-  ledgerBaseUrl,
-  noticeUuid,
-  purposes,
-  language,
-  signal,
-}: SubmitAssistedConsentParams): Promise<Record<string, unknown> | null> => {
-  if (!accessToken || !noticeUuid || !Array.isArray(purposes)) {
-    throw new Error("accessToken, noticeUuid and purposes array are required");
-  }
-
-  const validatedPurposes = purposes.map((purpose) => {
-    if (!purpose.uuid) {
-      throw new Error("Invalid purpose data: missing uuid");
-    }
-    // Only enabled data elements are selectable; required ones are always sent selected.
-    const dataElements = (purpose.data_elements || [])
-      .filter((element) => element.enabled !== false)
-      .map((element) => ({
-        uuid: element.uuid,
-        selected: element.required ? true : Boolean(element.selected),
-      }));
-    return {
-      purpose_uuid: purpose.uuid,
-      selected: Boolean(purpose.selected),
-      data_elements: dataElements.length > 0 ? dataElements : undefined,
-    };
-  });
-
-  const payload = {
-    notice_uuid: noticeUuid,
-    purposes: validatedPurposes,
-    select_all_mandatory: false,
-    source: "WEB",
-    declined: false,
-    language: language || undefined,
-  };
-
-  // Route the write to the Go ledger when configured, else the legacy consent
-  // server. publicScope already applies `|| BASE_URL`, so this yields the
-  // standard `ledgerBaseUrl || baseUrl || BASE_URL` fallback used by the other
-  // notice components. Only submit-consent routes to the ledger; notice/OTP/TTS
-  // stay on baseUrl.
-  const url = `${publicScope(ledgerBaseUrl || baseUrl, organisationUuid, workspaceUuid)}/submit-consent`;
-
-  const response = await fetch(url, {
-    method: "POST",
-    headers: {
-      accept: "application/json",
-      Authorization: `Bearer ${accessToken}`,
-      "Content-Type": "application/json",
-    },
-    body: JSON.stringify(payload),
-    signal,
-  });
-
-  if (!response.ok) {
-    throw await parseApiError(
-      response,
-      "Could not submit your consent. Please try again.",
-    );
-  }
-
-  // Submit returns an empty body today; tolerate that and surface any JSON if present.
-  const text = await response.text();
-  if (!text) return null;
-  try {
-    return JSON.parse(text) as Record<string, unknown>;
-  } catch {
-    return null;
-  }
-};
-
-/**
- * Fetch per-element TTS audio URLs for the notice — public, no auth.
- *
- * Same endpoint shape as RedactoNoticeConsent's `fetchTTSAudioUrls`, but the
- * organisation / workspace UUIDs come from props (not a decoded JWT) and the request
- * sends no Authorization header. `language` is the English language NAME path segment
- * (e.g. "Hindi", "English").
- */
-export const fetchAssistedTTSAudioUrls = async ({
-  organisationUuid,
-  workspaceUuid,
-  noticeUuid,
-  language,
-  baseUrl,
-  signal,
-}: FetchAssistedTTSAudioUrlsParams): Promise<TTSAudioUrlsResponse> => {
-  if (!organisationUuid || !workspaceUuid || !noticeUuid || !language) {
-    throw new Error(
-      "organisationUuid, workspaceUuid, noticeUuid and language are required",
-    );
-  }
-
-  const url = `${publicScope(baseUrl, organisationUuid, workspaceUuid)}/notices/${noticeUuid}/audio/${language}`;
-
-  const response = await fetch(url, {
-    method: "GET",
-    headers: {
-      accept: "application/json",
-    },
-    signal,
-  });
-
-  if (!response.ok) {
-    throw await parseApiError(
-      response,
-      "Could not load audio narration. Please try again.",
-    );
-  }
-
-  return (await response.json()) as TTSAudioUrlsResponse;
-};

package/src/RedactoNoticeAssisted/api/types.ts

@@ -1,182 +0,0 @@
-// API types for RedactoNoticeAssisted.
-//
-// The response shape is identical to RedactoNoticeConsent's notice endpoint, so we
-// reuse that ConsentContent type rather than duplicating the (large) definition.
-// The only Assisted-specific type is the public, no-auth fetch params.
-import type { ConsentContent } from "../../RedactoNoticeConsent/api/types";
-
-export type { ConsentContent } from "../../RedactoNoticeConsent/api/types";
-
-/** The `active_config` block we actually render. */
-export type ActiveConfig = ConsentContent["detail"]["active_config"];
-export type Purpose = ActiveConfig["purposes"][number];
-export type DataElement = Purpose["data_elements"][number];
-/** One language's translation bundle from `supported_languages_and_translations`. */
-export type TranslationMap =
-  ActiveConfig["supported_languages_and_translations"][string];
-
-/**
- * Params for the public (unauthenticated) notice fetch. Unlike NoticeConsent — which
- * derives org/workspace from a JWT and sends a Bearer token — these come straight
- * from the host (URL/props) and the request carries no Authorization header.
- */
-export type FetchAssistedNoticeParams = {
-  organisationUuid: string;
-  workspaceUuid: string;
-  noticeUuid: string;
-  baseUrl?: string;
-  signal?: AbortSignal;
-};
-
-/** Fields common to the org/workspace-scoped public OTP endpoints. */
-type PublicOtpScope = {
-  organisationUuid: string;
-  workspaceUuid: string;
-  baseUrl?: string;
-  signal?: AbortSignal;
-};
-
-// ── OTP create ────────────────────────────────────────────────────────────────
-export type CreateOtpParams = PublicOtpScope & {
-  /** Recipient in E.164 form, e.g. "+917409907246". */
-  to: string;
-  /** Delivery channel — only "sms" today. */
-  channel: string;
-};
-
-/** `detail` block returned by the create-OTP endpoint. */
-export type CreateOtpDetail = {
-  uuid: string;
-  to: string;
-  channel: string;
-  expire_at: string;
-  success: boolean;
-  message: string;
-};
-
-export type CreateOtpResponse = {
-  code: number;
-  status: string;
-  detail: CreateOtpDetail;
-};
-
-// ── OTP verify ────────────────────────────────────────────────────────────────
-export type VerifyOtpParams = PublicOtpScope & {
-  /** OTP uuid returned by create-OTP. */
-  uuid: string;
-  /** The code the customer typed. */
-  otp: string;
-  /** Verification purpose — "login" for this flow. */
-  purpose: string;
-};
-
-/** `detail` block returned by the verify-OTP endpoint. */
-export type VerifyOtpDetail = {
-  token: string | null;
-  access_token: string;
-  refresh_token: string;
-  expires_in: number;
-  token_type: string;
-  success: boolean;
-  message: string;
-};
-
-export type VerifyOtpResponse = {
-  code: number;
-  status: string;
-  detail: VerifyOtpDetail;
-};
-
-// ── Consent submission (authenticated with the verify access_token) ─────────────
-export type SubmitAssistedConsentParams = {
-  /** Bearer token obtained from verify-OTP. */
-  accessToken: string;
-  organisationUuid: string;
-  workspaceUuid: string;
-  baseUrl?: string;
-  /** Go ledger base URL — routes the write to the ledger; omit to use the legacy consent server. */
-  ledgerBaseUrl?: string;
-  /** `notice_uuid` from the fetched active_config. */
-  noticeUuid: string;
-  /** Purposes carrying their current `selected` state + data elements. */
-  purposes: Array<{
-    uuid: string;
-    selected: boolean;
-    data_elements: Array<{
-      uuid: string;
-      enabled?: boolean;
-      required?: boolean;
-      selected: boolean;
-    }>;
-  }>;
-  /** BCP-47 language code of the rendered notice. */
-  language?: string;
-  signal?: AbortSignal;
-};
-
-// ── TTS audio narration ─────────────────────────────────────────────────────────
-// Mirrors RedactoNoticeConsent's TTS response, with two extra fields the assisted
-// (public) audio endpoint returns: `language_name` and `full_notice_audio_url`.
-
-export type PurposeAudioUrls = {
-  name_audio_url: string;
-  description_audio_url: string;
-};
-
-export type DataElementAudioUrls = {
-  name_audio_url: string;
-};
-
-export type DpoInfoAudio = {
-  grievance_text_audio_url?: string;
-  grievance_anchor_text_audio_url?: string;
-  dp_board_text_audio_url?: string;
-  dp_board_anchor_text_audio_url?: string;
-  dpo_text_audio_url?: string;
-  dpo_anchor_text_audio_url?: string;
-  grievance_email_connector_text_audio_url?: string;
-  grievance_email_audio_url?: string;
-};
-
-export type DpoInfoAudioKey = keyof DpoInfoAudio;
-
-export type TTSAudioUrlsResponse = {
-  code: number;
-  status: string;
-  detail: {
-    /** English language name echoed back by the endpoint, e.g. "Hindi". */
-    language_name: string;
-    uuid: string;
-    language: string;
-    notice_text_audio_url: string;
-    additional_text_audio_url: string;
-    notice_summary_audio_url: string | null;
-    confirm_button_text_audio_url: string;
-    decline_button_text_audio_url: string;
-    privacy_policy_prefix_text_audio_url: string;
-    privacy_policy_anchor_text_audio_url: string;
-    privacy_center_anchor_text_audio_url?: string;
-    purpose_section_heading_audio_url: string;
-    notice_banner_heading_audio_url: string;
-    purposes_audio: Record<string, PurposeAudioUrls>;
-    data_elements_audio: Record<string, DataElementAudioUrls>;
-    dpo_info_audio?: DpoInfoAudio;
-    /** Single combined clip of the whole notice (not used by the per-element player). */
-    full_notice_audio_url: string;
-  };
-};
-
-/**
- * Params for the public (unauthenticated) audio fetch. Like the notice fetch, the
- * org/workspace/notice UUIDs come from props and no Authorization header is sent.
- * `language` is the English language NAME (e.g. "Hindi") — the endpoint's path
- * segment — which is exactly what the component's `selectedLanguage` holds.
- */
-export type FetchAssistedTTSAudioUrlsParams = {
-  organisationUuid: string;
-  workspaceUuid: string;
-  noticeUuid: string;
-  language: string;
-  baseUrl?: string;
-  signal?: AbortSignal;
-};

package/src/RedactoNoticeAssisted/constants.ts

@@ -1,51 +0,0 @@
-// Client-side config for the agent-assisted flow.
-//
-// The notice content itself comes from the public API; these are the OTP-step and
-// confirmation values that the notice payload does not provide. The consent
-// reference id (when shown) now comes from the submit-consent response.
-import type { DpoInfoAudioKey } from "./api/types";
-
-export const ASSISTED_CONFIG = {
-  /** Number of OTP digits. */
-  otpLength: 6,
-  /** Seconds before the customer can request a new OTP. */
-  resendSeconds: 30,
-  /** Fixed country dial code shown as the phone-field prefix. */
-  dialCode: "+91",
-  /** Delivery channel for the create-OTP request when verifying by mobile. */
-  channel: "sms",
-  /** Delivery channel for the create-OTP request when verifying by email. */
-  emailChannel: "email",
-  /** Verification purpose for the verify-OTP request. */
-  otpPurpose: "login",
-  /** Regulation label shown on the confirmation screen. */
-  regulationLabel: "DPDP Act 2023",
-} as const;
-
-/**
- * Email validity check for the email-verification path. Same lightweight pattern
- * used elsewhere in the SDK (see dpdpa-report-sdk-js): a non-empty local part, an
- * "@", and a dotted domain. Intentionally permissive — the backend is the source
- * of truth; this only gates the "Send OTP" button.
- */
-export const EMAIL_REGEX = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
-
-/**
- * Maps DPO info audio URL keys to their corresponding DOM element IDs.
- * Used by both the audio sequence and element-id sequence builders to keep them in
- * sync. Order determines playback sequence: grievance → dp board → dpo.
- * (Mirrors RedactoNoticeConsent's DPO_AUDIO_ELEMENT_MAP.)
- */
-export const DPO_AUDIO_ELEMENT_MAP: ReadonlyArray<{
-  audioKey: DpoInfoAudioKey;
-  elementId: string;
-}> = [
-  { audioKey: "grievance_text_audio_url", elementId: "dpo-grievance-text" },
-  { audioKey: "grievance_anchor_text_audio_url", elementId: "dpo-grievance-link" },
-  { audioKey: "grievance_email_connector_text_audio_url", elementId: "dpo-grievance-email-connector" },
-  { audioKey: "grievance_email_audio_url", elementId: "dpo-grievance-email" },
-  { audioKey: "dp_board_text_audio_url", elementId: "dpo-dp-board-text" },
-  { audioKey: "dp_board_anchor_text_audio_url", elementId: "dpo-dp-board-link" },
-  { audioKey: "dpo_text_audio_url", elementId: "dpo-dpo-text" },
-  { audioKey: "dpo_anchor_text_audio_url", elementId: "dpo-dpo-link" },
-] as const;