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

package/src/RedactoNoticeConsent/api/types.ts

@@ -1,505 +0,0 @@
-export type RedactoJwtPayload = {
-  organisation_uuid: string;
-  workspace_uuid: string;
-  user_uuid?: string;
-  exp?: number;
-  iat?: number;
-};
-
-/**
- * Optional sandbox-mode auth fields shared by every API param type. When
- * `token` is set the call sends the single `X-Consent-Token` header instead of
- * `Authorization: Bearer`, injects the subject into each request's own payload
- * (body for POSTs, query param for GETs), and takes org/workspace from these
- * props instead of decoding the JWT. All optional so existing JWT callers are
- * unaffected.
- */
-export type SandboxAuthParams = {
-  token?: string;
-  /** UCIC — the client's own user id (`org_user_id`); takes precedence over the subject. */
-  sandboxUcic?: string;
-  sandboxSubject?: string;
-  organisationUuid?: string;
-  workspaceUuid?: string;
-};
-
-/**
- * Sandbox authentication context. Present only when the host opts into sandbox
- * mode by passing a sandbox token; the token/org/workspace are always required
- * at that point because there is no JWT to fall back on. The acting identity is
- * a UCIC (the client's own `org_user_id`) or a `subject` (email/mobile) — at
- * least one is present (UCIC takes precedence when both are set).
- */
-export type SandboxAuth = {
-  token: string;
-  /** UCIC — the client's own user id (`org_user_id`). Takes precedence over `subject`. */
-  ucic?: string;
-  subject: string;
-  organisationUuid: string;
-  workspaceUuid: string;
-};
-
-/** The identity payload fragment for the sandbox acting principal. */
-export type SandboxIdentityPayload =
-  | { org_user_id: string }
-  | { primary_email: string }
-  | { primary_mobile: string };
-
-/** Org/workspace UUIDs plus the resolved sandbox context for a request. */
-export type ResolvedRequestAuth = {
-  organisationUuid: string;
-  workspaceUuid: string;
-  sandbox: SandboxAuth | null;
-};
-
-export type PurposeSelection = {
-  selected: boolean;
-  status: string; // ACTIVE | EXPIRED | WITHDRAW | DECLINED
-  needs_reconsent: boolean;
-  data_elements: Record<string, DataElementSelection>;
-};
-
-export type DataElementSelection = {
-  selected: boolean;
-  enabled: boolean;
-  required: boolean;
-};
-
-export type ConsentContent = {
-  code: number;
-  status: string;
-  detail: {
-    uuid: string;
-    name: string;
-    organisation_uuid: string;
-    workspace_uuid: string;
-    collection_point_uuids: string[];
-    collection_points: {
-      uuid: string;
-      organisation_uuid: string;
-      workspace_uuid: string;
-      name: string;
-      created_at: string;
-      updated_at: string;
-    }[];
-    active_config: {
-      uuid: string;
-      notice_uuid: string;
-      organisation_uuid: string;
-      workspace_uuid: string;
-      version: number;
-      status: string;
-      notice_text: string;
-      additional_text: string;
-      confirm_button_text: string;
-      decline_button_text: string;
-      logo_url: string;
-      privacy_policy_url: string;
-      privacy_center_url: string;
-      primary_color: string;
-      secondary_color: string;
-      font_preference: string;
-      purposes: {
-        uuid: string;
-        name: string;
-        description: string;
-        industries?: string;
-        data_elements: {
-          uuid: string;
-          name: string;
-          description: string | null;
-          industries?: string | null;
-          enabled: boolean;
-          required: boolean;
-        }[];
-      }[];
-      default_language: string;
-      supported_languages_and_translations: {
-        [key: string]: {
-          notice_text: string;
-          additional_text: string;
-          confirm_button_text: string;
-          decline_button_text: string;
-          privacy_policy_prefix_text: string;
-          privacy_policy_anchor_text: string;
-          privacy_center_anchor_text?: string;
-          purpose_section_heading: string;
-          notice_banner_heading: string;
-          data_elements: {
-            [key: string]: string;
-          };
-          purposes: {
-            [key: string]: string | { name: string; description: string };
-          };
-          dpo_info?: DpoInfoTranslation;
-        };
-      };
-      created_at: string;
-      updated_at: string;
-      deployed_at: string;
-      privacy_policy_prefix_text: string;
-      privacy_policy_anchor_text: string;
-      privacy_center_anchor_text?: string;
-      purpose_section_heading: string;
-      notice_banner_heading: string;
-      dpo_info?: DpoInfo;
-    };
-    notice_type?: string;
-    compliance_requirement?: string;
-    is_minor?: boolean;
-    purpose_selections?: Record<string, PurposeSelection>;
-    reconsent_required?: boolean;
-    created_at: string;
-    updated_at: string;
-  };
-};
-
-export type ConsentPreference = {
-  id: string;
-  name: string;
-  description: string;
-  required: boolean;
-};
-
-export type ConsentSelection = {
-  id: string;
-  enabled: boolean;
-};
-
-export type Settings = {
-  button: {
-    accept: {
-      backgroundColor: string;
-      textColor: string;
-    };
-    decline: {
-      backgroundColor: string;
-      textColor: string;
-    };
-    language: {
-      backgroundColor: string;
-      textColor: string;
-      selectedBackgroundColor?: string;
-      selectedTextColor?: string;
-    };
-  };
-  link: string;
-  borderRadius?: string;
-  backgroundColor?: string;
-  headingColor?: string;
-  textColor?: string;
-  borderColor?: string;
-  font?: string;
-};
-
-export type FetchConsentContentParams = SandboxAuthParams & {
-  noticeId: string;
-  accessToken?: string;
-  refreshToken?: string;
-  baseUrl?: string;
-  language?: string;
-  specific_uuid?: string;
-  validate_against?: "all" | "required";
-  include_fully_consented_data?: boolean;
-};
-
-export type ConsentEventPayload = {
-  notice_uuid: string;
-  purposes: Array<{
-    purpose_uuid: string;
-    selected: boolean;
-    data_elements?: Array<{
-      uuid: string;
-      selected: boolean;
-    }>;
-  }>;
-  select_all_mandatory: boolean;
-  source?: string;
-  declined?: boolean;
-  language?: string;
-  meta_data?: {
-    specific_uuid?: string;
-    minor_age?: number;
-  };
-  guardian_verification_reference?: string;
-  self_declared_adult?: boolean;
-};
-
-export type DataElement = {
-  uuid: string;
-  name: string;
-  enabled: boolean;
-  required: boolean;
-  selected: boolean;
-};
-
-export type Purpose = {
-  uuid: string;
-  name: string;
-  description: string;
-  industries?: string;
-  selected: boolean;
-  data_elements: Array<DataElement>;
-};
-
-export type SubmitConsentEventParams = SandboxAuthParams & {
-  accessToken?: string;
-  baseUrl?: string;
-  ledgerBaseUrl?: string;
-  noticeUuid: string;
-  purposes: Array<Purpose>;
-  declined: boolean;
-  language?: string;
-  meta_data?: {
-    specific_uuid?: string;
-    minor_age?: number;
-  };
-  guardianVerificationReference?: string;
-  selfDeclaredAdult?: boolean;
-};
-
-// UI Component Types
-export type PurposeItemData = {
-  uuid: string;
-  name: string;
-  description: string;
-  industries?: string;
-  data_elements: Array<{
-    uuid: string;
-    name: string;
-    required: boolean;
-    enabled: boolean;
-    description: string | null;
-    industries?: string | null;
-  }>;
-};
-
-export type PurposeItemSettings = {
-  headingColor?: string;
-  textColor?: string;
-  font?: string;
-};
-
-export type PurposeItemProps = {
-  purpose: PurposeItemData;
-  selectedPurposes: Record<string, boolean>;
-  collapsedPurposes: Record<string, boolean>;
-  selectedDataElements: Record<string, boolean>;
-  settings?: PurposeItemSettings;
-  styles: Record<string, any>;
-  responsiveStyles: Record<string, any>;
-  onPurposeToggle: (purposeId: string) => void;
-  onPurposeCollapse: (purposeId: string) => void;
-  onDataElementToggle: (elementUuid: string, purposeUuid: string) => void;
-  getTranslatedText: (key: string, defaultText: string, itemId?: string) => string;
-  isAlreadyConsented: boolean;
-};
-
-// DPO Info Types
-export type DpoInfo = {
-  grievance_text: string;
-  grievance_anchor_text: string;
-  grievance_url: string;
-  grievance_email: string;
-  grievance_email_connector_text?: string;
-  dp_board_text: string;
-  dp_board_anchor_text: string;
-  dp_board_url: string;
-  dpo_text: string;
-  dpo_anchor_text: string;
-  dpo_url: string;
-  dpo_email?: string;
-};
-
-export type DpoInfoTranslation = {
-  grievance_text?: string;
-  grievance_anchor_text?: string;
-  grievance_email_connector_text?: string;
-  dp_board_text?: string;
-  dp_board_anchor_text?: string;
-  dpo_text?: string;
-  dpo_anchor_text?: string;
-};
-
-// TTS Audio Types
-export type PurposeAudioUrls = {
-  name_audio_url: string;
-  description_audio_url: string;
-};
-
-export type DataElementAudioUrls = {
-  name_audio_url: string;
-};
-
-export type TTSAudioUrlsResponse = {
-  code: number;
-  status: string;
-  detail: {
-    uuid: string;
-    language: string;
-    notice_text_audio_url: string;
-    additional_text_audio_url: string;
-    notice_summary_audio_url: string;
-    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;
-  };
-};
-
-export type DpoInfoAudioKey = keyof DpoInfoAudio;
-
-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 FetchTTSAudioUrlsParams = SandboxAuthParams & {
-  accessToken?: string;
-  baseUrl?: string;
-  ledgerBaseUrl?: string;
-  noticeUuid: string;
-  language: string;
-};
-
-// =============================================================================
-// Guardian Verification Types (aligned with backend API)
-// =============================================================================
-
-/**
- * Parameters for initiating guardian verification
- * POST /guardian/initiate-verification
- */
-export type InitiateGuardianVerificationParams = SandboxAuthParams & {
-  accessToken?: string;
-  baseUrl?: string;
-  guardianName: string;
-  guardianContact: string;
-  guardianRelationship: string;
-  frontendCallbackUrl?: string;
-  metadata?: Record<string, unknown>;
-  signal?: AbortSignal;
-};
-
-/**
- * Response from initiate verification API
- *
- * Two shapes:
- * 1. New verification needed: already_verified=false, includes session_token + digilocker_redirect_url
- * 2. Already verified: already_verified=true, includes verification_reference — skip DigiLocker
- */
-export type InitiateGuardianVerificationResponse = {
-  success: boolean;
-  guardian_info_uuid: string;
-  already_verified: boolean;
-  /** Present only when already_verified=true */
-  verification_reference?: string;
-  /** Present only when already_verified=false (new flow) */
-  session_token?: string;
-  /** Present only when already_verified=false (new flow) */
-  digilocker_redirect_url?: string;
-  /** Present only when already_verified=false (new flow) */
-  expires_at?: string;
-};
-
-/**
- * Parameters for checking verification status
- * POST /guardian/verify-status
- */
-export type VerifyGuardianStatusParams = SandboxAuthParams & {
-  accessToken?: string;
-  baseUrl?: string;
-  sessionToken: string;
-  signal?: AbortSignal;
-};
-
-/**
- * Guardian details returned after successful verification
- */
-export type GuardianVerificationDetails = {
-  verified_name: string | null;
-  is_guardian_adult: boolean | null;
-  verified_at: string;
-  verification_reference: string | null;
-};
-
-/**
- * Response from verify status API
- */
-export type VerifyGuardianStatusResponse = {
-  status: "pending" | "in_progress" | "verified" | "failed" | "expired";
-  guardian_info_uuid: string | null;
-  verification_reference: string | null;
-  guardian_details: GuardianVerificationDetails | null;
-  error: string | null;
-  error_code: GuardianVerificationErrorCode | null;
-  can_retry: boolean;
-};
-
-/**
- * Error codes from guardian verification
- */
-export type GuardianVerificationErrorCode =
-  | "SESSION_EXPIRED"
-  | "GUARDIAN_UNDER_18"
-  | "TOKEN_FAILED"
-  | "DIGILOCKER_AUTH_FAILED"
-  | "NO_AUTH_CODE";
-
-// =============================================================================
-// Session Storage Types for redirect flow
-// =============================================================================
-
-/**
- * State persisted during DigiLocker redirect flow.
- * NOTE: accessToken is intentionally excluded — never store tokens in sessionStorage.
- * The host app must provide the token when the component re-mounts.
- */
-export type PersistedConsentState = {
-  flowState: ConsentFlowState;
-  sessionToken?: string;
-  guardianInfoUuid?: string;
-  verificationReference?: string;
-  selectedPurposes?: Record<string, boolean>;
-  selectedDataElements?: Record<string, boolean>;
-  timestamp: string;
-  originalUrl: string;
-  verificationResult?: "pending" | "verified" | "failed" | "in_progress" | "expired";
-  noticeId?: string;
-  baseUrl?: string;
-};
-
-export type ConsentFlowState =
-  | "age-check"
-  | "guardian-details"
-  | "digilocker-pending"
-  | "consent-form"
-  | "submitting"
-  | "success"
-  | "error";
-
-// =============================================================================
-// DigiLocker Callback Types
-// =============================================================================
-
-/**
- * Props for DigiLockerCallback component
- */
-export type DigiLockerCallbackProps = {
-  accessToken: string;
-  baseUrl?: string;
-  onSuccess?: (verificationReference: string) => void;
-  onError?: (error: Error, errorCode?: GuardianVerificationErrorCode) => void;
-};