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

package/src/RedactoPrivacyCenter/lib/types.ts

@@ -1,868 +0,0 @@
-export type Workspace = {
-  uuid: string;
-  suid: string;
-  name: string;
-  description: string;
-  workspace_type: string;
-  status: string;
-};
-
-export type OrganizationDetail = {
-  uuid: string;
-  suid: string;
-  name: string;
-  slug: string;
-  description: string;
-  domain: string;
-  workspaces: Workspace[];
-  ai_summary: Record<string, unknown>;
-  icon_url: string | null;
-  activated: boolean;
-  allowed_domains: string[];
-};
-
-export type OrganizationResponse = {
-  code: number;
-  status: string;
-  detail: OrganizationDetail;
-};
-
-export type OrgBrandingTheme = {
-  primary: string;
-  secondary: string;
-  primary_contrast: string;
-  link: string;
-  surface: string;
-  text: string;
-  text_muted: string;
-  border: string;
-  success: string;
-  warning: string;
-  danger: string;
-};
-
-export type OrgBrandingDetail = {
-  logo_url: string | null;
-  icon_url: string | null;
-  brand_name: string;
-  theme: OrgBrandingTheme;
-  hide_platform_branding: boolean;
-};
-
-export type DataElement = {
-  uuid: string;
-  name: string;
-  description: string;
-  enabled: boolean;
-  required: boolean;
-  given_consent: boolean;
-  selected: boolean;
-};
-
-export type Purpose = {
-  uuid: string;
-  name: string;
-  description: string;
-  industries: string;
-  selected: boolean;
-  given_consent: boolean;
-  data_elements: DataElement[];
-  status?: string;
-  validity?: number | null;
-  purpose_uuid?: string;
-  enabled?: boolean;
-};
-
-export type RawPurposeWrapper = {
-  purpose: Purpose;
-};
-
-export type GrievanceValue =
-  | 'consent_violation'
-  | 'unlawful_processing'
-  | 'data_breach';
-
-export type GrievanceOptions = {
-  value: GrievanceValue;
-  label: string;
-};
-
-/**
- * Product-scoped form-data group.
- *
- * Phase 2 of TECH-3712. Mirrors the backend `FormProductGroupOut`. Used to
- * render per-product sections inside the privacy-center form. `nominator`
- * is populated on nominated groups and `null` on direct (own-data) groups.
- */
-export type FormProductGroup = {
-  product_uuid: string;
-  product_name: string;
-  product_description: string | null;
-  nominator: NominatorInfo | null;
-  // Bare `Purpose[]` — matches the backend `FormProductGroupOut.purposes`
-  // contract (`List[PurposeConsentFormOut]`). The legacy `FormData.purposes`
-  // field below remains wrapped (`RawPurposeWrapper[]`) for back-compat.
-  purposes: Purpose[];
-};
-
-export type FormData = {
-  uuid: string;
-  name: string;
-  contact: string;
-  grievance_options: GrievanceOptions[];
-  // Legacy flat list, retained for backwards compatibility with older SDK
-  // consumers. The backend continues to populate this alongside the grouped
-  // fields below.
-  purposes: RawPurposeWrapper[];
-  // Phase 2 of TECH-3712. Product-grouped purposes for the data principal's
-  // own consents. Empty array when the backend has no direct groups to emit.
-  // Optional so legacy backends (pre-Phase 1) typecheck — the runtime
-  // grouped-render guard already handles the absent case.
-  direct_groups?: FormProductGroup[];
-  // Phase 2 of TECH-3712. Product-grouped purposes the data principal can
-  // act on as a nominee. Empty array when there are no nominator grants.
-  // Optional for the same backwards-compatibility reason as `direct_groups`.
-  nominated_groups?: FormProductGroup[];
-};
-
-export type FormDataResponse = {
-  code: number;
-  detail: FormData;
-};
-
-export enum RequestTypeEnum {
-  ACCESS = 'ACCESS',
-  CORRECTION = 'CORRECTION',
-  ERASURE = 'erasure',
-  GRIEVANCE = 'grievance',
-  NOMINATION = 'nomination',
-}
-
-export type NominationData = {
-  nominee_email: string;
-  nominee_mobile?: string;
-};
-
-export type UpdatePurpose = {
-  purpose_uuid: string;
-  data_element_uuids: string[];
-};
-
-export type UpdateCorrectionDataItem = {
-  name: string;
-  curr_value: string;
-  new_value: string;
-};
-
-export enum GrievanceTypeEnum {
-  CONSENT_VIOLATION = 'consent_violation',
-  UNLAWFUL_PROCESSING = 'unlawful_processing',
-  DATA_BREACH = 'data_breach',
-}
-
-export type GrievanceTypeElement = {
-  grievance: GrievanceValue;
-};
-
-export type UpdateRequestDetails = {
-  purposes: UpdatePurpose[];
-  correction_data: UpdateCorrectionDataItem[];
-  grievance_types?: GrievanceTypeElement[];
-  nomination_data?: NominationData;
-};
-
-export type UserDataRequest = {
-  uuid: string;
-  name: string;
-  contact: string;
-  request_type: RequestTypeEnum;
-  supporting_docs_uuids: string[];
-  request_details: {
-    purposes: UpdatePurpose[];
-    correction_data: UpdateCorrectionDataItem[];
-    grievance_types: GrievanceTypeElement[];
-    nomination_data?: NominationData;
-  };
-  time_period: number | null;
-  requestor_note: string;
-  revoke_consent_on_fulfilment?: boolean;
-  // Phase 2 of TECH-3712. Optional product anchor for the case. When set,
-  // the case is created against the (product, optional nominator) consent
-  // group; when omitted, the case is created as a legacy org-level case.
-  product_uuid?: string;
-  // Phase 2 of TECH-3712. Optional data-principal anchor used when the
-  // requestor is acting on behalf of a nominator. Omit for direct cases.
-  data_principal_uuid?: string;
-};
-
-export type CreateCaseResponse = {
-  code: number;
-  status: string;
-  detail: {
-    uuid: string;
-    case_id: string;
-  };
-};
-
-export type OtpResponse = {
-  uuid: string;
-  to: string;
-  channel: string;
-  expire_at: string;
-  success: boolean;
-  message: string;
-};
-
-export type OtpVerificationResponse = {
-  token: string;
-  success: boolean;
-  message: string;
-};
-
-export type TokenExchangeResponse = {
-  token: string;
-  refresh_token: string;
-  expires_at: string;
-  notice_uuid: string;
-};
-
-export type FetchOrgParams = {
-  slug?: string;
-  name?: string;
-};
-
-export type ConsentDataElement = {
-  uuid: string;
-  name: string;
-  enabled: boolean;
-  required: boolean;
-  selected: boolean;
-};
-
-export type NominatorInfo = {
-  org_user_id: string;
-  name: string | null;
-  uuid: string;
-  email: string | null;
-};
-
-export 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;
-  // UUID of the notice version this purpose was consented under. Served by the
-  // Go ledger's user-consents response; required to revoke/regrant via the
-  // ledger's submit-consent endpoint (which has no manage-consent route).
-  notice_uuid: string | null;
-};
-
-export 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;
-};
-
-export type PaginationMeta = {
-  total_count: number;
-  offset: number;
-  limit: number;
-};
-
-export type Pagination = PaginationMeta;
-
-export type ConsentHistoryStatusSummary = {
-  total_purposes: number;
-  direct_purposes: number;
-  nominated_purposes: number;
-  active_purposes: number;
-  inactive_purposes: number;
-};
-
-export type DisplayProductGroup = ConsentGroup & {
-  withdrawn_purposes: number;
-  expired_purposes: number;
-  declined_purposes: number;
-  latest_given_date: string | null;
-};
-
-export type DisplayPurposeRow = PurposeItem & {
-  product_uuid: string;
-  product_name: string;
-  product_description: string | null;
-  nominator: NominatorInfo | null;
-};
-
-export type ConsentModalRecord = PurposeItem & {
-  product_uuid: string;
-  product_name: string;
-  product_description: string | null;
-  nominator: NominatorInfo | null;
-};
-
-export type UserConsentDetail = {
-  direct: ConsentGroup[];
-  direct_pagination: PaginationMeta;
-  nominated: ConsentGroup[];
-  nominated_pagination: PaginationMeta;
-  user_status: 'ACTIVE' | 'TRANSFERRED' | null;
-  nominators: NominatorInfo[];
-  status_summary: ConsentHistoryStatusSummary;
-};
-
-export type GroupPurposesOut = {
-  purposes: PurposeItem[];
-  pagination: PaginationMeta;
-};
-
-export type UserConsentResponse = {
-  code: number;
-  status: string;
-  detail: UserConsentDetail;
-};
-
-export enum ConsentStatusEnum {
-  ACTIVE = 'ACTIVE',
-  WITHDRAWN = 'WITHDRAW',
-  REVOKED = 'REVOKED',
-  EXPIRED = 'EXPIRED',
-  DECLINED = 'DECLINED',
-}
-
-export type ConsentAction = 'revoke' | 'regrant' | 'renew';
-
-export type ManageConsentResponse = {
-  code: number;
-  status: string;
-  detail: {
-    success: boolean;
-  };
-};
-
-// Unwrapped `detail` of the legacy Python manage-consent response; the Go
-// ledger returns a ConsentEventResponse with no `success` flag instead.
-export type LegacyManageConsentResponse = {
-  success: boolean;
-};
-
-export type ManageConsentParams = {
-  organizationId: string;
-  workspaceId: string;
-  purposeId: string;
-  contact: string;
-  action: ConsentAction;
-  nominatorContact?: string;
-  dataElementUuids?: string[];
-};
-
-export type GrievanceDataSectionProps = {
-  grievanceOptions: GrievanceOptions[];
-  selectedGrievances: Record<string, boolean>;
-  setSelectedGrievances: React.Dispatch<
-    React.SetStateAction<Record<string, boolean>>
-  >;
-};
-
-export type NominationDataSectionProps = {
-  nominationData: NominationData;
-  setNominationData: React.Dispatch<React.SetStateAction<NominationData>>;
-  isTranslating?: boolean;
-};
-
-export type Activity = {
-  activity_type: string;
-  activity_type_display?: string;
-  timestamp: string;
-  title: string;
-  title_display?: string;
-  description: string;
-  description_display?: string;
-  case_id?: string;
-  status?: 'Processing' | 'Completed' | 'Rejected';
-  status_display?: string;
-};
-
-export type ActivityDetail = {
-  data: Activity[];
-  pagination: Pagination;
-};
-
-// ─── Receipts ────────────────────────────────────────────────────────────────
-
-export type ReceiptEventType = 'GRANTED' | 'WITHDRAWN' | 'DECLINED' | 'EXPIRED';
-export type ReceiptPurposeStatus = 'CONSENTED' | 'DECLINED' | 'WITHDRAWN';
-
-/**
- * A single consent receipt row. The backend returns localized `*_display`
- * fields alongside the raw enum/value — render the `*_display`, branch on the raw.
- */
-export type Receipt = {
-  uuid: string;
-  event_type: ReceiptEventType | string;
-  event_type_display?: string | null;
-  product_name?: string | null;
-  product_name_display?: string | null;
-  created_at: string;
-};
-
-// Mirrors the Go ledger's `ConsentReceiptListResponse` (offset-paginated page
-// of the principal's receipts): flat `total`/`skip`/`limit`, not a nested
-// `pagination` object. Without a configured ledgerBaseUrl the legacy Python
-// list is called instead, which returns a `{ data, pagination }` envelope —
-// `normalizeReceipts` in ReceiptsList tolerates either shape; this type
-// documents the ledger contract.
-export type ReceiptListResponse = {
-  data: Receipt[];
-  total: number;
-  skip: number;
-  limit: number;
-};
-
-export type ActivityResponse = {
-  code: number;
-  status: string;
-  detail: ActivityDetail;
-};
-
-export type ActivityBadgeStatus =
-  | 'success'
-  | 'warning'
-  | 'error'
-  | 'info'
-  | 'pending';
-
-export type CaseRequestDetails = {
-  purposes: RawPurposeWrapper[];
-  correction_data: UpdateCorrectionDataItem[];
-  grievance_types?: GrievanceTypeElement[];
-  nomination_data?: NominationData;
-};
-
-export type CaseRequest = {
-  uuid: string;
-  case_id: string;
-  status: string;
-  status_display?: string;
-  request_type: string;
-  request_type_display?: string;
-  description: string;
-  description_display?: string;
-  created_at: string;
-  completed_at?: string;
-  due_date?: string;
-  request_details?: CaseRequestDetails;
-  // Phase 2 of TECH-3712. Product anchor (when the case was created against
-  // a product consent group). Undefined for legacy org-level cases.
-  product_uuid?: string;
-  // Phase 2 of TECH-3712. Product display name hydrated by the console list
-  // endpoint. Undefined on legacy cases or when the product is not joinable.
-  product_name?: string;
-  // Phase 2 of TECH-3712. Data-principal anchor for nominee-driven cases.
-  data_principal_uuid?: string;
-  // Phase 2 of TECH-3712. UUID of the user who initiated the case (may be
-  // the data principal themselves or a nominee acting on their behalf).
-  requestor_uuid?: string;
-  // Phase 2 of TECH-3712. UUID of the nominator whose grant authorised the
-  // nominee to file this case. Undefined for direct cases.
-  nominator_uuid?: string;
-};
-
-export type RequestDetailsTabProps = {
-  selectedCase: CaseRequest;
-  request_details: CaseRequestDetails | undefined;
-  requestTypeLabel: string;
-};
-
-export type CaseHistoryDetail = {
-  data: CaseRequest[];
-  pagination: Pagination;
-};
-
-export type CaseHistoryResponse = {
-  code: number;
-  status: string;
-  detail: CaseRequest[];
-};
-
-// ─── Case Communication ──────────────────────────────────────────────────────
-
-export type MessageType =
-  | 'message_sent'
-  | 'document_requested'
-  | 'document_submitted'
-  | 'document_replaced'
-  | 'document_replacement_requested'
-  | 'document_approved'
-  | 'document_rejected';
-
-export type DocumentRequestStatus =
-  | 'pending'
-  | 'under_review'
-  | 'approved'
-  | 'rejected'
-  | 'replacement_requested';
-
-export type FileUrlMap = {
-  url?: string;
-  download_url?: string;
-};
-
-export type MessageDocument = {
-  uuid: string;
-  file_name: string | null;
-  content_type: string | null;
-  file_size: number | null;
-  file_url: FileUrlMap | null;
-};
-
-export type DocumentRequestMetadata = {
-  title: string;
-  accepted_document: string;
-  document_request_status: DocumentRequestStatus;
-  document_request_uuid: string | null;
-  rejection_reason: string;
-};
-
-export type CaseMessage = {
-  uuid: string;
-  case_uuid: string;
-  sender_role: 'data_fiduciary' | 'data_principal';
-  triggered_by_email: string;
-  created_at: string;
-  body: string;
-  document_uuids: string[];
-  documents: MessageDocument[];
-  message_type: MessageType;
-  document_request_metadata: DocumentRequestMetadata | null;
-};
-
-export type TabId = 'messages' | 'request-details';
-
-export type PendingUpload = { uuid: string; file_name: string; file_size: number };
-
-// ─── Case Communication server action params ────────────────────────────────
-
-export type CaseActionBaseParams = {
-  organizationId: string;
-  workspaceId: string;
-  caseUuid: string;
-  authToken?: string;
-  consentClient?: ReturnType<typeof import('../api/client').createConsentClient>;
-};
-
-export type GetCaseMessagesParams = CaseActionBaseParams;
-
-export type SendCaseMessageParams = CaseActionBaseParams & {
-  body: string;
-  documentUuids: string[];
-};
-
-export type UploadCaseDocumentParams = CaseActionBaseParams & {
-  file: File;
-};
-
-export type SubmitDocumentForRequestParams = CaseActionBaseParams & {
-  requestEventUuid: string;
-  documentUuid: string;
-  body: string;
-};
-
-export type GetCaseDocumentParams = CaseActionBaseParams & {
-  documentUuid: string;
-};
-
-export type UploadDocumentResponse = {
-  uuid: string;
-  suid: string;
-  file_name: string;
-  file_type: string;
-  content_type: string;
-  file_size: number;
-  created_at: string;
-  is_public: boolean;
-  file: string;
-  file_hash: string | null;
-  status: string;
-  allow_ai_processing: boolean;
-  metadata: Record<string, string> | null;
-};
-
-export type MessageItemProps = Readonly<{
-  message: CaseMessage;
-  onUploadForRequest: (requestEventUuid: string) => void;
-  isSubmittingForRequest: boolean;
-  isCaseFinalized: boolean;
-}>;
-
-export type ChatBubbleProps = Readonly<{
-  message: CaseMessage;
-  isPrincipal: boolean;
-  senderLabel: string;
-  timestamp: string;
-}>;
-
-export type AttachmentCardProps = Readonly<{
-  doc: MessageDocument;
-}>
-
-export type DocumentRequestCardProps = Readonly<{
-  message: CaseMessage;
-  onUpload: (requestEventUuid: string) => void;
-  isSubmitting: boolean;
-  isCaseFinalized: boolean;
-}>
-
-export type StatusEventProps = Readonly<{
-  icon: React.ReactNode;
-  color: string;
-  bgColor: string;
-  borderColor: string;
-  text: string;
-  subText?: string;
-  timestamp: string;
-}>;
-
-export type MessagesTabProps = Readonly<{
-  caseUuid: string;
-  caseStatus: string;
-}>;
-
-export type MessageComposerProps = Readonly<{
-  messageText: string;
-  onMessageTextChange: (text: string) => void;
-  pendingUpload: PendingUpload | null;
-  onRemovePendingUpload: () => void;
-  onAttachClick: () => void;
-  onSend: () => void;
-  isSending: boolean;
-  isUploading: boolean;
-  isCaseFinalized: boolean;
-}>;
-
-export type FinalizedTooltipWrapperProps = Readonly<{
-  enabled: boolean;
-  autoWidth?: boolean;
-  children: React.ReactElement;
-}>;
-
-export type CaseStatusVariant =
-  | 'success'
-  | 'error'
-  | 'warning'
-  | 'info'
-  | 'secondary';
-
-
-export type SendCaseMessageInput = Readonly<{
-  body: string; documentUuids: string[]
-}>;
-
-export type SubmitDocumentForRequestInput = Readonly<{
-  requestEventUuid: string; documentUuid: string; body: string
-}>;
-
-export type DocumentRequestStatusInfo = Readonly<{ labelKey: string; color: string }>;
-
-export type CaseDetailsTab = Readonly<{ id: TabId; label: string }>;
-
-// ─── Notification Hub ──────────────────────────────────────────────────────
-
-export type NotificationType =
-  | 'guardian_verification_request'
-  | 'consent_expiry_warning'
-  | 'new_consent_notice'
-  | 'consent_withdrawal_confirmation'
-  | 'data_request_status_update'
-  | 'case_message'
-  | 'grievance_status_update'
-  | 'consent_regrant_prompt';
-
-export type NotificationCategory = 'consent' | 'request' | 'system';
-
-export type NotificationCTA = {
-  label: string;
-  style: 'primary' | 'secondary' | 'danger';
-  action_type: 'link' | 'acknowledge';
-  url?: string;
-};
-
-export type Notification = {
-  uuid: string;
-  notification_type: NotificationType;
-  category: NotificationCategory;
-  title: string;
-  description: string;
-  is_read: boolean;
-  is_acknowledged: boolean;
-  source_type: string;
-  source_uuid: string | null;
-  request_type: string;
-  request_type_display?: string | null;
-  status_label: string;
-  status_label_display?: string | null;
-  ctas: NotificationCTA[];
-  created_at: string;
-};
-
-export type NotificationSummary = {
-  total: number;
-  unread: number;
-  action_needed: number;
-  acknowledged: number;
-};
-
-export type NotificationListResponse = {
-  data: Notification[];
-  total: number;
-  skip: number;
-  limit: number;
-  summary: NotificationSummary | null;
-};
-
-export type UnreadCountResponse = {
-  count: number;
-};
-
-export type NotificationActionResponse = {
-  message: string;
-};
-
-export type NotificationActionBaseParams = {
-  organizationId: string;
-  workspaceId: string;
-  authToken?: string;
-  consentClient?: ReturnType<typeof import('../api/client').createConsentClient>;
-};
-
-export type StatCardProps = Readonly<{
-  value: number; label: string;
-}>
-
-export type NotificationDropdownProps = Readonly<{
-  notifications: Notification[];
-  onMarkAllRead: () => void;
-  onRefresh: () => void;
-  isRefreshing: boolean;
-  onViewAll: () => void;
-  onNotificationClick: (notification: Notification) => void;
-  onCTAClick: (notification: Notification, cta: NotificationCTA) => void;
-}>;
-
-export type NotificationListPanelProps = Readonly<{
-  notifications: Notification[];
-  totalCount: number;
-  activeTab: FilterTab;
-  onTabChange: (tab: FilterTab) => void;
-  skip: number;
-  onSkipChange: (skip: number) => void;
-  isLoading: boolean;
-  isRefreshing: boolean;
-  onRefresh: () => void;
-  onMarkAllRead: () => void;
-  onNotificationClick: (notification: Notification) => void;
-  onCTAClick: (notification: Notification, cta: NotificationCTA) => void;
-}>;
-
-
-export type NotificationRowProps = Readonly<{
-  notification: Notification;
-  onClick: () => void;
-  onCTAClick: (cta: NotificationCTA) => void;
-}>;
-
-export type NotificationIconProps = Readonly<{
-  notificationType: NotificationType;
-  size?: 'sm' | 'lg';
-}>;
-
-export type NotificationCTAButtonProps = Readonly<{
-  cta: NotificationCTA;
-  onClick: (e: React.MouseEvent) => void;
-  size?: 'sm' | 'lg';
-}>;
-
-export type FilterTab = 'all' | 'consent' | 'request' | 'system';
-
-export type IconCategory = 'guardian' | 'consent' | 'access' | 'withdrawal' | 'grievance' | 'system';
-
-export type NotificationDropdownItemProps = Readonly<{
-  notification: Notification;
-  onNotificationClick: (notification: Notification) => void;
-  onCTAClick: (notification: Notification, cta: NotificationCTA) => void;
-}>
-
-export type NotificationQueryParams = {
-  category?: NotificationCategory;
-  notification_type?: NotificationType;
-  is_read?: boolean;
-  skip?: number;
-  limit?: number;
-  include_summary?: boolean;
-  language?: string;
-};
-
-export type NotificationClient = NonNullable<NotificationActionBaseParams['consentClient']>;
-
-export type GetNotificationsServerParams = NotificationActionBaseParams & NotificationQueryParams;
-
-export type NotificationByUuidServerParams = NotificationActionBaseParams & { notificationUuid: string };
-
-export type NotificationRefreshButtonProps = Readonly<{
-  isRefreshing: boolean;
-  onRefresh: () => void;
-  iconSize?: number;
-}>;
-
-export type IdentityCandidate = Readonly<{
-  uuid: string;
-  org_user_id?: string | null;
-  primary_email?: string | null;
-  primary_mobile?: string | null;
-  created_at?: string | null;
-}>;
-
-export type IdentityListResponse = Readonly<{
-  identities: IdentityCandidate[];
-}>;
-
-export type SelectPrincipalResponse = Readonly<{
-  token: string;
-  refresh_token: string;
-  expires_at?: string;
-}>;
-
-// Discrete phases of the shared-contact profile gate: `checking` probes the
-// backend for sibling principals, `picking` shows the profile picker, and
-// `resolved` passes through to children.
-export type GatePhase = 'checking' | 'picking' | 'resolved';
-
-export type SelectUserProps = Readonly<{
-  email: string | null;
-  candidates: IdentityCandidate[];
-  onSelect: (orgUserId: string) => void;
-  busyOrgUserId: string | null;
-  error?: string | null;
-}>;
-
-export type SelectUserGateProps = Readonly<{
-  children: React.ReactNode;
-}>;
-
-// Exposed by SelectUserGate so a signed-in session can re-open the profile
-// picker (shared contact). `canSwitch` is true only when the contact maps to
-// more than one principal; `switchProfile` drops the pinned choice and shows
-// the picker again.
-export type ProfileSwitchValue = Readonly<{
-  canSwitch: boolean;
-  switchProfile: () => void;
-}>;