@redacto.io/consent-sdk-react 3.4.0 → 4.0.0

package/src/RedactoNoticeConsent/api/types.ts

@@ -171,33 +171,11 @@ export type ConsentEventPayload = {
   source?: string;
   declined?: boolean;
   meta_data?: {
-    specific_uuid: string;
+    specific_uuid?: string;
+    minor_age?: number;
   };
-};
-
-// @deprecated Remove when production backend supports the new payload format.
-export type LegacyConsentEventPayload = {
-  primary_email?: string;
-  notice_uuid: string;
-  source: string;
-  declined: boolean;
-  consents: {
-    purposes: Array<{
-      uuid: string;
-      name: string;
-      description: string;
-      industries?: string;
-      selected: boolean;
-      data_elements: Array<{
-        uuid: string;
-        name: string;
-        enabled: boolean;
-        required: boolean;
-        selected: boolean;
-      }>;
-    }>;
-  };
-  meta_data?: { specific_uuid: string };
+  guardian_verification_reference?: string;
+  self_declared_adult?: boolean;
 };
 
 export type DataElement = {
@@ -224,22 +202,11 @@ export type SubmitConsentEventParams = {
   purposes: Array<Purpose>;
   declined: boolean;
   meta_data?: {
-    specific_uuid: string;
+    specific_uuid?: string;
+    minor_age?: number;
   };
-};
-
-export type SubmitGuardianInfoParams = {
-  accessToken: string;
-  baseUrl?: string;
-  guardianName: string;
-  guardianContact: string;
-  guardianRelationship: string;
-};
-
-export type GuardianInfoPayload = {
-  guardian_name: string;
-  guardian_contact: string;
-  guardian_relationship: string;
+  guardianVerificationReference?: string;
+  selfDeclaredAdult?: boolean;
 };
 
 // UI Component Types
@@ -355,3 +322,133 @@ export type FetchTTSAudioUrlsParams = {
   noticeUuid: string;
   language: string;
 };
+
+// =============================================================================
+// Guardian Verification Types (aligned with backend API)
+// =============================================================================
+
+/**
+ * Parameters for initiating guardian verification
+ * POST /guardian/initiate-verification
+ */
+export type InitiateGuardianVerificationParams = {
+  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 = {
+  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;
+};