inbox.ts

import { ComponentType, ReactNode } from 'react'

export type InboxState = {
  loading: boolean
  refreshing: boolean
  items: InboxLoadedItemWithData[]
  refresh: () => void
}

export type InboxLoadedItem = {
  id: string
  timestamp: string | undefined
  chainId: string
  data: unknown
}

export enum InboxItemType {
  JoinedDao = 'joined_dao',
  ProposalCreated = 'proposal_created',
  ProposalExecuted = 'proposal_executed',
  ProposalClosed = 'proposal_closed',
  PendingProposalCreated = 'pending_proposal_created',
  PendingProposalRejected = 'pending_proposal_rejected',
}

export type InboxItemTypeJoinedDaoData = {
  chainId: string
  dao: string
  name: string
  imageUrl: string | undefined
}

export type InboxItemTypeProposalCreatedData = {
  chainId: string
  dao: string
  daoName: string
  imageUrl: string | undefined
  proposalId: string
  proposalTitle: string
  // Whether or not this is an approver-created proposal.
  fromApprover?: boolean
}

export type InboxItemTypeProposalExecutedData =
  InboxItemTypeProposalCreatedData & {
    failed: boolean
    // Winning option for a multiple choice proposal.
    winningOption?: string
  }

export type InboxItemTypeProposalClosedData = InboxItemTypeProposalCreatedData
export type InboxItemTypePendingProposalCreatedData = Omit<
  InboxItemTypeProposalCreatedData,
  'fromApprover'
>
export type InboxItemTypePendingProposalRejectedData =
  InboxItemTypePendingProposalCreatedData

// Items from the inbox API.
export type InboxLoadedItemWithData = Omit<InboxLoadedItem, 'data'> &
  (
    | {
        type: InboxItemType.JoinedDao
        data: InboxItemTypeJoinedDaoData
      }
    | {
        type: InboxItemType.ProposalCreated
        data: InboxItemTypeProposalCreatedData
      }
    | {
        type: InboxItemType.ProposalExecuted
        data: InboxItemTypeProposalExecutedData
      }
    | {
        type: InboxItemType.ProposalClosed
        data: InboxItemTypeProposalClosedData
      }
    | {
        type: InboxItemType.PendingProposalCreated
        data: InboxItemTypePendingProposalCreatedData
      }
    | {
        type: InboxItemType.PendingProposalRejected
        data: InboxItemTypePendingProposalRejectedData
      }
  )

export enum InboxItemTypeMethod {
  Website = 1 << 0,
  Email = 1 << 1,
  Push = 1 << 2,
}

export type InboxItemTypeMethodData = {
  method: InboxItemTypeMethod
  i18nKey: string
  Icon: ComponentType<{ className?: string }>
}

export type InboxItemRendererProps<Data extends unknown> = {
  item: InboxLoadedItemWithData
  data: Data
  clear: () => Promise<boolean>
  /**
   * Optionally style things a bit more compact. Used in the popup.
   */
  compact?: boolean
}

export type InboxMainItemRendererProps = {
  /**
   * The loaded inbox item.
   */
  item: InboxLoadedItemWithData
  /**
   * Whether or not this inbox item is checked. Checking refers to batch marking
   * as cleared.
   */
  checked: boolean
  /**
   * Check handler. Called with the item.
   */
  onCheck: (item: InboxLoadedItem) => void
  /**
   * Optionally style things a bit more compact. Used in the popup.
   */
  compact?: boolean
}

export type InboxUpdateConfig = {
  // Update email. If empty or null, remove email.
  email?: string | null
  // Update notification settings per-type.
  types?: Record<string, number | null>
  // If present, verify email.
  verify?: string
  // If present, resend verification email.
  resend?: boolean
  // If present, update push settings.
  push?:
    | {
        // Add subscription.
        type: 'subscribe'
        subscription: any
      }
    | {
        // Check if subscribed or unsubscribe.
        type: 'check' | 'unsubscribe'
        p256dh: string
      }
    | {
        // Unsubscribe all subscriptions.
        type: 'unsubscribe_all'
      }
}

export type PushSubscriptionManager = {
  ready: boolean
  supported: boolean
  updating: boolean
  subscribed: boolean
  subscription: PushSubscription | undefined
  subscribe: () => Promise<void>
  unsubscribe: () => Promise<void>
  unsubscribeAll: () => Promise<void>
}

export type InboxConfig = {
  email: string | null
  verified: boolean
  types: Record<string, number | null>
  // Number of registered push subscriptions.
  pushSubscriptions: number
  // If `push` is defined in the body, returns whether or not the push is now
  // subscribed.
  pushSubscribed?: boolean
  // Allowed methods per type.
  typeAllowedMethods: Record<InboxItemType, InboxItemTypeMethod[]>
}

export type InboxApi = {
  ready: boolean
  updating: boolean
  clear: (
    items: {
      chainId: string
      id: string
    }[]
  ) => Promise<boolean>
  loadConfig: () => Promise<boolean>
  updateConfig: (
    data: InboxUpdateConfig,
    signatureType?: string
  ) => Promise<boolean>
  resendVerificationEmail: () => Promise<boolean>
  verify: (code: string) => Promise<boolean>
  config: InboxConfig | undefined
  push: PushSubscriptionManager
}

export type InboxApiWithUi = {
  /**
   * The inbox API.
   */
  api: InboxApi
  /**
   * A map of inbox item ID to whether or not it is checked for removal.
   */
  checked: Record<string, boolean>
  /**
   * The callback that toggles the checked status of an inbox item.
   */
  onCheck: (item: InboxLoadedItem) => void
  /**
   * A function that uses the verification code in the URL query params and
   * attempts to verify.
   */
  verify: () => void
  /**
   * The buttons that perform various actions.
   */
  buttons: {
    /**
     * Refresh the inbox.
     */
    refresh: ReactNode
    /**
     * Clear the checked items, or clear all if none are checked.
     */
    clear: ReactNode
    /**
     * Open the settings modal.
     */
    settings: ReactNode
  }
}

export enum InboxPageSlug {
  Settings = 'settings',
  Verify = 'verify',
}