make "queryClient" prop optional for <ThirdwebSDKProvider /> (#121)

jnsdls · web-flow · commit 0c324cf6b7f4 · 2022-08-09T14:37:45.000-07:00
* make "queryClient" prop optional for `&lt;ThirdwebSDKProvider /&gt;`

* v2.6.2-0
diff --git a/docs/react.md b/docs/react.md
@@ -136,6 +136,7 @@ import { useWalletConnect } from "@thirdweb-dev/react"
 |  [ThirdwebNftMediaProps](./react.thirdwebnftmediaprops.md) | The props for the [ThirdwebNftMedia](./react.thirdwebnftmedia.md) component. |
 |  [ThirdwebProviderProps](./react.thirdwebproviderprops.md) | The possible props for the ThirdwebProvider. |
 |  [ThirdwebSDKProviderProps](./react.thirdwebsdkproviderprops.md) |  |
+|  [ThirdwebSDKProviderWagmiWrapper](./react.thirdwebsdkproviderwagmiwrapper.md) |  |
 
 ## Variables
 
diff --git a/docs/react.thirdwebsdkproviderprops.md b/docs/react.thirdwebsdkproviderprops.md
@@ -7,15 +7,13 @@
 <b>Signature:</b>
 
 ```typescript
-export interface ThirdwebSDKProviderProps extends Pick<ThirdwebProviderProps, "desiredChainId" | "sdkOptions" | "storageInterface"> 
+export interface ThirdwebSDKProviderProps extends Omit<ThirdwebSDKProviderWagmiWrapper, "queryClient"> 
 ```
-<b>Extends:</b> Pick&lt;[ThirdwebProviderProps](./react.thirdwebproviderprops.md)
+<b>Extends:</b> Omit&lt;[ThirdwebSDKProviderWagmiWrapper](./react.thirdwebsdkproviderwagmiwrapper.md)
 
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [provider](./react.thirdwebsdkproviderprops.provider.md) |  | ChainOrRpc \| SignerOrProvider |  |
-|  [queryClient](./react.thirdwebsdkproviderprops.queryclient.md) |  | QueryClient |  |
-|  [signer?](./react.thirdwebsdkproviderprops.signer.md) |  | Signer | <i>(Optional)</i> |
+|  [queryClient?](./react.thirdwebsdkproviderprops.queryclient.md) |  | QueryClient | <i>(Optional)</i> |
 
diff --git a/docs/react.thirdwebsdkproviderprops.queryclient.md b/docs/react.thirdwebsdkproviderprops.queryclient.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-queryClient: QueryClient;
+queryClient?: QueryClient;
 ```
diff --git a/docs/react.thirdwebsdkproviderprops.signer.md b/docs/react.thirdwebsdkproviderprops.signer.md
diff --git a/docs/react.thirdwebsdkproviderwagmiwrapper.md b/docs/react.thirdwebsdkproviderwagmiwrapper.md
@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@thirdweb-dev/react](./react.md) &gt; [ThirdwebSDKProviderWagmiWrapper](./react.thirdwebsdkproviderwagmiwrapper.md)
+
+## ThirdwebSDKProviderWagmiWrapper interface
+
+<b>Signature:</b>
+
+```typescript
+export interface ThirdwebSDKProviderWagmiWrapper extends Pick<ThirdwebProviderProps, "desiredChainId" | "sdkOptions" | "storageInterface"> 
+```
+<b>Extends:</b> Pick&lt;[ThirdwebProviderProps](./react.thirdwebproviderprops.md)
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [provider](./react.thirdwebsdkproviderwagmiwrapper.provider.md) |  | ChainOrRpc \| SignerOrProvider |  |
+|  [queryClient?](./react.thirdwebsdkproviderwagmiwrapper.queryclient.md) |  | QueryClient | <i>(Optional)</i> |
+|  [signer?](./react.thirdwebsdkproviderwagmiwrapper.signer.md) |  | Signer | <i>(Optional)</i> |
+
diff --git a/docs/react.thirdwebsdkproviderwagmiwrapper.provider.md b/docs/react.thirdwebsdkproviderwagmiwrapper.provider.md
@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@thirdweb-dev/react](./react.md) &gt; [ThirdwebSDKProviderProps](./react.thirdwebsdkproviderprops.md) &gt; [provider](./react.thirdwebsdkproviderprops.provider.md)
+[Home](./index.md) &gt; [@thirdweb-dev/react](./react.md) &gt; [ThirdwebSDKProviderWagmiWrapper](./react.thirdwebsdkproviderwagmiwrapper.md) &gt; [provider](./react.thirdwebsdkproviderwagmiwrapper.provider.md)
 
-## ThirdwebSDKProviderProps.provider property
+## ThirdwebSDKProviderWagmiWrapper.provider property
 
 <b>Signature:</b>
 
diff --git a/docs/react.thirdwebsdkproviderwagmiwrapper.queryclient.md b/docs/react.thirdwebsdkproviderwagmiwrapper.queryclient.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@thirdweb-dev/react](./react.md) &gt; [ThirdwebSDKProviderWagmiWrapper](./react.thirdwebsdkproviderwagmiwrapper.md) &gt; [queryClient](./react.thirdwebsdkproviderwagmiwrapper.queryclient.md)
+
+## ThirdwebSDKProviderWagmiWrapper.queryClient property
+
+<b>Signature:</b>
+
+```typescript
+queryClient?: QueryClient;
+```
diff --git a/docs/react.thirdwebsdkproviderwagmiwrapper.signer.md b/docs/react.thirdwebsdkproviderwagmiwrapper.signer.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@thirdweb-dev/react](./react.md) &gt; [ThirdwebSDKProviderWagmiWrapper](./react.thirdwebsdkproviderwagmiwrapper.md) &gt; [signer](./react.thirdwebsdkproviderwagmiwrapper.signer.md)
+
+## ThirdwebSDKProviderWagmiWrapper.signer property
+
+<b>Signature:</b>
+
+```typescript
+signer?: Signer;
+```
diff --git a/etc/react.api.md b/etc/react.api.md
@@ -290,11 +290,17 @@ export interface ThirdwebProviderProps<TSupportedChain extends SupportedChain =
 export const ThirdwebSDKProvider: React_2.FC<React_2.PropsWithChildren<ThirdwebSDKProviderProps>>;
 
 // @public (undocumented)
-export interface ThirdwebSDKProviderProps extends Pick<ThirdwebProviderProps, "desiredChainId" | "sdkOptions" | "storageInterface"> {
+export interface ThirdwebSDKProviderProps extends Omit<ThirdwebSDKProviderWagmiWrapper, "queryClient"> {
+    // (undocumented)
+    queryClient?: QueryClient;
+}
+
+// @public (undocumented)
+export interface ThirdwebSDKProviderWagmiWrapper extends Pick<ThirdwebProviderProps, "desiredChainId" | "sdkOptions" | "storageInterface"> {
     // (undocumented)
     provider: ChainOrRpc | SignerOrProvider;
     // (undocumented)
-    queryClient: QueryClient;
+    queryClient?: QueryClient;
     // (undocumented)
     signer?: Signer;
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@thirdweb-dev/react",
-  "version": "2.6.1",
+  "version": "2.6.2-0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com:thirdweb-dev/react.git"
diff --git a/src/Provider.tsx b/src/Provider.tsx
@@ -403,17 +403,13 @@ export const ThirdwebProvider = <
     };
   }, [sdkOptions, readonlySettings]);
 
-  const queryClientWithDefault: QueryClient = useMemo(() => {
-    return queryClient ? queryClient : new QueryClient();
-  }, [queryClient]);
-
   return (
     <ThirdwebConfigProvider
       value={{ rpcUrlMap: _rpcUrlMap, supportedChains: _supporrtedChains }}
     >
       <WagmiProvider {...wagmiProps}>
         <ThirdwebSDKProviderWagmiWrapper
-          queryClient={queryClientWithDefault}
+          queryClient={queryClient}
           desiredChainId={desiredChainId}
           sdkOptions={sdkOptionsWithDefaults}
           storageInterface={storageInterface}
@@ -425,18 +421,20 @@ export const ThirdwebProvider = <
   );
 };
 
-export interface ThirdwebSDKProviderProps
+export interface ThirdwebSDKProviderWagmiWrapper
   extends Pick<
     ThirdwebProviderProps,
     "desiredChainId" | "sdkOptions" | "storageInterface"
   > {
   signer?: Signer;
   provider: ChainOrRpc | SignerOrProvider;
-  queryClient: QueryClient;
+  queryClient?: QueryClient;
 }
 
 const ThirdwebSDKProviderWagmiWrapper: React.FC<
-  React.PropsWithChildren<Omit<ThirdwebSDKProviderProps, "signer" | "provider">>
+  React.PropsWithChildren<
+    Omit<ThirdwebSDKProviderWagmiWrapper, "signer" | "provider">
+  >
 > = ({ children, ...props }) => {
   const provider = useProvider();
   const signer = useSigner();
@@ -455,6 +453,11 @@ interface SDKContext {
 
 const ThirdwebSDKContext = createContext<SDKContext>({ desiredChainId: -1 });
 
+export interface ThirdwebSDKProviderProps
+  extends Omit<ThirdwebSDKProviderWagmiWrapper, "queryClient"> {
+  queryClient?: QueryClient;
+}
+
 /**
  * A barebones wrapper around the Thirdweb SDK.
  *
@@ -475,6 +478,10 @@ export const ThirdwebSDKProvider: React.FC<
   queryClient,
   children,
 }) => {
+  const queryClientWithDefault: QueryClient = useMemo(() => {
+    return queryClient ? queryClient : new QueryClient();
+  }, [queryClient]);
+
   const sdk = useMemo(() => {
     if (!desiredChainId || typeof window === "undefined") {
       return undefined;
@@ -500,7 +507,7 @@ export const ThirdwebSDKProvider: React.FC<
   );
 
   return (
-    <QueryClientProvider client={queryClient}>
+    <QueryClientProvider client={queryClientWithDefault}>
       <ThirdwebSDKContext.Provider value={ctxValue}>
         {children}
       </ThirdwebSDKContext.Provider>

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@thirdweb-dev/react",`
`3`		`- "version": "2.6.1",`
	`3`	`+ "version": "2.6.2-0",`
`4`	`4`	`"repository": {`
`5`	`5`	`"type": "git",`
`6`	`6`	`"url": "git+https://github.com:thirdweb-dev/react.git"`