feat(client): add async support to beforeRequest hook

bigcommerce · Oct 23, 2024 · 5e46b4a · 5e46b4a
1 parent ef64ed5
commit 5e46b4a
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 3 deletions.
diff --git a/.changeset/smooth-carrots-punch.md b/.changeset/smooth-carrots-punch.md
@@ -0,0 +1,5 @@
+---
+"@bigcommerce/catalyst-client": minor
+---
+
+Adds async support to beforeRequest hook
diff --git a/packages/client/src/client.ts b/packages/client/src/client.ts
@@ -19,7 +19,9 @@ interface Config<FetcherRequestInit extends RequestInit = RequestInit> {
   backendUserAgentExtensions?: string;
   logger?: boolean;
   getChannelId?: (defaultChannelId: string) => Promise<string> | string;
-  beforeRequest?: (fetchOptions?: FetcherRequestInit) => Partial<FetcherRequestInit> | undefined;
+  beforeRequest?: (
+    fetchOptions?: FetcherRequestInit,
+  ) => Promise<Partial<FetcherRequestInit> | undefined> | Partial<FetcherRequestInit> | undefined;
 }
 
 interface BigCommerceResponse<T> {
@@ -32,7 +34,8 @@ class Client<FetcherRequestInit extends RequestInit = RequestInit> {
   private getChannelId: (defaultChannelId: string) => Promise<string> | string;
   private beforeRequest?: (
     fetchOptions?: FetcherRequestInit,
-  ) => Partial<FetcherRequestInit> | undefined;
+  ) => Promise<Partial<FetcherRequestInit> | undefined> | Partial<FetcherRequestInit> | undefined;
+
   private trustedProxySecret = process.env.BIGCOMMERCE_TRUSTED_PROXY_SECRET;
 
   constructor(private config: Config<FetcherRequestInit>) {
@@ -85,7 +88,7 @@ class Client<FetcherRequestInit extends RequestInit = RequestInit> {
 
     const graphqlUrl = await this.getGraphQLEndpoint(channelId);
     const { headers: additionalFetchHeaders = {}, ...additionalFetchOptions } =
-      this.beforeRequest?.(fetchOptions) ?? {};
+      (await this.beforeRequest?.(fetchOptions)) ?? {};
 
     const response = await fetch(graphqlUrl, {
       method: 'POST',