@atproto/api 0.11.0-next.0 → 0.11.1

package/src/moderation/util.ts

@@ -1,69 +1,15 @@
-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 {
+  InterpretedLabelValueDefinition,
+  ModerationBehavior,
+  LabelPreference,
+  LabelValueDefinitionFlag,
+} from './types'
 
 export function isQuotedPost(embed: unknown): embed is AppBskyEmbedRecord.View {
   return Boolean(embed && AppBskyEmbedRecord.isView(embed))
@@ -75,12 +21,93 @@ export function isQuotedPostWithMedia(
   return Boolean(embed && AppBskyEmbedRecordWithMedia.isView(embed))
 }
 
-export function toModerationUI(decision: ModerationDecision): ModerationUI {
+export function interpretLabelValueDefinition(
+  def: ComAtprotoLabelDefs.LabelValueDefinition,
+  definedBy: string | undefined,
+): InterpretedLabelValueDefinition {
+  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 = def.adultOnly ? 'blur' : alertOrInform
+    // target=profile, blurs=content
+    behaviors.profile.profileList = alertOrInform
+    behaviors.profile.profileView = alertOrInform
+    // target=content, blurs=content
+    behaviors.content.contentList = 'blur'
+    behaviors.content.contentView = def.adultOnly ? 'blur' : 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'
+    // target=profile, blurs=media
+    behaviors.profile.profileList = alertOrInform
+    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.profileList = alertOrInform
+    behaviors.profile.profileView = alertOrInform
+    // target=content, blurs=none
+    behaviors.content.contentList = alertOrInform
+    behaviors.content.contentView = alertOrInform
+  }
+
+  let defaultSetting: LabelPreference = 'warn'
+  if (def.defaultSetting === 'hide' || def.defaultSetting === 'ignore') {
+    defaultSetting = def.defaultSetting as LabelPreference
+  }
+
+  const flags: LabelValueDefinitionFlag[] = ['no-self']
+  if (def.adultOnly) {
+    flags.push('adult')
+  }
+
   return {
-    cause: decision.cause,
-    filter: decision.filter,
-    blur: decision.blur,
-    alert: decision.alert,
-    noOverride: decision.noOverride,
+    ...def,
+    definedBy,
+    configurable: true,
+    defaultSetting,
+    flags,
+    behaviors,
   }
 }
+
+export function interpretLabelValueDefinitions(
+  labelerView: AppBskyLabelerDefs.LabelerViewDetailed,
+): InterpretedLabelValueDefinition[] {
+  return (labelerView.policies?.labelValueDefinitions || [])
+    .filter(
+      (labelValDef) =>
+        ComAtprotoLabelDefs.validateLabelValueDefinition(labelValDef).success,
+    )
+    .map((labelValDef) =>
+      interpretLabelValueDefinition(labelValDef, labelerView.creator.did),
+    )
+}

package/src/rich-text/detection.ts

@@ -1,6 +1,12 @@
 import TLDs from 'tlds'
 import { AppBskyRichtextFacet } from '../client'
 import { UnicodeString } from './unicode'
+import {
+  URL_REGEX,
+  MENTION_REGEX,
+  TAG_REGEX,
+  TRAILING_PUNCTUATION_REGEX,
+} from './util'
 
 export type Facet = AppBskyRichtextFacet.Main
 
@@ -9,7 +15,7 @@ export function detectFacets(text: UnicodeString): Facet[] | undefined {
   const facets: Facet[] = []
   {
     // mentions
-    const re = /(^|\s|\()(@)([a-zA-Z0-9.-]+)(\b)/g
+    const re = MENTION_REGEX
     while ((match = re.exec(text.utf16))) {
       if (!isValidDomain(match[3]) && !match[3].endsWith('.test')) {
         continue // probably not a handle
@@ -33,8 +39,7 @@ export function detectFacets(text: UnicodeString): Facet[] | undefined {
   }
   {
     // links
-    const re =
-      /(^|\s|\()((https?:\/\/[\S]+)|((?<domain>[a-z][a-z0-9]*(\.[a-z0-9]+)+)[\S]*))/gim
+    const re = URL_REGEX
     while ((match = re.exec(text.utf16))) {
       let uri = match[2]
       if (!uri.startsWith('http')) {
@@ -70,27 +75,28 @@ export function detectFacets(text: UnicodeString): Facet[] | undefined {
     }
   }
   {
-    const re = /(?:^|\s)(#[^\d\s]\S*)(?=\s)?/g
+    const re = TAG_REGEX
     while ((match = re.exec(text.utf16))) {
-      let [tag] = match
-      const hasLeadingSpace = /^\s/.test(tag)
+      let [, leading, tag] = match
 
-      tag = tag.trim().replace(/\p{P}+$/gu, '') // strip ending punctuation
+      if (!tag) continue
 
-      // inclusive of #, max of 64 chars
-      if (tag.length > 66) continue
+      // strip ending punctuation and any spaces
+      tag = tag.trim().replace(TRAILING_PUNCTUATION_REGEX, '')
 
-      const index = match.index + (hasLeadingSpace ? 1 : 0)
+      if (tag.length === 0 || tag.length > 64) continue
+
+      const index = match.index + leading.length
 
       facets.push({
         index: {
           byteStart: text.utf16IndexToUtf8Index(index),
-          byteEnd: text.utf16IndexToUtf8Index(index + tag.length), // inclusive of last char
+          byteEnd: text.utf16IndexToUtf8Index(index + 1 + tag.length),
         },
         features: [
           {
             $type: 'app.bsky.richtext.facet#tag',
-            tag: tag.replace(/^#/, ''),
+            tag: tag,
           },
         ],
       })

package/src/rich-text/util.ts

@@ -0,0 +1,11 @@
+export const MENTION_REGEX = /(^|\s|\()(@)([a-zA-Z0-9.-]+)(\b)/g
+export const URL_REGEX =
+  /(^|\s|\()((https?:\/\/[\S]+)|((?<domain>[a-z][a-z0-9]*(\.[a-z0-9]+)+)[\S]*))/gim
+export const TRAILING_PUNCTUATION_REGEX = /\p{P}+$/gu
+
+/**
+ * `\ufe0f` emoji modifier
+ * `\u00AD\u2060\u200A\u200B\u200C\u200D\u20e2` zero-width spaces (likely incomplete)
+ */
+export const TAG_REGEX =
+  /(^|\s)[#＃]((?!\ufe0f)[^\s\u00AD\u2060\u200A\u200B\u200C\u200D\u20e2]*[^\d\s\p{P}\u00AD\u2060\u200A\u200B\u200C\u200D\u20e2]+[^\s\u00AD\u2060\u200A\u200B\u200C\u200D\u20e2]*)?/gu

package/src/types.ts

@@ -1,5 +1,10 @@
 import { AppBskyActorDefs } from './client'
-import { LabelPreference } from './moderation/types'
+import { ModerationPrefs } from './moderation/types'
+
+/**
+ * Supported proxy targets
+ */
+export type AtprotoServiceType = 'atproto_labeler'
 
 /**
  * Used by the PersistSessionHandler to indicate what change occurred
@@ -67,15 +72,10 @@ export type AtpAgentFetchHandler = (
  * AtpAgent global config opts
  */
 export interface AtpAgentGlobalOpts {
-  fetch: AtpAgentFetchHandler
+  fetch?: AtpAgentFetchHandler
+  appLabelers?: string[]
 }
 
-/**
- * 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,10 +116,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[]
-  hiddenPosts: string[]
 }

package/src/util.ts

@@ -0,0 +1,6 @@
+export function sanitizeMutedWordValue(value: string) {
+  return value
+    .trim()
+    .replace(/^#(?!\ufe0f)/, '')
+    .replace(/[\r\n\u00AD\u2060\u200D\u200C\u200B]+/, '')
+}

package/tests/agent.test.ts

@@ -1,13 +1,16 @@
 import assert from 'assert'
+import getPort from 'get-port'
 import { defaultFetchHandler } from '@atproto/xrpc'
 import {
   AtpAgent,
   AtpAgentFetchHandlerResponse,
   AtpSessionEvent,
   AtpSessionData,
+  BSKY_LABELER_DID,
 } 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
@@ -25,6 +28,14 @@ describe('agent', () => {
     await network.close()
   })
 
+  it('clones correctly', () => {
+    const persistSession = (_evt: AtpSessionEvent, _sess?: AtpSessionData) => {}
+    const agent = new AtpAgent({ service: network.pds.url, persistSession })
+    const agent2 = agent.clone()
+    expect(agent2 instanceof AtpAgent).toBeTruthy()
+    expect(agent.service).toEqual(agent2.service)
+  })
+
   it('creates a new session on account creation.', async () => {
     const events: string[] = []
     const sessions: (AtpSessionData | undefined)[] = []
@@ -479,6 +490,81 @@ describe('agent', () => {
       expect(sessions[0]).toEqual(undefined)
     })
   })
+
+  describe('App labelers header', () => {
+    it('adds the labelers header as expected', async () => {
+      const port = await getPort()
+      const server = await createHeaderEchoServer(port)
+      const agent = new AtpAgent({ service: `http://localhost:${port}` })
+      const agent2 = new AtpAgent({ service: `http://localhost:${port}` })
+
+      const res1 = await agent.com.atproto.server.describeServer()
+      expect(res1.data['atproto-accept-labelers']).toEqual(
+        `${BSKY_LABELER_DID};redact`,
+      )
+
+      AtpAgent.configure({ appLabelers: ['did:plc:test1', 'did:plc:test2'] })
+      const res2 = await agent.com.atproto.server.describeServer()
+      expect(res2.data['atproto-accept-labelers']).toEqual(
+        'did:plc:test1;redact, did:plc:test2;redact',
+      )
+      const res3 = await agent2.com.atproto.server.describeServer()
+      expect(res3.data['atproto-accept-labelers']).toEqual(
+        'did:plc:test1;redact, did:plc:test2;redact',
+      )
+      AtpAgent.configure({ appLabelers: [BSKY_LABELER_DID] })
+
+      await new Promise((r) => server.close(r))
+    })
+  })
+
+  describe('configureLabelersHeader', () => {
+    it('adds the labelers header as expected', async () => {
+      const port = await getPort()
+      const server = await createHeaderEchoServer(port)
+      const agent = new AtpAgent({ service: `http://localhost:${port}` })
+
+      agent.configureLabelersHeader(['did:plc:test1'])
+      const res1 = await agent.com.atproto.server.describeServer()
+      expect(res1.data['atproto-accept-labelers']).toEqual(
+        `${BSKY_LABELER_DID};redact, did:plc:test1`,
+      )
+
+      agent.configureLabelersHeader(['did:plc:test1', 'did:plc:test2'])
+      const res2 = await agent.com.atproto.server.describeServer()
+      expect(res2.data['atproto-accept-labelers']).toEqual(
+        `${BSKY_LABELER_DID};redact, did:plc:test1, did:plc:test2`,
+      )
+
+      await new Promise((r) => server.close(r))
+    })
+  })
+
+  describe('configureProxyHeader', () => {
+    it('adds the proxy header as expected', async () => {
+      const port = await getPort()
+      const server = await createHeaderEchoServer(port)
+      const agent = new AtpAgent({ service: `http://localhost:${port}` })
+
+      const res1 = await agent.com.atproto.server.describeServer()
+      expect(res1.data['atproto-proxy']).toBeFalsy()
+
+      agent.configureProxyHeader('atproto_labeler', 'did:plc:test1')
+      const res2 = await agent.com.atproto.server.describeServer()
+      expect(res2.data['atproto-proxy']).toEqual(
+        'did:plc:test1#atproto_labeler',
+      )
+
+      const res3 = await agent
+        .withProxy('atproto_labeler', 'did:plc:test2')
+        .com.atproto.server.describeServer()
+      expect(res3.data['atproto-proxy']).toEqual(
+        'did:plc:test2#atproto_labeler',
+      )
+
+      await new Promise((r) => server.close(r))
+    })
+  })
 })
 
 const createPost = async (agent: AtpAgent) => {