consolidated event types into file

thinknoack · thinknoack · commit 03434de3ca2a · 2025-08-11T11:47:44.000-07:00
diff --git a/packages/openneuro-app/src/scripts/dataset/components/dataset-event-item.tsx b/packages/openneuro-app/src/scripts/dataset/components/dataset-event-item.tsx
@@ -3,36 +3,12 @@ import { useMutation, useQuery } from "@apollo/client"
 import { toast } from "react-toastify"
 import ToastContent from "../../common/partials/toast-content.jsx"
 import * as Sentry from "@sentry/react"
+import { Event } from "../../types/event-types"
 import styles from "./scss/dataset-events.module.scss"
 import { PROCESS_CONTRIBUTOR_REQUEST_MUTATION } from "../../queries/datasetEvents.js"
 import { Username } from "../../users/username.js"
 import { GET_USER } from "../../queries/user.js"
 
-interface Event {
-  id: string
-  timestamp: string
-  note?: string
-  event: {
-    type: string
-    targetUserId?: string
-    status?: string
-    requestId?: string
-    message?: string
-    reason?: string
-    datasetId?: string
-    resolutionStatus?: string
-    target?: {
-      id: string
-      name?: string
-      email?: string
-      orcid?: string
-    }
-  }
-  user?: { name?: string; email?: string; id?: string; orcid?: string }
-  hasBeenRespondedTo?: boolean
-  responseStatus?: string
-}
-
 interface DatasetEventItemProps {
   event: Event
   datasetId: string
diff --git a/packages/openneuro-app/src/scripts/dataset/components/dataset-event-list.tsx b/packages/openneuro-app/src/scripts/dataset/components/dataset-event-list.tsx
@@ -1,28 +1,9 @@
 import React from "react"
+import { Event } from "../../types/event-types"
 import { DatasetEventItem } from "./dataset-event-item"
 
-interface ProcessedDatasetEvent {
-  id: string
-  note: string
-  timestamp: string
-  user: {
-    id: string
-    name: string
-    email: string
-    orcid: string
-  }
-  event: {
-    type: string
-    requestId?: string
-    status?: string
-  }
-  success: boolean
-  hasBeenRespondedTo?: boolean
-  responseStatus?: string
-}
-
 interface DatasetEventListProps {
-  events: ProcessedDatasetEvent[]
+  events: Event[]
   datasetId: string
   editingNoteId: string | null
   updatedNote: string
diff --git a/packages/openneuro-app/src/scripts/types/event-types.ts b/packages/openneuro-app/src/scripts/types/event-types.ts
@@ -0,0 +1,116 @@
+import { User } from "./user-types"
+
+export type RequestStatus = "pending" | "accepted" | "denied"
+
+export interface EventDescription {
+  type: string
+  targetUserId?: string
+  status?: RequestStatus
+  requestId?: string
+  message?: string
+  reason?: string
+  datasetId?: string
+  resolutionStatus?: RequestStatus
+  target?: User
+  version?: string
+  public?: boolean
+  level?: string
+  ref?: string
+}
+
+export interface Event {
+  id: string
+  timestamp: string
+  note?: string
+  success?: boolean
+  event: EventDescription
+  user?: User
+  hasBeenRespondedTo?: boolean
+  responseStatus?: string
+  dataset?: {
+    id: string
+    name?: string
+  }
+  datasetId?: string
+  status?: "unread" | "saved" | "archived"
+}
+
+export interface MappedNotification {
+  id: string
+  title: string
+  content: string
+  status: "unread" | "saved" | "archived"
+  type: "general" | "approval" | "response"
+  approval?: "pending" | "accepted" | "denied"
+  originalNotification: Event
+  datasetId?: string
+  requestId?: string
+  targetUserId?: string
+  requesterUser?: User
+  adminUser?: User
+  reason?: string
+}
+
+/**
+ * @param rawNotification The raw Event object.
+ * @returns A MappedNotification object with properties populated from the raw data.
+ */
+export const mapRawEventToMappedNotification = (
+  rawNotification: Event,
+): MappedNotification => {
+  const { event, note, user, dataset, datasetId: rawDatasetId } =
+    rawNotification
+  const {
+    type,
+    resolutionStatus,
+    status: eventStatus,
+    requestId,
+    targetUserId,
+    reason,
+  } = event
+
+  let title = note || "General Notification"
+  let mappedType: MappedNotification["type"] = "general"
+  let approval: MappedNotification["approval"]
+  let requesterUser: User | undefined
+  let adminUser: User | undefined
+
+  switch (type) {
+    case "contributorRequest":
+      title = "Contributor Request for Dataset"
+      mappedType = "approval"
+      approval = resolutionStatus ?? "pending"
+      requesterUser = user
+      break
+    case "contributorResponse":
+      title = `Contributor ${eventStatus} for Dataset`
+      mappedType = "response"
+      approval = eventStatus as "accepted" | "denied"
+      adminUser = user
+      break
+    case "note":
+      title = note || "Admin Note on Dataset"
+      break
+    default:
+      title = note || `Dataset ${type || "Unknown Type"}`
+      break
+  }
+
+  const datasetId = dataset?.id || rawDatasetId || event.datasetId || ""
+
+  return {
+    id: rawNotification.id,
+    title,
+    content: note || "",
+    status: rawNotification.status ?? "unread",
+    type: mappedType,
+    approval,
+    datasetId,
+    requestId: requestId,
+    targetUserId: targetUserId || user?.id,
+    originalNotification: rawNotification,
+    requesterUser,
+    adminUser,
+    reason: reason,
+  }
+}
diff --git a/packages/openneuro-app/src/scripts/types/user-types.ts b/packages/openneuro-app/src/scripts/types/user-types.ts
@@ -1,3 +1,5 @@
+import { Event, MappedNotification } from "./event-types"
+
 export interface User {
   id: string
   name: string
@@ -15,146 +17,7 @@ export interface User {
   provider?: string
   modified?: string
   githubSynced?: Date
-  notifications?: DatasetEventGraphQL[]
-}
-
-export interface DatasetEventDescriptionGraphQL {
-  type?: string
-  version?: string
-  public?: boolean
-  level?: string
-  ref?: string
-  message?: string
-  requestId?: string
-  targetUserId?: string
-  status?: string
-  reason?: string
-  datasetId?: string
-  resolutionStatus?: "pending" | "accepted" | "denied"
-}
-
-export interface DatasetEventGraphQL {
-  id: string
-  timestamp: string // GraphQL DateTime is a string
-  note?: string
-  success?: boolean
-  user?: User
-  event: DatasetEventDescriptionGraphQL
-  dataset?: {
-    id: string
-    name?: string
-  }
-  datasetId?: string
-  status?: "unread" | "saved" | "archived"
-}
-
-export type OutletContextType = {
-  notifications: MappedNotification[]
-  handleUpdateNotification: (
-    id: string,
-    updates: Partial<MappedNotification>,
-  ) => void
-}
-
-export interface MappedNotification {
-  id: string
-  title: string
-  content: string
-  status: "unread" | "saved" | "archived"
-  type: "general" | "approval" | "response"
-  approval?: "pending" | "accepted" | "denied"
-  originalNotification: DatasetEventGraphQL
-  datasetId?: string
-  requestId?: string
-  targetUserId?: string
-  requesterUser?: User
-  adminUser?: User
-  reason?: string
-}
-
-export const mapRawDatasetEventToMappedNotification = (
-  rawNotification: DatasetEventGraphQL,
-): MappedNotification => {
-  const event = rawNotification.event
-  let title = "General Notification"
-
-  const status: MappedNotification["status"] = rawNotification.status ??
-    "unread"
-
-  let mappedType: MappedNotification["type"] = "general"
-  let approval: MappedNotification["approval"]
-
-  const datasetId = rawNotification.dataset?.id ||
-    rawNotification.datasetId ||
-    event.datasetId ||
-    ""
-
-  let requestIdForMutation: string | undefined
-  let targetUserIdForMutation: string | undefined
-
-  let requesterUser: User | undefined
-  let adminUser: User | undefined
-  let eventReason: string | undefined
-  switch (event?.type) {
-    case "contributorRequest":
-      title = `Contributor Request for Dataset`
-      mappedType = "approval"
-      approval = event.resolutionStatus ?? "pending"
-      requestIdForMutation = event.requestId
-      targetUserIdForMutation = rawNotification.user?.id
-      requesterUser = rawNotification.user
-      break
-
-    case "contributorResponse":
-      title = `Contributor ${event.status} for Dataset`
-      mappedType = "response"
-      approval = event.status as "accepted" | "denied"
-      requestIdForMutation = event.requestId
-      targetUserIdForMutation = event.targetUserId
-      adminUser = rawNotification.user
-      eventReason = event.reason
-      break
-
-    case "note":
-      title = `Admin Note on Dataset`
-      break
-
-    default:
-      title = rawNotification.note ||
-        `Dataset ${rawNotification.event.type || "Unknown Type"}` ||
-        `${datasetId}: ${event}` ||
-        `${rawNotification.event}`
-      break
-  }
-
-  return {
-    id: rawNotification.id,
-    title: title,
-    content: rawNotification.note || "",
-    status: status,
-    type: mappedType,
-    approval: approval,
-    datasetId: datasetId,
-    requestId: requestIdForMutation,
-    targetUserId: targetUserIdForMutation,
-    originalNotification: rawNotification,
-    requesterUser: requesterUser,
-    adminUser: adminUser,
-    reason: eventReason,
-  }
-}
-
-export interface UserRoutesProps {
-  orcidUser: User
-  hasEdit: boolean
-  isUser: boolean
-}
-export interface UserCardProps {
-  orcidUser: User
-}
-
-export interface UserAccountViewProps {
-  orcidUser: User
+  notifications?: Event[]
 }
 
 export interface Dataset {
@@ -188,6 +51,19 @@ export interface Dataset {
   }
 }
 
+export interface UserRoutesProps {
+  orcidUser: User
+  hasEdit: boolean
+  isUser: boolean
+}
+export interface UserCardProps {
+  orcidUser: User
+}
+
+export interface UserAccountViewProps {
+  orcidUser: User
+}
+
 export interface DatasetCardProps {
   dataset: Dataset
   hasEdit: boolean
@@ -203,3 +79,11 @@ export interface AccountContainerProps {
   hasEdit: boolean
   isUser: boolean
 }
+
+export type OutletContextType = {
+  notifications: MappedNotification[]
+  handleUpdateNotification: (
+    id: string,
+    updates: Partial<MappedNotification>,
+  ) => void
+}
diff --git a/packages/openneuro-app/src/scripts/users/__tests__/user-routes.spec.tsx b/packages/openneuro-app/src/scripts/users/__tests__/user-routes.spec.tsx
@@ -4,8 +4,8 @@ import { vi } from "vitest"
 import { MemoryRouter, Outlet } from "react-router-dom"
 import { MockedProvider } from "@apollo/client/testing"
 import { UserRoutes } from "../user-routes"
+import type { Event } from "../../types/event-types"
 import type {
-  DatasetEventGraphQL,
   MappedNotification,
   OutletContextType,
   User,
@@ -159,7 +159,7 @@ vi.mock("./user-notifications-tab-content", () => ({
 
 // Mock the UserNotificationsView
 vi.mock("./user-notifications-view", () => {
-  const baseDatasetEvent: DatasetEventGraphQL = {
+  const baseDatasetEvent: Event = {
     id: "1",
     timestamp: "2023-01-01T12:00:00Z",
     event: { type: "published", message: "A dataset has been published." },
diff --git a/packages/openneuro-app/src/scripts/users/user-notification-accordion-actions.tsx b/packages/openneuro-app/src/scripts/users/user-notification-accordion-actions.tsx
@@ -2,7 +2,7 @@ import React, { useCallback } from "react"
 import * as Sentry from "@sentry/react"
 import { toast } from "react-toastify"
 import { useMutation } from "@apollo/client"
-import type { MappedNotification } from "../types/user-types"
+import type { MappedNotification } from "../types/event-types"
 import { UPDATE_NOTIFICATION_STATUS_MUTATION } from "../queries/datasetEvents"
 import { StatusActionButton } from "./components/status-action-buttons"
 import iconUnread from "../../assets/icon-unread.png"
diff --git a/packages/openneuro-app/src/scripts/users/user-notification-accordion.tsx b/packages/openneuro-app/src/scripts/users/user-notification-accordion.tsx
diff --git a/packages/openneuro-app/src/scripts/users/user-notifications-view.tsx b/packages/openneuro-app/src/scripts/users/user-notifications-view.tsx
