@atproto/api 0.13.2 → 0.13.4

package/src/atp-agent.ts

@@ -4,16 +4,18 @@ import {
   Gettable,
   ResponseType,
   XRPCError,
-  combineHeaders,
+  XrpcClient,
   errorResponseBody,
 } from '@atproto/xrpc'
 import { Agent } from './agent'
 import {
-  AtpBaseClient,
   ComAtprotoServerCreateAccount,
   ComAtprotoServerCreateSession,
   ComAtprotoServerGetSession,
+  ComAtprotoServerNS,
 } from './client'
+import { schemas } from './client/lexicons'
+import { SessionManager } from './session-manager'
 import {
   AtpAgentLoginOpts,
   AtpPersistSessionHandler,
@@ -32,92 +34,44 @@ export type AtpAgentOptions = {
 }
 
 /**
- * An {@link AtpAgent} extends the {@link Agent} abstract class by
- * implementing password based session management.
+ * A wrapper around the {@link Agent} class that uses credential based session
+ * management. This class also exposes most of the session management methods
+ * directly.
+ *
+ * This class will be deprecated in the near future. Use {@link Agent} directly
+ * with a {@link CredentialSession} instead:
+ *
+ *  ```ts
+ *  const session = new CredentialSession({
+ *    service: new URL('https://example.com'),
+ *  })
+ *
+ *  const agent = new Agent(session)
+ *  ```
  */
 export class AtpAgent extends Agent {
-  public readonly headers: Map<string, Gettable<null | string>>
-  public readonly sessionManager: SessionManager
-
-  constructor(options: AtpAgentOptions | SessionManager) {
-    super(async (url: string, init?: RequestInit): Promise<Response> => {
-      // wait for any active session-refreshes to finish
-      await this.sessionManager.refreshSessionPromise
-
-      const initialHeaders = combineHeaders(init?.headers, this.headers)
-      const reqInit = { ...init, headers: initialHeaders }
-
-      const initialUri = new URL(url, this.dispatchUrl)
-      const initialReq = new Request(initialUri, reqInit)
-
-      const initialToken = this.session?.accessJwt
-      if (!initialToken || initialReq.headers.has('authorization')) {
-        return (0, this.sessionManager.fetch)(initialReq)
-      }
-
-      initialReq.headers.set('authorization', `Bearer ${initialToken}`)
-      const initialRes = await (0, this.sessionManager.fetch)(initialReq)
-
-      if (!this.session?.refreshJwt) {
-        return initialRes
-      }
-      const isExpiredToken = await isErrorResponse(
-        initialRes,
-        [400],
-        ['ExpiredToken'],
-      )
-
-      if (!isExpiredToken) {
-        return initialRes
+  readonly sessionManager: CredentialSession
+
+  constructor(options: AtpAgentOptions | CredentialSession) {
+    const sessionManager =
+      options instanceof CredentialSession
+        ? options
+        : new CredentialSession(
+            new URL(options.service),
+            options.fetch,
+            options.persistSession,
+          )
+
+    super(sessionManager)
+
+    // This assignment is already being done in the super constructor, but we
+    // need to do it here to make TypeScript happy.
+    this.sessionManager = sessionManager
+
+    if (!(options instanceof CredentialSession) && options.headers) {
+      for (const [key, value] of options.headers) {
+        this.setHeader(key, value)
       }
-
-      try {
-        await this.sessionManager.refreshSession()
-      } catch {
-        return initialRes
-      }
-
-      if (reqInit?.signal?.aborted) {
-        return initialRes
-      }
-
-      // The stream was already consumed. We cannot retry the request. A solution
-      // would be to tee() the input stream but that would bufferize the entire
-      // stream in memory which can lead to memory starvation. Instead, we will
-      // return the original response and let the calling code handle retries.
-      if (ReadableStream && reqInit.body instanceof ReadableStream) {
-        return initialRes
-      }
-
-      // Return initial "ExpiredToken" response if the session was not refreshed.
-      const updatedToken = this.session?.accessJwt
-      if (!updatedToken || updatedToken === initialToken) {
-        return initialRes
-      }
-
-      // Make sure the initial request is cancelled to avoid leaking resources
-      // (NodeJS 👀): https://undici.nodejs.org/#/?id=garbage-collection
-      await initialRes.body?.cancel()
-
-      // We need to re-compute the URI in case the PDS endpoint has changed
-      const updatedUri = new URL(url, this.dispatchUrl)
-      const updatedReq = new Request(updatedUri, reqInit)
-
-      updatedReq.headers.set('authorization', `Bearer ${updatedToken}`)
-
-      return await (0, this.sessionManager.fetch)(updatedReq)
-    })
-
-    if (options instanceof SessionManager) {
-      this.headers = new Map()
-      this.sessionManager = options
-    } else {
-      this.headers = new Map(options.headers)
-      this.sessionManager = new SessionManager(
-        new URL(options.service),
-        options.fetch,
-        options.persistSession,
-      )
     }
   }
 
@@ -125,36 +79,16 @@ export class AtpAgent extends Agent {
     return this.copyInto(new AtpAgent(this.sessionManager))
   }
 
-  copyInto<T extends Agent>(inst: T): T {
-    if (inst instanceof AtpAgent) {
-      for (const [key] of inst.headers) {
-        inst.unsetHeader(key)
-      }
-      for (const [key, value] of this.headers) {
-        inst.setHeader(key, value)
-      }
-    }
-    return super.copyInto(inst)
-  }
-
-  setHeader(key: string, value: Gettable<null | string>): void {
-    this.headers.set(key.toLowerCase(), value)
-  }
-
-  unsetHeader(key: string): void {
-    this.headers.delete(key.toLowerCase())
-  }
-
   get session() {
     return this.sessionManager.session
   }
 
   get hasSession() {
-    return !!this.session
+    return this.sessionManager.hasSession
   }
 
   get did() {
-    return this.session?.did
+    return this.sessionManager.did
   }
 
   get serviceUrl() {
@@ -166,7 +100,7 @@ export class AtpAgent extends Agent {
   }
 
   get dispatchUrl() {
-    return this.pdsUrl || this.serviceUrl
+    return this.sessionManager.dispatchUrl
   }
 
   /** @deprecated use {@link serviceUrl} instead */
@@ -186,7 +120,7 @@ export class AtpAgent extends Agent {
     )
   }
 
-  /** @deprecated This will be removed in OAuthAtpAgent */
+  /** @deprecated use {@link AtpAgent.serviceUrl} instead */
   getServiceUrl() {
     return this.serviceUrl
   }
@@ -216,23 +150,34 @@ export class AtpAgent extends Agent {
 }
 
 /**
- * Private class meant to be used by clones of {@link AtpAgent} so they can
- * share the same session across multiple instances (with different
- * proxying/labelers/headers options).
+ * Credentials (username / password) based session manager. Instances of this
+ * class will typically be used as the session manager for an {@link AtpAgent}.
+ * They can also be used with an {@link XrpcClient}, if you want to use you
+ * own Lexicons.
  */
-class SessionManager {
+export class CredentialSession implements SessionManager {
   public pdsUrl?: URL // The PDS URL, driven by the did doc
   public session?: AtpSessionData
   public refreshSessionPromise: Promise<void> | undefined
 
   /**
-   * Private {@link AtpBaseClient} used to perform session management API
+   * Private {@link ComAtprotoServerNS} used to perform session management API
    * calls on the service endpoint. Calls performed by this agent will not be
-   * authenticated using the user's session.
+   * authenticated using the user's session to allow proper manual configuration
+   * of the headers when performing session management operations.
    */
-  protected api = new AtpBaseClient((url, init) => {
-    return (0, this.fetch)(new URL(url, this.serviceUrl), init)
-  })
+  protected server = new ComAtprotoServerNS(
+    // Note that the use of the codegen "schemas" (to instantiate `this.api`),
+    // as well as the use of `ComAtprotoServerNS` will cause this class to
+    // reference (way) more code than it actually needs. It is not possible,
+    // with the current state of the codegen, to generate a client that only
+    // includes the methods that are actually used by this class. This is a
+    // known limitation that should be addressed in a future version of the
+    // codegen.
+    new XrpcClient((url, init) => {
+      return (0, this.fetch)(new URL(url, this.serviceUrl), init)
+    }, schemas),
+  )
 
   constructor(
     public readonly serviceUrl: URL,
@@ -240,6 +185,18 @@ class SessionManager {
     protected readonly persistSession?: AtpPersistSessionHandler,
   ) {}
 
+  get did() {
+    return this.session?.did
+  }
+
+  get dispatchUrl() {
+    return this.pdsUrl || this.serviceUrl
+  }
+
+  get hasSession() {
+    return !!this.session
+  }
+
   /**
    * Sets a WhatWG "fetch()" function to be used for making HTTP requests.
    */
@@ -247,6 +204,71 @@ class SessionManager {
     this.fetch = fetch
   }
 
+  async fetchHandler(url: string, init?: RequestInit): Promise<Response> {
+    // wait for any active session-refreshes to finish
+    await this.refreshSessionPromise
+
+    const initialUri = new URL(url, this.dispatchUrl)
+    const initialReq = new Request(initialUri, init)
+
+    const initialToken = this.session?.accessJwt
+    if (!initialToken || initialReq.headers.has('authorization')) {
+      return (0, this.fetch)(initialReq)
+    }
+
+    initialReq.headers.set('authorization', `Bearer ${initialToken}`)
+    const initialRes = await (0, this.fetch)(initialReq)
+
+    if (!this.session?.refreshJwt) {
+      return initialRes
+    }
+    const isExpiredToken = await isErrorResponse(
+      initialRes,
+      [400],
+      ['ExpiredToken'],
+    )
+
+    if (!isExpiredToken) {
+      return initialRes
+    }
+
+    try {
+      await this.refreshSession()
+    } catch {
+      return initialRes
+    }
+
+    if (init?.signal?.aborted) {
+      return initialRes
+    }
+
+    // The stream was already consumed. We cannot retry the request. A solution
+    // would be to tee() the input stream but that would bufferize the entire
+    // stream in memory which can lead to memory starvation. Instead, we will
+    // return the original response and let the calling code handle retries.
+    if (ReadableStream && init?.body instanceof ReadableStream) {
+      return initialRes
+    }
+
+    // Return initial "ExpiredToken" response if the session was not refreshed.
+    const updatedToken = this.session?.accessJwt
+    if (!updatedToken || updatedToken === initialToken) {
+      return initialRes
+    }
+
+    // Make sure the initial request is cancelled to avoid leaking resources
+    // (NodeJS 👀): https://undici.nodejs.org/#/?id=garbage-collection
+    await initialRes.body?.cancel()
+
+    // We need to re-compute the URI in case the PDS endpoint has changed
+    const updatedUri = new URL(url, this.dispatchUrl)
+    const updatedReq = new Request(updatedUri, init)
+
+    updatedReq.headers.set('authorization', `Bearer ${updatedToken}`)
+
+    return await (0, this.fetch)(updatedReq)
+  }
+
   /**
    * Create a new account and hydrate its session in this agent.
    */
@@ -255,7 +277,7 @@ class SessionManager {
     opts?: ComAtprotoServerCreateAccount.CallOptions,
   ): Promise<ComAtprotoServerCreateAccount.Response> {
     try {
-      const res = await this.api.com.atproto.server.createAccount(data, opts)
+      const res = await this.server.createAccount(data, opts)
       this.session = {
         accessJwt: res.data.accessJwt,
         refreshJwt: res.data.refreshJwt,
@@ -283,7 +305,7 @@ class SessionManager {
     opts: AtpAgentLoginOpts,
   ): Promise<ComAtprotoServerCreateSession.Response> {
     try {
-      const res = await this.api.com.atproto.server.createSession({
+      const res = await this.server.createSession({
         identifier: opts.identifier,
         password: opts.password,
         authFactorToken: opts.authFactorToken,
@@ -312,7 +334,7 @@ class SessionManager {
   async logout(): Promise<void> {
     if (this.session) {
       try {
-        await this.api.com.atproto.server.deleteSession(undefined, {
+        await this.server.deleteSession(undefined, {
           headers: {
             authorization: `Bearer ${this.session.accessJwt}`,
           },
@@ -335,7 +357,7 @@ class SessionManager {
     this.session = session
 
     try {
-      const res = await this.api.com.atproto.server
+      const res = await this.server
         .getSession(undefined, {
           headers: { authorization: `Bearer ${session.accessJwt}` },
         })
@@ -346,15 +368,14 @@ class SessionManager {
             session.refreshJwt
           ) {
             try {
-              const res = await this.api.com.atproto.server.refreshSession(
-                undefined,
-                { headers: { authorization: `Bearer ${session.refreshJwt}` } },
-              )
+              const res = await this.server.refreshSession(undefined, {
+                headers: { authorization: `Bearer ${session.refreshJwt}` },
+              })
 
               session.accessJwt = res.data.accessJwt
               session.refreshJwt = res.data.refreshJwt
 
-              return this.api.com.atproto.server.getSession(undefined, {
+              return this.server.getSession(undefined, {
                 headers: { authorization: `Bearer ${session.accessJwt}` },
               })
             } catch {
@@ -425,7 +446,7 @@ class SessionManager {
     }
 
     try {
-      const res = await this.api.com.atproto.server.refreshSession(undefined, {
+      const res = await this.server.refreshSession(undefined, {
         headers: { authorization: `Bearer ${this.session.refreshJwt}` },
       })
       // succeeded, update the session

package/src/client/index.ts

@@ -1749,11 +1749,7 @@ export class AppBskyFeedNS {
     params?: AppBskyFeedGetQuotes.QueryParams,
     opts?: AppBskyFeedGetQuotes.CallOptions,
   ): Promise<AppBskyFeedGetQuotes.Response> {
-    return this._client
-      .call('app.bsky.feed.getQuotes', params, undefined, opts)
-      .catch((e) => {
-        throw AppBskyFeedGetQuotes.toKnownErr(e)
-      })
+    return this._client.call('app.bsky.feed.getQuotes', params, undefined, opts)
   }
 
   getRepostedBy(

package/src/client/lexicons.ts

@@ -5034,6 +5034,9 @@ export const schemaDict = {
           likeCount: {
             type: 'integer',
           },
+          quoteCount: {
+            type: 'integer',
+          },
           embeds: {
             type: 'array',
             items: {
@@ -5749,7 +5752,7 @@ export const schemaDict = {
       main: {
         type: 'query',
         description:
-          'Get a list of posts liked by an actor. Does not require auth.',
+          'Get a list of posts liked by an actor. Requires auth, actor must be the requesting account.',
         parameters: {
           type: 'params',
           required: ['actor'],
@@ -6248,6 +6251,10 @@ export const schemaDict = {
                   'lex:app.bsky.feed.defs#blockedPost',
                 ],
               },
+              threadgate: {
+                type: 'ref',
+                ref: 'lex:app.bsky.feed.defs#threadgateView',
+              },
             },
           },
         },

package/src/client/types/app/bsky/embed/record.ts

@@ -67,6 +67,7 @@ export interface ViewRecord {
   replyCount?: number
   repostCount?: number
   likeCount?: number
+  quoteCount?: number
   embeds?: (
     | AppBskyEmbedImages.View
     | AppBskyEmbedExternal.View

package/src/client/types/app/bsky/feed/getPostThread.ts

@@ -25,6 +25,7 @@ export interface OutputSchema {
     | AppBskyFeedDefs.NotFoundPost
     | AppBskyFeedDefs.BlockedPost
     | { $type: string; [k: string]: unknown }
+  threadgate?: AppBskyFeedDefs.ThreadgateView
   [k: string]: unknown
 }
 

package/src/client/types/app/bsky/feed/getQuotes.ts

@@ -1,7 +1,7 @@
 /**
  * GENERATED CODE - DO NOT MODIFY
  */
-import { Headers, XRPCError } from '@atproto/xrpc'
+import { HeadersMap, XRPCError } from '@atproto/xrpc'
 import { ValidationResult, BlobRef } from '@atproto/lexicon'
 import { isObj, hasProp } from '../../../../util'
 import { lexicons } from '../../../../lexicons'
@@ -28,17 +28,16 @@ export interface OutputSchema {
 }
 
 export interface CallOptions {
-  headers?: Headers
+  signal?: AbortSignal
+  headers?: HeadersMap
 }
 
 export interface Response {
   success: boolean
-  headers: Headers
+  headers: HeadersMap
   data: OutputSchema
 }
 
 export function toKnownErr(e: any) {
-  if (e instanceof XRPCError) {
-  }
   return e
 }

package/src/index.ts

@@ -25,10 +25,13 @@ export { LABELS, DEFAULT_LABEL_SETTINGS } from './moderation/const/labels'
 export { Agent } from './agent'
 
 export { AtpAgent, type AtpAgentOptions } from './atp-agent'
+export { CredentialSession } from './atp-agent'
 export { BskyAgent } from './bsky-agent'
 
-/** @deprecated */
-export { AtpAgent as default } from './atp-agent'
+export {
+  /** @deprecated */
+  AtpAgent as default,
+} from './atp-agent'
 
 // Expose a copy to prevent alteration of the internal Lexicon instance used by
 // the AtpBaseClient class.

package/src/session-manager.ts

@@ -0,0 +1,5 @@
+import { FetchHandlerObject } from '@atproto/xrpc'
+
+export interface SessionManager extends FetchHandlerObject {
+  readonly did?: string
+}