@atproto/api 0.6.13 → 0.6.15

package/dist/types.d.ts

@@ -1,4 +1,5 @@
 import { LabelPreference } from './moderation/types';
+import { AppBskyActorDefs } from './client';
 export declare type AtpSessionEvent = 'create' | 'create-failed' | 'update' | 'expired';
 export interface AtpSessionData {
     refreshJwt: string;
@@ -38,6 +39,8 @@ export interface BskyPreferences {
         saved?: string[];
         pinned?: string[];
     };
+    feedViewPrefs: Record<string, Omit<AppBskyActorDefs.FeedViewPref, '$type'>>;
+    threadViewPrefs: Omit<AppBskyActorDefs.ThreadViewPref, '$type'>;
     adultContentEnabled: boolean;
     contentLabels: Record<string, BskyLabelPreference>;
     birthDate: Date | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.6.13",
+  "version": "0.6.15",
   "main": "dist/index.js",
   "license": "MIT",
   "repository": {
@@ -13,14 +13,14 @@
     "tlds": "^1.234.0",
     "typed-emitter": "^2.1.0",
     "@atproto/common-web": "^0.2.0",
-    "@atproto/lexicon": "^0.2.0",
-    "@atproto/syntax": "^0.1.0",
-    "@atproto/xrpc": "^0.3.0"
+    "@atproto/lexicon": "^0.2.1",
+    "@atproto/syntax": "^0.1.1",
+    "@atproto/xrpc": "^0.3.1"
   },
   "devDependencies": {
     "common-tags": "^1.8.2",
-    "@atproto/lex-cli": "^0.2.0",
-    "@atproto/pds": "^0.1.13"
+    "@atproto/lex-cli": "^0.2.1",
+    "@atproto/pds": "^0.1.15"
   },
   "scripts": {
     "codegen": "pnpm docgen && node ./scripts/generate-code.mjs && lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",

package/src/bsky-agent.ts

@@ -8,6 +8,18 @@ import {
 } from './client'
 import { BskyPreferences, BskyLabelPreference } from './types'
 
+const FEED_VIEW_PREF_DEFAULTS = {
+  hideReplies: false,
+  hideRepliesByUnfollowed: false,
+  hideRepliesByLikeCount: 0,
+  hideReposts: false,
+  hideQuotePosts: false,
+}
+const THREAD_VIEW_PREF_DEFAULTS = {
+  sort: 'oldest',
+  prioritizeFollowedUsers: true,
+}
+
 declare global {
   interface Array<T> {
     findLast(
@@ -254,6 +266,12 @@ export class BskyAgent extends AtpAgent {
         saved: undefined,
         pinned: undefined,
       },
+      feedViewPrefs: {
+        home: {
+          ...FEED_VIEW_PREF_DEFAULTS,
+        },
+      },
+      threadViewPrefs: { ...THREAD_VIEW_PREF_DEFAULTS },
       adultContentEnabled: false,
       contentLabels: {},
       birthDate: undefined,
@@ -289,6 +307,18 @@ export class BskyAgent extends AtpAgent {
         if (pref.birthDate) {
           prefs.birthDate = new Date(pref.birthDate)
         }
+      } else if (
+        AppBskyActorDefs.isFeedViewPref(pref) &&
+        AppBskyActorDefs.validateFeedViewPref(pref).success
+      ) {
+        const { $type, feed, ...v } = pref
+        prefs.feedViewPrefs[pref.feed] = { ...FEED_VIEW_PREF_DEFAULTS, ...v }
+      } else if (
+        AppBskyActorDefs.isThreadViewPref(pref) &&
+        AppBskyActorDefs.validateThreadViewPref(pref).success
+      ) {
+        const { $type, ...v } = pref
+        prefs.threadViewPrefs = { ...prefs.threadViewPrefs, ...v }
       }
     }
     return prefs
@@ -406,6 +436,46 @@ export class BskyAgent extends AtpAgent {
         .concat([personalDetailsPref])
     })
   }
+
+  async setFeedViewPrefs(
+    feed: string,
+    pref: Omit<AppBskyActorDefs.FeedViewPref, '$type' | 'feed'>,
+  ) {
+    await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
+      const existing = prefs.findLast(
+        (pref) =>
+          AppBskyActorDefs.isFeedViewPref(pref) &&
+          AppBskyActorDefs.validateFeedViewPref(pref).success &&
+          pref.feed === feed,
+      )
+      if (existing) {
+        pref = { ...existing, ...pref }
+      }
+      return prefs
+        .filter(
+          (p) => !AppBskyActorDefs.isFeedViewPref(pref) || p.feed !== feed,
+        )
+        .concat([{ ...pref, $type: 'app.bsky.actor.defs#feedViewPref', feed }])
+    })
+  }
+
+  async setThreadViewPrefs(
+    pref: Omit<AppBskyActorDefs.ThreadViewPref, '$type'>,
+  ) {
+    await updatePreferences(this, (prefs: AppBskyActorDefs.Preferences) => {
+      const existing = prefs.findLast(
+        (pref) =>
+          AppBskyActorDefs.isThreadViewPref(pref) &&
+          AppBskyActorDefs.validateThreadViewPref(pref).success,
+      )
+      if (existing) {
+        pref = { ...existing, ...pref }
+      }
+      return prefs
+        .filter((p) => !AppBskyActorDefs.isThreadViewPref(p))
+        .concat([{ ...pref, $type: 'app.bsky.actor.defs#threadViewPref' }])
+    })
+  }
 }
 
 /**

package/src/client/lexicons.ts

@@ -3687,6 +3687,8 @@ export const schemaDict = {
             'lex:app.bsky.actor.defs#contentLabelPref',
             'lex:app.bsky.actor.defs#savedFeedsPref',
             'lex:app.bsky.actor.defs#personalDetailsPref',
+            'lex:app.bsky.actor.defs#feedViewPref',
+            'lex:app.bsky.actor.defs#threadViewPref',
           ],
         },
       },
@@ -3743,6 +3745,53 @@ export const schemaDict = {
           },
         },
       },
+      feedViewPref: {
+        type: 'object',
+        required: ['feed'],
+        properties: {
+          feed: {
+            type: 'string',
+            description:
+              'The URI of the feed, or an identifier which describes the feed.',
+          },
+          hideReplies: {
+            type: 'boolean',
+            description: 'Hide replies in the feed.',
+          },
+          hideRepliesByUnfollowed: {
+            type: 'boolean',
+            description:
+              'Hide replies in the feed if they are not by followed users.',
+          },
+          hideRepliesByLikeCount: {
+            type: 'integer',
+            description:
+              'Hide replies in the feed if they do not have this number of likes.',
+          },
+          hideReposts: {
+            type: 'boolean',
+            description: 'Hide reposts in the feed.',
+          },
+          hideQuotePosts: {
+            type: 'boolean',
+            description: 'Hide quote posts in the feed.',
+          },
+        },
+      },
+      threadViewPref: {
+        type: 'object',
+        properties: {
+          sort: {
+            type: 'string',
+            description: 'Sorting mode.',
+            knownValues: ['oldest', 'newest', 'most-likes', 'random'],
+          },
+          prioritizeFollowedUsers: {
+            type: 'boolean',
+            description: 'Show followed users at the top of all replies.',
+          },
+        },
+      },
     },
   },
   AppBskyActorGetPreferences: {
@@ -5693,10 +5742,12 @@ export const schemaDict = {
       mentionRule: {
         type: 'object',
         description: 'Allow replies from actors mentioned in your post.',
+        properties: {},
       },
       followingRule: {
         type: 'object',
         description: 'Allow replies from actors you follow.',
+        properties: {},
       },
       listRule: {
         type: 'object',

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

@@ -109,6 +109,8 @@ export type Preferences = (
   | ContentLabelPref
   | SavedFeedsPref
   | PersonalDetailsPref
+  | FeedViewPref
+  | ThreadViewPref
   | { $type: string; [k: string]: unknown }
 )[]
 
@@ -182,3 +184,51 @@ export function isPersonalDetailsPref(v: unknown): v is PersonalDetailsPref {
 export function validatePersonalDetailsPref(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.actor.defs#personalDetailsPref', v)
 }
+
+export interface FeedViewPref {
+  /** The URI of the feed, or an identifier which describes the feed. */
+  feed: string
+  /** Hide replies in the feed. */
+  hideReplies?: boolean
+  /** Hide replies in the feed if they are not by followed users. */
+  hideRepliesByUnfollowed?: boolean
+  /** Hide replies in the feed if they do not have this number of likes. */
+  hideRepliesByLikeCount?: number
+  /** Hide reposts in the feed. */
+  hideReposts?: boolean
+  /** Hide quote posts in the feed. */
+  hideQuotePosts?: boolean
+  [k: string]: unknown
+}
+
+export function isFeedViewPref(v: unknown): v is FeedViewPref {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.actor.defs#feedViewPref'
+  )
+}
+
+export function validateFeedViewPref(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.actor.defs#feedViewPref', v)
+}
+
+export interface ThreadViewPref {
+  /** Sorting mode. */
+  sort?: 'oldest' | 'newest' | 'most-likes' | 'random' | (string & {})
+  /** Show followed users at the top of all replies. */
+  prioritizeFollowedUsers?: boolean
+  [k: string]: unknown
+}
+
+export function isThreadViewPref(v: unknown): v is ThreadViewPref {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.actor.defs#threadViewPref'
+  )
+}
+
+export function validateThreadViewPref(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.actor.defs#threadViewPref', v)
+}

package/src/client/types/app/bsky/feed/threadgate.ts

@@ -32,7 +32,9 @@ export function validateRecord(v: unknown): ValidationResult {
 }
 
 /** Allow replies from actors mentioned in your post. */
-export interface MentionRule {}
+export interface MentionRule {
+  [k: string]: unknown
+}
 
 export function isMentionRule(v: unknown): v is MentionRule {
   return (
@@ -47,7 +49,9 @@ export function validateMentionRule(v: unknown): ValidationResult {
 }
 
 /** Allow replies from actors you follow. */
-export interface FollowingRule {}
+export interface FollowingRule {
+  [k: string]: unknown
+}
 
 export function isFollowingRule(v: unknown): v is FollowingRule {
   return (

package/src/types.ts

@@ -1,4 +1,5 @@
 import { LabelPreference } from './moderation/types'
+import { AppBskyActorDefs } from './client'
 
 /**
  * Used by the PersistSessionHandler to indicate what change occurred
@@ -87,6 +88,8 @@ export interface BskyPreferences {
     saved?: string[]
     pinned?: string[]
   }
+  feedViewPrefs: Record<string, Omit<AppBskyActorDefs.FeedViewPref, '$type'>>
+  threadViewPrefs: Omit<AppBskyActorDefs.ThreadViewPref, '$type'>
   adultContentEnabled: boolean
   contentLabels: Record<string, BskyLabelPreference>
   birthDate: Date | undefined