@atproto/bsky 0.0.83 → 0.0.84

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/bsky",
-  "version": "0.0.83",
+  "version": "0.0.84",
   "license": "MIT",
   "description": "Reference implementation of app.bsky App View (Bluesky API)",
   "keywords": [
@@ -41,15 +41,15 @@
     "structured-headers": "^1.0.1",
     "typed-emitter": "^2.1.0",
     "uint8arrays": "3.0.0",
-    "@atproto/api": "^0.13.7",
-    "@atproto/common": "^0.4.2",
+    "@atproto/api": "^0.13.8",
+    "@atproto/common": "^0.4.3",
     "@atproto/crypto": "^0.4.1",
-    "@atproto/identity": "^0.4.1",
-    "@atproto/lexicon": "^0.4.1",
-    "@atproto/repo": "^0.5.1",
-    "@atproto/sync": "^0.1.1",
+    "@atproto/identity": "^0.4.2",
+    "@atproto/lexicon": "^0.4.2",
+    "@atproto/repo": "^0.5.2",
+    "@atproto/sync": "^0.1.2",
     "@atproto/syntax": "^0.3.0",
-    "@atproto/xrpc-server": "^0.6.4"
+    "@atproto/xrpc-server": "^0.7.0"
   },
   "devDependencies": {
     "@bufbuild/buf": "^1.28.1",
@@ -64,10 +64,10 @@
     "axios": "^0.27.2",
     "jest": "^28.1.2",
     "ts-node": "^10.8.2",
-    "@atproto/api": "^0.13.7",
-    "@atproto/lex-cli": "^0.5.0",
-    "@atproto/pds": "^0.4.59",
-    "@atproto/xrpc": "^0.6.2"
+    "@atproto/api": "^0.13.8",
+    "@atproto/lex-cli": "^0.5.1",
+    "@atproto/pds": "^0.4.60",
+    "@atproto/xrpc": "^0.6.3"
   },
   "scripts": {
     "codegen": "lex gen-server --yes ./src/lexicon ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/* ../../lexicons/chat/bsky/*/*",

package/src/api/app/bsky/feed/getAuthorFeed.ts

@@ -79,21 +79,46 @@ export const skeleton = async (inputs: {
   if (clearlyBadCursor(params.cursor)) {
     return { actor, filter: params.filter, items: [] }
   }
+
+  const isFirstPageRequest = !params.cursor
+  const shouldInsertPinnedPost =
+    isFirstPageRequest && params.includePins && !!actor.profile?.pinnedPost
+
   const res = await ctx.dataplane.getAuthorFeed({
     actorDid: did,
     limit: params.limit,
     cursor: params.cursor,
     feedType: FILTER_TO_FEED_TYPE[params.filter],
   })
+
+  let items: FeedItem[] = res.items.map((item) => ({
+    post: { uri: item.uri, cid: item.cid || undefined },
+    repost: item.repost
+      ? { uri: item.repost, cid: item.repostCid || undefined }
+      : undefined,
+  }))
+
+  if (shouldInsertPinnedPost && actor.profile?.pinnedPost) {
+    const pinnedItem = {
+      post: {
+        uri: actor.profile.pinnedPost.uri,
+        cid: actor.profile.pinnedPost.cid,
+      },
+      authorPinned: true,
+    }
+    if (params.limit === 1) {
+      items[0] = pinnedItem
+    } else {
+      // filter pinned post from first page only
+      items = items.filter((item) => item.post.uri !== pinnedItem.post.uri)
+      items.unshift(pinnedItem)
+    }
+  }
+
   return {
     actor,
     filter: params.filter,
-    items: res.items.map((item) => ({
-      post: { uri: item.uri, cid: item.cid || undefined },
-      repost: item.repost
-        ? { uri: item.repost, cid: item.repostCid || undefined }
-        : undefined,
-    })),
+    items,
     cursor: parseString(res.cursor),
   }
 }
@@ -147,7 +172,7 @@ const noBlocksOrMutedReposts = (inputs: {
     skeleton.items = skeleton.items.filter((item) => {
       return (
         checkBlocksAndMutes(item) &&
-        (item.repost || selfThread.ok(item.post.uri))
+        (item.repost || item.authorPinned || selfThread.ok(item.post.uri))
       )
     })
   } else {

package/src/api/app/bsky/graph/getSuggestedFollowsByActor.ts

@@ -71,6 +71,7 @@ const skeleton = async (input: SkeletonFnInput<Context, Params>) => {
         { headers: params.headers },
       )
     return {
+      isFallback: !res.data.relativeToDid,
       suggestedDids: res.data.actors.map((a) => a.did),
       headers: res.headers,
     }
@@ -80,6 +81,7 @@ const skeleton = async (input: SkeletonFnInput<Context, Params>) => {
       relativeToDid,
     })
     return {
+      isFallback: true,
       suggestedDids: dids,
     }
   }
@@ -113,7 +115,7 @@ const presentation = (
   const suggestions = mapDefined(suggestedDids, (did) =>
     ctx.views.profileDetailed(did, hydration),
   )
-  return { suggestions, headers }
+  return { isFallback: skeleton.isFallback, suggestions, headers }
 }
 
 type Context = {
@@ -129,6 +131,7 @@ type Params = QueryParams & {
 }
 
 type SkeletonState = {
+  isFallback: boolean
   suggestedDids: string[]
   headers?: Record<string, string>
 }

package/src/data-plane/server/db/migrations/20240831T134810923Z-pinned-posts.ts

@@ -0,0 +1,17 @@
+import { Kysely } from 'kysely'
+
+export async function up(db: Kysely<unknown>): Promise<void> {
+  await db.schema
+    .alterTable('profile')
+    .addColumn('pinnedPost', 'varchar')
+    .execute()
+  await db.schema
+    .alterTable('profile')
+    .addColumn('pinnedPostCid', 'varchar')
+    .execute()
+}
+
+export async function down(db: Kysely<unknown>): Promise<void> {
+  await db.schema.alterTable('profile').dropColumn('pinnedPost').execute()
+  await db.schema.alterTable('profile').dropColumn('pinnedPostCid').execute()
+}

package/src/data-plane/server/db/migrations/index.ts

@@ -43,3 +43,4 @@ export * as _20240723T220703655Z from './20240723T220703655Z-quotes'
 export * as _20240801T193939827Z from './20240801T193939827Z-post-gate'
 export * as _20240808T224251220Z from './20240808T224251220Z-post-gate-flags'
 export * as _20240829T211238293Z from './20240829T211238293Z-simplify-actor-sync'
+export * as _20240831T134810923Z from './20240831T134810923Z-pinned-posts'

package/src/data-plane/server/db/tables/profile.ts

@@ -9,6 +9,8 @@ export interface Profile {
   avatarCid: string | null
   bannerCid: string | null
   joinedViaStarterPackUri: string | null
+  pinnedPost: string | null
+  pinnedPostCid: string | null
   createdAt: string
   indexedAt: string
 }

package/src/hydration/feed.ts

@@ -71,7 +71,15 @@ export type ThreadRef = ItemRef & { threadRoot: string }
 
 // @NOTE the feed item types in the protos for author feeds and timelines
 // technically have additional fields, not supported by the mock dataplane.
-export type FeedItem = { post: ItemRef; repost?: ItemRef }
+export type FeedItem = {
+  post: ItemRef
+  repost?: ItemRef
+  /**
+   * If true, overrides the `reason` with `app.bsky.feed.defs#reasonPin`. Used
+   * only in author feeds.
+   */
+  authorPinned?: boolean
+}
 
 export class FeedHydrator {
   constructor(public dataplane: DataPlaneClient) {}

package/src/lexicon/lexicons.ts

@@ -4190,6 +4190,10 @@ export const schemaDict = {
               ref: 'lex:com.atproto.label.defs#label',
             },
           },
+          pinnedPost: {
+            type: 'ref',
+            ref: 'lex:com.atproto.repo.strongRef',
+          },
         },
       },
       profileAssociated: {
@@ -4812,6 +4816,10 @@ export const schemaDict = {
               type: 'ref',
               ref: 'lex:com.atproto.repo.strongRef',
             },
+            pinnedPost: {
+              type: 'ref',
+              ref: 'lex:com.atproto.repo.strongRef',
+            },
             createdAt: {
               type: 'string',
               format: 'datetime',
@@ -5468,6 +5476,9 @@ export const schemaDict = {
           embeddingDisabled: {
             type: 'boolean',
           },
+          pinned: {
+            type: 'boolean',
+          },
         },
       },
       feedViewPost: {
@@ -5484,7 +5495,10 @@ export const schemaDict = {
           },
           reason: {
             type: 'union',
-            refs: ['lex:app.bsky.feed.defs#reasonRepost'],
+            refs: [
+              'lex:app.bsky.feed.defs#reasonRepost',
+              'lex:app.bsky.feed.defs#reasonPin',
+            ],
           },
           feedContext: {
             type: 'string',
@@ -5536,6 +5550,10 @@ export const schemaDict = {
           },
         },
       },
+      reasonPin: {
+        type: 'object',
+        properties: {},
+      },
       threadViewPost: {
         type: 'object',
         required: ['post'],
@@ -5693,7 +5711,10 @@ export const schemaDict = {
           },
           reason: {
             type: 'union',
-            refs: ['lex:app.bsky.feed.defs#skeletonReasonRepost'],
+            refs: [
+              'lex:app.bsky.feed.defs#skeletonReasonRepost',
+              'lex:app.bsky.feed.defs#skeletonReasonPin',
+            ],
           },
           feedContext: {
             type: 'string',
@@ -5713,6 +5734,10 @@ export const schemaDict = {
           },
         },
       },
+      skeletonReasonPin: {
+        type: 'object',
+        properties: {},
+      },
       threadgateView: {
         type: 'object',
         properties: {
@@ -6078,6 +6103,10 @@ export const schemaDict = {
               ],
               default: 'posts_with_replies',
             },
+            includePins: {
+              type: 'boolean',
+              default: false,
+            },
           },
         },
         output: {
@@ -7162,7 +7191,7 @@ export const schemaDict = {
         type: 'record',
         key: 'tid',
         description:
-          "Record defining interaction gating rules for a thread (aka, reply controls). The record key (rkey) of the threadgate record must match the record key of the thread's root post, and that record must be in the same repository..",
+          "Record defining interaction gating rules for a thread (aka, reply controls). The record key (rkey) of the threadgate record must match the record key of the thread's root post, and that record must be in the same repository.",
         record: {
           type: 'object',
           required: ['post', 'createdAt'],
@@ -8236,6 +8265,12 @@ export const schemaDict = {
                   ref: 'lex:app.bsky.actor.defs#profileView',
                 },
               },
+              isFallback: {
+                type: 'boolean',
+                description:
+                  'If true, response has fallen-back to generic results, and is not scoped using relativeToDid',
+                default: false,
+              },
             },
           },
         },
@@ -9192,6 +9227,12 @@ export const schemaDict = {
                   ref: 'lex:app.bsky.unspecced.defs#skeletonSearchActor',
                 },
               },
+              relativeToDid: {
+                type: 'string',
+                format: 'did',
+                description:
+                  'DID of the account these suggestions are relative to. If this is returned undefined, suggestions are based on the viewer.',
+              },
             },
           },
         },

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

@@ -7,6 +7,7 @@ import { isObj, hasProp } from '../../../../util'
 import { CID } from 'multiformats/cid'
 import * as ComAtprotoLabelDefs from '../../../com/atproto/label/defs'
 import * as AppBskyGraphDefs from '../graph/defs'
+import * as ComAtprotoRepoStrongRef from '../../../com/atproto/repo/strongRef'
 
 export interface ProfileViewBasic {
   did: string
@@ -74,6 +75,7 @@ export interface ProfileViewDetailed {
   createdAt?: string
   viewer?: ViewerState
   labels?: ComAtprotoLabelDefs.Label[]
+  pinnedPost?: ComAtprotoRepoStrongRef.Main
   [k: string]: unknown
 }
 

package/src/lexicon/types/app/bsky/actor/profile.ts

@@ -20,6 +20,7 @@ export interface Record {
     | ComAtprotoLabelDefs.SelfLabels
     | { $type: string; [k: string]: unknown }
   joinedViaStarterPack?: ComAtprotoRepoStrongRef.Main
+  pinnedPost?: ComAtprotoRepoStrongRef.Main
   createdAt?: string
   [k: string]: unknown
 }

package/src/lexicon/types/app/bsky/feed/defs.ts

@@ -55,6 +55,7 @@ export interface ViewerState {
   threadMuted?: boolean
   replyDisabled?: boolean
   embeddingDisabled?: boolean
+  pinned?: boolean
   [k: string]: unknown
 }
 
@@ -73,7 +74,7 @@ export function validateViewerState(v: unknown): ValidationResult {
 export interface FeedViewPost {
   post: PostView
   reply?: ReplyRef
-  reason?: ReasonRepost | { $type: string; [k: string]: unknown }
+  reason?: ReasonRepost | ReasonPin | { $type: string; [k: string]: unknown }
   /** Context provided by feed generator that may be passed back alongside interactions. */
   feedContext?: string
   [k: string]: unknown
@@ -134,6 +135,22 @@ export function validateReasonRepost(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.feed.defs#reasonRepost', v)
 }
 
+export interface ReasonPin {
+  [k: string]: unknown
+}
+
+export function isReasonPin(v: unknown): v is ReasonPin {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.feed.defs#reasonPin'
+  )
+}
+
+export function validateReasonPin(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.feed.defs#reasonPin', v)
+}
+
 export interface ThreadViewPost {
   post: PostView
   parent?:
@@ -265,7 +282,10 @@ export function validateGeneratorViewerState(v: unknown): ValidationResult {
 
 export interface SkeletonFeedPost {
   post: string
-  reason?: SkeletonReasonRepost | { $type: string; [k: string]: unknown }
+  reason?:
+    | SkeletonReasonRepost
+    | SkeletonReasonPin
+    | { $type: string; [k: string]: unknown }
   /** Context that will be passed through to client and may be passed to feed generator back alongside interactions. */
   feedContext?: string
   [k: string]: unknown
@@ -300,6 +320,22 @@ export function validateSkeletonReasonRepost(v: unknown): ValidationResult {
   return lexicons.validate('app.bsky.feed.defs#skeletonReasonRepost', v)
 }
 
+export interface SkeletonReasonPin {
+  [k: string]: unknown
+}
+
+export function isSkeletonReasonPin(v: unknown): v is SkeletonReasonPin {
+  return (
+    isObj(v) &&
+    hasProp(v, '$type') &&
+    v.$type === 'app.bsky.feed.defs#skeletonReasonPin'
+  )
+}
+
+export function validateSkeletonReasonPin(v: unknown): ValidationResult {
+  return lexicons.validate('app.bsky.feed.defs#skeletonReasonPin', v)
+}
+
 export interface ThreadgateView {
   uri?: string
   cid?: string

package/src/lexicon/types/app/bsky/feed/getAuthorFeed.ts

@@ -20,6 +20,7 @@ export interface QueryParams {
     | 'posts_with_media'
     | 'posts_and_author_threads'
     | (string & {})
+  includePins: boolean
 }
 
 export type InputSchema = undefined

package/src/lexicon/types/app/bsky/graph/getSuggestedFollowsByActor.ts

@@ -17,6 +17,8 @@ export type InputSchema = undefined
 
 export interface OutputSchema {
   suggestions: AppBskyActorDefs.ProfileView[]
+  /** If true, response has fallen-back to generic results, and is not scoped using relativeToDid */
+  isFallback?: boolean
   [k: string]: unknown
 }
 

package/src/lexicon/types/app/bsky/unspecced/getSuggestionsSkeleton.ts

@@ -23,6 +23,8 @@ export type InputSchema = undefined
 export interface OutputSchema {
   cursor?: string
   actors: AppBskyUnspeccedDefs.SkeletonSearchActor[]
+  /** DID of the account these suggestions are relative to. If this is returned undefined, suggestions are based on the viewer. */
+  relativeToDid?: string
   [k: string]: unknown
 }
 

package/src/views/index.ts

@@ -16,6 +16,7 @@ import {
   NotFoundPost,
   PostView,
   ReasonRepost,
+  ReasonPin,
   ReplyRef,
   ThreadViewPost,
   ThreadgateView,
@@ -169,6 +170,7 @@ export class Views {
       joinedViaStarterPack: actor.profile?.joinedViaStarterPack
         ? this.starterPackBasic(actor.profile.joinedViaStarterPack.uri, state)
         : undefined,
+      pinnedPost: actor.profile?.pinnedPost,
     }
   }
 
@@ -606,6 +608,7 @@ export class Views {
             threadMuted: viewer.threadMuted,
             replyDisabled: this.userReplyDisabled(uri, state),
             embeddingDisabled: this.userPostEmbeddingDisabled(uri, state),
+            pinned: this.viewerPinned(uri, state, authorDid),
           }
         : undefined,
       labels,
@@ -620,8 +623,10 @@ export class Views {
     state: HydrationState,
   ): FeedViewPost | undefined {
     const postInfo = state.posts?.get(item.post.uri)
-    let reason: ReasonRepost | undefined
-    if (item.repost) {
+    let reason: ReasonRepost | ReasonPin | undefined
+    if (item.authorPinned) {
+      reason = this.reasonPin()
+    } else if (item.repost) {
       const repost = state.reposts?.get(item.repost.uri)
       if (!repost) return
       if (repost.record.subject.uri !== item.post.uri) return
@@ -723,6 +728,12 @@ export class Views {
     }
   }
 
+  reasonPin() {
+    return {
+      $type: 'app.bsky.feed.defs#reasonPin',
+    }
+  }
+
   // Threads
   // ------------
 
@@ -1128,6 +1139,15 @@ export class Views {
     return true
   }
 
+  viewerPinned(uri: string, state: HydrationState, authorDid: string) {
+    if (!state.ctx?.viewer || state.ctx.viewer !== authorDid) return
+    const actor = state.actors?.get(authorDid)
+    if (!actor) return
+    const pinnedPost = actor.profile?.pinnedPost
+    if (!pinnedPost) return undefined
+    return pinnedPost.uri === uri
+  }
+
   notification(
     notif: Notification,
     lastSeenAt: string | undefined,