@atproto/api 0.20.22 → 0.20.25

package/src/mocker.ts

@@ -1,220 +0,0 @@
-import {
-  AppBskyActorDefs,
-  AppBskyEmbedRecord,
-  AppBskyFeedDefs,
-  AppBskyFeedPost,
-  AppBskyGraphDefs,
-  AppBskyNotificationListNotifications,
-  ComAtprotoLabelDefs,
-} from './client/index.js'
-import { $Typed, Un$Typed } from './client/util.js'
-
-const FAKE_CID = 'bafyreiclp443lavogvhj3d2ob2cxbfuscni2k5jk7bebjzg7khl3esabwq'
-
-export const mock = {
-  post({
-    text,
-    facets,
-    reply,
-    embed,
-  }: {
-    text: string
-    facets?: AppBskyFeedPost.Record['facets']
-    reply?: AppBskyFeedPost.ReplyRef
-    embed?: AppBskyFeedPost.Record['embed']
-  }): $Typed<AppBskyFeedPost.Record> {
-    return {
-      $type: 'app.bsky.feed.post',
-      text,
-      facets,
-      reply,
-      embed,
-      langs: ['en'],
-      createdAt: new Date().toISOString(),
-    }
-  },
-
-  postView({
-    record,
-    author,
-    embed,
-    replyCount,
-    repostCount,
-    likeCount,
-    viewer,
-    labels,
-  }: {
-    record: AppBskyFeedPost.Record
-    author: AppBskyActorDefs.ProfileViewBasic
-    embed?: AppBskyFeedDefs.PostView['embed']
-    replyCount?: number
-    repostCount?: number
-    likeCount?: number
-    viewer?: AppBskyFeedDefs.ViewerState
-    labels?: ComAtprotoLabelDefs.Label[]
-  }): $Typed<AppBskyFeedDefs.PostView> {
-    return {
-      $type: 'app.bsky.feed.defs#postView',
-      uri: `at://${author.did}/app.bsky.feed.post/fake`,
-      cid: FAKE_CID,
-      author,
-      record,
-      embed,
-      replyCount,
-      repostCount,
-      likeCount,
-      indexedAt: new Date().toISOString(),
-      viewer,
-      labels,
-    }
-  },
-
-  embedRecordView({
-    record,
-    author,
-    labels,
-  }: {
-    record: AppBskyFeedPost.Record
-    author: AppBskyActorDefs.ProfileViewBasic
-    labels?: ComAtprotoLabelDefs.Label[]
-  }): $Typed<AppBskyEmbedRecord.View> {
-    return {
-      $type: 'app.bsky.embed.record#view',
-      record: {
-        $type: 'app.bsky.embed.record#viewRecord',
-        uri: `at://${author.did}/app.bsky.feed.post/fake`,
-        cid: FAKE_CID,
-        author,
-        value: record,
-        labels,
-        indexedAt: new Date().toISOString(),
-      },
-    }
-  },
-
-  profileViewBasic({
-    handle,
-    displayName,
-    description,
-    viewer,
-    labels,
-  }: {
-    handle: string
-    displayName?: string
-    description?: string
-    viewer?: AppBskyActorDefs.ViewerState
-    labels?: ComAtprotoLabelDefs.Label[]
-  }): AppBskyActorDefs.ProfileViewBasic {
-    return {
-      did: `did:web:${handle}`,
-      handle,
-      displayName,
-      // @ts-expect-error technically not in ProfileViewBasic but useful in some cases
-      description,
-      viewer,
-      labels,
-    }
-  },
-
-  actorViewerState({
-    muted,
-    mutedByList,
-    blockedBy,
-    blocking,
-    blockingByList,
-    following,
-    followedBy,
-  }: {
-    muted?: boolean
-    mutedByList?: AppBskyGraphDefs.ListViewBasic
-    blockedBy?: boolean
-    blocking?: string
-    blockingByList?: AppBskyGraphDefs.ListViewBasic
-    following?: string
-    followedBy?: string
-  }): AppBskyActorDefs.ViewerState {
-    return {
-      muted,
-      mutedByList,
-      blockedBy,
-      blocking,
-      blockingByList,
-      following,
-      followedBy,
-    }
-  },
-
-  listViewBasic({ name }: { name: string }): AppBskyGraphDefs.ListViewBasic {
-    return {
-      uri: 'at://did:plc:fake/app.bsky.graph.list/fake',
-      cid: FAKE_CID,
-      name,
-      purpose: 'app.bsky.graph.defs#modlist',
-      indexedAt: new Date().toISOString(),
-    }
-  },
-
-  replyNotification({
-    author,
-    record,
-    labels,
-  }: {
-    record: AppBskyFeedPost.Record
-    author: Un$Typed<AppBskyActorDefs.ProfileViewBasic>
-    labels?: ComAtprotoLabelDefs.Label[]
-  }): AppBskyNotificationListNotifications.Notification {
-    return {
-      uri: `at://${author.did}/app.bsky.feed.post/fake`,
-      cid: FAKE_CID,
-      author,
-      reason: 'reply',
-      reasonSubject: `at://${author.did}/app.bsky.feed.post/fake-parent`,
-      record,
-      isRead: false,
-      indexedAt: new Date().toISOString(),
-      labels,
-    }
-  },
-
-  followNotification({
-    author,
-    subjectDid,
-    labels,
-  }: {
-    author: Un$Typed<AppBskyActorDefs.ProfileViewBasic>
-    subjectDid: string
-    labels?: ComAtprotoLabelDefs.Label[]
-  }): AppBskyNotificationListNotifications.Notification {
-    return {
-      uri: `at://${author.did}/app.bsky.graph.follow/fake`,
-      cid: FAKE_CID,
-      author,
-      reason: 'follow',
-      record: {
-        $type: 'app.bsky.graph.follow',
-        createdAt: new Date().toISOString(),
-        subject: subjectDid,
-      },
-      isRead: false,
-      indexedAt: new Date().toISOString(),
-      labels,
-    }
-  },
-
-  label({
-    val,
-    uri,
-    src,
-  }: {
-    val: string
-    uri: string
-    src?: string
-  }): ComAtprotoLabelDefs.Label {
-    return {
-      src: src || 'did:plc:fake-labeler',
-      uri,
-      val,
-      cts: new Date().toISOString(),
-    }
-  },
-}

package/src/moderation/decision.ts

@@ -1,389 +0,0 @@
-import { AppBskyGraphDefs } from '../client/index.js'
-import { LABELS } from './const/labels.js'
-import { MuteWordMatch } from './mutewords.js'
-import {
-  BLOCK_BEHAVIOR,
-  CUSTOM_LABEL_VALUE_RE,
-  HIDE_BEHAVIOR,
-  Label,
-  LabelPreference,
-  LabelTarget,
-  MUTEWORD_BEHAVIOR,
-  MUTE_BEHAVIOR,
-  ModerationBehavior,
-  ModerationCause,
-  ModerationOpts,
-  NOOP_BEHAVIOR,
-} from './types.js'
-import { ModerationUI } from './ui.js'
-
-enum ModerationBehaviorSeverity {
-  High,
-  Medium,
-  Low,
-}
-
-export class ModerationDecision {
-  did = ''
-  isMe = false
-  causes: ModerationCause[] = []
-
-  constructor() {}
-
-  static merge(
-    ...decisions: (ModerationDecision | undefined)[]
-  ): ModerationDecision {
-    const decisionsFiltered = decisions.filter((v) => v != null)
-    const decision = new ModerationDecision()
-    if (decisionsFiltered[0]) {
-      decision.did = decisionsFiltered[0].did
-      decision.isMe = decisionsFiltered[0].isMe
-    }
-    decision.causes = decisionsFiltered.flatMap((d) => d.causes)
-    return decision
-  }
-
-  downgrade() {
-    for (const cause of this.causes) {
-      cause.downgraded = true
-    }
-    return this
-  }
-
-  get blocked() {
-    return !!this.blockCause
-  }
-
-  get muted() {
-    return !!this.muteCause
-  }
-
-  get blockCause() {
-    return this.causes.find(
-      (cause) =>
-        cause.type === 'blocking' ||
-        cause.type === 'blocked-by' ||
-        cause.type === 'block-other',
-    )
-  }
-
-  get muteCause() {
-    return this.causes.find((cause) => cause.type === 'muted')
-  }
-
-  get labelCauses() {
-    return this.causes.filter((cause) => cause.type === 'label')
-  }
-
-  ui(context: keyof ModerationBehavior): ModerationUI {
-    const ui = new ModerationUI()
-    for (const cause of this.causes) {
-      if (
-        cause.type === 'blocking' ||
-        cause.type === 'blocked-by' ||
-        cause.type === 'block-other'
-      ) {
-        if (this.isMe) {
-          continue
-        }
-        if (context === 'profileList' || context === 'contentList') {
-          ui.filters.push(cause)
-        }
-        if (!cause.downgraded) {
-          if (BLOCK_BEHAVIOR[context] === 'blur') {
-            ui.noOverride = true
-            ui.blurs.push(cause)
-          } else if (BLOCK_BEHAVIOR[context] === 'alert') {
-            ui.alerts.push(cause)
-          } else if (BLOCK_BEHAVIOR[context] === 'inform') {
-            ui.informs.push(cause)
-          }
-        }
-      } else if (cause.type === 'muted') {
-        if (this.isMe) {
-          continue
-        }
-        if (context === 'profileList' || context === 'contentList') {
-          ui.filters.push(cause)
-        }
-        if (!cause.downgraded) {
-          if (MUTE_BEHAVIOR[context] === 'blur') {
-            ui.blurs.push(cause)
-          } else if (MUTE_BEHAVIOR[context] === 'alert') {
-            ui.alerts.push(cause)
-          } else if (MUTE_BEHAVIOR[context] === 'inform') {
-            ui.informs.push(cause)
-          }
-        }
-      } else if (cause.type === 'mute-word') {
-        if (this.isMe) {
-          continue
-        }
-        if (context === 'contentList') {
-          ui.filters.push(cause)
-        }
-        if (!cause.downgraded) {
-          if (MUTEWORD_BEHAVIOR[context] === 'blur') {
-            ui.blurs.push(cause)
-          } else if (MUTEWORD_BEHAVIOR[context] === 'alert') {
-            ui.alerts.push(cause)
-          } else if (MUTEWORD_BEHAVIOR[context] === 'inform') {
-            ui.informs.push(cause)
-          }
-        }
-      } else if (cause.type === 'hidden') {
-        if (context === 'profileList' || context === 'contentList') {
-          ui.filters.push(cause)
-        }
-        if (!cause.downgraded) {
-          if (HIDE_BEHAVIOR[context] === 'blur') {
-            ui.blurs.push(cause)
-          } else if (HIDE_BEHAVIOR[context] === 'alert') {
-            ui.alerts.push(cause)
-          } else if (HIDE_BEHAVIOR[context] === 'inform') {
-            ui.informs.push(cause)
-          }
-        }
-      } else if (cause.type === 'label') {
-        if (context === 'profileList' && cause.target === 'account') {
-          if (cause.setting === 'hide' && !this.isMe) {
-            ui.filters.push(cause)
-          }
-        } else if (
-          context === 'contentList' &&
-          (cause.target === 'account' || cause.target === 'content')
-        ) {
-          if (cause.setting === 'hide' && !this.isMe) {
-            ui.filters.push(cause)
-          }
-        }
-        if (!cause.downgraded) {
-          if (cause.behavior[context] === 'blur') {
-            ui.blurs.push(cause)
-            if (cause.noOverride && !this.isMe) {
-              ui.noOverride = true
-            }
-          } else if (cause.behavior[context] === 'alert') {
-            ui.alerts.push(cause)
-          } else if (cause.behavior[context] === 'inform') {
-            ui.informs.push(cause)
-          }
-        }
-      }
-    }
-
-    ui.filters.sort(sortByPriority)
-    ui.blurs.sort(sortByPriority)
-
-    return ui
-  }
-
-  setDid(did: string) {
-    this.did = did
-  }
-
-  setIsMe(isMe: boolean) {
-    this.isMe = isMe
-  }
-
-  addHidden(hidden: boolean) {
-    if (hidden) {
-      this.causes.push({
-        type: 'hidden',
-        source: { type: 'user' },
-        priority: 6,
-      })
-    }
-  }
-
-  addMutedWord(matches: MuteWordMatch[] | undefined) {
-    if (matches?.length) {
-      this.causes.push({
-        type: 'mute-word',
-        source: { type: 'user' },
-        priority: 6,
-        matches,
-      })
-    }
-  }
-
-  addBlocking(blocking: string | undefined) {
-    if (blocking) {
-      this.causes.push({
-        type: 'blocking',
-        source: { type: 'user' },
-        priority: 3,
-      })
-    }
-  }
-
-  addBlockingByList(
-    blockingByList: AppBskyGraphDefs.ListViewBasic | undefined,
-  ) {
-    if (blockingByList) {
-      this.causes.push({
-        type: 'blocking',
-        source: { type: 'list', list: blockingByList },
-        priority: 3,
-      })
-    }
-  }
-
-  addBlockedBy(blockedBy: boolean | undefined) {
-    if (blockedBy) {
-      this.causes.push({
-        type: 'blocked-by',
-        source: { type: 'user' },
-        priority: 4,
-      })
-    }
-  }
-
-  addBlockOther(blockOther: boolean | undefined) {
-    if (blockOther) {
-      this.causes.push({
-        type: 'block-other',
-        source: { type: 'user' },
-        priority: 4,
-      })
-    }
-  }
-
-  addLabel(target: LabelTarget, label: Label, opts: ModerationOpts) {
-    // look up the label definition
-    const labelDef = CUSTOM_LABEL_VALUE_RE.test(label.val)
-      ? opts.labelDefs?.[label.src]?.find(
-          (def) => def.identifier === label.val,
-        ) || LABELS[label.val]
-      : LABELS[label.val]
-    if (!labelDef) {
-      // ignore labels we don't understand
-      return
-    }
-
-    // look up the label preference
-    const isSelf = label.src === this.did
-    const labeler = isSelf
-      ? undefined
-      : opts.prefs.labelers.find((s) => s.did === label.src)
-
-    if (!isSelf && !labeler) {
-      return // skip labelers not configured by the user
-    }
-    if (isSelf && labelDef.flags.includes('no-self')) {
-      return // skip self-labels that aren't supported
-    }
-
-    // establish the label preference for interpretation
-    let labelPref: LabelPreference = labelDef.defaultSetting || 'ignore'
-    if (!labelDef.configurable) {
-      labelPref = labelDef.defaultSetting || 'hide'
-    } else if (
-      labelDef.flags.includes('adult') &&
-      !opts.prefs.adultContentEnabled
-    ) {
-      labelPref = 'hide'
-    } else if (labeler?.labels[labelDef.identifier]) {
-      labelPref = labeler?.labels[labelDef.identifier]
-    } else if (opts.prefs.labels[labelDef.identifier]) {
-      labelPref = opts.prefs.labels[labelDef.identifier]
-    }
-
-    // ignore labels the user has asked to ignore
-    if (labelPref === 'ignore') {
-      return
-    }
-
-    // ignore 'unauthed' labels when the user is authed
-    if (labelDef.flags.includes('unauthed') && !!opts.userDid) {
-      return
-    }
-
-    // establish the priority of the label
-    let priority: 1 | 2 | 5 | 7 | 8
-    const severity = measureModerationBehaviorSeverity(
-      labelDef.behaviors[target],
-    )
-    if (
-      labelDef.flags.includes('no-override') ||
-      (labelDef.flags.includes('adult') && !opts.prefs.adultContentEnabled)
-    ) {
-      priority = 1
-    } else if (labelPref === 'hide') {
-      priority = 2
-    } else if (severity === ModerationBehaviorSeverity.High) {
-      // blurring profile view or content view
-      priority = 5
-    } else if (severity === ModerationBehaviorSeverity.Medium) {
-      // blurring content list or content media
-      priority = 7
-    } else {
-      // blurring avatar, adding alerts
-      priority = 8
-    }
-
-    let noOverride = false
-    if (labelDef.flags.includes('no-override')) {
-      noOverride = true
-    } else if (
-      labelDef.flags.includes('adult') &&
-      !opts.prefs.adultContentEnabled
-    ) {
-      noOverride = true
-    }
-
-    this.causes.push({
-      type: 'label',
-      source:
-        isSelf || !labeler
-          ? { type: 'user' }
-          : { type: 'labeler', did: labeler.did },
-      label,
-      labelDef,
-      target,
-      setting: labelPref,
-      behavior: labelDef.behaviors[target] || NOOP_BEHAVIOR,
-      noOverride,
-      priority,
-    })
-  }
-
-  addMuted(muted: boolean | undefined) {
-    if (muted) {
-      this.causes.push({
-        type: 'muted',
-        source: { type: 'user' },
-        priority: 6,
-      })
-    }
-  }
-
-  addMutedByList(mutedByList: AppBskyGraphDefs.ListViewBasic | undefined) {
-    if (mutedByList) {
-      this.causes.push({
-        type: 'muted',
-        source: { type: 'list', list: mutedByList },
-        priority: 6,
-      })
-    }
-  }
-}
-
-function measureModerationBehaviorSeverity(
-  beh: ModerationBehavior | undefined,
-): ModerationBehaviorSeverity {
-  if (!beh) {
-    return ModerationBehaviorSeverity.Low
-  }
-  if (beh.profileView === 'blur' || beh.contentView === 'blur') {
-    return ModerationBehaviorSeverity.High
-  }
-  if (beh.contentList === 'blur' || beh.contentMedia === 'blur') {
-    return ModerationBehaviorSeverity.Medium
-  }
-  return ModerationBehaviorSeverity.Low
-}
-
-function sortByPriority(a: ModerationCause, b: ModerationCause) {
-  return a.priority - b.priority
-}

package/src/moderation/index.ts

@@ -1,69 +0,0 @@
-import { ModerationDecision } from './decision.js'
-import { decideAccount } from './subjects/account.js'
-import { decideFeedGenerator } from './subjects/feed-generator.js'
-import { decideNotification } from './subjects/notification.js'
-import { decidePost } from './subjects/post.js'
-import { decideProfile } from './subjects/profile.js'
-import { decideStatus } from './subjects/status.js'
-import { decideUserList } from './subjects/user-list.js'
-import {
-  ModerationOpts,
-  ModerationSubjectFeedGenerator,
-  ModerationSubjectNotification,
-  ModerationSubjectPost,
-  ModerationSubjectProfile,
-  ModerationSubjectUserList,
-} from './types.js'
-
-export { ModerationUI } from './ui.js'
-export { ModerationDecision } from './decision.js'
-export { hasMutedWord, matchMuteWords } from './mutewords.js'
-export {
-  interpretLabelValueDefinition,
-  interpretLabelValueDefinitions,
-} from './util.js'
-
-export function moderateProfile(
-  subject: ModerationSubjectProfile,
-  opts: ModerationOpts,
-): ModerationDecision {
-  return ModerationDecision.merge(
-    decideAccount(subject, opts),
-    decideProfile(subject, opts),
-  )
-}
-
-export function moderatePost(
-  subject: ModerationSubjectPost,
-  opts: ModerationOpts,
-): ModerationDecision {
-  return decidePost(subject, opts)
-}
-
-export function moderateNotification(
-  subject: ModerationSubjectNotification,
-  opts: ModerationOpts,
-): ModerationDecision {
-  return decideNotification(subject, opts)
-}
-
-export function moderateFeedGenerator(
-  subject: ModerationSubjectFeedGenerator,
-  opts: ModerationOpts,
-): ModerationDecision {
-  return decideFeedGenerator(subject, opts)
-}
-
-export function moderateUserList(
-  subject: ModerationSubjectUserList,
-  opts: ModerationOpts,
-): ModerationDecision {
-  return decideUserList(subject, opts)
-}
-
-export function moderateStatus(
-  subject: ModerationSubjectProfile,
-  opts: ModerationOpts,
-): ModerationDecision {
-  return decideStatus(subject, opts)
-}