@atproto/xrpc 0.7.6 → 0.7.7

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atproto/xrpc
 
+## 0.7.7
+
+### Patch Changes
+
+- Updated dependencies [[`d551b0e`](https://github.com/bluesky-social/atproto/commit/d551b0e3527714c111c3ec6e4c90ad7f46369fab)]:
+  - @atproto/lexicon@0.6.0
+
 ## 0.7.6
 
 ### Patch Changes
@@ -190,7 +197,7 @@
   `AtpAgent`.
 
   ```ts
-  import { Agent, AtpAgent } from "@atproto/api";
+  import { Agent, AtpAgent } from '@atproto/api'
 
   async function setupAgent(
     service: string,
@@ -202,30 +209,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()
     }
   }
   ```
@@ -303,24 +310,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>
@@ -337,23 +344,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}`,
         },
-      });
+      })
     }
   }
   ```
@@ -362,11 +369,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({
@@ -375,21 +382,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'
     }
   }
   ```
@@ -408,38 +415,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)
         },
-      });
+      })
     }
   }
   ```
@@ -460,40 +467,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 })
         },
-      });
+      })
     }
   }
   ```
@@ -552,7 +559,7 @@
      */
     url: string,
     init: RequestInit,
-  ) => Promise<Response>;
+  ) => Promise<Response>
   ```
 
   A noticeable change that has been introduced is that the `uri` field of the
@@ -590,7 +597,7 @@
   <td>
 
   ```ts
-  import client, { defaultFetchHandler } from "@atproto/xrpc";
+  import client, { defaultFetchHandler } from '@atproto/xrpc'
 
   client.fetch = function (
     httpUri: string,
@@ -599,50 +606,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>
@@ -654,62 +661,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/xrpc",
-  "version": "0.7.6",
+  "version": "0.7.7",
   "license": "MIT",
   "description": "atproto HTTP API (XRPC) client library",
   "keywords": [
@@ -17,7 +17,7 @@
   "types": "dist/index.d.ts",
   "dependencies": {
     "zod": "^3.23.8",
-    "@atproto/lexicon": "^0.5.2"
+    "@atproto/lexicon": "^0.6.0"
   },
   "devDependencies": {
     "typescript": "^5.6.3"