@atproto/api 0.6.14 → 0.6.16

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atproto/api
 
+## 0.6.16
+
+### Patch Changes
+
+- [#1653](https://github.com/bluesky-social/atproto/pull/1653) [`56e2cf89`](https://github.com/bluesky-social/atproto/commit/56e2cf8999f6d7522529a9be8652c47545f82242) Thanks [@pfrazee](https://github.com/pfrazee)! - Improve the types of the thread and feed preferences APIs
+
+## 0.6.15
+
+### Patch Changes
+
+- [#1639](https://github.com/bluesky-social/atproto/pull/1639) [`2cc329f2`](https://github.com/bluesky-social/atproto/commit/2cc329f26547217dd94b6bb11ee590d707cbd14f) Thanks [@pfrazee](https://github.com/pfrazee)! - Added new preferences for feed and thread view behaviors.
+
 ## 0.6.14
 
 ### Patch Changes

package/README.md

@@ -31,6 +31,8 @@ Log into a server or create accounts using these APIs. You'll need an active ses
 
 ```typescript
 import { BskyAgent, AtpSessionEvent, AtpSessionData } from '@atproto/api'
+
+// configure connection to the server, without account authentication
 const agent = new BskyAgent({
   service: 'https://example.com',
   persistSession: (evt: AtpSessionEvent, sess?: AtpSessionData) => {
@@ -38,13 +40,19 @@ const agent = new BskyAgent({
   },
 })
 
-await agent.login({ identifier: 'alice@mail.com', password: 'hunter2' })
-await agent.resumeSession(savedSessionData)
+// create a new account on the server
 await agent.createAccount({
   email: 'alice@mail.com',
   password: 'hunter2',
   handle: 'alice.example.com',
+  inviteCode: 'some-code-12345-abcde',
 })
+
+// if an existing session (accessed with 'agent.session') was securely stored previously, then reuse that
+await agent.resumeSession(savedSessionData)
+
+// if no old session was available, create a new one by logging in with password (App Password)
+await agent.login({ identifier: 'alice@mail.com', password: 'hunter2' })
 ```
 
 ### API calls

package/dist/bsky-agent.d.ts

@@ -1,6 +1,6 @@
 import { AtpAgent } from './agent';
 import { AppBskyFeedPost, AppBskyActorProfile } from './client';
-import { BskyPreferences, BskyLabelPreference } from './types';
+import { BskyPreferences, BskyLabelPreference, BskyFeedViewPreference, BskyThreadViewPreference } from './types';
 declare global {
     interface Array<T> {
         findLast(predicate: (value: T, index: number, obj: T[]) => unknown, thisArg?: any): T;
@@ -75,4 +75,6 @@ export declare class BskyAgent extends AtpAgent {
     setPersonalDetails({ birthDate, }: {
         birthDate: string | Date | undefined;
     }): Promise<void>;
+    setFeedViewPrefs(feed: string, pref: Partial<BskyFeedViewPreference>): Promise<void>;
+    setThreadViewPrefs(pref: Partial<BskyThreadViewPreference>): Promise<void>;
 }

package/dist/client/lexicons.d.ts

@@ -3472,6 +3472,50 @@ export declare const schemaDict: {
                     };
                 };
             };
+            feedViewPref: {
+                type: string;
+                required: string[];
+                properties: {
+                    feed: {
+                        type: string;
+                        description: string;
+                    };
+                    hideReplies: {
+                        type: string;
+                        description: string;
+                    };
+                    hideRepliesByUnfollowed: {
+                        type: string;
+                        description: string;
+                    };
+                    hideRepliesByLikeCount: {
+                        type: string;
+                        description: string;
+                    };
+                    hideReposts: {
+                        type: string;
+                        description: string;
+                    };
+                    hideQuotePosts: {
+                        type: string;
+                        description: string;
+                    };
+                };
+            };
+            threadViewPref: {
+                type: string;
+                properties: {
+                    sort: {
+                        type: string;
+                        description: string;
+                        knownValues: string[];
+                    };
+                    prioritizeFollowedUsers: {
+                        type: string;
+                        description: string;
+                    };
+                };
+            };
         };
     };
     AppBskyActorGetPreferences: {
@@ -5342,10 +5386,12 @@ export declare const schemaDict: {
             mentionRule: {
                 type: string;
                 description: string;
+                properties: {};
             };
             followingRule: {
                 type: string;
                 description: string;
+                properties: {};
             };
             listRule: {
                 type: string;

package/dist/client/types/app/bsky/actor/defs.d.ts

@@ -53,7 +53,7 @@ export interface ViewerState {
 }
 export declare function isViewerState(v: unknown): v is ViewerState;
 export declare function validateViewerState(v: unknown): ValidationResult;
-export declare type Preferences = (AdultContentPref | ContentLabelPref | SavedFeedsPref | PersonalDetailsPref | {
+export declare type Preferences = (AdultContentPref | ContentLabelPref | SavedFeedsPref | PersonalDetailsPref | FeedViewPref | ThreadViewPref | {
     $type: string;
     [k: string]: unknown;
 })[];
@@ -83,3 +83,21 @@ export interface PersonalDetailsPref {
 }
 export declare function isPersonalDetailsPref(v: unknown): v is PersonalDetailsPref;
 export declare function validatePersonalDetailsPref(v: unknown): ValidationResult;
+export interface FeedViewPref {
+    feed: string;
+    hideReplies?: boolean;
+    hideRepliesByUnfollowed?: boolean;
+    hideRepliesByLikeCount?: number;
+    hideReposts?: boolean;
+    hideQuotePosts?: boolean;
+    [k: string]: unknown;
+}
+export declare function isFeedViewPref(v: unknown): v is FeedViewPref;
+export declare function validateFeedViewPref(v: unknown): ValidationResult;
+export interface ThreadViewPref {
+    sort?: 'oldest' | 'newest' | 'most-likes' | 'random' | (string & {});
+    prioritizeFollowedUsers?: boolean;
+    [k: string]: unknown;
+}
+export declare function isThreadViewPref(v: unknown): v is ThreadViewPref;
+export declare function validateThreadViewPref(v: unknown): ValidationResult;

package/dist/client/types/app/bsky/feed/threadgate.d.ts

@@ -11,10 +11,12 @@ export interface Record {
 export declare function isRecord(v: unknown): v is Record;
 export declare function validateRecord(v: unknown): ValidationResult;
 export interface MentionRule {
+    [k: string]: unknown;
 }
 export declare function isMentionRule(v: unknown): v is MentionRule;
 export declare function validateMentionRule(v: unknown): ValidationResult;
 export interface FollowingRule {
+    [k: string]: unknown;
 }
 export declare function isFollowingRule(v: unknown): v is FollowingRule;
 export declare function validateFollowingRule(v: unknown): ValidationResult;

package/dist/index.js

@@ -14891,7 +14891,7 @@ var lexObject = z.object({
   description: z.string().optional(),
   required: z.string().array().optional(),
   nullable: z.string().array().optional(),
-  properties: z.record(z.union([lexRefVariant, lexIpldType, lexArray, lexBlob, lexPrimitive])).optional()
+  properties: z.record(z.union([lexRefVariant, lexIpldType, lexArray, lexBlob, lexPrimitive]))
 }).strict().superRefine(requiredPropertiesRefinement);
 var lexXrpcParameters = z.object({
   type: z.literal("params"),
@@ -19247,7 +19247,9 @@ var schemaDict = {
             "lex:app.bsky.actor.defs#adultContentPref",
             "lex:app.bsky.actor.defs#contentLabelPref",
             "lex:app.bsky.actor.defs#savedFeedsPref",
-            "lex:app.bsky.actor.defs#personalDetailsPref"
+            "lex:app.bsky.actor.defs#personalDetailsPref",
+            "lex:app.bsky.actor.defs#feedViewPref",
+            "lex:app.bsky.actor.defs#threadViewPref"
           ]
         }
       },
@@ -19303,6 +19305,50 @@ var schemaDict = {
             description: "The birth date of the owner of the account."
           }
         }
+      },
+      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."
+          }
+        }
       }
     }
   },
@@ -21243,11 +21289,13 @@ var schemaDict = {
       },
       mentionRule: {
         type: "object",
-        description: "Allow replies from actors mentioned in your post."
+        description: "Allow replies from actors mentioned in your post.",
+        properties: {}
       },
       followingRule: {
         type: "object",
-        description: "Allow replies from actors you follow."
+        description: "Allow replies from actors you follow.",
+        properties: {}
       },
       listRule: {
         type: "object",
@@ -22334,7 +22382,7 @@ var 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: {
@@ -24264,19 +24312,23 @@ var defs_exports5 = {};
 __export(defs_exports5, {
   isAdultContentPref: () => isAdultContentPref,
   isContentLabelPref: () => isContentLabelPref,
+  isFeedViewPref: () => isFeedViewPref,
   isPersonalDetailsPref: () => isPersonalDetailsPref,
   isProfileView: () => isProfileView,
   isProfileViewBasic: () => isProfileViewBasic,
   isProfileViewDetailed: () => isProfileViewDetailed,
   isSavedFeedsPref: () => isSavedFeedsPref,
+  isThreadViewPref: () => isThreadViewPref,
   isViewerState: () => isViewerState,
   validateAdultContentPref: () => validateAdultContentPref,
   validateContentLabelPref: () => validateContentLabelPref,
+  validateFeedViewPref: () => validateFeedViewPref,
   validatePersonalDetailsPref: () => validatePersonalDetailsPref,
   validateProfileView: () => validateProfileView,
   validateProfileViewBasic: () => validateProfileViewBasic,
   validateProfileViewDetailed: () => validateProfileViewDetailed,
   validateSavedFeedsPref: () => validateSavedFeedsPref,
+  validateThreadViewPref: () => validateThreadViewPref,
   validateViewerState: () => validateViewerState
 });
 function isProfileViewBasic(v) {
@@ -24327,6 +24379,18 @@ function isPersonalDetailsPref(v) {
 function validatePersonalDetailsPref(v) {
   return lexicons.validate("app.bsky.actor.defs#personalDetailsPref", v);
 }
+function isFeedViewPref(v) {
+  return isObj2(v) && hasProp2(v, "$type") && v.$type === "app.bsky.actor.defs#feedViewPref";
+}
+function validateFeedViewPref(v) {
+  return lexicons.validate("app.bsky.actor.defs#feedViewPref", v);
+}
+function isThreadViewPref(v) {
+  return isObj2(v) && hasProp2(v, "$type") && v.$type === "app.bsky.actor.defs#threadViewPref";
+}
+function validateThreadViewPref(v) {
+  return lexicons.validate("app.bsky.actor.defs#threadViewPref", v);
+}
 
 // src/client/types/app/bsky/actor/profile.ts
 var profile_exports = {};
@@ -28828,12 +28892,12 @@ function decideQuotedPostWithMediaAccount(subject, opts) {
 }
 
 // src/moderation/subjects/feed-generator.ts
-function decideFeedGenerator(subject, opts) {
+function decideFeedGenerator(_subject, _opts) {
   return ModerationDecision.noop();
 }
 
 // src/moderation/subjects/user-list.ts
-function decideUserList(subject, opts) {
+function decideUserList(_subject, _opts) {
   return ModerationDecision.noop();
 }
 
@@ -29194,6 +29258,17 @@ var LABEL_GROUPS = {
 };
 
 // src/bsky-agent.ts
+var FEED_VIEW_PREF_DEFAULTS = {
+  hideReplies: false,
+  hideRepliesByUnfollowed: false,
+  hideRepliesByLikeCount: 0,
+  hideReposts: false,
+  hideQuotePosts: false
+};
+var THREAD_VIEW_PREF_DEFAULTS = {
+  sort: "oldest",
+  prioritizeFollowedUsers: true
+};
 var BskyAgent = class extends AtpAgent {
   constructor() {
     super(...arguments);
@@ -29348,6 +29423,12 @@ var BskyAgent = class extends AtpAgent {
         saved: void 0,
         pinned: void 0
       },
+      feedViewPrefs: {
+        home: {
+          ...FEED_VIEW_PREF_DEFAULTS
+        }
+      },
+      threadViewPrefs: { ...THREAD_VIEW_PREF_DEFAULTS },
       adultContentEnabled: false,
       contentLabels: {},
       birthDate: void 0
@@ -29371,6 +29452,12 @@ var BskyAgent = class extends AtpAgent {
         if (pref.birthDate) {
           prefs.birthDate = new Date(pref.birthDate);
         }
+      } else if (defs_exports5.isFeedViewPref(pref) && defs_exports5.validateFeedViewPref(pref).success) {
+        const { $type, feed, ...v } = pref;
+        prefs.feedViewPrefs[pref.feed] = { ...FEED_VIEW_PREF_DEFAULTS, ...v };
+      } else if (defs_exports5.isThreadViewPref(pref) && defs_exports5.validateThreadViewPref(pref).success) {
+        const { $type, ...v } = pref;
+        prefs.threadViewPrefs = { ...prefs.threadViewPrefs, ...v };
       }
     }
     return prefs;
@@ -29454,6 +29541,24 @@ var BskyAgent = class extends AtpAgent {
       return prefs.filter((pref) => !defs_exports5.isPersonalDetailsPref(pref)).concat([personalDetailsPref]);
     });
   }
+  async setFeedViewPrefs(feed, pref) {
+    await updatePreferences(this, (prefs) => {
+      const existing = prefs.findLast((pref2) => defs_exports5.isFeedViewPref(pref2) && defs_exports5.validateFeedViewPref(pref2).success && pref2.feed === feed);
+      if (existing) {
+        pref = { ...existing, ...pref };
+      }
+      return prefs.filter((p) => !defs_exports5.isFeedViewPref(pref) || p.feed !== feed).concat([{ ...pref, $type: "app.bsky.actor.defs#feedViewPref", feed }]);
+    });
+  }
+  async setThreadViewPrefs(pref) {
+    await updatePreferences(this, (prefs) => {
+      const existing = prefs.findLast((pref2) => defs_exports5.isThreadViewPref(pref2) && defs_exports5.validateThreadViewPref(pref2).success);
+      if (existing) {
+        pref = { ...existing, ...pref };
+      }
+      return prefs.filter((p) => !defs_exports5.isThreadViewPref(p)).concat([{ ...pref, $type: "app.bsky.actor.defs#threadViewPref" }]);
+    });
+  }
 };
 async function updatePreferences(agent, cb) {
   const res = await agent.app.bsky.actor.getPreferences({});