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

package/src/RedactoPrivacyCenter/lib/types.ts

@@ -0,0 +1,531 @@
+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 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;
+};
+
+export type FormData = {
+  uuid: string;
+  name: string;
+  contact: string;
+  grievance_options: GrievanceOptions[];
+  purposes: RawPurposeWrapper[];
+};
+
+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;
+};
+
+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 UserConsent = {
+  purpose_uuid?: string;
+  purpose: string;
+  purpose_description: string;
+  status: ConsentStatusEnum;
+  given_date: string;
+  valid_till: string;
+  method: string;
+  data_elements: ConsentDataElement[];
+  product_uuid?: string;
+  product_name?: string;
+  product_description?: string | null;
+  nominator_info?: NominatorInfo;
+};
+
+export type NominatorInfo = {
+  org_user_id: string;
+  name: string | null;
+  uuid: string;
+  email: string | null;
+};
+
+export type ConsentHistoryStatusSummary = {
+  total_purposes: number;
+  direct_purposes: number;
+  nominated_purposes: number;
+  nominee_purposes?: number;
+  active_purposes: number;
+  inactive_purposes: number;
+};
+
+export type ProductConsentHistoryGroup = {
+  product_uuid: string;
+  product_name: string;
+  product_description: string | null;
+  purposes: UserConsent[];
+  total_purposes: number;
+  active_purposes: number;
+};
+
+export type NominatedPurposesGroup = {
+  nominator_info: NominatorInfo;
+  product_groups: ProductConsentHistoryGroup[];
+};
+
+export type Pagination = {
+  total_count: number;
+  offset: number;
+  limit: number;
+};
+
+export type UserConsentDetail = {
+  data?: UserConsent[];
+  product_purpose_groups?: ProductConsentHistoryGroup[];
+  pagination: Pagination;
+  direct_product_groups?: ProductConsentHistoryGroup[];
+  user_status?: 'ACTIVE' | 'TRANSFERRED' | null;
+  nominated_purposes?: NominatedPurposesGroup[];
+  nominators?: NominatorInfo[];
+  status_summary?: ConsentHistoryStatusSummary | null;
+};
+
+export type UserConsentResponse = {
+  code: number;
+  status: string;
+  detail: UserConsentDetail;
+};
+
+export enum ConsentStatusEnum {
+  ACTIVE = 'ACTIVE',
+  WITHDRAWN = 'WITHDRAW',
+  EXPIRED = 'EXPIRED',
+  DECLINED = 'DECLINED',
+}
+
+export type ConsentAction = 'revoke' | 'regrant' | 'renew';
+
+export type ManageConsentResponse = {
+  code: number;
+  status: string;
+  detail: {
+    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;
+};
+
+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;
+};
+
+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;
+}>;
+
+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;
+}>
+
+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;
+}>;
+
+export type MessageComposerProps = Readonly<{
+  messageText: string;
+  onMessageTextChange: (text: string) => void;
+  pendingUpload: PendingUpload | null;
+  onRemovePendingUpload: () => void;
+  onAttachClick: () => void;
+  onSend: () => void;
+  isSending: boolean;
+  isUploading: boolean;
+}>;
+
+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 }>;

package/src/RedactoPrivacyCenter/lib/useCurrentLanguage.ts

@@ -0,0 +1,37 @@
+import { useSyncExternalStore, useCallback } from 'react';
+import i18n from './i18n';
+
+const DEFAULT_LANGUAGE = 'en';
+
+/**
+ * Returns the language query param to send to the API.
+ * Returns `undefined` for the default language (English) so that
+ * existing un-localised behaviour is preserved.
+ */
+export function getLangParam(language: string): string | undefined {
+  return language !== DEFAULT_LANGUAGE ? language : undefined;
+}
+
+/**
+ * React hook that subscribes to i18next language changes.
+ * Returns `{ currentLanguage, langParam }` where `langParam`
+ * is `undefined` for the default language.
+ *
+ * Unlike reading `i18n.language` directly, this hook triggers a
+ * component re-render whenever the language changes.
+ */
+export function useCurrentLanguage() {
+  const subscribe = useCallback((onStoreChange: () => void) => {
+    i18n.on('languageChanged', onStoreChange);
+    return () => {
+      i18n.off('languageChanged', onStoreChange);
+    };
+  }, []);
+
+  const getSnapshot = useCallback(() => i18n.language, []);
+
+  const currentLanguage = useSyncExternalStore(subscribe, getSnapshot, getSnapshot);
+  const langParam = getLangParam(currentLanguage);
+
+  return { currentLanguage, langParam };
+}