@atproto/api 0.6.14 → 0.6.16

package/dist/moderation/subjects/feed-generator.d.ts

@@ -1,2 +1,2 @@
 import { ModerationSubjectFeedGenerator, ModerationDecision, ModerationOpts } from '../types';
-export declare function decideFeedGenerator(subject: ModerationSubjectFeedGenerator, opts: ModerationOpts): ModerationDecision;
+export declare function decideFeedGenerator(_subject: ModerationSubjectFeedGenerator, _opts: ModerationOpts): ModerationDecision;

package/dist/moderation/subjects/user-list.d.ts

@@ -1,2 +1,2 @@
 import { ModerationSubjectUserList, ModerationOpts, ModerationDecision } from '../types';
-export declare function decideUserList(subject: ModerationSubjectUserList, opts: ModerationOpts): ModerationDecision;
+export declare function decideUserList(_subject: ModerationSubjectUserList, _opts: ModerationOpts): ModerationDecision;

package/dist/types.d.ts

@@ -33,11 +33,26 @@ export interface AtpAgentGlobalOpts {
     fetch: AtpAgentFetchHandler;
 }
 export declare type BskyLabelPreference = LabelPreference | 'show';
+export interface BskyFeedViewPreference {
+    hideReplies: boolean;
+    hideRepliesByUnfollowed: boolean;
+    hideRepliesByLikeCount: number;
+    hideReposts: boolean;
+    hideQuotePosts: boolean;
+    [key: string]: any;
+}
+export interface BskyThreadViewPreference {
+    sort: string;
+    prioritizeFollowedUsers: boolean;
+    [key: string]: any;
+}
 export interface BskyPreferences {
     feeds: {
         saved?: string[];
         pinned?: string[];
     };
+    feedViewPrefs: Record<string, BskyFeedViewPreference>;
+    threadViewPrefs: BskyThreadViewPreference;
     adultContentEnabled: boolean;
     contentLabels: Record<string, BskyLabelPreference>;
     birthDate: Date | undefined;

package/package.json

@@ -1,13 +1,20 @@
 {
   "name": "@atproto/api",
-  "version": "0.6.14",
-  "main": "dist/index.js",
+  "version": "0.6.16",
   "license": "MIT",
+  "description": "Client library for atproto and Bluesky",
+  "keywords": [
+    "atproto",
+    "bluesky",
+    "api"
+  ],
+  "homepage": "https://atproto.com",
   "repository": {
     "type": "git",
-    "url": "https://github.com/bluesky-social/atproto.git",
+    "url": "https://github.com/bluesky-social/atproto",
     "directory": "packages/api"
   },
+  "main": "dist/index.js",
   "dependencies": {
     "multiformats": "^9.9.0",
     "tlds": "^1.234.0",
@@ -20,7 +27,7 @@
   "devDependencies": {
     "common-tags": "^1.8.2",
     "@atproto/lex-cli": "^0.2.1",
-    "@atproto/pds": "^0.1.14"
+    "@atproto/pds": "^0.1.16"
   },
   "scripts": {
     "codegen": "pnpm docgen && node ./scripts/generate-code.mjs && lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",

package/src/agent.ts

@@ -7,7 +7,6 @@ import {
   ComAtprotoServerCreateSession,
   ComAtprotoServerGetSession,
   ComAtprotoServerRefreshSession,
-  ComAtprotoRepoUploadBlob,
 } from './client'
 import {
   AtpSessionData,

package/src/bsky-agent.ts

@@ -6,7 +6,24 @@ import {
   AppBskyActorDefs,
   ComAtprotoRepoPutRecord,
 } from './client'
-import { BskyPreferences, BskyLabelPreference } from './types'
+import {
+  BskyPreferences,
+  BskyLabelPreference,
+  BskyFeedViewPreference,
+  BskyThreadViewPreference,
+} 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> {
@@ -254,6 +271,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 +312,20 @@ export class BskyAgent extends AtpAgent {
         if (pref.birthDate) {
           prefs.birthDate = new Date(pref.birthDate)
         }
+      } else if (
+        AppBskyActorDefs.isFeedViewPref(pref) &&
+        AppBskyActorDefs.validateFeedViewPref(pref).success
+      ) {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { $type, feed, ...v } = pref
+        prefs.feedViewPrefs[pref.feed] = { ...FEED_VIEW_PREF_DEFAULTS, ...v }
+      } else if (
+        AppBskyActorDefs.isThreadViewPref(pref) &&
+        AppBskyActorDefs.validateThreadViewPref(pref).success
+      ) {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { $type, ...v } = pref
+        prefs.threadViewPrefs = { ...prefs.threadViewPrefs, ...v }
       }
     }
     return prefs
@@ -406,6 +443,41 @@ export class BskyAgent extends AtpAgent {
         .concat([personalDetailsPref])
     })
   }
+
+  async setFeedViewPrefs(feed: string, pref: Partial<BskyFeedViewPreference>) {
+    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: Partial<BskyThreadViewPreference>) {
+    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',
@@ -6787,7 +6838,8 @@ export const schemaDict = {
     defs: {
       main: {
         type: 'query',
-        description: 'An unspecced view of globally popular items',
+        description:
+          'DEPRECATED: will be removed soon, please find a feed generator alternative',
         parameters: {
           type: 'params',
           properties: {

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/moderation/subjects/feed-generator.ts

@@ -5,8 +5,8 @@ import {
 } from '../types'
 
 export function decideFeedGenerator(
-  subject: ModerationSubjectFeedGenerator,
-  opts: ModerationOpts,
+  _subject: ModerationSubjectFeedGenerator,
+  _opts: ModerationOpts,
 ): ModerationDecision {
   // TODO handle labels applied on the feed generator itself
   return ModerationDecision.noop()

package/src/moderation/subjects/user-list.ts

@@ -5,8 +5,8 @@ import {
 } from '../types'
 
 export function decideUserList(
-  subject: ModerationSubjectUserList,
-  opts: ModerationOpts,
+  _subject: ModerationSubjectUserList,
+  _opts: ModerationOpts,
 ): ModerationDecision {
   // TODO handle labels applied on the list itself
   return ModerationDecision.noop()

package/src/moderation/util.ts

@@ -1,8 +1,4 @@
-import {
-  AppBskyEmbedRecord,
-  AppBskyEmbedRecordWithMedia,
-  AppBskyFeedPost,
-} from '../client'
+import { AppBskyEmbedRecord, AppBskyEmbedRecordWithMedia } from '../client'
 import { ModerationDecision, ModerationUI } from './types'
 
 export function takeHighestPriorityDecision(

package/src/rich-text/sanitization.ts

@@ -1,6 +1,8 @@
 import { RichText } from './rich-text'
 import { UnicodeString } from './unicode'
 
+// this regex is intentionally matching on the zero-with-separator codepoint
+// eslint-disable-next-line no-misleading-character-class
 const EXCESS_SPACE_RE = /[\r\n]([\u00AD\u2060\u200D\u200C\u200B\s]*[\r\n]){2,}/
 const REPLACEMENT_STR = '\n\n'
 

package/src/types.ts

@@ -80,13 +80,37 @@ export type BskyLabelPreference = LabelPreference | 'show'
 // TEMP we need to permanently convert 'show' to 'ignore', for now we manually convert -prf
 
 /**
- * Bluesky preferences object
+ * Bluesky feed view preferences
+ */
+
+export interface BskyFeedViewPreference {
+  hideReplies: boolean
+  hideRepliesByUnfollowed: boolean
+  hideRepliesByLikeCount: number
+  hideReposts: boolean
+  hideQuotePosts: boolean
+  [key: string]: any
+}
+
+/**
+ * Bluesky thread view preferences
+ */
+export interface BskyThreadViewPreference {
+  sort: string
+  prioritizeFollowedUsers: boolean
+  [key: string]: any
+}
+
+/**
+ * Bluesky preferences
  */
 export interface BskyPreferences {
   feeds: {
     saved?: string[]
     pinned?: string[]
   }
+  feedViewPrefs: Record<string, BskyFeedViewPreference>
+  threadViewPrefs: BskyThreadViewPreference
   adultContentEnabled: boolean
   contentLabels: Record<string, BskyLabelPreference>
   birthDate: Date | undefined