@atproto/api/src/types.ts

Client library for atproto and Bluesky

import { LabelPreference } from './moderation/types'

/**
 * Used by the PersistSessionHandler to indicate what change occurred
 */
export type AtpSessionEvent = 'create' | 'create-failed' | 'update' | 'expired'

/**
 * Used by AtpAgent to store active sessions
 */
export interface AtpSessionData {
  refreshJwt: string
  accessJwt: string
  handle: string
  did: string
  email?: string
  emailConfirmed?: boolean
}

/**
 * Handler signature passed to AtpAgent to store session data
 */
export type AtpPersistSessionHandler = (
  evt: AtpSessionEvent,
  session: AtpSessionData | undefined,
) => void | Promise<void>

/**
 * AtpAgent constructor() opts
 */
export interface AtpAgentOpts {
  service: string | URL
  persistSession?: AtpPersistSessionHandler
}

/**
 * AtpAgent createAccount() opts
 */
export interface AtpAgentCreateAccountOpts {
  email: string
  password: string
  handle: string
  inviteCode?: string
}

/**
 * AtpAgent login() opts
 */
export interface AtpAgentLoginOpts {
  identifier: string
  password: string
}

/**
 * AtpAgent global fetch handler
 */
type AtpAgentFetchHeaders = Record<string, string>
export interface AtpAgentFetchHandlerResponse {
  status: number
  headers: Record<string, string>
  body: any
}
export type AtpAgentFetchHandler = (
  httpUri: string,
  httpMethod: string,
  httpHeaders: AtpAgentFetchHeaders,
  httpReqBody: any,
) => Promise<AtpAgentFetchHandlerResponse>

/**
 * AtpAgent global config opts
 */
export interface AtpAgentGlobalOpts {
  fetch: AtpAgentFetchHandler
}

/**
 * Content-label preference
 */
export type BskyLabelPreference = LabelPreference | 'show'
// TEMP we need to permanently convert 'show' to 'ignore', for now we manually convert -prf

/**
 * Bluesky feed view preferences
 */

export interface BskyFeedViewPreference {
  hideReplies: boolean
  hideRepliesByUnfollowed: boolean
  hideRepliesByLikeCount: number
  hideReposts: boolean
  hideQuotePosts: boolean
  [key: string]: any
}

/**
 * Bluesky thread view preferences
 */
export interface BskyThreadViewPreference {
  sort: string
  prioritizeFollowedUsers: boolean
  [key: string]: any
}

/**
 * Bluesky preferences
 */
export interface BskyPreferences {
  feeds: {
    saved?: string[]
    pinned?: string[]
  }
  feedViewPrefs: Record<string, BskyFeedViewPreference>
  threadViewPrefs: BskyThreadViewPreference
  adultContentEnabled: boolean
  contentLabels: Record<string, BskyLabelPreference>
  birthDate: Date | undefined
}