@atproto/api 0.13.0 → 0.13.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atproto/api
 
+## 0.13.1
+
+### Patch Changes
+
+- [#2708](https://github.com/bluesky-social/atproto/pull/2708) [`22af354a5`](https://github.com/bluesky-social/atproto/commit/22af354a5db595d7cbc0e65f02601de3565337e1) Thanks [@devinivy](https://github.com/devinivy)! - Export AtpAgentOptions type to better support extending AtpAgent.
+
 ## 0.13.0
 
 ### Minor Changes
@@ -42,7 +48,7 @@
   `AtpAgent`.
 
   ```ts
-  import { Agent, AtpAgent } from '@atproto/api'
+  import { Agent, AtpAgent } from "@atproto/api";
 
   async function setupAgent(
     service: string,
@@ -54,30 +60,30 @@
       persistSession: (evt, session) => {
         // handle session update
       },
-    })
+    });
 
-    await agent.login(username, password)
+    await agent.login(username, password);
 
-    return agent
+    return agent;
   }
   ```
 
   ```ts
-  import { Agent } from '@atproto/api'
+  import { Agent } from "@atproto/api";
 
   async function doStuffWithAgent(agent: Agent, arg: string) {
-    return agent.resolveHandle(arg)
+    return agent.resolveHandle(arg);
   }
   ```
 
   ```ts
-  import { Agent, AtpAgent } from '@atproto/api'
+  import { Agent, AtpAgent } from "@atproto/api";
 
   class MyClass {
-    agent: Agent
+    agent: Agent;
 
     constructor() {
-      this.agent = new AtpAgent()
+      this.agent = new AtpAgent();
     }
   }
   ```
@@ -155,24 +161,24 @@
   <td>
 
   ```ts
-  import { AtpBaseClient, ComAtprotoSyncSubscribeRepos } from '@atproto/api'
+  import { AtpBaseClient, ComAtprotoSyncSubscribeRepos } from "@atproto/api";
 
-  const baseClient = new AtpBaseClient()
+  const baseClient = new AtpBaseClient();
 
-  baseClient.xrpc.lex.assertValidXrpcMessage('io.example.doStuff', {
+  baseClient.xrpc.lex.assertValidXrpcMessage("io.example.doStuff", {
     // ...
-  })
+  });
   ```
 
   </td>
   <td>
 
   ```ts
-  import { lexicons } from '@atproto/api'
+  import { lexicons } from "@atproto/api";
 
-  lexicons.assertValidXrpcMessage('io.example.doStuff', {
+  lexicons.assertValidXrpcMessage("io.example.doStuff", {
     // ...
-  })
+  });
   ```
 
   </td>
@@ -189,23 +195,23 @@
   <td>
 
   ```ts
-  import { BskyAgent } from '@atproto/api'
+  import { BskyAgent } from "@atproto/api";
 
   class MyAgent extends BskyAgent {
-    private accessToken?: string
+    private accessToken?: string;
 
     async createOrRefreshSession(identifier: string, password: string) {
       // custom logic here
 
-      this.accessToken = 'my-access-jwt'
+      this.accessToken = "my-access-jwt";
     }
 
     async doStuff() {
-      return this.call('io.example.doStuff', {
+      return this.call("io.example.doStuff", {
         headers: {
           Authorization: this.accessToken && `Bearer ${this.accessToken}`,
         },
-      })
+      });
     }
   }
   ```
@@ -214,11 +220,11 @@
   <td>
 
   ```ts
-  import { Agent } from '@atproto/api'
+  import { Agent } from "@atproto/api";
 
   class MyAgent extends Agent {
-    private accessToken?: string
-    public did?: string
+    private accessToken?: string;
+    public did?: string;
 
     constructor(private readonly service: string | URL) {
       super({
@@ -227,21 +233,21 @@
           Authorization: () =>
             this.accessToken ? `Bearer ${this.accessToken}` : null,
         },
-      })
+      });
     }
 
     clone(): MyAgent {
-      const agent = new MyAgent(this.service)
-      agent.accessToken = this.accessToken
-      agent.did = this.did
-      return this.copyInto(agent)
+      const agent = new MyAgent(this.service);
+      agent.accessToken = this.accessToken;
+      agent.did = this.did;
+      return this.copyInto(agent);
     }
 
     async createOrRefreshSession(identifier: string, password: string) {
       // custom logic here
 
-      this.did = 'did:example:123'
-      this.accessToken = 'my-access-jwt'
+      this.did = "did:example:123";
+      this.accessToken = "my-access-jwt";
     }
   }
   ```
@@ -260,38 +266,38 @@
   <td>
 
   ```ts
-  import { BskyAgent } from '@atproto/api'
-  import { RateLimitThreshold } from 'rate-limit-threshold'
+  import { BskyAgent } from "@atproto/api";
+  import { RateLimitThreshold } from "rate-limit-threshold";
 
-  const agent = new BskyAgent()
-  const limiter = new RateLimitThreshold(3000, 300_000)
+  const agent = new BskyAgent();
+  const limiter = new RateLimitThreshold(3000, 300_000);
 
-  const origCall = agent.api.xrpc.call
+  const origCall = agent.api.xrpc.call;
   agent.api.xrpc.call = async function (...args) {
-    await limiter.wait()
-    return origCall.call(this, ...args)
-  }
+    await limiter.wait();
+    return origCall.call(this, ...args);
+  };
   ```
 
   </td>
   <td>
 
   ```ts
-  import { AtpAgent } from '@atproto/api'
-  import { RateLimitThreshold } from 'rate-limit-threshold'
+  import { AtpAgent } from "@atproto/api";
+  import { RateLimitThreshold } from "rate-limit-threshold";
 
   class LimitedAtpAgent extends AtpAgent {
     constructor(options: AtpAgentOptions) {
-      const fetch: typeof globalThis.fetch = options.fetch ?? globalThis.fetch
-      const limiter = new RateLimitThreshold(3000, 300_000)
+      const fetch: typeof globalThis.fetch = options.fetch ?? globalThis.fetch;
+      const limiter = new RateLimitThreshold(3000, 300_000);
 
       super({
         ...options,
         fetch: async (...args) => {
-          await limiter.wait()
-          return fetch(...args)
+          await limiter.wait();
+          return fetch(...args);
         },
-      })
+      });
     }
   }
   ```
@@ -312,40 +318,40 @@
   <td>
 
   ```ts
-  import { BskyAgent, defaultFetchHandler } from '@atproto/api'
+  import { BskyAgent, defaultFetchHandler } from "@atproto/api";
 
   BskyAgent.configure({
     fetch: async (httpUri, httpMethod, httpHeaders, httpReqBody) => {
-      const ua = httpHeaders['User-Agent']
+      const ua = httpHeaders["User-Agent"];
 
-      httpHeaders['User-Agent'] = ua ? `${ua} ${userAgent}` : userAgent
+      httpHeaders["User-Agent"] = ua ? `${ua} ${userAgent}` : userAgent;
 
-      return defaultFetchHandler(httpUri, httpMethod, httpHeaders, httpReqBody)
+      return defaultFetchHandler(httpUri, httpMethod, httpHeaders, httpReqBody);
     },
-  })
+  });
   ```
 
   </td>
   <td>
 
   ```ts
-  import { AtpAgent } from '@atproto/api'
+  import { AtpAgent } from "@atproto/api";
 
   class MyAtpAgent extends AtpAgent {
     constructor(options: AtpAgentOptions) {
-      const fetch = options.fetch ?? globalThis.fetch
+      const fetch = options.fetch ?? globalThis.fetch;
 
       super({
         ...options,
         fetch: async (url, init) => {
-          const headers = new Headers(init.headers)
+          const headers = new Headers(init.headers);
 
-          const ua = headersList.get('User-Agent')
-          headersList.set('User-Agent', ua ? `${ua} ${userAgent}` : userAgent)
+          const ua = headersList.get("User-Agent");
+          headersList.set("User-Agent", ua ? `${ua} ${userAgent}` : userAgent);
 
-          return fetch(url, { ...init, headers })
+          return fetch(url, { ...init, headers });
         },
-      })
+      });
     }
   }
   ```
@@ -404,7 +410,7 @@
      */
     url: string,
     init: RequestInit,
-  ) => Promise<Response>
+  ) => Promise<Response>;
   ```
 
   A noticeable change that has been introduced is that the `uri` field of the
@@ -442,7 +448,7 @@
   <td>
 
   ```ts
-  import client, { defaultFetchHandler } from '@atproto/xrpc'
+  import client, { defaultFetchHandler } from "@atproto/xrpc";
 
   client.fetch = function (
     httpUri: string,
@@ -451,50 +457,50 @@
     httpReqBody: unknown,
   ) {
     // Custom logic here
-    return defaultFetchHandler(httpUri, httpMethod, httpHeaders, httpReqBody)
-  }
+    return defaultFetchHandler(httpUri, httpMethod, httpHeaders, httpReqBody);
+  };
 
   client.addLexicon({
     lexicon: 1,
-    id: 'io.example.doStuff',
+    id: "io.example.doStuff",
     defs: {},
-  })
+  });
 
-  const instance = client.service('http://my-service.com')
+  const instance = client.service("http://my-service.com");
 
-  instance.setHeader('my-header', 'my-value')
+  instance.setHeader("my-header", "my-value");
 
-  await instance.call('io.example.doStuff')
+  await instance.call("io.example.doStuff");
   ```
 
   </td>
   <td>
 
   ```ts
-  import { XrpcClient } from '@atproto/xrpc'
+  import { XrpcClient } from "@atproto/xrpc";
 
   const instance = new XrpcClient(
     async (url, init) => {
-      const headers = new Headers(init.headers)
+      const headers = new Headers(init.headers);
 
-      headers.set('my-header', 'my-value')
+      headers.set("my-header", "my-value");
 
       // Custom logic here
 
-      const fullUrl = new URL(url, 'http://my-service.com')
+      const fullUrl = new URL(url, "http://my-service.com");
 
-      return fetch(fullUrl, { ...init, headers })
+      return fetch(fullUrl, { ...init, headers });
     },
     [
       {
         lexicon: 1,
-        id: 'io.example.doStuff',
+        id: "io.example.doStuff",
         defs: {},
       },
     ],
-  )
+  );
 
-  await instance.call('io.example.doStuff')
+  await instance.call("io.example.doStuff");
   ```
 
   </td>
@@ -506,62 +512,62 @@
   previous example can be simplified to:
 
   ```ts
-  import { XrpcClient } from '@atproto/xrpc'
+  import { XrpcClient } from "@atproto/xrpc";
 
-  const instance = new XrpcClient('http://my-service.com', [
+  const instance = new XrpcClient("http://my-service.com", [
     {
       lexicon: 1,
-      id: 'io.example.doStuff',
+      id: "io.example.doStuff",
       defs: {},
     },
-  ])
+  ]);
   ```
 
   If you need to add static headers to all requests, you can instead instantiate
   the `XrpcClient` as follows:
 
   ```ts
-  import { XrpcClient } from '@atproto/xrpc'
+  import { XrpcClient } from "@atproto/xrpc";
 
   const instance = new XrpcClient(
     {
-      service: 'http://my-service.com',
+      service: "http://my-service.com",
       headers: {
-        'my-header': 'my-value',
+        "my-header": "my-value",
       },
     },
     [
       {
         lexicon: 1,
-        id: 'io.example.doStuff',
+        id: "io.example.doStuff",
         defs: {},
       },
     ],
-  )
+  );
   ```
 
   If you need the headers or service url to be dynamic, you can define them using
   functions:
 
   ```ts
-  import { XrpcClient } from '@atproto/xrpc'
+  import { XrpcClient } from "@atproto/xrpc";
 
   const instance = new XrpcClient(
     {
-      service: () => 'http://my-service.com',
+      service: () => "http://my-service.com",
       headers: {
-        'my-header': () => 'my-value',
-        'my-ignored-header': () => null, // ignored
+        "my-header": () => "my-value",
+        "my-ignored-header": () => null, // ignored
       },
     },
     [
       {
         lexicon: 1,
-        id: 'io.example.doStuff',
+        id: "io.example.doStuff",
         defs: {},
       },
     ],
-  )
+  );
   ```
 
 - [#2483](https://github.com/bluesky-social/atproto/pull/2483) [`b934b396b`](https://github.com/bluesky-social/atproto/commit/b934b396b13ba32bf2bf7e75ecdf6871e5f310dd) Thanks [@matthieusieben](https://github.com/matthieusieben)! - Add the ability to use `fetch()` compatible `BodyInit` body when making XRPC calls.

package/dist/index.d.ts

@@ -15,7 +15,7 @@ export * from './moderation/types';
 export * from './mocker';
 export { LABELS, DEFAULT_LABEL_SETTINGS } from './moderation/const/labels';
 export { Agent } from './agent';
-export { AtpAgent } from './atp-agent';
+export { AtpAgent, type AtpAgentOptions } from './atp-agent';
 export { BskyAgent } from './bsky-agent';
 /** @deprecated */
 export { AtpAgent as default } from './atp-agent';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAG3C,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EACL,OAAO,EACP,SAAS,EACT,YAAY,EACZ,SAAS,EACT,eAAe,GAChB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA;AACvB,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,oBAAoB,CAAA;AAClC,cAAc,UAAU,CAAA;AACxB,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AAC1E,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAE/B,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAExC,kBAAkB;AAClB,OAAO,EAAE,QAAQ,IAAI,OAAO,EAAE,MAAM,aAAa,CAAA;AAIjD,eAAO,MAAM,QAAQ,UAAiC,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAG3C,OAAO,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACvC,OAAO,EACL,OAAO,EACP,SAAS,EACT,YAAY,EACZ,SAAS,EACT,eAAe,GAChB,MAAM,kBAAkB,CAAA;AACzB,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAA;AACnD,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA;AACvB,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,uBAAuB,CAAA;AACrC,cAAc,0BAA0B,CAAA;AACxC,cAAc,qBAAqB,CAAA;AACnC,cAAc,kBAAkB,CAAA;AAChC,cAAc,cAAc,CAAA;AAC5B,cAAc,oBAAoB,CAAA;AAClC,cAAc,UAAU,CAAA;AACxB,OAAO,EAAE,MAAM,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA;AAC1E,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AAE/B,OAAO,EAAE,QAAQ,EAAE,KAAK,eAAe,EAAE,MAAM,aAAa,CAAA;AAC5D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAA;AAExC,kBAAkB;AAClB,OAAO,EAAE,QAAQ,IAAI,OAAO,EAAE,MAAM,aAAa,CAAA;AAIjD,eAAO,MAAM,QAAQ,UAAiC,CAAA"}

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8CAA2C;AAC3C,gDAAgE;AAEhE,0CAAuC;AAA9B,+FAAA,KAAK,OAAA;AACd,4CAMyB;AALvB,kGAAA,OAAO,OAAA;AACP,oGAAA,SAAS,OAAA;AACT,uGAAA,YAAY,OAAA;AACZ,oGAAA,SAAS,OAAA;AACT,0GAAA,eAAe,OAAA;AAEjB,kDAAmD;AAA1C,2GAAA,aAAa,OAAA;AACtB,0CAAuB;AACvB,0CAAuB;AACvB,yCAAsB;AACtB,2CAAwB;AACxB,wDAAqC;AACrC,2DAAwC;AACxC,sDAAmC;AACnC,mDAAgC;AAChC,+CAA4B;AAC5B,qDAAkC;AAClC,2CAAwB;AACxB,oDAA0E;AAAjE,gGAAA,MAAM,OAAA;AAAE,gHAAA,sBAAsB,OAAA;AACvC,iCAA+B;AAAtB,8FAAA,KAAK,OAAA;AAEd,yCAAsC;AAA7B,qGAAA,QAAQ,OAAA;AACjB,2CAAwC;AAA/B,uGAAA,SAAS,OAAA;AAElB,kBAAkB;AAClB,yCAAiD;AAAxC,oGAAA,QAAQ,OAAW;AAE5B,+EAA+E;AAC/E,2BAA2B;AACd,QAAA,QAAQ,GAAG,IAAI,kBAAQ,CAAC,mBAAgB,CAAC,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,8CAA2C;AAC3C,gDAAgE;AAEhE,0CAAuC;AAA9B,+FAAA,KAAK,OAAA;AACd,4CAMyB;AALvB,kGAAA,OAAO,OAAA;AACP,oGAAA,SAAS,OAAA;AACT,uGAAA,YAAY,OAAA;AACZ,oGAAA,SAAS,OAAA;AACT,0GAAA,eAAe,OAAA;AAEjB,kDAAmD;AAA1C,2GAAA,aAAa,OAAA;AACtB,0CAAuB;AACvB,0CAAuB;AACvB,yCAAsB;AACtB,2CAAwB;AACxB,wDAAqC;AACrC,2DAAwC;AACxC,sDAAmC;AACnC,mDAAgC;AAChC,+CAA4B;AAC5B,qDAAkC;AAClC,2CAAwB;AACxB,oDAA0E;AAAjE,gGAAA,MAAM,OAAA;AAAE,gHAAA,sBAAsB,OAAA;AACvC,iCAA+B;AAAtB,8FAAA,KAAK,OAAA;AAEd,yCAA4D;AAAnD,qGAAA,QAAQ,OAAA;AACjB,2CAAwC;AAA/B,uGAAA,SAAS,OAAA;AAElB,kBAAkB;AAClB,yCAAiD;AAAxC,oGAAA,QAAQ,OAAW;AAE5B,+EAA+E;AAC/E,2BAA2B;AACd,QAAA,QAAQ,GAAG,IAAI,kBAAQ,CAAC,mBAAgB,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/api",
-  "version": "0.13.0",
+  "version": "0.13.1",
   "license": "MIT",
   "description": "Client library for atproto and Bluesky",
   "keywords": [

package/src/index.ts

@@ -24,7 +24,7 @@ export * from './mocker'
 export { LABELS, DEFAULT_LABEL_SETTINGS } from './moderation/const/labels'
 export { Agent } from './agent'
 
-export { AtpAgent } from './atp-agent'
+export { AtpAgent, type AtpAgentOptions } from './atp-agent'
 export { BskyAgent } from './bsky-agent'
 
 /** @deprecated */