@atproto/api 0.6.20 → 0.6.21

package/dist/moderation/accumulator.d.ts

@@ -6,6 +6,7 @@ export declare class ModerationCauseAccumulator {
     constructor();
     setDid(did: string): void;
     addBlocking(blocking: string | undefined): void;
+    addBlockingByList(blockingByList: AppBskyGraphDefs.ListViewBasic | undefined): void;
     addBlockedBy(blockedBy: boolean | undefined): void;
     addBlockOther(blockOther: boolean | undefined): void;
     addLabel(label: Label, opts: ModerationOpts): void;

package/docs/moderation-behaviors/profiles.md

@@ -547,6 +547,23 @@ Key:
 </td>
 </tr>
 
+<tr>
+<td><strong>Mute/block: Blocking-by-list user</strong></td>
+<td>
+❌
+</td>
+<td>
+
+</td>
+<td>
+
+</td>
+<td>
+🚫
+
+</td>
+</tr>
+
 <tr>
 <td><strong>Mute/block: Blocked by user</strong></td>
 <td>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.6.20",
+  "version": "0.6.21",
   "license": "MIT",
   "description": "Client library for atproto and Bluesky",
   "keywords": [
@@ -19,15 +19,16 @@
     "multiformats": "^9.9.0",
     "tlds": "^1.234.0",
     "typed-emitter": "^2.1.0",
-    "@atproto/common-web": "^0.2.1",
-    "@atproto/lexicon": "^0.2.2",
-    "@atproto/syntax": "^0.1.2",
-    "@atproto/xrpc": "^0.3.2"
+    "zod": "^3.21.4",
+    "@atproto/common-web": "^0.2.2",
+    "@atproto/lexicon": "^0.2.3",
+    "@atproto/syntax": "^0.1.3",
+    "@atproto/xrpc": "^0.3.3"
   },
   "devDependencies": {
     "common-tags": "^1.8.2",
-    "@atproto/lex-cli": "^0.2.2",
-    "@atproto/pds": "^0.1.20"
+    "@atproto/lex-cli": "^0.2.3",
+    "@atproto/dev-env": "^0.2.12"
   },
   "scripts": {
     "codegen": "pnpm docgen && node ./scripts/generate-code.mjs && lex gen-api ./src/client ../../lexicons/com/atproto/*/* ../../lexicons/app/bsky/*/*",

package/src/agent.ts

@@ -1,5 +1,6 @@
 import { ErrorResponseBody, errorResponseBody } from '@atproto/xrpc'
 import { defaultFetchHandler } from '@atproto/xrpc'
+import { isValidDidDoc, getPdsEndpoint } from '@atproto/common-web'
 import {
   AtpBaseClient,
   AtpServiceClient,
@@ -30,6 +31,11 @@ export class AtpAgent {
   api: AtpServiceClient
   session?: AtpSessionData
 
+  /**
+   * The PDS URL, driven by the did doc. May be undefined.
+   */
+  pdsUrl: URL | undefined
+
   private _baseClient: AtpBaseClient
   private _persistSession?: AtpPersistSessionHandler
   private _refreshSessionPromise: Promise<void> | undefined
@@ -97,6 +103,7 @@ export class AtpAgent {
         email: opts.email,
         emailConfirmed: false,
       }
+      this._updateApiEndpoint(res.data.didDoc)
       return res
     } catch (e) {
       this.session = undefined
@@ -129,6 +136,7 @@ export class AtpAgent {
         email: res.data.email,
         emailConfirmed: res.data.emailConfirmed,
       }
+      this._updateApiEndpoint(res.data.didDoc)
       return res
     } catch (e) {
       this.session = undefined
@@ -253,7 +261,7 @@ export class AtpAgent {
     }
 
     // send the refresh request
-    const url = new URL(this.service.origin)
+    const url = new URL((this.pdsUrl || this.service).origin)
     url.pathname = `/xrpc/${REFRESH_SESSION}`
     const res = await AtpAgent.fetch(
       url.toString(),
@@ -277,6 +285,7 @@ export class AtpAgent {
         handle: res.body.handle,
         did: res.body.did,
       }
+      this._updateApiEndpoint(res.body.didDoc)
       this._persistSession?.('update', this.session)
     }
     // else: other failures should be ignored - the issue will
@@ -311,6 +320,24 @@ export class AtpAgent {
    */
   createModerationReport: typeof this.api.com.atproto.moderation.createReport =
     (data, opts) => this.api.com.atproto.moderation.createReport(data, opts)
+
+  /**
+   * Helper to update the pds endpoint dynamically.
+   *
+   * The session methods (create, resume, refresh) may respond with the user's
+   * did document which contains the user's canonical PDS endpoint. That endpoint
+   * may differ from the endpoint used to contact the server. We capture that
+   * PDS endpoint and update the client to use that given endpoint for future
+   * requests. (This helps ensure smooth migrations between PDSes, especially
+   * when the PDSes are operated by a single org.)
+   */
+  private _updateApiEndpoint(didDoc: unknown) {
+    if (isValidDidDoc(didDoc)) {
+      const endpoint = getPdsEndpoint(didDoc)
+      this.pdsUrl = endpoint ? new URL(endpoint) : undefined
+    }
+    this.api.xrpc.uri = this.pdsUrl || this.service
+  }
 }
 
 function isErrorObject(v: unknown): v is ErrorResponseBody {

package/src/bsky-agent.ts

@@ -258,6 +258,49 @@ export class BskyAgent extends AtpAgent {
     return this.api.app.bsky.graph.unmuteActor({ actor })
   }
 
+  async muteModList(uri: string) {
+    return this.api.app.bsky.graph.muteActorList({
+      list: uri,
+    })
+  }
+
+  async unmuteModList(uri: string) {
+    return this.api.app.bsky.graph.unmuteActorList({
+      list: uri,
+    })
+  }
+
+  async blockModList(uri: string) {
+    if (!this.session) {
+      throw new Error('Not logged in')
+    }
+    return await this.api.app.bsky.graph.listblock.create(
+      { repo: this.session.did },
+      {
+        subject: uri,
+        createdAt: new Date().toISOString(),
+      },
+    )
+  }
+
+  async unblockModList(uri: string) {
+    if (!this.session) {
+      throw new Error('Not logged in')
+    }
+    const listInfo = await this.api.app.bsky.graph.getList({
+      list: uri,
+      limit: 1,
+    })
+    if (!listInfo.data.list.viewer?.blocked) {
+      return
+    }
+    const { rkey } = new AtUri(listInfo.data.list.viewer.blocked)
+    return await this.api.app.bsky.graph.listblock.delete({
+      repo: this.session.did,
+      rkey,
+    })
+  }
+
   async updateSeenNotifications(seenAt?: string) {
     seenAt = seenAt || new Date().toISOString()
     return this.api.app.bsky.notification.updateSeen({

package/src/client/index.ts

@@ -59,6 +59,7 @@ import * as ComAtprotoServerRequestAccountDelete from './types/com/atproto/serve
 import * as ComAtprotoServerRequestEmailConfirmation from './types/com/atproto/server/requestEmailConfirmation'
 import * as ComAtprotoServerRequestEmailUpdate from './types/com/atproto/server/requestEmailUpdate'
 import * as ComAtprotoServerRequestPasswordReset from './types/com/atproto/server/requestPasswordReset'
+import * as ComAtprotoServerReserveSigningKey from './types/com/atproto/server/reserveSigningKey'
 import * as ComAtprotoServerResetPassword from './types/com/atproto/server/resetPassword'
 import * as ComAtprotoServerRevokeAppPassword from './types/com/atproto/server/revokeAppPassword'
 import * as ComAtprotoServerUpdateEmail from './types/com/atproto/server/updateEmail'
@@ -192,6 +193,7 @@ export * as ComAtprotoServerRequestAccountDelete from './types/com/atproto/serve
 export * as ComAtprotoServerRequestEmailConfirmation from './types/com/atproto/server/requestEmailConfirmation'
 export * as ComAtprotoServerRequestEmailUpdate from './types/com/atproto/server/requestEmailUpdate'
 export * as ComAtprotoServerRequestPasswordReset from './types/com/atproto/server/requestPasswordReset'
+export * as ComAtprotoServerReserveSigningKey from './types/com/atproto/server/reserveSigningKey'
 export * as ComAtprotoServerResetPassword from './types/com/atproto/server/resetPassword'
 export * as ComAtprotoServerRevokeAppPassword from './types/com/atproto/server/revokeAppPassword'
 export * as ComAtprotoServerUpdateEmail from './types/com/atproto/server/updateEmail'
@@ -907,6 +909,17 @@ export class ServerNS {
       })
   }
 
+  reserveSigningKey(
+    data?: ComAtprotoServerReserveSigningKey.InputSchema,
+    opts?: ComAtprotoServerReserveSigningKey.CallOptions,
+  ): Promise<ComAtprotoServerReserveSigningKey.Response> {
+    return this._service.xrpc
+      .call('com.atproto.server.reserveSigningKey', opts?.qp, data, opts)
+      .catch((e) => {
+        throw ComAtprotoServerReserveSigningKey.toKnownErr(e)
+      })
+  }
+
   resetPassword(
     data?: ComAtprotoServerResetPassword.InputSchema,
     opts?: ComAtprotoServerResetPassword.CallOptions,

package/src/client/lexicons.ts

@@ -2315,6 +2315,9 @@ export const schemaDict = {
               recoveryKey: {
                 type: 'string',
               },
+              plcOp: {
+                type: 'bytes',
+              },
             },
           },
         },
@@ -2338,6 +2341,9 @@ export const schemaDict = {
                 type: 'string',
                 format: 'did',
               },
+              didDoc: {
+                type: 'unknown',
+              },
             },
           },
         },
@@ -2563,6 +2569,9 @@ export const schemaDict = {
                 type: 'string',
                 format: 'did',
               },
+              didDoc: {
+                type: 'unknown',
+              },
               email: {
                 type: 'string',
               },
@@ -2879,6 +2888,9 @@ export const schemaDict = {
                 type: 'string',
                 format: 'did',
               },
+              didDoc: {
+                type: 'unknown',
+              },
             },
           },
         },
@@ -2955,6 +2967,29 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoServerReserveSigningKey: {
+    lexicon: 1,
+    id: 'com.atproto.server.reserveSigningKey',
+    defs: {
+      main: {
+        type: 'procedure',
+        description: 'Reserve a repo signing key for account creation.',
+        output: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['signingKey'],
+            properties: {
+              signingKey: {
+                type: 'string',
+                description: 'Public signing key in the form of a did:key.',
+              },
+            },
+          },
+        },
+      },
+    },
+  },
   ComAtprotoServerResetPassword: {
     lexicon: 1,
     id: 'com.atproto.server.resetPassword',
@@ -3376,7 +3411,7 @@ export const schemaDict = {
       },
       repo: {
         type: 'object',
-        required: ['did', 'head'],
+        required: ['did', 'head', 'rev'],
         properties: {
           did: {
             type: 'string',
@@ -3386,6 +3421,9 @@ export const schemaDict = {
             type: 'string',
             format: 'cid',
           },
+          rev: {
+            type: 'string',
+          },
         },
       },
     },
@@ -3789,6 +3827,10 @@ export const schemaDict = {
             type: 'string',
             format: 'at-uri',
           },
+          blockingByList: {
+            type: 'ref',
+            ref: 'lex:app.bsky.graph.defs#listViewBasic',
+          },
           following: {
             type: 'string',
             format: 'at-uri',
@@ -7379,6 +7421,7 @@ export const ids = {
   ComAtprotoServerRequestEmailUpdate: 'com.atproto.server.requestEmailUpdate',
   ComAtprotoServerRequestPasswordReset:
     'com.atproto.server.requestPasswordReset',
+  ComAtprotoServerReserveSigningKey: 'com.atproto.server.reserveSigningKey',
   ComAtprotoServerResetPassword: 'com.atproto.server.resetPassword',
   ComAtprotoServerRevokeAppPassword: 'com.atproto.server.revokeAppPassword',
   ComAtprotoServerUpdateEmail: 'com.atproto.server.updateEmail',

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

@@ -87,6 +87,7 @@ export interface ViewerState {
   mutedByList?: AppBskyGraphDefs.ListViewBasic
   blockedBy?: boolean
   blocking?: string
+  blockingByList?: AppBskyGraphDefs.ListViewBasic
   following?: string
   followedBy?: string
   [k: string]: unknown

package/src/client/types/com/atproto/server/createAccount.ts

@@ -16,6 +16,7 @@ export interface InputSchema {
   inviteCode?: string
   password: string
   recoveryKey?: string
+  plcOp?: Uint8Array
   [k: string]: unknown
 }
 
@@ -24,6 +25,7 @@ export interface OutputSchema {
   refreshJwt: string
   handle: string
   did: string
+  didDoc?: {}
   [k: string]: unknown
 }
 

package/src/client/types/com/atproto/server/createSession.ts

@@ -21,6 +21,7 @@ export interface OutputSchema {
   refreshJwt: string
   handle: string
   did: string
+  didDoc?: {}
   email?: string
   emailConfirmed?: boolean
   [k: string]: unknown

package/src/client/types/com/atproto/server/refreshSession.ts

@@ -16,6 +16,7 @@ export interface OutputSchema {
   refreshJwt: string
   handle: string
   did: string
+  didDoc?: {}
   [k: string]: unknown
 }
 

package/src/client/types/com/atproto/server/reserveSigningKey.ts

@@ -0,0 +1,35 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+
+export interface QueryParams {}
+
+export type InputSchema = undefined
+
+export interface OutputSchema {
+  /** Public signing key in the form of a did:key. */
+  signingKey: string
+  [k: string]: unknown
+}
+
+export interface CallOptions {
+  headers?: Headers
+  qp?: QueryParams
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+  data: OutputSchema
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+  }
+  return e
+}

package/src/client/types/com/atproto/sync/listRepos.ts

@@ -39,6 +39,7 @@ export function toKnownErr(e: any) {
 export interface Repo {
   did: string
   head: string
+  rev: string
   [k: string]: unknown
 }
 

package/src/moderation/accumulator.ts

@@ -1,4 +1,5 @@
 import { AppBskyGraphDefs } from '../client/index'
+import { AtUri } from '@atproto/syntax'
 import {
   Label,
   LabelPreference,
@@ -28,6 +29,18 @@ export class ModerationCauseAccumulator {
     }
   }
 
+  addBlockingByList(
+    blockingByList: AppBskyGraphDefs.ListViewBasic | undefined,
+  ) {
+    if (blockingByList) {
+      this.causes.push({
+        type: 'blocking',
+        source: { type: 'list', list: blockingByList },
+        priority: 3,
+      })
+    }
+  }
+
   addBlockedBy(blockedBy: boolean | undefined) {
     if (blockedBy) {
       this.causes.push({

package/src/moderation/subjects/account.ts

@@ -20,7 +20,13 @@ export function decideAccount(
       acc.addMuted(subject.viewer?.muted)
     }
   }
-  acc.addBlocking(subject.viewer?.blocking)
+  if (subject.viewer?.blocking) {
+    if (subject.viewer?.blockingByList) {
+      acc.addBlockingByList(subject.viewer?.blockingByList)
+    } else {
+      acc.addBlocking(subject.viewer?.blocking)
+    }
+  }
   acc.addBlockedBy(subject.viewer?.blockedBy)
 
   for (const label of filterAccountLabels(subject.labels)) {

package/tests/agent.test.ts

@@ -1,29 +1,26 @@
 import { defaultFetchHandler } from '@atproto/xrpc'
-import {
-  CloseFn,
-  runTestServer,
-  TestServerInfo,
-} from '@atproto/pds/tests/_util'
 import {
   AtpAgent,
   AtpAgentFetchHandlerResponse,
   AtpSessionEvent,
   AtpSessionData,
 } from '..'
+import { TestNetworkNoAppView } from '@atproto/dev-env'
 
 describe('agent', () => {
-  let server: TestServerInfo
-  let close: CloseFn
+  let network: TestNetworkNoAppView
 
   beforeAll(async () => {
-    server = await runTestServer({
+    network = await TestNetworkNoAppView.create({
       dbPostgresSchema: 'api_agent',
+      pds: {
+        enableDidDocWithSession: true,
+      },
     })
-    close = server.close
   })
 
   afterAll(async () => {
-    await close()
+    await network.close()
   })
 
   it('creates a new session on account creation.', async () => {
@@ -34,7 +31,7 @@ describe('agent', () => {
       sessions.push(sess)
     }
 
-    const agent = new AtpAgent({ service: server.url, persistSession })
+    const agent = new AtpAgent({ service: network.pds.url, persistSession })
 
     const res = await agent.createAccount({
       handle: 'user1.test',
@@ -74,7 +71,7 @@ describe('agent', () => {
       sessions.push(sess)
     }
 
-    const agent1 = new AtpAgent({ service: server.url, persistSession })
+    const agent1 = new AtpAgent({ service: network.pds.url, persistSession })
 
     const email = 'user2@test.com'
     await agent1.createAccount({
@@ -83,7 +80,7 @@ describe('agent', () => {
       password: 'password',
     })
 
-    const agent2 = new AtpAgent({ service: server.url, persistSession })
+    const agent2 = new AtpAgent({ service: network.pds.url, persistSession })
     const res1 = await agent2.login({
       identifier: 'user2.test',
       password: 'password',
@@ -122,7 +119,7 @@ describe('agent', () => {
       sessions.push(sess)
     }
 
-    const agent1 = new AtpAgent({ service: server.url, persistSession })
+    const agent1 = new AtpAgent({ service: network.pds.url, persistSession })
 
     await agent1.createAccount({
       handle: 'user3.test',
@@ -133,7 +130,7 @@ describe('agent', () => {
       throw new Error('No session created')
     }
 
-    const agent2 = new AtpAgent({ service: server.url, persistSession })
+    const agent2 = new AtpAgent({ service: network.pds.url, persistSession })
     const res1 = await agent2.resumeSession(agent1.session)
 
     expect(agent2.hasSession).toEqual(true)
@@ -165,7 +162,7 @@ describe('agent', () => {
       sessions.push(sess)
     }
 
-    const agent = new AtpAgent({ service: server.url, persistSession })
+    const agent = new AtpAgent({ service: network.pds.url, persistSession })
 
     // create an account and a session with it
     await agent.createAccount({
@@ -230,7 +227,7 @@ describe('agent', () => {
       sessions.push(sess)
     }
 
-    const agent = new AtpAgent({ service: server.url, persistSession })
+    const agent = new AtpAgent({ service: network.pds.url, persistSession })
 
     // create an account and a session with it
     await agent.createAccount({
@@ -309,7 +306,7 @@ describe('agent', () => {
       sessions.push(sess)
     }
 
-    const agent = new AtpAgent({ service: server.url, persistSession })
+    const agent = new AtpAgent({ service: network.pds.url, persistSession })
 
     try {
       await agent.login({
@@ -349,7 +346,7 @@ describe('agent', () => {
       sessions.push(sess)
     }
 
-    const agent = new AtpAgent({ service: server.url, persistSession })
+    const agent = new AtpAgent({ service: network.pds.url, persistSession })
 
     // create an account and a session with it
     await agent.createAccount({
@@ -420,7 +417,7 @@ describe('agent', () => {
         newHandlerCallCount++
       }
 
-      const agent = new AtpAgent({ service: server.url, persistSession })
+      const agent = new AtpAgent({ service: network.pds.url, persistSession })
 
       await agent.createAccount({
         handle: 'user7.test',
@@ -452,7 +449,7 @@ describe('agent', () => {
         sessions.push(sess)
       }
 
-      const agent = new AtpAgent({ service: server.url, persistSession })
+      const agent = new AtpAgent({ service: network.pds.url, persistSession })
 
       await expect(
         agent.createAccount({