@atproto/api 0.12.4 → 0.12.6

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

@@ -132,6 +132,7 @@ export type Preferences = (
   | AdultContentPref
   | ContentLabelPref
   | SavedFeedsPref
+  | SavedFeedsPrefV2
   | PersonalDetailsPref
   | FeedViewPref
   | ThreadViewPref
@@ -178,6 +179,43 @@ export function validateContentLabelPref(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.actor.defs#contentLabelPref', v)
 }
 
+export interface SavedFeed {
+  id: string
+  type: 'feed' | 'list' | 'timeline' | (string & {})
+  value: string
+  pinned: boolean
+  [k: string]: unknown
+}
+
+export function isSavedFeed(v: unknown): v is SavedFeed {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.actor.defs#savedFeed'
+  )
+}
+
+export function validateSavedFeed(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.actor.defs#savedFeed', v)
+}
+
+export interface SavedFeedsPrefV2 {
+  items: SavedFeed[]
+  [k: string]: unknown
+}
+
+export function isSavedFeedsPrefV2(v: unknown): v is SavedFeedsPrefV2 {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.actor.defs#savedFeedsPrefV2'
+  )
+}
+
+export function validateSavedFeedsPrefV2(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.actor.defs#savedFeedsPrefV2', v)
+}
+
 export interface SavedFeedsPref {
   pinned: string[]
   saved: string[]

package/src/types.ts

@@ -26,6 +26,7 @@ export interface AtpSessionData {
   did: string
   email?: string
   emailConfirmed?: boolean
+  emailAuthFactor?: boolean
 }
 
 /**
@@ -50,6 +51,7 @@ export interface AtpAgentOpts {
 export interface AtpAgentLoginOpts {
   identifier: string
   password: string
+  authFactorToken?: string | undefined
 }
 
 /**
@@ -110,10 +112,14 @@ export interface BskyInterestsPreference {
  * Bluesky preferences
  */
 export interface BskyPreferences {
+  /**
+   * @deprecated use `savedFeeds`
+   */
   feeds: {
     saved?: string[]
     pinned?: string[]
   }
+  savedFeeds: AppBskyActorDefs.SavedFeed[]
   feedViewPrefs: Record<string, BskyFeedViewPreference>
   threadViewPrefs: BskyThreadViewPreference
   moderationPrefs: ModerationPrefs

package/src/util.ts

@@ -1,6 +1,78 @@
+import { AtUri } from '@atproto/syntax'
+import { TID } from '@atproto/common-web'
+
+import { AppBskyActorDefs } from './client'
+
 export function sanitizeMutedWordValue(value: string) {
   return value
     .trim()
     .replace(/^#(?!\ufe0f)/, '')
     .replace(/[\r\n\u00AD\u2060\u200D\u200C\u200B]+/, '')
 }
+
+export function savedFeedsToUriArrays(
+  savedFeeds: AppBskyActorDefs.SavedFeed[],
+): {
+  pinned: string[]
+  saved: string[]
+} {
+  const pinned: string[] = []
+  const saved: string[] = []
+
+  for (const feed of savedFeeds) {
+    if (feed.pinned) {
+      pinned.push(feed.value)
+      // saved in v1 includes pinned
+      saved.push(feed.value)
+    } else {
+      saved.push(feed.value)
+    }
+  }
+
+  return {
+    pinned,
+    saved,
+  }
+}
+
+/**
+ * Get the type of a saved feed, used by deprecated methods for backwards
+ * compat. Should not be used moving forward. *Invalid URIs will throw.*
+ *
+ * @param uri - The AT URI of the saved feed
+ */
+export function getSavedFeedType(
+  uri: string,
+): AppBskyActorDefs.SavedFeed['type'] {
+  const urip = new AtUri(uri)
+
+  switch (urip.collection) {
+    case 'app.bsky.feed.generator':
+      return 'feed'
+    case 'app.bsky.graph.list':
+      return 'list'
+    default:
+      return 'unknown'
+  }
+}
+
+export function validateSavedFeed(savedFeed: AppBskyActorDefs.SavedFeed) {
+  new TID(savedFeed.id)
+
+  if (['feed', 'list'].includes(savedFeed.type)) {
+    const uri = new AtUri(savedFeed.value)
+    const isFeed = uri.collection === 'app.bsky.feed.generator'
+    const isList = uri.collection === 'app.bsky.graph.list'
+
+    if (savedFeed.type === 'feed' && !isFeed) {
+      throw new Error(
+        `Saved feed of type 'feed' must be a feed, got ${uri.collection}`,
+      )
+    }
+    if (savedFeed.type === 'list' && !isList) {
+      throw new Error(
+        `Saved feed of type 'list' must be a list, got ${uri.collection}`,
+      )
+    }
+  }
+}