@atproto/api 0.10.5-next.0 → 0.11.0-next

package/src/moderation/types.ts

@@ -1,72 +1,81 @@
 import {
   AppBskyActorDefs,
   AppBskyFeedDefs,
+  AppBskyNotificationListNotifications,
   AppBskyGraphDefs,
   ComAtprotoLabelDefs,
 } from '../client/index'
+import { KnownLabelValue } from './const/labels'
 
-// labels
+// syntax
 // =
 
-export type Label = ComAtprotoLabelDefs.Label
-
-export type LabelPreference = 'ignore' | 'warn' | 'hide'
-export type LabelDefinitionFlag = 'no-override' | 'adult' | 'unauthed'
-export type LabelDefinitionOnWarnBehavior =
-  | 'blur'
-  | 'blur-media'
-  | 'alert'
-  | null
-
-export interface LabelDefinitionLocalizedStrings {
-  name: string
-  description: string
-}
+export const CUSTOM_LABEL_VALUE_RE = /^[a-z-]+$/
 
-export type LabelDefinitionLocalizedStringsMap = Record<
-  string,
-  LabelDefinitionLocalizedStrings
->
+// behaviors
+// =
 
-export interface LabelDefinition {
-  id: string
-  groupId: string
-  configurable: boolean
-  preferences: LabelPreference[]
-  flags: LabelDefinitionFlag[]
-  onwarn: LabelDefinitionOnWarnBehavior
-  strings: {
-    settings: LabelDefinitionLocalizedStringsMap
-    account: LabelDefinitionLocalizedStringsMap
-    content: LabelDefinitionLocalizedStringsMap
-  }
+export interface ModerationBehavior {
+  profileList?: 'blur' | 'alert' | 'inform'
+  profileView?: 'blur' | 'alert' | 'inform'
+  avatar?: 'blur' | 'alert'
+  banner?: 'blur'
+  displayName?: 'blur'
+  contentList?: 'blur' | 'alert' | 'inform'
+  contentView?: 'blur' | 'alert' | 'inform'
+  contentMedia?: 'blur'
 }
-
-export interface LabelGroupDefinition {
-  id: string
-  configurable: boolean
-  labels: LabelDefinition[]
-  strings: {
-    settings: LabelDefinitionLocalizedStringsMap
-  }
+export const BLOCK_BEHAVIOR: ModerationBehavior = {
+  profileList: 'blur',
+  profileView: 'alert',
+  avatar: 'blur',
+  banner: 'blur',
+  contentList: 'blur',
+  contentView: 'blur',
 }
+export const MUTE_BEHAVIOR: ModerationBehavior = {
+  profileList: 'inform',
+  profileView: 'alert',
+  contentList: 'blur',
+  contentView: 'inform',
+}
+export const HIDE_BEHAVIOR: ModerationBehavior = {
+  contentList: 'blur',
+  contentView: 'blur',
+}
+export const NOOP_BEHAVIOR: ModerationBehavior = {}
 
-export type LabelDefinitionMap = Record<string, LabelDefinition>
-export type LabelGroupDefinitionMap = Record<string, LabelGroupDefinition>
-
-// labelers
+// labels
 // =
 
-interface Labeler {
-  did: string
-  displayName: string
-}
+export type Label = ComAtprotoLabelDefs.Label
+export type LabelTarget = 'account' | 'profile' | 'content'
+export type LabelPreference = 'ignore' | 'warn' | 'hide'
 
-export interface LabelerSettings {
-  labeler: Labeler
-  labels: Record<string, LabelPreference>
+export type LabelValueDefinitionFlag =
+  | 'no-override'
+  | 'adult'
+  | 'unauthed'
+  | 'no-self'
+
+export interface InterprettedLabelValueDefinition
+  extends ComAtprotoLabelDefs.LabelValueDefinition {
+  // identifier: string
+  configurable: boolean
+  defaultSetting: LabelPreference // type narrowing
+  flags: LabelValueDefinitionFlag[]
+  behaviors: {
+    account?: ModerationBehavior
+    profile?: ModerationBehavior
+    content?: ModerationBehavior
+  }
 }
 
+export type LabelDefinitionMap = Record<
+  KnownLabelValue,
+  InterprettedLabelValueDefinition
+>
+
 // subjects
 // =
 
@@ -77,6 +86,9 @@ export type ModerationSubjectProfile =
 
 export type ModerationSubjectPost = AppBskyFeedDefs.PostView
 
+export type ModerationSubjectNotification =
+  AppBskyNotificationListNotifications.Notification
+
 export type ModerationSubjectFeedGenerator = AppBskyFeedDefs.GeneratorView
 
 export type ModerationSubjectUserList =
@@ -86,6 +98,7 @@ export type ModerationSubjectUserList =
 export type ModerationSubject =
   | ModerationSubjectProfile
   | ModerationSubjectPost
+  | ModerationSubjectNotification
   | ModerationSubjectFeedGenerator
   | ModerationSubjectUserList
 
@@ -95,7 +108,7 @@ export type ModerationSubject =
 export type ModerationCauseSource =
   | { type: 'user' }
   | { type: 'list'; list: AppBskyGraphDefs.ListViewBasic }
-  | { type: 'labeler'; labeler: Labeler }
+  | { type: 'labeler'; did: string }
 
 export type ModerationCause =
   | { type: 'blocking'; source: ModerationCauseSource; priority: 3 }
@@ -105,40 +118,31 @@ export type ModerationCause =
       type: 'label'
       source: ModerationCauseSource
       label: Label
-      labelDef: LabelDefinition
+      labelDef: InterprettedLabelValueDefinition
       setting: LabelPreference
+      behavior: ModerationBehavior
+      noOverride: boolean
       priority: 1 | 2 | 5 | 7 | 8
     }
   | { type: 'muted'; source: ModerationCauseSource; priority: 6 }
+  | { type: 'hidden'; source: ModerationCauseSource; priority: 6 }
 
-export interface ModerationOpts {
-  userDid: string
-  adultContentEnabled: boolean
+export interface ModerationPrefsModerator {
+  did: string
   labels: Record<string, LabelPreference>
-  labelers: LabelerSettings[]
 }
 
-export class ModerationDecision {
-  static noop() {
-    return new ModerationDecision()
-  }
-
-  constructor(
-    public cause: ModerationCause | undefined = undefined,
-    public alert: boolean = false,
-    public blur: boolean = false,
-    public blurMedia: boolean = false,
-    public filter: boolean = false,
-    public noOverride: boolean = false,
-    public additionalCauses: ModerationCause[] = [],
-    public did: string = '',
-  ) {}
+export interface ModerationPrefs {
+  adultContentEnabled: boolean
+  labels: Record<string, LabelPreference>
+  mods: ModerationPrefsModerator[]
 }
 
-export interface ModerationUI {
-  filter?: boolean
-  blur?: boolean
-  alert?: boolean
-  cause?: ModerationCause
-  noOverride?: boolean
+export interface ModerationOpts {
+  userDid: string | undefined
+  prefs: ModerationPrefs
+  /**
+   * Map of labeler did -> custom definitions
+   */
+  labelDefs?: Record<string, InterprettedLabelValueDefinition[]>
 }

package/src/moderation/ui.ts

@@ -0,0 +1,21 @@
+import { ModerationCause } from './types'
+
+export class ModerationUI {
+  noOverride: boolean = false
+  filters: ModerationCause[] = []
+  blurs: ModerationCause[] = []
+  alerts: ModerationCause[] = []
+  informs: ModerationCause[] = []
+  get filter(): boolean {
+    return this.filters.length !== 0
+  }
+  get blur(): boolean {
+    return this.blurs.length !== 0
+  }
+  get alert(): boolean {
+    return this.alerts.length !== 0
+  }
+  get inform(): boolean {
+    return this.informs.length !== 0
+  }
+}

package/src/moderation/util.ts

@@ -1,69 +1,10 @@
-import { AppBskyEmbedRecord, AppBskyEmbedRecordWithMedia } from '../client'
-import { ModerationDecision, ModerationUI } from './types'
-
-export function takeHighestPriorityDecision(
-  ...decisions: (ModerationDecision | undefined)[]
-): ModerationDecision {
-  // remove undefined decisions
-  const filtered = decisions.filter((d) => !!d) as ModerationDecision[]
-  if (filtered.length === 0) {
-    return ModerationDecision.noop()
-  }
-
-  // sort by highest priority
-  filtered.sort((a, b) => {
-    if (a.cause && b.cause) {
-      return a.cause.priority - b.cause.priority
-    }
-    if (a.cause) {
-      return -1
-    }
-    if (b.cause) {
-      return 1
-    }
-    return 0
-  })
-
-  // use the top priority
-  return filtered[0]
-}
-
-export function downgradeDecision(
-  decision: ModerationDecision,
-  to: 'blur' | 'alert' | 'noop',
-) {
-  decision.filter = false
-  decision.noOverride = false
-  if (to === 'noop') {
-    decision.blur = false
-    decision.blurMedia = false
-    decision.alert = false
-    delete decision.cause
-  } else if (to === 'alert') {
-    decision.blur = false
-    decision.blurMedia = false
-    decision.alert = true
-  }
-}
-
-export function isModerationDecisionNoop(
-  decision: ModerationDecision | undefined,
-  { ignoreFilter }: { ignoreFilter: boolean } = { ignoreFilter: false },
-): boolean {
-  if (!decision) {
-    return true
-  }
-  if (decision.alert) {
-    return false
-  }
-  if (decision.blur) {
-    return false
-  }
-  if (decision.filter && !ignoreFilter) {
-    return false
-  }
-  return true
-}
+import {
+  AppBskyEmbedRecord,
+  AppBskyEmbedRecordWithMedia,
+  AppBskyLabelerDefs,
+  ComAtprotoLabelDefs,
+} from '../client'
+import { InterprettedLabelValueDefinition, ModerationBehavior } from './types'
 
 export function isQuotedPost(embed: unknown): embed is AppBskyEmbedRecord.View {
   return Boolean(embed && AppBskyEmbedRecord.isView(embed))
@@ -75,12 +16,81 @@ export function isQuotedPostWithMedia(
   return Boolean(embed && AppBskyEmbedRecordWithMedia.isView(embed))
 }
 
-export function toModerationUI(decision: ModerationDecision): ModerationUI {
+export function interpretLabelValueDefinition(
+  def: ComAtprotoLabelDefs.LabelValueDefinition,
+): InterprettedLabelValueDefinition {
+  const behaviors: {
+    account: ModerationBehavior
+    profile: ModerationBehavior
+    content: ModerationBehavior
+  } = {
+    account: {},
+    profile: {},
+    content: {},
+  }
+  const alertOrInform: 'alert' | 'inform' | undefined =
+    def.severity === 'alert'
+      ? 'alert'
+      : def.severity === 'inform'
+      ? 'inform'
+      : undefined
+  if (def.blurs === 'content') {
+    // target=account, blurs=content
+    behaviors.account.profileList = alertOrInform
+    behaviors.account.profileView = alertOrInform
+    behaviors.account.contentList = 'blur'
+    behaviors.account.contentView = alertOrInform
+    // target=profile, blurs=content
+    behaviors.account.profileView = alertOrInform
+    behaviors.profile.avatar = 'blur'
+    behaviors.profile.banner = 'blur'
+    behaviors.profile.displayName = 'blur'
+    // target=content, blurs=content
+    behaviors.content.contentList = 'blur'
+    behaviors.content.contentView = alertOrInform
+  } else if (def.blurs === 'media') {
+    // target=account, blurs=media
+    behaviors.account.profileList = alertOrInform
+    behaviors.account.profileView = alertOrInform
+    behaviors.account.avatar = 'blur'
+    behaviors.account.banner = 'blur'
+    behaviors.account.contentMedia = 'blur'
+    // target=profile, blurs=media
+    behaviors.profile.profileView = alertOrInform
+    behaviors.profile.avatar = 'blur'
+    behaviors.profile.banner = 'blur'
+    // target=content, blurs=media
+    behaviors.content.contentMedia = 'blur'
+  } else if (def.blurs === 'none') {
+    // target=account, blurs=none
+    behaviors.account.profileList = alertOrInform
+    behaviors.account.profileView = alertOrInform
+    behaviors.account.contentList = alertOrInform
+    behaviors.account.contentView = alertOrInform
+    // target=profile, blurs=none
+    behaviors.profile.profileView = alertOrInform
+    // target=content, blurs=none
+    behaviors.content.contentList = alertOrInform
+    behaviors.content.contentView = alertOrInform
+  }
+
   return {
-    cause: decision.cause,
-    filter: decision.filter,
-    blur: decision.blur,
-    alert: decision.alert,
-    noOverride: decision.noOverride,
+    ...def,
+    configurable: true,
+    defaultSetting: 'warn',
+    flags: ['no-self'],
+    behaviors,
   }
 }
+
+export function interpretLabelValueDefinitions(
+  modserviceView: AppBskyLabelerDefs.LabelerViewDetailed,
+): InterprettedLabelValueDefinition[] {
+  return (modserviceView.policies?.labelValueDefinitions || [])
+    .filter(
+      (labelValDef) =>
+        ComAtprotoLabelDefs.isLabelValueDefinition(labelValDef) &&
+        ComAtprotoLabelDefs.validateLabelValueDefinition(labelValDef).success,
+    )
+    .map((labelValDef) => interpretLabelValueDefinition(labelValDef))
+}

package/src/types.ts

@@ -1,5 +1,5 @@
 import { AppBskyActorDefs } from './client'
-import { LabelPreference } from './moderation/types'
+import { ModerationPrefs } from './moderation/types'
 
 /**
  * Used by the PersistSessionHandler to indicate what change occurred
@@ -70,12 +70,6 @@ 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
  */
@@ -116,8 +110,7 @@ export interface BskyPreferences {
   }
   feedViewPrefs: Record<string, BskyFeedViewPreference>
   threadViewPrefs: BskyThreadViewPreference
-  adultContentEnabled: boolean
-  contentLabels: Record<string, BskyLabelPreference>
+  moderationPrefs: ModerationPrefs
   birthDate: Date | undefined
   interests: BskyInterestsPreference
   mutedWords: AppBskyActorDefs.MutedWord[]

package/tests/agent.test.ts

@@ -8,6 +8,7 @@ import {
 } from '..'
 import { TestNetworkNoAppView } from '@atproto/dev-env'
 import { getPdsEndpoint, isValidDidDoc } from '@atproto/common-web'
+import { createHeaderEchoServer } from './util/echo-server'
 
 describe('agent', () => {
   let network: TestNetworkNoAppView
@@ -479,6 +480,25 @@ describe('agent', () => {
       expect(sessions[0]).toEqual(undefined)
     })
   })
+
+  describe('configureLabelersHeader', () => {
+    it('adds the labelers header as expected', async () => {
+      const server = await createHeaderEchoServer(15991)
+      const agent = new AtpAgent({ service: 'http://localhost:15991' })
+
+      agent.configureLabelersHeader(['did:plc:test1'])
+      const res1 = await agent.com.atproto.server.describeServer()
+      expect(res1.data['atproto-labelers']).toEqual('did:plc:test1')
+
+      agent.configureLabelersHeader(['did:plc:test1', 'did:plc:test2'])
+      const res2 = await agent.com.atproto.server.describeServer()
+      expect(res2.data['atproto-labelers']).toEqual(
+        'did:plc:test1,did:plc:test2',
+      )
+
+      await new Promise((r) => server.close(r))
+    })
+  })
 })
 
 const createPost = async (agent: AtpAgent) => {