@atproto/api 0.18.13 → 0.18.15

package/src/client/types/app/bsky/actor/defs.ts

@@ -269,6 +269,7 @@ export type Preferences = (
   | $Typed<LabelersPref>
   | $Typed<PostInteractionSettingsPref>
   | $Typed<VerificationPrefs>
+  | $Typed<LiveEventPreferences>
   | { $type: string }
 )[]
 
@@ -618,6 +619,25 @@ export function validateVerificationPrefs<V>(v: V) {
   return validate<VerificationPrefs & V>(v, id, hashVerificationPrefs)
 }
 
+/** Preferences for live events. */
+export interface LiveEventPreferences {
+  $type?: 'app.bsky.actor.defs#liveEventPreferences'
+  /** A list of feed IDs that the user has hidden from live events. */
+  hiddenFeedIds?: string[]
+  /** Whether to hide all feeds from live events. */
+  hideAllFeeds: boolean
+}
+
+const hashLiveEventPreferences = 'liveEventPreferences'
+
+export function isLiveEventPreferences<V>(v: V) {
+  return is$typed(v, id, hashLiveEventPreferences)
+}
+
+export function validateLiveEventPreferences<V>(v: V) {
+  return validate<LiveEventPreferences & V>(v, id, hashLiveEventPreferences)
+}
+
 /** Default post interaction settings for the account. These values should be applied as default values when creating new posts. These refs should mirror the threadgate and postgate records exactly. */
 export interface PostInteractionSettingsPref {
   $type?: 'app.bsky.actor.defs#postInteractionSettingsPref'

package/src/predicate.ts

@@ -47,3 +47,6 @@ export const isValidThreadViewPref = asPredicate(
 export const isValidVerificationPrefs = asPredicate(
   AppBskyActorDefs.validateVerificationPrefs,
 )
+export const isValidLiveEventPreferences = asPredicate(
+  AppBskyActorDefs.validateLiveEventPreferences,
+)

package/src/rich-text/detection.ts

@@ -2,6 +2,7 @@ import TLDs from 'tlds'
 import { AppBskyRichtextFacet } from '../client'
 import { UnicodeString } from './unicode'
 import {
+  CASHTAG_REGEX,
   MENTION_REGEX,
   TAG_REGEX,
   TRAILING_PUNCTUATION_REGEX,
@@ -103,6 +104,34 @@ export function detectFacets(text: UnicodeString): Facet[] | undefined {
       })
     }
   }
+  {
+    // cashtags
+    const re = CASHTAG_REGEX
+    while ((match = re.exec(text.utf16))) {
+      const leading = match[1]
+      let ticker = match[2]
+
+      if (!ticker) continue
+
+      // Normalize to uppercase
+      ticker = ticker.toUpperCase()
+
+      const index = match.index + leading.length
+
+      facets.push({
+        index: {
+          byteStart: text.utf16IndexToUtf8Index(index),
+          byteEnd: text.utf16IndexToUtf8Index(index + 1 + ticker.length), // +1 for $
+        },
+        features: [
+          {
+            $type: 'app.bsky.richtext.facet#tag',
+            tag: '$' + ticker, // Store with $ prefix
+          },
+        ],
+      })
+    }
+  }
   return facets.length > 0 ? facets : undefined
 }
 

package/src/rich-text/util.ts

@@ -10,3 +10,6 @@ export const TRAILING_PUNCTUATION_REGEX = /\p{P}+$/gu
 export const TAG_REGEX =
   // eslint-disable-next-line no-misleading-character-class
   /(^|\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
+
+export const CASHTAG_REGEX =
+  /(^|\s|\()\$([A-Za-z][A-Za-z0-9]{0,4})(?=\s|$|[.,;:!?)"'\u2019])/gu

package/src/types.ts

@@ -158,4 +158,8 @@ export interface BskyPreferences {
   }
   postInteractionSettings: AppBskyActorDefs.PostInteractionSettingsPref
   verificationPrefs: AppBskyActorDefs.VerificationPrefs
+  liveEventPreferences: {
+    hiddenFeedIds: string[]
+    hideAllFeeds: boolean
+  }
 }

package/tests/atp-agent.test.ts

@@ -285,6 +285,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setAdultContentEnabled(true)
@@ -333,6 +337,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setAdultContentEnabled(false)
@@ -381,6 +389,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setContentLabelPref('misinfo', 'hide')
@@ -429,6 +441,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setContentLabelPref('spam', 'ignore')
@@ -481,6 +497,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.addSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -536,6 +556,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -591,6 +615,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.removePinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -646,6 +674,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.removeSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -701,6 +733,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -756,6 +792,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake2')
@@ -817,6 +857,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.removeSavedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -872,6 +916,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setPersonalDetails({ birthDate: '2023-09-11T18:05:42.556Z' })
@@ -932,6 +980,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setFeedViewPrefs('home', { hideReplies: true })
@@ -992,6 +1044,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setFeedViewPrefs('home', { hideReplies: false })
@@ -1052,6 +1108,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setFeedViewPrefs('other', { hideReplies: true })
@@ -1119,6 +1179,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setThreadViewPrefs({ sort: 'random' })
@@ -1186,6 +1250,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setThreadViewPrefs({ sort: 'oldest' })
@@ -1253,6 +1321,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setInterestsPref({ tags: ['foo', 'bar'] })
@@ -1320,6 +1392,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
     })
 
@@ -1518,6 +1594,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setAdultContentEnabled(false)
@@ -1587,6 +1667,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setContentLabelPref('porn', 'ignore')
@@ -1657,6 +1741,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.removeLabeler('did:plc:other')
@@ -1723,6 +1811,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.addPinnedFeed('at://bob.com/app.bsky.feed.generator/fake')
@@ -1789,6 +1881,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setPersonalDetails({ birthDate: '2023-09-11T18:05:42.556Z' })
@@ -1855,6 +1951,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       await agent.setFeedViewPrefs('home', {
@@ -1932,6 +2032,10 @@ describe('agent', () => {
         verificationPrefs: {
           hideBadges: false,
         },
+        liveEventPreferences: {
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        },
       })
 
       const res = await agent.app.bsky.actor.getPreferences()
@@ -3676,6 +3780,82 @@ describe('agent', () => {
       })
     })
 
+    describe('updateLiveEventPreferences', () => {
+      let agent: AtpAgent
+
+      beforeAll(async () => {
+        agent = new AtpAgent({ service: network.pds.url })
+
+        await agent.createAccount({
+          handle: 'live-event-prefs.test',
+          email: 'live-event-prefs@test.com',
+          password: 'password',
+        })
+      })
+
+      it('default state', async () => {
+        const prefs = await agent.getPreferences()
+        expect(prefs.liveEventPreferences).toEqual({
+          hiddenFeedIds: [],
+          hideAllFeeds: false,
+        })
+      })
+
+      it('hideFeed adds a feed id', async () => {
+        await agent.updateLiveEventPreferences({
+          type: 'hideFeed',
+          id: 'feed1',
+        })
+        const prefs = await agent.getPreferences()
+        expect(prefs.liveEventPreferences).toEqual({
+          hiddenFeedIds: ['feed1'],
+          hideAllFeeds: false,
+        })
+      })
+
+      it('hideFeed adds another feed id', async () => {
+        await agent.updateLiveEventPreferences({
+          type: 'hideFeed',
+          id: 'feed2',
+        })
+        const prefs = await agent.getPreferences()
+        expect(prefs.liveEventPreferences).toEqual({
+          hiddenFeedIds: ['feed1', 'feed2'],
+          hideAllFeeds: false,
+        })
+      })
+
+      it('unhideFeed removes a feed id', async () => {
+        await agent.updateLiveEventPreferences({
+          type: 'unhideFeed',
+          id: 'feed1',
+        })
+        const prefs = await agent.getPreferences()
+        expect(prefs.liveEventPreferences).toEqual({
+          hiddenFeedIds: ['feed2'],
+          hideAllFeeds: false,
+        })
+      })
+
+      it('toggleHideAllFeeds toggles the flag', async () => {
+        await agent.updateLiveEventPreferences({ type: 'toggleHideAllFeeds' })
+        const prefs = await agent.getPreferences()
+        expect(prefs.liveEventPreferences).toEqual({
+          hiddenFeedIds: ['feed2'],
+          hideAllFeeds: true,
+        })
+      })
+
+      it('toggleHideAllFeeds toggles back', async () => {
+        await agent.updateLiveEventPreferences({ type: 'toggleHideAllFeeds' })
+        const prefs = await agent.getPreferences()
+        expect(prefs.liveEventPreferences).toEqual({
+          hiddenFeedIds: ['feed2'],
+          hideAllFeeds: false,
+        })
+      })
+    })
+
     // end
   })
 })

package/tests/moderation-prefs.test.ts

@@ -93,6 +93,10 @@ describe('agent', () => {
       verificationPrefs: {
         hideBadges: false,
       },
+      liveEventPreferences: {
+        hiddenFeedIds: [],
+        hideAllFeeds: false,
+      },
     })
   })
 
@@ -149,6 +153,10 @@ describe('agent', () => {
       verificationPrefs: {
         hideBadges: false,
       },
+      liveEventPreferences: {
+        hiddenFeedIds: [],
+        hideAllFeeds: false,
+      },
     })
     expect(agent.labelers).toStrictEqual(['did:plc:other'])
 
@@ -190,6 +198,10 @@ describe('agent', () => {
       verificationPrefs: {
         hideBadges: false,
       },
+      liveEventPreferences: {
+        hiddenFeedIds: [],
+        hideAllFeeds: false,
+      },
     })
     expect(agent.labelers).toStrictEqual([])
   })
@@ -253,6 +265,10 @@ describe('agent', () => {
       verificationPrefs: {
         hideBadges: false,
       },
+      liveEventPreferences: {
+        hiddenFeedIds: [],
+        hideAllFeeds: false,
+      },
     })
   })
 

package/tests/rich-text-detection.test.ts

@@ -371,6 +371,74 @@ describe('detectFacets', () => {
       expect(detectedIndices).toEqual(indices)
     })
   })
+
+  describe('correctly detects cashtags inline', () => {
+    const inputs: [
+      string,
+      string[],
+      { byteStart: number; byteEnd: number }[],
+    ][] = [
+      ['$AAPL', ['$AAPL'], [{ byteStart: 0, byteEnd: 5 }]],
+      ['$aapl', ['$AAPL'], [{ byteStart: 0, byteEnd: 5 }]], // normalized to uppercase
+      ['$A', ['$A'], [{ byteStart: 0, byteEnd: 2 }]],
+      ['$a', ['$A'], [{ byteStart: 0, byteEnd: 2 }]], // single char normalized
+      [
+        '$BTC $ETH',
+        ['$BTC', '$ETH'],
+        [
+          { byteStart: 0, byteEnd: 4 },
+          { byteStart: 5, byteEnd: 9 },
+        ],
+      ],
+      ['$100', [], []], // starts with digit - not a cashtag
+      ['$GOOGL', ['$GOOGL'], [{ byteStart: 0, byteEnd: 6 }]], // 5 chars - max length
+      ['$TOOLONG', [], []], // >5 chars
+      ['check $LEGO now', ['$LEGO'], [{ byteStart: 6, byteEnd: 11 }]],
+      ['($GOOG)', ['$GOOG'], [{ byteStart: 1, byteEnd: 6 }]],
+      ['$AAPL.', ['$AAPL'], [{ byteStart: 0, byteEnd: 5 }]], // trailing punctuation
+      [
+        '$AAPL, $MSFT!',
+        ['$AAPL', '$MSFT'],
+        [
+          { byteStart: 0, byteEnd: 5 },
+          { byteStart: 7, byteEnd: 12 },
+        ],
+      ],
+      ['no$SPACE', [], []], // must have leading space or start
+      ['$', [], []], // just dollar sign
+      ['$ AAPL', [], []], // space after $
+      ['$123ABC', [], []], // starts with digit
+      ['$ABC12', ['$ABC12'], [{ byteStart: 0, byteEnd: 6 }]], // digits after letters OK (5 chars)
+      ['$ABC123', [], []], // 6 chars - too long
+    ]
+
+    it.each(inputs)('%s', (input, tags, indices) => {
+      const rt = new RichText({ text: input })
+      rt.detectFacetsWithoutResolution()
+
+      const detectedTags: string[] = []
+      const detectedIndices: { byteStart: number; byteEnd: number }[] = []
+
+      for (const { facet } of rt.segments()) {
+        if (!facet) continue
+        for (const feature of facet.features) {
+          if (isTag(feature) && feature.tag.startsWith('$')) {
+            detectedTags.push(feature.tag)
+          }
+        }
+        if (
+          facet.features.some(
+            (f) => isTag(f) && (f as any).tag?.startsWith('$'),
+          )
+        ) {
+          detectedIndices.push(facet.index)
+        }
+      }
+
+      expect(detectedTags).toEqual(tags)
+      expect(detectedIndices).toEqual(indices)
+    })
+  })
 })
 
 function segmentToOutput(segment: RichTextSegment): string[] {