@dynamic-labs-sdk/react-hooks 1.17.0 → 1.17.1

package/dist/middlewares/invalidateOnEvent/index.d.ts

@@ -0,0 +1,2 @@
+export { invalidateOnEvent } from './invalidateOnEvent';
+//# sourceMappingURL=index.d.ts.map

package/dist/middlewares/invalidateOnEvent/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/middlewares/invalidateOnEvent/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC"}

package/dist/middlewares/invalidateOnEvent/invalidateOnEvent.d.ts

@@ -0,0 +1,29 @@
+import type { QueryMiddleware } from '../../foundation/useBaseQuery';
+export type InvalidateOnEventParams<E extends keyof DynamicEvents> = {
+    /**
+     * The client event to listen for (e.g. `'walletAccountsChanged'`).
+     */
+    event: E;
+};
+/**
+ * Query middleware factory that refetches the query whenever the given client
+ * event fires (e.g. `walletAccountsChanged`).
+ *
+ * It only wires up the subscription, invalidating the query's own cache key so
+ * any mounted consumer refetches. This replaces the manual `useOnEvent` +
+ * `refetch` boilerplate consumers would otherwise pair with the hook. It is the
+ * client-event counterpart to `invalidateOnWalletProviderEvent` (which listens
+ * on a single wallet account's provider). The subscription lives here, not in
+ * `useBaseQuery`.
+ *
+ * @example
+ * ```ts
+ * useBaseQuery({
+ *   middlewares: [invalidateOnEvent({ event: 'walletAccountsChanged' })],
+ *   queryFn: (client) => getConnectedAddresses(args, client),
+ *   queryKey: ['useGetConnectedAddresses', args],
+ * });
+ * ```
+ */
+export declare const invalidateOnEvent: <E extends keyof DynamicEvents>({ event, }: InvalidateOnEventParams<E>) => QueryMiddleware;
+//# sourceMappingURL=invalidateOnEvent.d.ts.map

package/dist/middlewares/invalidateOnEvent/invalidateOnEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invalidateOnEvent.d.ts","sourceRoot":"","sources":["../../../src/middlewares/invalidateOnEvent/invalidateOnEvent.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAIrE,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,MAAM,aAAa,IAAI;IACnE;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC;CACV,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,iBAAiB,GAC3B,CAAC,SAAS,MAAM,aAAa,cAE3B,uBAAuB,CAAC,CAAC,CAAC,KAAG,eAsC/B,CAAC"}

package/dist/middlewares/invalidateOnUserSwitch/index.d.ts

@@ -0,0 +1,2 @@
+export { invalidateOnUserSwitch } from './invalidateOnUserSwitch';
+//# sourceMappingURL=index.d.ts.map

package/dist/middlewares/invalidateOnUserSwitch/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/middlewares/invalidateOnUserSwitch/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC"}

package/dist/middlewares/invalidateOnUserSwitch/invalidateOnUserSwitch.d.ts

@@ -0,0 +1,27 @@
+import type { QueryMiddleware } from '../../foundation/useBaseQuery';
+/**
+ * Query middleware factory that refetches the query when a *different* user
+ * becomes the current user (login or account switch).
+ *
+ * Unlike `invalidateOnEvent({ event: 'userChanged' })`, this never invalidates
+ * on:
+ * - logout (the user becomes `undefined`) — the refetch would just 401 and the
+ *   cleared session leaves nothing to refetch; and
+ * - same-user `userChanged` fires (e.g. linking a credential or a profile
+ *   update) — the data still belongs to the same user, whose own mutations
+ *   already invalidate it within the session.
+ *
+ * It tracks the previous user id across renders (seeded from the user present
+ * at mount) and only invalidates when the new id is defined and differs.
+ *
+ * @example
+ * ```ts
+ * useBaseQuery({
+ *   middlewares: [invalidateOnUserSwitch()],
+ *   queryFn: (client) => getMfaDevices(client),
+ *   queryKey: ['useGetMfaDevices'],
+ * });
+ * ```
+ */
+export declare const invalidateOnUserSwitch: () => QueryMiddleware;
+//# sourceMappingURL=invalidateOnUserSwitch.d.ts.map

package/dist/middlewares/invalidateOnUserSwitch/invalidateOnUserSwitch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invalidateOnUserSwitch.d.ts","sourceRoot":"","sources":["../../../src/middlewares/invalidateOnUserSwitch/invalidateOnUserSwitch.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAMrE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,sBAAsB,QAC7B,eAmDH,CAAC"}

package/dist/middlewares/invalidateOnWalletProviderEvent/index.d.ts

@@ -0,0 +1,2 @@
+export { invalidateOnWalletProviderEvent } from './invalidateOnWalletProviderEvent';
+//# sourceMappingURL=index.d.ts.map

package/dist/middlewares/invalidateOnWalletProviderEvent/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/middlewares/invalidateOnWalletProviderEvent/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC"}

package/dist/middlewares/invalidateOnWalletProviderEvent/invalidateOnWalletProviderEvent.d.ts

@@ -0,0 +1,36 @@
+import type { WalletAccount, WalletProviderEvents } from '@dynamic-labs-sdk/client';
+import type { QueryMiddleware } from '../../foundation/useBaseQuery';
+export type InvalidateOnWalletProviderEventParams<E extends Extract<keyof WalletProviderEvents, string>> = {
+    /**
+     * The wallet provider event to listen for (e.g. `'networkChanged'`).
+     */
+    event: E;
+    /**
+     * The wallet account whose provider emits the event. When `undefined` the
+     * subscription is a no-op, so hooks can pass an optional account directly.
+     */
+    walletAccount: WalletAccount | undefined;
+};
+/**
+ * Query middleware factory that refetches the query whenever the given wallet
+ * account's provider emits `event` (e.g. `networkChanged`).
+ *
+ * It only wires up the subscription, invalidating the query's own cache key so
+ * any mounted consumer refetches. This replaces the manual
+ * `useOnWalletProviderEvent` + `refetch` boilerplate consumers would otherwise
+ * pair with the hook. When `walletAccount` is undefined the subscription is a
+ * no-op. The subscription lives here, not in `useBaseQuery`.
+ *
+ * @example
+ * ```ts
+ * useBaseQuery({
+ *   middlewares: [
+ *     invalidateOnWalletProviderEvent({ event: 'networkChanged', walletAccount }),
+ *   ],
+ *   queryFn: (client) => getActiveNetworkData({ walletAccount }, client),
+ *   queryKey: ['useGetActiveNetworkData', walletAccount],
+ * });
+ * ```
+ */
+export declare const invalidateOnWalletProviderEvent: <E extends Extract<keyof WalletProviderEvents, string>>({ event, walletAccount, }: InvalidateOnWalletProviderEventParams<E>) => QueryMiddleware;
+//# sourceMappingURL=invalidateOnWalletProviderEvent.d.ts.map

package/dist/middlewares/invalidateOnWalletProviderEvent/invalidateOnWalletProviderEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invalidateOnWalletProviderEvent.d.ts","sourceRoot":"","sources":["../../../src/middlewares/invalidateOnWalletProviderEvent/invalidateOnWalletProviderEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,oBAAoB,EACrB,MAAM,0BAA0B,CAAC;AAIlC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAIrE,MAAM,MAAM,qCAAqC,CAC/C,CAAC,SAAS,OAAO,CAAC,MAAM,oBAAoB,EAAE,MAAM,CAAC,IACnD;IACF;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC;IACT;;;OAGG;IACH,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;CAC1C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,+BAA+B,GACzC,CAAC,SAAS,OAAO,CAAC,MAAM,oBAAoB,EAAE,MAAM,CAAC,6BAGnD,qCAAqC,CAAC,CAAC,CAAC,KAAG,eAgC7C,CAAC"}