@atproto/bsky 0.0.184 → 0.0.186

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/bsky",
-  "version": "0.0.184",
+  "version": "0.0.186",
   "license": "MIT",
   "description": "Reference implementation of app.bsky App View (Bluesky API)",
   "keywords": [
@@ -53,14 +53,14 @@
     "zod": "3.23.8",
     "@atproto-labs/fetch-node": "0.1.10",
     "@atproto-labs/xrpc-utils": "0.0.22",
-    "@atproto/api": "^0.16.9",
+    "@atproto/api": "^0.16.11",
     "@atproto/common": "^0.4.12",
     "@atproto/crypto": "^0.4.4",
     "@atproto/did": "^0.2.0",
     "@atproto/identity": "^0.4.9",
     "@atproto/lexicon": "^0.5.1",
-    "@atproto/repo": "^0.8.9",
-    "@atproto/sync": "^0.1.34",
+    "@atproto/repo": "^0.8.10",
+    "@atproto/sync": "^0.1.35",
     "@atproto/syntax": "^0.4.1",
     "@atproto/xrpc-server": "^0.9.5"
   },
@@ -77,9 +77,9 @@
     "jest": "^28.1.2",
     "ts-node": "^10.8.2",
     "typescript": "^5.6.3",
-    "@atproto/api": "^0.16.9",
+    "@atproto/api": "^0.16.11",
     "@atproto/lex-cli": "^0.9.5",
-    "@atproto/pds": "^0.4.178",
+    "@atproto/pds": "^0.4.182",
     "@atproto/xrpc": "^0.7.5"
   },
   "scripts": {

package/src/api/app/bsky/unspecced/getOnboardingSuggestedStarterPacks.ts

@@ -0,0 +1,152 @@
+import AtpAgent, { AtUri } from '@atproto/api'
+import { dedupeStrs, mapDefined, noUndefinedVals } from '@atproto/common'
+import { InternalServerError } from '@atproto/xrpc-server'
+import { AppContext } from '../../../../context'
+import {
+  HydrateCtx,
+  Hydrator,
+  mergeManyStates,
+} from '../../../../hydration/hydrator'
+import { Server } from '../../../../lexicon'
+import { QueryParams } from '../../../../lexicon/types/app/bsky/unspecced/getTrendingTopics'
+import {
+  HydrationFnInput,
+  PresentationFnInput,
+  RulesFnInput,
+  SkeletonFnInput,
+  createPipeline,
+} from '../../../../pipeline'
+import { Views } from '../../../../views'
+
+export default function (server: Server, ctx: AppContext) {
+  const getOnboardingSuggestedStarterPacks = createPipeline(
+    skeleton,
+    hydration,
+    noBlocks,
+    presentation,
+  )
+  server.app.bsky.unspecced.getOnboardingSuggestedStarterPacks({
+    auth: ctx.authVerifier.standardOptional,
+    handler: async ({ auth, params, req }) => {
+      const viewer = auth.credentials.iss
+      const labelers = ctx.reqLabelers(req)
+      const hydrateCtx = await ctx.hydrator.createContext({ labelers, viewer })
+      const headers = noUndefinedVals({
+        'accept-language': req.headers['accept-language'],
+        'x-bsky-topics': Array.isArray(req.headers['x-bsky-topics'])
+          ? req.headers['x-bsky-topics'].join(',')
+          : req.headers['x-bsky-topics'],
+      })
+      const { ...result } = await getOnboardingSuggestedStarterPacks(
+        {
+          ...params,
+          viewer: viewer ?? undefined,
+          hydrateCtx: hydrateCtx.copy({ viewer }),
+          headers,
+        },
+        ctx,
+      )
+      return {
+        encoding: 'application/json',
+        body: result,
+      }
+    },
+  })
+}
+
+const skeleton = async (input: SkeletonFnInput<Context, Params>) => {
+  const { params, ctx } = input
+  if (ctx.topicsAgent) {
+    const res =
+      await ctx.topicsAgent.app.bsky.unspecced.getOnboardingSuggestedStarterPacksSkeleton(
+        {
+          limit: params.limit,
+          viewer: params.viewer,
+        },
+        {
+          headers: params.headers,
+        },
+      )
+
+    return res.data
+  } else {
+    throw new InternalServerError('Topics agent not available')
+  }
+}
+
+const hydration = async (
+  input: HydrationFnInput<Context, Params, SkeletonState>,
+) => {
+  const { ctx, params, skeleton } = input
+  let dids: string[] = []
+  for (const uri of skeleton.starterPacks) {
+    let aturi: AtUri | undefined
+    try {
+      aturi = new AtUri(uri)
+    } catch {
+      continue
+    }
+    dids.push(aturi.hostname)
+  }
+  dids = dedupeStrs(dids)
+  const pairs: Map<string, string[]> = new Map()
+  if (params.viewer) {
+    pairs.set(params.viewer, dids)
+  }
+  const [starterPacksState, bidirectionalBlocks] = await Promise.all([
+    ctx.hydrator.hydrateStarterPacks(skeleton.starterPacks, params.hydrateCtx),
+    ctx.hydrator.hydrateBidirectionalBlocks(pairs, params.hydrateCtx),
+  ])
+
+  return mergeManyStates(starterPacksState, { bidirectionalBlocks })
+}
+
+const noBlocks = (input: RulesFnInput<Context, Params, SkeletonState>) => {
+  const { skeleton, params, hydration } = input
+
+  if (!params.viewer) {
+    return skeleton
+  }
+
+  const blocks = hydration.bidirectionalBlocks?.get(params.viewer)
+  const filteredSkeleton: SkeletonState = {
+    starterPacks: skeleton.starterPacks.filter((uri) => {
+      let aturi: AtUri | undefined
+      try {
+        aturi = new AtUri(uri)
+      } catch {
+        return false
+      }
+      return !blocks?.get(aturi.hostname)
+    }),
+  }
+
+  return filteredSkeleton
+}
+
+const presentation = (
+  input: PresentationFnInput<Context, Params, SkeletonState>,
+) => {
+  const { ctx, skeleton, hydration } = input
+
+  return {
+    starterPacks: mapDefined(skeleton.starterPacks, (uri) =>
+      ctx.views.starterPack(uri, hydration),
+    ),
+  }
+}
+
+type Context = {
+  hydrator: Hydrator
+  views: Views
+  topicsAgent: AtpAgent | undefined
+}
+
+type Params = QueryParams & {
+  hydrateCtx: HydrateCtx & { viewer: string | null }
+  headers: Record<string, string>
+}
+
+type SkeletonState = {
+  starterPacks: string[]
+}

package/src/api/index.ts

@@ -58,6 +58,7 @@ import registerPush from './app/bsky/notification/registerPush'
 import updateSeen from './app/bsky/notification/updateSeen'
 import getAgeAssuranceState from './app/bsky/unspecced/getAgeAssuranceState'
 import getConfig from './app/bsky/unspecced/getConfig'
+import getOnboardingSuggestedStarterPacks from './app/bsky/unspecced/getOnboardingSuggestedStarterPacks'
 import getPopularFeedGenerators from './app/bsky/unspecced/getPopularFeedGenerators'
 import getPostThreadOtherV2 from './app/bsky/unspecced/getPostThreadOtherV2'
 import getPostThreadV2 from './app/bsky/unspecced/getPostThreadV2'
@@ -133,6 +134,7 @@ export default function (server: Server, ctx: AppContext) {
   getSuggestedFollowsByActor(server, ctx)
   getTrendingTopics(server, ctx)
   getTrends(server, ctx)
+  getOnboardingSuggestedStarterPacks(server, ctx)
   getSuggestedStarterPacks(server, ctx)
   getSuggestedUsers(server, ctx)
   getUnspeccedSuggestedFeeds(server, ctx)

package/src/lexicon/index.ts

@@ -74,6 +74,8 @@ import * as AppBskyNotificationUnregisterPush from './types/app/bsky/notificatio
 import * as AppBskyNotificationUpdateSeen from './types/app/bsky/notification/updateSeen.js'
 import * as AppBskyUnspeccedGetAgeAssuranceState from './types/app/bsky/unspecced/getAgeAssuranceState.js'
 import * as AppBskyUnspeccedGetConfig from './types/app/bsky/unspecced/getConfig.js'
+import * as AppBskyUnspeccedGetOnboardingSuggestedStarterPacks from './types/app/bsky/unspecced/getOnboardingSuggestedStarterPacks.js'
+import * as AppBskyUnspeccedGetOnboardingSuggestedStarterPacksSkeleton from './types/app/bsky/unspecced/getOnboardingSuggestedStarterPacksSkeleton.js'
 import * as AppBskyUnspeccedGetPopularFeedGenerators from './types/app/bsky/unspecced/getPopularFeedGenerators.js'
 import * as AppBskyUnspeccedGetPostThreadOtherV2 from './types/app/bsky/unspecced/getPostThreadOtherV2.js'
 import * as AppBskyUnspeccedGetPostThreadV2 from './types/app/bsky/unspecced/getPostThreadV2.js'
@@ -1132,6 +1134,30 @@ export class AppBskyUnspeccedNS {
     return this._server.xrpc.method(nsid, cfg)
   }
 
+  getOnboardingSuggestedStarterPacks<A extends Auth = void>(
+    cfg: MethodConfigOrHandler<
+      A,
+      AppBskyUnspeccedGetOnboardingSuggestedStarterPacks.QueryParams,
+      AppBskyUnspeccedGetOnboardingSuggestedStarterPacks.HandlerInput,
+      AppBskyUnspeccedGetOnboardingSuggestedStarterPacks.HandlerOutput
+    >,
+  ) {
+    const nsid = 'app.bsky.unspecced.getOnboardingSuggestedStarterPacks' // @ts-ignore
+    return this._server.xrpc.method(nsid, cfg)
+  }
+
+  getOnboardingSuggestedStarterPacksSkeleton<A extends Auth = void>(
+    cfg: MethodConfigOrHandler<
+      A,
+      AppBskyUnspeccedGetOnboardingSuggestedStarterPacksSkeleton.QueryParams,
+      AppBskyUnspeccedGetOnboardingSuggestedStarterPacksSkeleton.HandlerInput,
+      AppBskyUnspeccedGetOnboardingSuggestedStarterPacksSkeleton.HandlerOutput
+    >,
+  ) {
+    const nsid = 'app.bsky.unspecced.getOnboardingSuggestedStarterPacksSkeleton' // @ts-ignore
+    return this._server.xrpc.method(nsid, cfg)
+  }
+
   getPopularFeedGenerators<A extends Auth = void>(
     cfg: MethodConfigOrHandler<
       A,

package/src/lexicon/lexicons.ts

@@ -145,6 +145,13 @@ export const schemaDict = {
             maxGraphemes: 256,
             maxLength: 2560,
           },
+          pronouns: {
+            type: 'string',
+          },
+          website: {
+            type: 'string',
+            format: 'uri',
+          },
           avatar: {
             type: 'string',
             format: 'uri',
@@ -964,6 +971,16 @@ export const schemaDict = {
               maxGraphemes: 256,
               maxLength: 2560,
             },
+            pronouns: {
+              type: 'string',
+              description: 'Free-form pronouns text.',
+              maxGraphemes: 20,
+              maxLength: 200,
+            },
+            website: {
+              type: 'string',
+              format: 'uri',
+            },
             avatar: {
               type: 'blob',
               description:
@@ -6611,6 +6628,87 @@ export const schemaDict = {
       },
     },
   },
+  AppBskyUnspeccedGetOnboardingSuggestedStarterPacks: {
+    lexicon: 1,
+    id: 'app.bsky.unspecced.getOnboardingSuggestedStarterPacks',
+    defs: {
+      main: {
+        type: 'query',
+        description: 'Get a list of suggested starterpacks for onboarding',
+        parameters: {
+          type: 'params',
+          properties: {
+            limit: {
+              type: 'integer',
+              minimum: 1,
+              maximum: 25,
+              default: 10,
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['starterPacks'],
+            properties: {
+              starterPacks: {
+                type: 'array',
+                items: {
+                  type: 'ref',
+                  ref: 'lex:app.bsky.graph.defs#starterPackView',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+  AppBskyUnspeccedGetOnboardingSuggestedStarterPacksSkeleton: {
+    lexicon: 1,
+    id: 'app.bsky.unspecced.getOnboardingSuggestedStarterPacksSkeleton',
+    defs: {
+      main: {
+        type: 'query',
+        description:
+          'Get a skeleton of suggested starterpacks for onboarding. Intended to be called and hydrated by app.bsky.unspecced.getOnboardingSuggestedStarterPacks',
+        parameters: {
+          type: 'params',
+          properties: {
+            viewer: {
+              type: 'string',
+              format: 'did',
+              description:
+                'DID of the account making the request (not included for public/unauthenticated queries).',
+            },
+            limit: {
+              type: 'integer',
+              minimum: 1,
+              maximum: 25,
+              default: 10,
+            },
+          },
+        },
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['starterPacks'],
+            properties: {
+              starterPacks: {
+                type: 'array',
+                items: {
+                  type: 'string',
+                  format: 'at-uri',
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
   AppBskyUnspeccedGetPopularFeedGenerators: {
     lexicon: 1,
     id: 'app.bsky.unspecced.getPopularFeedGenerators',
@@ -13962,6 +14060,10 @@ export const ids = {
   AppBskyUnspeccedGetAgeAssuranceState:
     'app.bsky.unspecced.getAgeAssuranceState',
   AppBskyUnspeccedGetConfig: 'app.bsky.unspecced.getConfig',
+  AppBskyUnspeccedGetOnboardingSuggestedStarterPacks:
+    'app.bsky.unspecced.getOnboardingSuggestedStarterPacks',
+  AppBskyUnspeccedGetOnboardingSuggestedStarterPacksSkeleton:
+    'app.bsky.unspecced.getOnboardingSuggestedStarterPacksSkeleton',
   AppBskyUnspeccedGetPopularFeedGenerators:
     'app.bsky.unspecced.getPopularFeedGenerators',
   AppBskyUnspeccedGetPostThreadOtherV2:

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

@@ -77,6 +77,8 @@ export interface ProfileViewDetailed {
   handle: string
   displayName?: string
   description?: string
+  pronouns?: string
+  website?: string
   avatar?: string
   banner?: string
   followersCount?: number

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

@@ -21,6 +21,9 @@ export interface Record {
   displayName?: string
   /** Free-form profile description text. */
   description?: string
+  /** Free-form pronouns text. */
+  pronouns?: string
+  website?: string
   /** Small image to be displayed next to posts from account. AKA, 'profile picture' */
   avatar?: BlobRef
   /** Larger horizontal image to display behind profile view. */

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

@@ -0,0 +1,40 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { type ValidationResult, BlobRef } from '@atproto/lexicon'
+import { CID } from 'multiformats/cid'
+import { validate as _validate } from '../../../../lexicons'
+import {
+  type $Typed,
+  is$typed as _is$typed,
+  type OmitKey,
+} from '../../../../util'
+import type * as AppBskyGraphDefs from '../graph/defs.js'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'app.bsky.unspecced.getOnboardingSuggestedStarterPacks'
+
+export type QueryParams = {
+  limit: number
+}
+export type InputSchema = undefined
+
+export interface OutputSchema {
+  starterPacks: AppBskyGraphDefs.StarterPackView[]
+}
+
+export type HandlerInput = void
+
+export interface HandlerSuccess {
+  encoding: 'application/json'
+  body: OutputSchema
+  headers?: { [key: string]: string }
+}
+
+export interface HandlerError {
+  status: number
+  message?: string
+}
+
+export type HandlerOutput = HandlerError | HandlerSuccess

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

@@ -0,0 +1,41 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { type ValidationResult, BlobRef } from '@atproto/lexicon'
+import { CID } from 'multiformats/cid'
+import { validate as _validate } from '../../../../lexicons'
+import {
+  type $Typed,
+  is$typed as _is$typed,
+  type OmitKey,
+} from '../../../../util'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'app.bsky.unspecced.getOnboardingSuggestedStarterPacksSkeleton'
+
+export type QueryParams = {
+  /** DID of the account making the request (not included for public/unauthenticated queries). */
+  viewer?: string
+  limit: number
+}
+export type InputSchema = undefined
+
+export interface OutputSchema {
+  starterPacks: string[]
+}
+
+export type HandlerInput = void
+
+export interface HandlerSuccess {
+  encoding: 'application/json'
+  body: OutputSchema
+  headers?: { [key: string]: string }
+}
+
+export interface HandlerError {
+  status: number
+  message?: string
+}
+
+export type HandlerOutput = HandlerError | HandlerSuccess

package/src/util.ts

@@ -8,7 +8,9 @@ export type ParsedLabelers = {
 export const parseLabelerHeader = (
   header: string | undefined,
 ): ParsedLabelers | null => {
-  if (!header) return null
+  // An empty header is valid, so we shouldn't return null
+  // https://datatracker.ietf.org/doc/html/rfc7230#section-3.2
+  if (header === undefined) return null
   const labelerDids = new Set<string>()
   const redactDids = new Set<string>()
   const parsed = parseList(header)

package/src/views/index.ts

@@ -265,6 +265,8 @@ export class Views {
 
     return {
       ...baseView,
+      pronouns: actor.profile?.pronouns,
+      website: this.profileWebsite(did, state),
       viewer: baseView.viewer
         ? {
             ...baseView.viewer,
@@ -444,6 +446,16 @@ export class Views {
     return undefined
   }
 
+  profileWebsite(did: string, state: HydrationState): string | undefined {
+    const actor = state.actors?.get(did)
+    if (!actor?.profile?.website) return
+    const { website } = actor.profile
+
+    // The record property accepts any URI, but we don't want
+    // to pass the client any schemes other than HTTPS.
+    return website.startsWith('https://') ? website : undefined
+  }
+
   knownFollowers(
     did: string,
     state: HydrationState,

package/tests/views/__snapshots__/profile.test.ts.snap

@@ -255,6 +255,60 @@ Array [
       "muted": false,
     },
   },
+  Object {
+    "associated": Object {
+      "activitySubscription": Object {
+        "allowSubscriptions": "followers",
+      },
+      "feedgens": 0,
+      "labeler": false,
+      "lists": 0,
+      "starterPacks": 0,
+    },
+    "avatar": "https://bsky.public.url/img/avatar/plain/user(7)/cids(0)@jpeg",
+    "createdAt": "1970-01-01T00:00:00.000Z",
+    "description": "It's me, eve",
+    "did": "user(6)",
+    "displayName": "eve",
+    "followersCount": 0,
+    "followsCount": 0,
+    "handle": "eve.test",
+    "indexedAt": "1970-01-01T00:00:00.000Z",
+    "labels": Array [],
+    "postsCount": 0,
+    "pronouns": "They/them",
+    "viewer": Object {
+      "blockedBy": false,
+      "muted": false,
+    },
+  },
+  Object {
+    "associated": Object {
+      "activitySubscription": Object {
+        "allowSubscriptions": "followers",
+      },
+      "feedgens": 0,
+      "labeler": false,
+      "lists": 0,
+      "starterPacks": 0,
+    },
+    "avatar": "https://bsky.public.url/img/avatar/plain/user(9)/cids(0)@jpeg",
+    "createdAt": "1970-01-01T00:00:00.000Z",
+    "description": "It's me, frank",
+    "did": "user(8)",
+    "displayName": "frank",
+    "followersCount": 0,
+    "followsCount": 0,
+    "handle": "frank.test",
+    "indexedAt": "1970-01-01T00:00:00.000Z",
+    "labels": Array [],
+    "postsCount": 0,
+    "viewer": Object {
+      "blockedBy": false,
+      "muted": false,
+    },
+    "website": "https://frank.example.com",
+  },
 ]
 `;
 

package/tests/views/profile.test.ts

@@ -16,6 +16,8 @@ describe('pds profile views', () => {
   let alice: string
   let bob: string
   let dan: string
+  let eve: string
+  let frank: string
 
   beforeAll(async () => {
     network = await TestNetwork.create({
@@ -25,10 +27,47 @@ describe('pds profile views', () => {
     pdsAgent = network.pds.getClient()
     sc = network.getSeedClient()
     await basicSeed(sc)
+
+    await sc.createAccount('eve', {
+      handle: 'eve.test',
+      email: 'eve@test.com',
+      password: 'eve-pass',
+    })
+    await sc.createProfile(
+      sc.dids.eve,
+      'eve',
+      `It's me, eve`,
+      undefined,
+      undefined,
+      {
+        pronouns: 'They/them',
+        // Not allowing that to go through, even though is a valid URL.
+        website: 'wss://jetstream1.us-east.bsky.network',
+      },
+    )
+
+    await sc.createAccount('frank', {
+      handle: 'frank.test',
+      email: 'frank@test.com',
+      password: 'frank-pass',
+    })
+    await sc.createProfile(
+      sc.dids.frank,
+      'frank',
+      `It's me, frank`,
+      undefined,
+      undefined,
+      {
+        website: 'https://frank.example.com',
+      },
+    )
+
     await network.processAll()
     alice = sc.dids.alice
     bob = sc.dids.bob
     dan = sc.dids.dan
+    eve = sc.dids.eve
+    frank = sc.dids.frank
   })
 
   afterAll(async () => {
@@ -100,6 +139,8 @@ describe('pds profile views', () => {
           'did:example:missing',
           'carol.test',
           dan,
+          eve,
+          frank,
           'missing.test',
         ],
       },
@@ -113,6 +154,8 @@ describe('pds profile views', () => {
       'bob.test',
       'carol.test',
       'dan.test',
+      'eve.test',
+      'frank.test',
     ])
 
     expect(forSnapshot(profiles)).toMatchSnapshot()