@atproto/dev-env 0.0.0-spaces-alpha-20260818163953

package/src/seed/client.ts

@@ -0,0 +1,676 @@
+import fs from 'node:fs/promises'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+import { CID } from 'multiformats/cid'
+import type {
+  $Typed,
+  AppBskyActorProfile,
+  AppBskyFeedLike,
+  AppBskyFeedPost,
+  AppBskyFeedRepost,
+  AppBskyGraphBlock,
+  AppBskyGraphFollow,
+  AppBskyGraphList,
+  AppBskyGraphVerification,
+  AppBskyRichtextFacet,
+  AtpAgent,
+  ChatBskyConvoDefs,
+  ComAtprotoAdminDefs,
+  ComAtprotoModerationCreateReport,
+  ComAtprotoRepoStrongRef,
+} from '@atproto/api'
+import type { CidString, Client } from '@atproto/lex'
+import type { BlobRef } from '@atproto/lexicon'
+import {
+  AtUri,
+  type AtUriString,
+  type DidString,
+  type HandleString,
+} from '@atproto/syntax'
+import type { TestNetworkNoAppView } from '../network-no-appview.js'
+
+// Makes it simple to create data via the XRPC client,
+// and keeps track of all created data in memory for convenience.
+
+let AVATAR_IMG: Uint8Array | undefined
+
+// AVATAR_PATH is defined in a non-CWD-dependant way, so this works
+// for any consumer of this package, even outside the atproto repo.
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const AVATAR_PATH = path.resolve(
+  __dirname,
+  '../../assets/key-portrait-small.jpg',
+)
+
+export type ImageRef = {
+  image: BlobRef
+  alt: string
+}
+
+export class RecordRef {
+  uri: AtUri
+  cid: CID
+
+  constructor(uri: AtUri | string, cid: CID | string) {
+    this.uri = new AtUri(uri.toString())
+    this.cid = CID.parse(cid.toString())
+  }
+
+  get raw(): { uri: AtUriString; cid: CidString } {
+    return {
+      uri: this.uri.toString(),
+      cid: this.cid.toString(),
+    }
+  }
+
+  get uriStr(): AtUriString {
+    return this.uri.toString()
+  }
+
+  get cidStr(): CidString {
+    return this.cid.toString()
+  }
+}
+
+export type Account = {
+  did: DidString
+  accessJwt: string
+  refreshJwt: string
+  handle: HandleString
+  email: string
+  password: string
+}
+
+export class SeedClient<
+  Network extends TestNetworkNoAppView = TestNetworkNoAppView,
+> {
+  accounts: Record<DidString, Account>
+  profiles: Record<
+    DidString,
+    {
+      displayName: string
+      description: string
+      avatar: { cid: string; mimeType: string }
+      joinedViaStarterPack: RecordRef | undefined
+      ref: RecordRef
+    }
+  >
+  follows: Record<DidString, Record<DidString, RecordRef>>
+  blocks: Record<DidString, Record<DidString, RecordRef>>
+  mutes: Record<DidString, Set<DidString>>
+  posts: Record<
+    DidString,
+    { text: string; ref: RecordRef; images: ImageRef[]; quote?: RecordRef }[]
+  >
+  likes: Record<DidString, Record<string, AtUri>>
+  replies: Record<
+    string,
+    { text: string; ref: RecordRef; images: ImageRef[] }[]
+  >
+  reposts: Record<DidString, RecordRef[]>
+  lists: Record<
+    DidString,
+    Record<
+      AtUriString,
+      {
+        ref: RecordRef
+        items: Record<DidString, RecordRef>
+      }
+    >
+  >
+  feedgens: Record<
+    DidString,
+    Record<
+      AtUriString,
+      {
+        ref: RecordRef
+        items: Record<string, RecordRef>
+      }
+    >
+  >
+  starterpacks: Record<
+    DidString,
+    Record<
+      AtUriString,
+      {
+        ref: RecordRef
+        name: string
+        list: RecordRef
+        feeds: readonly AtUriString[]
+      }
+    >
+  >
+
+  verifications: Record<DidString, Record<DidString, AtUri>>
+
+  dids: Record<string, DidString>
+
+  constructor(
+    public network: Network,
+    public agent: AtpAgent,
+    public client: Client,
+  ) {
+    this.accounts = {}
+    this.profiles = {}
+    this.follows = {}
+    this.blocks = {}
+    this.mutes = {}
+    this.posts = {}
+    this.likes = {}
+    this.replies = {}
+    this.reposts = {}
+    this.lists = {}
+    this.feedgens = {}
+    this.starterpacks = {}
+    this.verifications = {}
+    this.dids = {}
+  }
+
+  async createAccount(
+    shortName: string,
+    params: {
+      handle: HandleString
+      email: string
+      password: string
+      inviteCode?: string
+    },
+  ): Promise<Account> {
+    const { data: account } =
+      await this.agent.com.atproto.server.createAccount(params)
+    const did = account.did as DidString
+    this.dids[shortName] = did
+    this.accounts[account.did] = {
+      // @NOTE type case needed until we move test to lex-sdk
+      ...(account as typeof account & { handle: HandleString }),
+      did,
+      email: params.email,
+      password: params.password,
+    }
+    return this.accounts[account.did]
+  }
+
+  async updateHandle(by: DidString, handle: HandleString) {
+    await this.agent.com.atproto.identity.updateHandle(
+      { handle },
+      { encoding: 'application/json', headers: this.getHeaders(by) },
+    )
+  }
+
+  async createProfile(
+    by: DidString,
+    displayName: string,
+    description: string,
+    selfLabels?: readonly string[],
+    joinedViaStarterPack?: RecordRef,
+    overrides?: Partial<AppBskyActorProfile.Record>,
+  ): Promise<{
+    displayName: string
+    description: string
+    avatar: { cid: string; mimeType: string }
+    ref: RecordRef
+    joinedViaStarterPack?: RecordRef
+  }> {
+    AVATAR_IMG ??= await fs.readFile(AVATAR_PATH)
+
+    let avatarBlob
+    {
+      const res = await this.agent.com.atproto.repo.uploadBlob(AVATAR_IMG, {
+        encoding: 'image/jpeg',
+        headers: this.getHeaders(by),
+      } as any)
+      avatarBlob = res.data.blob
+    }
+
+    {
+      const res = await this.agent.app.bsky.actor.profile.create(
+        { repo: by },
+        {
+          displayName,
+          description,
+          avatar: avatarBlob,
+          labels: selfLabels
+            ? {
+                $type: 'com.atproto.label.defs#selfLabels',
+                values: selfLabels.map((val) => ({ val })),
+              }
+            : undefined,
+          joinedViaStarterPack: joinedViaStarterPack?.raw,
+          createdAt: new Date().toISOString(),
+          ...overrides,
+        },
+        this.getHeaders(by),
+      )
+      this.profiles[by] = {
+        displayName,
+        description,
+        avatar: avatarBlob,
+        joinedViaStarterPack,
+        ref: new RecordRef(res.uri, res.cid),
+      }
+    }
+    return this.profiles[by]
+  }
+
+  async updateProfile(by: DidString, record: Record<string, unknown>) {
+    const res = await this.agent.com.atproto.repo.putRecord(
+      {
+        repo: by,
+        collection: 'app.bsky.actor.profile',
+        rkey: 'self',
+        record,
+      },
+      { headers: this.getHeaders(by), encoding: 'application/json' },
+    )
+    this.profiles[by] = {
+      ...(this.profiles[by] ?? {}),
+      ...record,
+      ref: new RecordRef(res.data.uri, res.data.cid),
+    }
+    return this.profiles[by]
+  }
+
+  async follow(
+    from: DidString,
+    to: DidString,
+    overrides?: Partial<AppBskyGraphFollow.Record>,
+  ) {
+    const res = await this.agent.app.bsky.graph.follow.create(
+      { repo: from },
+      {
+        subject: to,
+        createdAt: new Date().toISOString(),
+        ...overrides,
+      },
+      this.getHeaders(from),
+    )
+    this.follows[from] ??= {}
+    this.follows[from][to] = new RecordRef(res.uri, res.cid)
+    return this.follows[from][to]
+  }
+
+  async unfollow(from: DidString, to: DidString) {
+    const follow = this.follows[from][to]
+    if (!follow) {
+      throw new Error('follow does not exist')
+    }
+    await this.agent.app.bsky.graph.follow.delete(
+      { repo: from, rkey: follow.uri.rkey },
+      this.getHeaders(from),
+    )
+    delete this.follows[from][to]
+  }
+
+  async block(
+    from: DidString,
+    to: DidString,
+    overrides?: Partial<AppBskyGraphBlock.Record>,
+  ) {
+    const res = await this.agent.app.bsky.graph.block.create(
+      { repo: from },
+      {
+        subject: to,
+        createdAt: new Date().toISOString(),
+        ...overrides,
+      },
+      this.getHeaders(from),
+    )
+    this.blocks[from] ??= {}
+    this.blocks[from][to] = new RecordRef(res.uri, res.cid)
+    return this.blocks[from][to]
+  }
+
+  async unblock(from: DidString, to: DidString) {
+    const block = this.blocks[from][to]
+    if (!block) {
+      throw new Error('block does not exist')
+    }
+    await this.agent.app.bsky.graph.block.delete(
+      { repo: from, rkey: block.uri.rkey },
+      this.getHeaders(from),
+    )
+    delete this.blocks[from][to]
+  }
+
+  async mute(from: DidString, to: DidString) {
+    await this.agent.app.bsky.graph.muteActor(
+      {
+        actor: to,
+      },
+      { headers: this.getHeaders(from) },
+    )
+    this.mutes[from] ??= new Set()
+    this.mutes[from].add(to)
+    return this.mutes[from][to]
+  }
+
+  async post(
+    by: DidString,
+    text: string,
+    facets?: AppBskyRichtextFacet.Main[],
+    images?: ImageRef[],
+    quote?: RecordRef,
+    overrides?: Partial<AppBskyFeedPost.Record>,
+  ) {
+    const imageEmbed = images && {
+      $type: 'app.bsky.embed.images',
+      images,
+    }
+    const recordEmbed = quote && {
+      record: { uri: quote.uriStr, cid: quote.cidStr },
+    }
+    const embed =
+      imageEmbed && recordEmbed
+        ? {
+            $type: 'app.bsky.embed.recordWithMedia',
+            record: recordEmbed,
+            media: imageEmbed,
+          }
+        : recordEmbed
+          ? { $type: 'app.bsky.embed.record', ...recordEmbed }
+          : imageEmbed
+    const res = await this.agent.app.bsky.feed.post.create(
+      { repo: by },
+      {
+        text: text,
+        facets,
+        embed,
+        createdAt: new Date().toISOString(),
+        ...overrides,
+      },
+      this.getHeaders(by),
+    )
+    this.posts[by] ??= []
+    const post = {
+      text,
+      ref: new RecordRef(res.uri, res.cid),
+      images: images ?? [],
+      quote,
+    }
+    this.posts[by].push(post)
+    return post
+  }
+
+  async deletePost(by: DidString, uri: AtUri) {
+    await this.agent.app.bsky.feed.post.delete(
+      {
+        repo: by,
+        rkey: uri.rkey,
+      },
+      this.getHeaders(by),
+    )
+  }
+
+  async uploadFile(
+    by: DidString,
+    filePath: string,
+    encoding: string,
+  ): Promise<ImageRef> {
+    const file = await fs.readFile(filePath)
+    const res = await this.agent.com.atproto.repo.uploadBlob(file, {
+      headers: this.getHeaders(by),
+      encoding,
+    } as any)
+    return { image: res.data.blob, alt: filePath }
+  }
+
+  async like(
+    by: DidString,
+    subject: RecordRef,
+    overrides?: Partial<AppBskyFeedLike.Record>,
+  ) {
+    const res = await this.agent.app.bsky.feed.like.create(
+      { repo: by },
+      {
+        subject: subject.raw,
+        createdAt: new Date().toISOString(),
+        ...overrides,
+      },
+      this.getHeaders(by),
+    )
+    this.likes[by] ??= {}
+    this.likes[by][subject.uriStr] = new AtUri(res.uri)
+    return this.likes[by][subject.uriStr]
+  }
+
+  async reply(
+    by: DidString,
+    root: RecordRef,
+    parent: RecordRef,
+    text: string,
+    facets?: AppBskyRichtextFacet.Main[],
+    images?: ImageRef[],
+    overrides?: Partial<AppBskyFeedPost.Record>,
+  ) {
+    const embed = images
+      ? {
+          $type: 'app.bsky.embed.images',
+          images,
+        }
+      : undefined
+    const res = await this.agent.app.bsky.feed.post.create(
+      { repo: by },
+      {
+        text: text,
+        reply: {
+          root: root.raw,
+          parent: parent.raw,
+        },
+        facets,
+        embed,
+        createdAt: new Date().toISOString(),
+        ...overrides,
+      },
+      this.getHeaders(by),
+    )
+    this.replies[by] ??= []
+    const reply = {
+      text,
+      ref: new RecordRef(res.uri, res.cid),
+      images: images ?? [],
+    }
+    this.replies[by].push(reply)
+    return reply
+  }
+
+  async repost(
+    by: DidString,
+    subject: RecordRef,
+    overrides?: Partial<AppBskyFeedRepost.Record>,
+  ) {
+    const res = await this.agent.app.bsky.feed.repost.create(
+      { repo: by },
+      {
+        subject: subject.raw,
+        createdAt: new Date().toISOString(),
+        ...overrides,
+      },
+      this.getHeaders(by),
+    )
+    this.reposts[by] ??= []
+    const repost = new RecordRef(res.uri, res.cid)
+    this.reposts[by].push(repost)
+    return repost
+  }
+
+  async createList(
+    by: DidString,
+    name: string,
+    purpose: 'mod' | 'curate' | 'reference',
+    overrides?: Partial<AppBskyGraphList.Record>,
+  ) {
+    const res = await this.agent.app.bsky.graph.list.create(
+      { repo: by },
+      {
+        name,
+        purpose:
+          purpose === 'mod'
+            ? 'app.bsky.graph.defs#modlist'
+            : purpose === 'curate'
+              ? 'app.bsky.graph.defs#curatelist'
+              : 'app.bsky.graph.defs#referencelist',
+        createdAt: new Date().toISOString(),
+        ...(overrides || {}),
+      },
+      this.getHeaders(by),
+    )
+    this.lists[by] ??= {}
+    const ref = new RecordRef(res.uri, res.cid)
+    this.lists[by][ref.uriStr] = {
+      ref: ref,
+      items: {},
+    }
+    return ref
+  }
+
+  async createFeedGen(by: DidString, feedDid: string, name: string) {
+    const res = await this.agent.app.bsky.feed.generator.create(
+      { repo: by },
+      {
+        did: feedDid,
+        displayName: name,
+        createdAt: new Date().toISOString(),
+      },
+      this.getHeaders(by),
+    )
+    this.feedgens[by] ??= {}
+    const ref = new RecordRef(res.uri, res.cid)
+    this.feedgens[by][ref.uriStr] = {
+      ref: ref,
+      items: {},
+    }
+    return ref
+  }
+
+  async createStarterPack(
+    by: DidString,
+    name: string,
+    actors: readonly DidString[],
+    feeds?: readonly AtUriString[],
+  ) {
+    const list = await this.createList(by, 'n/a', 'reference')
+    for (const did of actors) {
+      await this.addToList(by, did, list)
+    }
+    const res = await this.agent.app.bsky.graph.starterpack.create(
+      { repo: by },
+      {
+        name,
+        list: list.uriStr,
+        feeds: feeds?.map((uri) => ({ uri })),
+        createdAt: new Date().toISOString(),
+      },
+      this.getHeaders(by),
+    )
+    this.starterpacks[by] ??= {}
+    const ref = new RecordRef(res.uri, res.cid)
+    this.starterpacks[by][ref.uriStr] = {
+      ref: ref,
+      list,
+      feeds: feeds ?? [],
+      name,
+    }
+    return ref
+  }
+
+  async addToList(by: DidString, subject: DidString, list: RecordRef) {
+    const res = await this.agent.app.bsky.graph.listitem.create(
+      { repo: by },
+      { subject, list: list.uriStr, createdAt: new Date().toISOString() },
+      this.getHeaders(by),
+    )
+    const ref = new RecordRef(res.uri, res.cid)
+    const found = (this.lists[by] ?? {})[list.uriStr]
+    if (found) {
+      found.items[subject] = ref
+    }
+    return ref
+  }
+
+  async rmFromList(by: DidString, subject: DidString, list: RecordRef) {
+    const foundList = (this.lists[by] ?? {})[list.uriStr] ?? {}
+    if (!foundList) return
+    const foundItem = foundList.items[subject]
+    if (!foundItem) return
+    await this.agent.app.bsky.graph.listitem.delete(
+      { repo: by, rkey: foundItem.uri.rkey },
+      this.getHeaders(by),
+    )
+    delete foundList.items[subject]
+  }
+
+  // override public signature to add support for convos and messages
+  async createReport(opts: {
+    reasonType: ComAtprotoModerationCreateReport.InputSchema['reasonType']
+    subject:
+      | $Typed<ComAtprotoAdminDefs.RepoRef>
+      | $Typed<ComAtprotoRepoStrongRef.Main>
+      | $Typed<ChatBskyConvoDefs.MessageRef>
+      | $Typed<ChatBskyConvoDefs.ConvoRef>
+      | { $type: string }
+    reason?: string
+    reportedBy: DidString
+  }): Promise<
+    ComAtprotoModerationCreateReport.OutputSchema & {
+      subject:
+        | $Typed<ComAtprotoAdminDefs.RepoRef>
+        | $Typed<ComAtprotoRepoStrongRef.Main>
+        | $Typed<ChatBskyConvoDefs.MessageRef>
+        | $Typed<ChatBskyConvoDefs.ConvoRef>
+        | { $type: string }
+    }
+  > {
+    const { reasonType, subject, reason, reportedBy } = opts
+    const result = await this.agent.com.atproto.moderation.createReport(
+      { reasonType, subject, reason },
+      {
+        encoding: 'application/json',
+        headers: this.getHeaders(reportedBy),
+      },
+    )
+    return result.data
+  }
+
+  async verify(
+    by: DidString,
+    subject: DidString,
+    handle: HandleString,
+    displayName: string,
+    overrides?: Partial<AppBskyGraphVerification.Record>,
+  ) {
+    const res = await this.agent.app.bsky.graph.verification.create(
+      { repo: by },
+      {
+        subject,
+        createdAt: new Date().toISOString(),
+        handle,
+        displayName,
+        ...overrides,
+      },
+      this.getHeaders(by),
+    )
+    this.verifications[by] ??= {}
+    this.verifications[by][subject] = new AtUri(res.uri)
+    return this.verifications[by][subject]
+  }
+
+  async unverify(by: DidString, subject: DidString) {
+    const verification = this.verifications[by]?.[subject]
+    if (!verification) {
+      throw new Error('verification does not exist')
+    }
+
+    await this.agent.app.bsky.graph.verification.delete(
+      { repo: by, rkey: verification.rkey },
+      this.getHeaders(by),
+    )
+    delete this.verifications[by][subject]
+  }
+
+  getHeaders(did: DidString) {
+    return SeedClient.getHeaders(this.accounts[did].accessJwt)
+  }
+
+  static getHeaders(jwt: string) {
+    return { authorization: `Bearer ${jwt}` }
+  }
+}

package/src/seed/follows.ts

@@ -0,0 +1,57 @@
+import type { SeedClient } from './client.js'
+
+export default async (sc: SeedClient) => {
+  await sc.createAccount('alice', users.alice)
+  await sc.createAccount('bob', users.bob)
+  await sc.createAccount('carol', users.carol)
+  await sc.createAccount('dan', users.dan)
+  await sc.createAccount('eve', users.eve)
+  for (const name in sc.dids) {
+    await sc.createProfile(sc.dids[name], `display-${name}`, `descript-${name}`)
+  }
+  const alice = sc.dids.alice
+  const bob = sc.dids.bob
+  const carol = sc.dids.carol
+  const dan = sc.dids.dan
+  const eve = sc.dids.eve
+  await sc.follow(alice, bob)
+  await sc.follow(alice, carol)
+  await sc.follow(alice, dan)
+  await sc.follow(alice, eve)
+  await sc.follow(carol, alice)
+  await sc.follow(bob, alice)
+  await sc.follow(bob, carol)
+  await sc.follow(dan, alice)
+  await sc.follow(dan, bob)
+  await sc.follow(dan, eve)
+  await sc.follow(eve, alice)
+  await sc.follow(eve, carol)
+}
+
+const users = {
+  alice: {
+    email: 'alice@test.com',
+    handle: 'alice.test',
+    password: 'alice-pass',
+  },
+  bob: {
+    email: 'bob@test.com',
+    handle: 'bob.test',
+    password: 'bob-pass',
+  },
+  carol: {
+    email: 'carol@test.com',
+    handle: 'carol.test',
+    password: 'carol-pass',
+  },
+  dan: {
+    email: 'dan@test.com',
+    handle: 'dan.test',
+    password: 'dan-pass',
+  },
+  eve: {
+    email: 'eve@test.com',
+    handle: 'eve.test',
+    password: 'eve-pass',
+  },
+} as const