@atproto/bsky 0.0.176 → 0.0.177

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

@@ -0,0 +1,65 @@
+/**
+ * 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 './defs.js'
+
+const is$typed = _is$typed,
+  validate = _validate
+const id = 'app.bsky.graph.getStarterPacksWithMembership'
+
+export type QueryParams = {
+  /** The account (actor) to check for membership. */
+  actor: string
+  limit: number
+  cursor?: string
+}
+export type InputSchema = undefined
+
+export interface OutputSchema {
+  cursor?: string
+  starterPacksWithMembership: StarterPackWithMembership[]
+}
+
+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
+
+/** A starter pack and an optional list item indicating membership of a target user to that starter pack. */
+export interface StarterPackWithMembership {
+  $type?: 'app.bsky.graph.getStarterPacksWithMembership#starterPackWithMembership'
+  starterPack: AppBskyGraphDefs.StarterPackView
+  listItem?: AppBskyGraphDefs.ListItemView
+}
+
+const hashStarterPackWithMembership = 'starterPackWithMembership'
+
+export function isStarterPackWithMembership<V>(v: V) {
+  return is$typed(v, id, hashStarterPackWithMembership)
+}
+
+export function validateStarterPackWithMembership<V>(v: V) {
+  return validate<StarterPackWithMembership & V>(
+    v,
+    id,
+    hashStarterPackWithMembership,
+  )
+}

package/src/views/index.ts

@@ -44,6 +44,7 @@ import {
 import { Record as RepostRecord } from '../lexicon/types/app/bsky/feed/repost'
 import { isListRule } from '../lexicon/types/app/bsky/feed/threadgate'
 import {
+  ListItemView,
   ListView,
   ListViewBasic,
   StarterPackView,
@@ -625,6 +626,16 @@ export class Views {
     }
   }
 
+  listItemView(
+    uri: string,
+    did: string,
+    state: HydrationState,
+  ): Un$Typed<ListItemView> | undefined {
+    const subject = this.profile(did, state)
+    if (!subject) return
+    return { uri, subject }
+  }
+
   starterPackBasic(
     uri: string,
     state: HydrationState,

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

@@ -139,8 +139,8 @@ Array [
     "indexedAt": "1970-01-01T00:00:00.000Z",
     "labels": Array [],
     "listItemCount": 0,
-    "name": "cool curate list",
-    "purpose": "app.bsky.graph.defs#curatelist",
+    "name": "mod2",
+    "purpose": "app.bsky.graph.defs#modlist",
     "uri": "record(0)",
   },
   Object {
@@ -157,10 +157,86 @@ Array [
     },
     "indexedAt": "1970-01-01T00:00:00.000Z",
     "labels": Array [],
+    "listItemCount": 0,
+    "name": "mod1",
+    "purpose": "app.bsky.graph.defs#modlist",
+    "uri": "record(1)",
+  },
+  Object {
+    "cid": "cids(2)",
+    "creator": Object {
+      "associated": Object {
+        "activitySubscription": Object {
+          "allowSubscriptions": "followers",
+        },
+      },
+      "did": "user(0)",
+      "handle": "eve.test",
+      "labels": Array [],
+    },
+    "indexedAt": "1970-01-01T00:00:00.000Z",
+    "labels": Array [],
+    "listItemCount": 2,
+    "name": "mod0",
+    "purpose": "app.bsky.graph.defs#modlist",
+    "uri": "record(2)",
+  },
+  Object {
+    "cid": "cids(3)",
+    "creator": Object {
+      "associated": Object {
+        "activitySubscription": Object {
+          "allowSubscriptions": "followers",
+        },
+      },
+      "did": "user(0)",
+      "handle": "eve.test",
+      "labels": Array [],
+    },
+    "indexedAt": "1970-01-01T00:00:00.000Z",
+    "labels": Array [],
+    "listItemCount": 0,
+    "name": "cur2",
+    "purpose": "app.bsky.graph.defs#curatelist",
+    "uri": "record(3)",
+  },
+  Object {
+    "cid": "cids(4)",
+    "creator": Object {
+      "associated": Object {
+        "activitySubscription": Object {
+          "allowSubscriptions": "followers",
+        },
+      },
+      "did": "user(0)",
+      "handle": "eve.test",
+      "labels": Array [],
+    },
+    "indexedAt": "1970-01-01T00:00:00.000Z",
+    "labels": Array [],
+    "listItemCount": 0,
+    "name": "cur1",
+    "purpose": "app.bsky.graph.defs#curatelist",
+    "uri": "record(4)",
+  },
+  Object {
+    "cid": "cids(5)",
+    "creator": Object {
+      "associated": Object {
+        "activitySubscription": Object {
+          "allowSubscriptions": "followers",
+        },
+      },
+      "did": "user(0)",
+      "handle": "eve.test",
+      "labels": Array [],
+    },
+    "indexedAt": "1970-01-01T00:00:00.000Z",
+    "labels": Array [],
     "listItemCount": 3,
-    "name": "blah curate list!",
+    "name": "cur0",
     "purpose": "app.bsky.graph.defs#curatelist",
-    "uri": "record(1)",
+    "uri": "record(5)",
   },
 ]
 `;
@@ -471,8 +547,8 @@ Array [
     "indexedAt": "1970-01-01T00:00:00.000Z",
     "labels": Array [],
     "listItemCount": 0,
-    "name": "cool curate list",
-    "purpose": "app.bsky.graph.defs#curatelist",
+    "name": "mod2",
+    "purpose": "app.bsky.graph.defs#modlist",
     "uri": "record(0)",
   },
   Object {
@@ -489,10 +565,86 @@ Array [
     },
     "indexedAt": "1970-01-01T00:00:00.000Z",
     "labels": Array [],
+    "listItemCount": 0,
+    "name": "mod1",
+    "purpose": "app.bsky.graph.defs#modlist",
+    "uri": "record(1)",
+  },
+  Object {
+    "cid": "cids(2)",
+    "creator": Object {
+      "associated": Object {
+        "activitySubscription": Object {
+          "allowSubscriptions": "followers",
+        },
+      },
+      "did": "user(0)",
+      "handle": "eve.test",
+      "labels": Array [],
+    },
+    "indexedAt": "1970-01-01T00:00:00.000Z",
+    "labels": Array [],
+    "listItemCount": 2,
+    "name": "mod0",
+    "purpose": "app.bsky.graph.defs#modlist",
+    "uri": "record(2)",
+  },
+  Object {
+    "cid": "cids(3)",
+    "creator": Object {
+      "associated": Object {
+        "activitySubscription": Object {
+          "allowSubscriptions": "followers",
+        },
+      },
+      "did": "user(0)",
+      "handle": "eve.test",
+      "labels": Array [],
+    },
+    "indexedAt": "1970-01-01T00:00:00.000Z",
+    "labels": Array [],
+    "listItemCount": 0,
+    "name": "cur2",
+    "purpose": "app.bsky.graph.defs#curatelist",
+    "uri": "record(3)",
+  },
+  Object {
+    "cid": "cids(4)",
+    "creator": Object {
+      "associated": Object {
+        "activitySubscription": Object {
+          "allowSubscriptions": "followers",
+        },
+      },
+      "did": "user(0)",
+      "handle": "eve.test",
+      "labels": Array [],
+    },
+    "indexedAt": "1970-01-01T00:00:00.000Z",
+    "labels": Array [],
+    "listItemCount": 0,
+    "name": "cur1",
+    "purpose": "app.bsky.graph.defs#curatelist",
+    "uri": "record(4)",
+  },
+  Object {
+    "cid": "cids(5)",
+    "creator": Object {
+      "associated": Object {
+        "activitySubscription": Object {
+          "allowSubscriptions": "followers",
+        },
+      },
+      "did": "user(0)",
+      "handle": "eve.test",
+      "labels": Array [],
+    },
+    "indexedAt": "1970-01-01T00:00:00.000Z",
+    "labels": Array [],
     "listItemCount": 3,
-    "name": "blah curate list!",
+    "name": "cur0",
     "purpose": "app.bsky.graph.defs#curatelist",
-    "uri": "record(1)",
+    "uri": "record(5)",
   },
 ]
 `;

package/tests/views/lists.test.ts

@@ -1,15 +1,26 @@
 import { AtpAgent } from '@atproto/api'
 import { SeedClient, TestNetwork, basicSeed } from '@atproto/dev-env'
 import { ids } from '../../src/lexicon/lexicons'
-import { forSnapshot } from '../_util'
+import { OutputSchema as GetListsOutputSchema } from '../../src/lexicon/types/app/bsky/graph/getLists'
+import {
+  ListWithMembership,
+  OutputSchema as GetListsWithMembershipOutputSchema,
+} from '../../src/lexicon/types/app/bsky/graph/getListsWithMembership'
+import { forSnapshot, paginateAll } from '../_util'
 
 describe('bsky actor likes feed views', () => {
   let network: TestNetwork
   let agent: AtpAgent
   let sc: SeedClient
 
+  let blockList: string
   let curateList: string
   let referenceList: string
+  let eveListItemCur: string
+  let frankieListItemCur: string
+  let frankieListItemMod: string
+  let gretaListItemMod: string
+
   let alice: string
   let eve: string
   let frankie: string
@@ -38,30 +49,53 @@ describe('bsky actor likes feed views', () => {
       password: 'hunter4real',
     })
 
-    const newRefList = await sc.createList(
+    const newRefList = await sc.createList(sc.dids.eve, 'ref0', 'reference')
+    await sc.addToList(sc.dids.eve, sc.dids.eve, newRefList)
+    await sc.addToList(sc.dids.eve, sc.dids.bob, newRefList)
+    await sc.addToList(sc.dids.eve, sc.dids.frankie, newRefList)
+
+    const newCurList = await sc.createList(sc.dids.eve, 'cur0', 'curate')
+    await sc.createList(sc.dids.eve, 'cur1', 'curate')
+    await sc.createList(sc.dids.eve, 'cur2', 'curate')
+    const newEveListItemCur = await sc.addToList(
+      sc.dids.eve,
       sc.dids.eve,
-      'blah starter pack list!',
-      'reference',
+      newCurList,
     )
-    const newCurrList = await sc.createList(
+    await sc.addToList(sc.dids.eve, sc.dids.bob, newCurList)
+    const newFrankieListItemCur = await sc.addToList(
       sc.dids.eve,
-      'blah curate list!',
-      'curate',
+      sc.dids.frankie,
+      newCurList,
     )
 
-    await sc.addToList(sc.dids.eve, sc.dids.eve, newRefList)
-    await sc.addToList(sc.dids.eve, sc.dids.bob, newRefList)
-    await sc.addToList(sc.dids.eve, sc.dids.frankie, newRefList)
-
-    await sc.addToList(sc.dids.eve, sc.dids.eve, newCurrList)
-    await sc.addToList(sc.dids.eve, sc.dids.bob, newCurrList)
-    await sc.addToList(sc.dids.eve, sc.dids.frankie, newCurrList)
+    const newBlockList = await sc.createList(sc.dids.eve, 'mod0', 'mod')
+    await sc.createList(sc.dids.eve, 'mod1', 'mod')
+    await sc.createList(sc.dids.eve, 'mod2', 'mod')
+    const newFrankieListItemMod = await sc.addToList(
+      sc.dids.eve,
+      sc.dids.frankie,
+      newBlockList,
+    )
+    const newGretaListItemMod = await sc.addToList(
+      sc.dids.eve,
+      sc.dids.greta,
+      newBlockList,
+    )
 
+    await sc.block(sc.dids.frankie, sc.dids.greta)
     await sc.block(sc.dids.frankie, sc.dids.eve)
 
     await network.processAll()
-    curateList = newCurrList.uriStr
+    blockList = newBlockList.uriStr
+    curateList = newCurList.uriStr
     referenceList = newRefList.uriStr
+
+    eveListItemCur = newEveListItemCur.uriStr
+    frankieListItemCur = newFrankieListItemCur.uriStr
+    frankieListItemMod = newFrankieListItemMod.uriStr
+    gretaListItemMod = newGretaListItemMod.uriStr
+
     alice = sc.dids.alice
     eve = sc.dids.eve
     frankie = sc.dids.frankie
@@ -73,12 +107,10 @@ describe('bsky actor likes feed views', () => {
   })
 
   it('does not include reference lists in getActorLists', async () => {
-    await sc.createList(eve, 'cool curate list', 'curate')
-    await network.processAll()
-    const view = await agent.api.app.bsky.graph.getLists({
+    const view = await agent.app.bsky.graph.getLists({
       actor: eve,
     })
-    expect(view.data.lists.length).toBe(2)
+    expect(view.data.lists.length).toBe(6)
     expect(forSnapshot(view.data.lists)).toMatchSnapshot()
   })
 
@@ -86,12 +118,79 @@ describe('bsky actor likes feed views', () => {
     const view = await agent.app.bsky.graph.getLists({
       actor: 'eve.test',
     })
-    expect(view.data.lists.length).toBe(2)
+    expect(view.data.lists.length).toBe(6)
     expect(forSnapshot(view.data.lists)).toMatchSnapshot()
   })
 
+  it('allows filtering by list purpose', async () => {
+    const viewCurate = await agent.app.bsky.graph.getLists({
+      actor: eve,
+      purposes: ['curatelist'],
+    })
+    expect(viewCurate.data.lists.length).toBe(3)
+
+    const viewMod = await agent.app.bsky.graph.getLists({
+      actor: eve,
+      purposes: ['modlist'],
+    })
+    expect(viewMod.data.lists.length).toBe(3)
+
+    const viewAll = await agent.app.bsky.graph.getLists({
+      actor: eve,
+      purposes: ['curatelist', 'modlist'],
+    })
+    expect(viewAll.data.lists.length).toBe(6)
+  })
+
+  it.each([
+    { expected: 6, purposes: [] },
+    { expected: 6, purposes: ['curatelist', 'modlist'] },
+    { expected: 3, purposes: ['curatelist'] },
+    { expected: 3, purposes: ['modlist'] },
+    { expected: 0, purposes: ['referencelist'] }, // not supported on getLists.
+  ])(
+    'paginates for purposes filter: $purposes',
+    async ({ expected, purposes }) => {
+      const results = (out: GetListsOutputSchema[]) =>
+        out.flatMap((res) => res.lists)
+      const paginator = async (cursor?: string) => {
+        const res = await agent.app.bsky.graph.getLists(
+          { actor: eve, purposes, limit: 2, cursor },
+          {
+            headers: await network.serviceHeaders(
+              eve,
+              ids.AppBskyGraphGetLists,
+            ),
+          },
+        )
+        return res.data
+      }
+
+      const paginatedAll = await paginateAll(paginator)
+      paginatedAll.forEach((res) =>
+        expect(res.lists.length).toBeLessThanOrEqual(2),
+      )
+
+      const full = await agent.app.bsky.graph.getLists(
+        { actor: eve, purposes },
+        {
+          headers: await network.serviceHeaders(eve, ids.AppBskyGraphGetLists),
+        },
+      )
+      expect(full.data.lists.length).toBe(expected)
+
+      const sortedFull = results([full.data]).sort((a, b) =>
+        a.uri > b.uri ? 1 : -1,
+      )
+      const sortedPaginated = results(paginatedAll).sort((a, b) =>
+        a.uri > b.uri ? 1 : -1,
+      )
+      expect(sortedPaginated).toEqual(sortedFull)
+    },
+  )
+
   it('does not include users with creator block relationship in reference lists for non-creator, in-list viewers', async () => {
-    const curView = await agent.api.app.bsky.graph.getList(
+    const curView = await agent.app.bsky.graph.getList(
       {
         list: curateList,
       },
@@ -102,7 +201,7 @@ describe('bsky actor likes feed views', () => {
     expect(curView.data.items.length).toBe(2)
     expect(forSnapshot(curView.data.items)).toMatchSnapshot()
 
-    const refView = await agent.api.app.bsky.graph.getList(
+    const refView = await agent.app.bsky.graph.getList(
       { list: referenceList },
       {
         headers: await network.serviceHeaders(frankie, ids.AppBskyGraphGetList),
@@ -113,7 +212,7 @@ describe('bsky actor likes feed views', () => {
   })
 
   it('does not include users with creator block relationship in reference lists for non-creator, not-in-list viewers', async () => {
-    const curView = await agent.api.app.bsky.graph.getList(
+    const curView = await agent.app.bsky.graph.getList(
       {
         list: curateList,
       },
@@ -122,7 +221,7 @@ describe('bsky actor likes feed views', () => {
     expect(curView.data.items.length).toBe(2)
     expect(forSnapshot(curView.data.items)).toMatchSnapshot()
 
-    const refView = await agent.api.app.bsky.graph.getList(
+    const refView = await agent.app.bsky.graph.getList(
       { list: referenceList },
       { headers: await network.serviceHeaders(greta, ids.AppBskyGraphGetList) },
     )
@@ -131,13 +230,13 @@ describe('bsky actor likes feed views', () => {
   })
 
   it('does not include users with creator block relationship in reference and curate lists for signed-out viewers', async () => {
-    const curView = await agent.api.app.bsky.graph.getList({
+    const curView = await agent.app.bsky.graph.getList({
       list: curateList,
     })
     expect(curView.data.items.length).toBe(2)
     expect(forSnapshot(curView.data.items)).toMatchSnapshot()
 
-    const refView = await agent.api.app.bsky.graph.getList({
+    const refView = await agent.app.bsky.graph.getList({
       list: referenceList,
     })
     expect(refView.data.items.length).toBe(2)
@@ -145,14 +244,14 @@ describe('bsky actor likes feed views', () => {
   })
 
   it('does include users with creator block relationship in reference lists for creator', async () => {
-    const curView = await agent.api.app.bsky.graph.getList(
+    const curView = await agent.app.bsky.graph.getList(
       { list: curateList },
       { headers: await network.serviceHeaders(eve, ids.AppBskyGraphGetList) },
     )
     expect(curView.data.items.length).toBe(3)
     expect(forSnapshot(curView.data.items)).toMatchSnapshot()
 
-    const refView = await agent.api.app.bsky.graph.getList(
+    const refView = await agent.app.bsky.graph.getList(
       { list: referenceList },
       { headers: await network.serviceHeaders(eve, ids.AppBskyGraphGetList) },
     )
@@ -161,17 +260,152 @@ describe('bsky actor likes feed views', () => {
   })
 
   it('does return all users regardless of creator block relationship in moderation lists', async () => {
-    const blockList = await sc.createList(eve, 'block list', 'mod')
-    await sc.addToList(eve, frankie, blockList)
-    await sc.addToList(eve, greta, blockList)
-    await sc.block(frankie, greta)
-    await network.processAll()
-
-    const view = await agent.api.app.bsky.graph.getList(
-      { list: blockList.uriStr },
+    const view = await agent.app.bsky.graph.getList(
+      { list: blockList },
       { headers: await network.serviceHeaders(alice, ids.AppBskyGraphGetList) },
     )
     expect(view.data.items.length).toBe(2)
     expect(forSnapshot(view.data.items)).toMatchSnapshot()
   })
+
+  describe('list membership', () => {
+    const uriSort = (a: string, b: string) => (a > b ? 1 : -1)
+    const membershipsUris = (lwms: ListWithMembership[]): string[] =>
+      lwms
+        .map((lwm) => lwm.listItem?.uri)
+        .filter((li): li is string => typeof li === 'string')
+        .sort(uriSort)
+
+    it('returns all lists by the user', async () => {
+      const view = await agent.app.bsky.graph.getListsWithMembership(
+        { actor: frankie },
+        {
+          headers: await network.serviceHeaders(
+            eve,
+            ids.AppBskyGraphGetListsWithMembership,
+          ),
+        },
+      )
+      expect(view.data.listsWithMembership.length).toBe(6)
+    })
+
+    it('finds self membership', async () => {
+      const view = await agent.app.bsky.graph.getListsWithMembership(
+        { actor: eve },
+        {
+          headers: await network.serviceHeaders(
+            eve,
+            ids.AppBskyGraphGetListsWithMembership,
+          ),
+        },
+      )
+
+      expect(view.data.listsWithMembership.length).toBe(6)
+      const memberships = membershipsUris(view.data.listsWithMembership)
+      const expectedMemberships = [eveListItemCur].sort(uriSort)
+      expect(memberships).toEqual(expectedMemberships)
+    })
+
+    it('finds membership in curatelist and modlist if actor is in both and purpose filter includes both', async () => {
+      const view = await agent.app.bsky.graph.getListsWithMembership(
+        { actor: frankie },
+        {
+          headers: await network.serviceHeaders(
+            eve,
+            ids.AppBskyGraphGetListsWithMembership,
+          ),
+        },
+      )
+
+      expect(view.data.listsWithMembership.length).toBe(6)
+      const memberships = membershipsUris(view.data.listsWithMembership)
+      const expectedMemberships = [frankieListItemCur, frankieListItemMod].sort(
+        uriSort,
+      )
+      expect(memberships).toEqual(expectedMemberships)
+    })
+
+    it('finds modlist membership filtering by modlist', async () => {
+      const view = await agent.app.bsky.graph.getListsWithMembership(
+        { actor: greta, purposes: ['modlist'] },
+        {
+          headers: await network.serviceHeaders(
+            eve,
+            ids.AppBskyGraphGetListsWithMembership,
+          ),
+        },
+      )
+
+      expect(view.data.listsWithMembership.length).toBe(3)
+      const memberships = membershipsUris(view.data.listsWithMembership)
+      const expectedMemberships = [gretaListItemMod].sort(uriSort)
+      expect(memberships).toEqual(expectedMemberships)
+    })
+
+    it('does not find modlist membership filtering by curatelist', async () => {
+      const view = await agent.app.bsky.graph.getListsWithMembership(
+        { actor: greta, purposes: ['curatelist'] },
+        {
+          headers: await network.serviceHeaders(
+            eve,
+            ids.AppBskyGraphGetListsWithMembership,
+          ),
+        },
+      )
+
+      expect(view.data.listsWithMembership.length).toBe(3)
+      const memberships = membershipsUris(view.data.listsWithMembership)
+      expect(memberships.length).toBe(0)
+    })
+
+    it.each([
+      { expected: 6, purposes: [] },
+      { expected: 6, purposes: ['curatelist', 'modlist'] },
+      { expected: 3, purposes: ['curatelist'] },
+      { expected: 3, purposes: ['modlist'] },
+      { expected: 0, purposes: ['referencelist'] }, // not supported on getLists.
+    ])(
+      'paginates for purposes filter: $purposes',
+      async ({ expected, purposes }) => {
+        const results = (out: GetListsWithMembershipOutputSchema[]) =>
+          out.flatMap((res) => res.listsWithMembership)
+        const paginator = async (cursor?: string) => {
+          const res = await agent.app.bsky.graph.getListsWithMembership(
+            { actor: eve, purposes, limit: 2, cursor },
+            {
+              headers: await network.serviceHeaders(
+                eve,
+                ids.AppBskyGraphGetListsWithMembership,
+              ),
+            },
+          )
+          return res.data
+        }
+
+        const paginatedAll = await paginateAll(paginator)
+        paginatedAll.forEach((res) =>
+          expect(res.listsWithMembership.length).toBeLessThanOrEqual(2),
+        )
+
+        const full = await agent.app.bsky.graph.getListsWithMembership(
+          { actor: eve, purposes },
+          {
+            headers: await network.serviceHeaders(
+              eve,
+              ids.AppBskyGraphGetListsWithMembership,
+            ),
+          },
+        )
+        expect(full.data.listsWithMembership.length).toBe(expected)
+
+        const sortedFull = results([full.data]).sort((a, b) =>
+          a.list.uri > b.list.uri ? 1 : -1,
+        )
+        const sortedPaginated = results(paginatedAll).sort((a, b) =>
+          a.list.uri > b.list.uri ? 1 : -1,
+        )
+        expect(sortedPaginated).toEqual(sortedFull)
+      },
+    )
+  })
 })