chore(clerk-js, shared): Remove SWR from clerk-js and create variants for existing internal hooks

packages/clerk-js/src/ui/components/APIKeys/APIKeys.tsx

@@ -94,6 +94,7 @@ export const APIKeysPage = ({ subject, perPage, revokeModalRoot }: APIKeysPagePr
   };
   const card = useCardState();
   const clerk = useClerk();
+  // TODO: Replace useSWRMutation with the react-query equivalent.
   const {
     data: createdAPIKey,
     trigger: createAPIKey,

packages/clerk-js/src/ui/components/PaymentAttempts/PaymentAttemptPage.tsx

@@ -1,6 +1,5 @@
-import { useClerk, useOrganizationContext } from '@clerk/shared/react';
+import { __internal_usePaymentAttemptQuery } from '@clerk/shared/react/index';
 import type { BillingSubscriptionItemResource } from '@clerk/shared/types';
-import useSWR from 'swr';
 
 import { Alert } from '@/ui/elements/Alert';
 import { Header } from '@/ui/elements/Header';
@@ -31,28 +30,17 @@ export const PaymentAttemptPage = () => {
   const subscriberType = useSubscriberTypeContext();
   const localizationRoot = useSubscriberTypeLocalizationRoot();
   const { t, translateError } = useLocalizations();
-  const clerk = useClerk();
-  // Do not use `useOrganization` to avoid triggering the in-app enable organizations prompt in development instance
-  const organizationCtx = useOrganizationContext();
+  const requesterType = subscriberType === 'organization' ? 'organization' : 'user';
 
   const {
     data: paymentAttempt,
     isLoading,
     error,
-  } = useSWR(
-    params.paymentAttemptId
-      ? {
-          type: 'payment-attempt',
-          id: params.paymentAttemptId,
-          orgId: subscriberType === 'organization' ? organizationCtx?.organization?.id : undefined,
-        }
-      : null,
-    () =>
-      clerk.billing.getPaymentAttempt({
-        id: params.paymentAttemptId,
-        orgId: subscriberType === 'organization' ? organizationCtx?.organization?.id : undefined,
-      }),
-  );
+  } = __internal_usePaymentAttemptQuery({
+    paymentAttemptId: params.paymentAttemptId,
+    for: requesterType,
+    enabled: Boolean(params.paymentAttemptId),
+  });
 
   const subscriptionItem = paymentAttempt?.subscriptionItem;
 

packages/clerk-js/src/ui/components/Plans/PlanDetails.tsx

@@ -1,4 +1,4 @@
-import { useClerk } from '@clerk/shared/react';
+import { __internal_usePlanDetailsQuery } from '@clerk/shared/react/index';
 import type {
   __internal_PlanDetailsProps,
   BillingPlanResource,
@@ -7,7 +7,6 @@ import type {
 } from '@clerk/shared/types';
 import * as React from 'react';
 import { useMemo, useState } from 'react';
-import useSWR from 'swr';
 
 import { Alert } from '@/ui/elements/Alert';
 import { Avatar } from '@/ui/elements/Avatar';
@@ -79,24 +78,17 @@ const PlanDetailsInternal = ({
   plan: initialPlan,
   initialPlanPeriod = 'month',
 }: __internal_PlanDetailsProps) => {
-  const clerk = useClerk();
   const [planPeriod, setPlanPeriod] = useState<BillingSubscriptionPlanPeriod>(initialPlanPeriod);
 
   const {
     data: plan,
     isLoading,
     error,
-  } = useSWR<BillingPlanResource, ClerkAPIResponseError>(
-    planId || initialPlan ? { type: 'plan', id: planId || initialPlan?.id } : null,
-    // @ts-expect-error we are handling it above
-    () => clerk.billing.getPlan({ id: planId || initialPlan?.id }),
-    {
-      fallbackData: initialPlan,
-      revalidateOnFocus: false,
-      shouldRetryOnError: false,
-      keepPreviousData: true,
-    },
-  );
+  } = __internal_usePlanDetailsQuery({
+    planId,
+    initialPlan,
+    enabled: Boolean(planId || initialPlan?.id),
+  });
 
   if (isLoading && !initialPlan) {
     return (

packages/clerk-js/src/ui/components/Statements/StatementPage.tsx

@@ -1,5 +1,4 @@
-import { useClerk, useOrganizationContext } from '@clerk/shared/react';
-import useSWR from 'swr';
+import { __internal_useStatementQuery } from '@clerk/shared/react/index';
 
 import { Alert } from '@/ui/elements/Alert';
 import { Header } from '@/ui/elements/Header';
@@ -25,28 +24,17 @@ export const StatementPage = () => {
   const subscriberType = useSubscriberTypeContext();
   const localizationRoot = useSubscriberTypeLocalizationRoot();
   const { t, translateError } = useLocalizations();
-  const clerk = useClerk();
-  // Do not use `useOrganization` to avoid triggering the in-app enable organizations prompt in development instance
-  const organizationCtx = useOrganizationContext();
+  const requesterType = subscriberType === 'organization' ? 'organization' : 'user';
 
   const {
     data: statement,
     isLoading,
     error,
-  } = useSWR(
-    params.statementId
-      ? {
-          type: 'statement',
-          id: params.statementId,
-          orgId: subscriberType === 'organization' ? organizationCtx?.organization?.id : undefined,
-        }
-      : null,
-    () =>
-      clerk.billing.getStatement({
-        id: params.statementId,
-        orgId: subscriberType === 'organization' ? organizationCtx?.organization?.id : undefined,
-      }),
-  );
+  } = __internal_useStatementQuery({
+    statementId: params.statementId,
+    for: requesterType,
+    enabled: Boolean(params.statementId),
+  });
 
   if (isLoading) {
     return (

packages/shared/src/react/clerk-rq/keep-previous-data.ts

@@ -0,0 +1,11 @@
+/**
+ * @internal
+ */
+export function defineKeepPreviousDataFn(enabled: boolean) {
+  if (enabled) {
+    return function KeepPreviousDataFn<Data>(previousData: Data): Data {
+      return previousData;
+    };
+  }
+  return undefined;
+}

packages/shared/src/react/clerk-swr.ts

@@ -1,5 +1,6 @@
 'use client';
 
+// TODO: Replace these SWR re-exports with react-query equivalents.
 export * from 'swr';
 
 export { default as useSWR } from 'swr';

packages/shared/src/react/commerce.tsx

@@ -32,6 +32,7 @@ const [StripeLibsContext, useStripeLibsContext] = createContextAndHook<{
 
 const StripeLibsProvider = ({ children }: PropsWithChildren) => {
   const clerk = useClerk();
+  // TODO: Replace useSWR with the react-query equivalent.
   const { data: stripeClerkLibs } = useSWR(
     'clerk-stripe-sdk',
     async () => {
@@ -85,6 +86,7 @@ const usePaymentSourceUtils = (forResource: ForPayerType = 'user') => {
   const resource = forResource === 'organization' ? organization : user;
   const stripeClerkLibs = useStripeLibsContext();
 
+  // TODO: Replace useSWRMutation with the react-query equivalent.
   const { data: initializedPaymentMethod, trigger: initializePaymentMethod } = useSWRMutation(
     {
       key: 'billing-payment-method-initialize',
@@ -113,6 +115,7 @@ const usePaymentSourceUtils = (forResource: ForPayerType = 'user') => {
   const paymentMethodOrder = initializedPaymentMethod?.paymentMethodOrder;
   const stripePublishableKey = environment?.commerceSettings.billing.stripePublishableKey;
 
+  // TODO: Replace useSWR with the react-query equivalent.
   const { data: stripe } = useSWR(
     stripeClerkLibs && externalGatewayId && stripePublishableKey
       ? { key: 'stripe-sdk', externalGatewayId, stripePublishableKey }

packages/shared/src/react/hooks/__tests__/wrapper.tsx

@@ -2,6 +2,7 @@ import React from 'react';
 import { SWRConfig } from 'swr';
 
 export const wrapper = ({ children }: { children: React.ReactNode }) => (
+  // TODO: Replace SWRConfig with the react-query equivalent.
   <SWRConfig
     value={{
       provider: () => new Map(),

packages/shared/src/react/hooks/createCacheKeys.ts

@@ -1,4 +1,5 @@
-import type { ResourceCacheStableKey } from '../stable-keys';
+import type { __internal_ResourceCacheStableKey, ResourceCacheStableKey } from '../stable-keys';
+import type { QueryKeyWithArgs } from './usePageOrInfinite.types';
 
 /**
  * @internal
@@ -8,7 +9,7 @@ export function createCacheKeys<
   T extends Record<string, unknown> = Record<string, unknown>,
   U extends Record<string, unknown> | undefined = undefined,
 >(params: {
-  stablePrefix: ResourceCacheStableKey;
+  stablePrefix: ResourceCacheStableKey | __internal_ResourceCacheStableKey;
   authenticated: boolean;
   tracked: T;
   untracked: U extends { args: Params } ? U : never;
@@ -20,3 +21,12 @@ export function createCacheKeys<
     authenticated: params.authenticated,
   };
 }
+
+export function toSWRQuery<T extends { queryKey: QueryKeyWithArgs<unknown> }>(keys: T) {
+  const { queryKey } = keys;
+  return {
+    type: queryKey[0],
+    ...queryKey[2],
+    ...(queryKey[3] as { args: Record<string, unknown> }).args,
+  };
+}

packages/shared/src/react/hooks/index.ts

@@ -15,3 +15,6 @@ export { usePaymentMethods as __experimental_usePaymentMethods } from './usePaym
 export { usePlans as __experimental_usePlans } from './usePlans';
 export { useSubscription as __experimental_useSubscription } from './useSubscription';
 export { useCheckout as __experimental_useCheckout } from './useCheckout';
+export { __internal_useStatementQuery } from './useStatementQuery';
+export { __internal_usePlanDetailsQuery } from './usePlanDetailsQuery';
+export { __internal_usePaymentAttemptQuery } from './usePaymentAttemptQuery';

packages/shared/src/react/hooks/usePageOrInfinite.types.ts

@@ -10,7 +10,7 @@ type QueryArgs<Params> = Readonly<{
   args: Params;
 }>;
 
-type QueryKeyWithArgs<Params> = readonly [
+export type QueryKeyWithArgs<Params> = readonly [
   string,
   boolean,
   Record<string, unknown>,
@@ -27,6 +27,7 @@ export type UsePagesOrInfiniteSignature = <
     queryKey: QueryKeyWithArgs<Params>;
     invalidationKey: InvalidationQueryKey;
     stableKey: string;
+    authenticated: boolean;
   },
   TConfig extends Config = Config,
 >(params: {

packages/shared/src/react/hooks/usePagesOrInfinite.rq.tsx

@@ -3,6 +3,7 @@
 import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
 
 import type { ClerkPaginatedResponse } from '../../types';
+import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
 import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client';
 import { useClerkInfiniteQuery } from '../clerk-rq/useInfiniteQuery';
 import { useClerkQuery } from '../clerk-rq/useQuery';
@@ -11,13 +12,6 @@ import type { UsePagesOrInfiniteSignature } from './usePageOrInfinite.types';
 import { useWithSafeValues } from './usePagesOrInfinite.shared';
 import { usePreviousValue } from './usePreviousValue';
 
-/**
- * @internal
- */
-function KeepPreviousDataFn<Data>(previousData: Data): Data {
-  return previousData;
-}
-
 export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
   const { fetcher, config, keys } = params;
 
@@ -77,7 +71,7 @@ export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
     staleTime: 60_000,
     enabled: queriesEnabled && !triggerInfinite,
     // Use placeholderData to keep previous data while fetching new page
-    placeholderData: keepPreviousData ? KeepPreviousDataFn : undefined,
+    placeholderData: defineKeepPreviousDataFn(keepPreviousData),
   });
 
   // Infinite mode: accumulate pages

packages/shared/src/react/hooks/usePagesOrInfinite.swr.tsx

@@ -4,6 +4,7 @@ import { useCallback, useMemo, useRef, useState } from 'react';
 
 import { useSWR, useSWRInfinite } from '../clerk-swr';
 import type { CacheSetter, ValueOrSetter } from '../types';
+import { toSWRQuery } from './createCacheKeys';
 import type { UsePagesOrInfiniteSignature } from './usePageOrInfinite.types';
 import { getDifferentKeys, useWithSafeValues } from './usePagesOrInfinite.shared';
 import { usePreviousValue } from './usePreviousValue';
@@ -49,9 +50,7 @@ export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
   const isSignedIn = config.isSignedIn;
 
   const pagesCacheKey = {
-    type: keys.queryKey[0],
-    ...keys.queryKey[2],
-    ...keys.queryKey[3].args,
+    ...toSWRQuery(keys),
     initialPage: paginatedPage,
     pageSize: pageSizeRef.current,
   };
@@ -136,9 +135,7 @@ export const usePagesOrInfinite: UsePagesOrInfiniteSignature = params => {
       }
 
       return {
-        type: keys.queryKey[0],
-        ...keys.queryKey[2],
-        ...keys.queryKey[3].args,
+        ...toSWRQuery(keys),
         initialPage: initialPageRef.current + pageIndex,
         pageSize: pageSizeRef.current,
       };

packages/shared/src/react/hooks/usePaymentAttemptQuery.rq.tsx

@@ -0,0 +1,62 @@
+import { eventMethodCalled } from '../../telemetry/events';
+import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data';
+import { useClerkQuery } from '../clerk-rq/useQuery';
+import {
+  useAssertWrappedByClerkProvider,
+  useClerkInstanceContext,
+  useOrganizationContext,
+  useUserContext,
+} from '../contexts';
+import { usePaymentAttemptQueryCacheKeys } from './usePaymentAttemptQuery.shared';
+import type { PaymentAttemptQueryResult, UsePaymentAttemptQueryParams } from './usePaymentAttemptQuery.types';
+
+const HOOK_NAME = 'usePaymentAttemptQuery';
+
+/**
+ * This is the new implementation of usePaymentAttemptQuery using React Query.
+ * It is exported only if the package is built with the `CLERK_USE_RQ` environment variable set to `true`.
+ *
+ * @internal
+ */
+function usePaymentAttemptQuery(params: UsePaymentAttemptQueryParams): PaymentAttemptQueryResult {
+  useAssertWrappedByClerkProvider(HOOK_NAME);
+
+  const { paymentAttemptId, enabled = true, keepPreviousData = false, for: forType = 'user' } = params;
+  const clerk = useClerkInstanceContext();
+  const user = useUserContext();
+  const { organization } = useOrganizationContext();
+
+  clerk.telemetry?.record(eventMethodCalled(HOOK_NAME));
+
+  const organizationId = forType === 'organization' ? (organization?.id ?? null) : null;
+  const userId = user?.id ?? null;
+
+  const { queryKey } = usePaymentAttemptQueryCacheKeys({
+    paymentAttemptId,
+    userId,
+    orgId: organizationId,
+    for: forType,
+  });
+
+  const queryEnabled = Boolean(paymentAttemptId) && enabled && (forType !== 'organization' || Boolean(organizationId));
+
+  const query = useClerkQuery({
+    queryKey,
+    queryFn: ({ queryKey }) => {
+      const args = queryKey[3].args;
+      return clerk.billing.getPaymentAttempt(args);
+    },
+    enabled: queryEnabled,
+    placeholderData: defineKeepPreviousDataFn(keepPreviousData),
+    staleTime: 1_000 * 60,
+  });
+
+  return {
+    data: query.data,
+    error: (query.error ?? null) as PaymentAttemptQueryResult['error'],
+    isLoading: query.isLoading,
+    isFetching: query.isFetching,
+  };
+}
+
+export { usePaymentAttemptQuery as __internal_usePaymentAttemptQuery };

packages/shared/src/react/hooks/usePaymentAttemptQuery.shared.ts

@@ -0,0 +1,32 @@
+import { useMemo } from 'react';
+
+import type { ForPayerType } from '../../types';
+import { INTERNAL_STABLE_KEYS } from '../stable-keys';
+import { createCacheKeys } from './createCacheKeys';
+
+export function usePaymentAttemptQueryCacheKeys(params: {
+  paymentAttemptId: string;
+  userId: string | null;
+  orgId: string | null;
+  for?: ForPayerType;
+}) {
+  const { paymentAttemptId, userId, orgId, for: forType } = params;
+  return useMemo(() => {
+    return createCacheKeys({
+      stablePrefix: INTERNAL_STABLE_KEYS.PAYMENT_ATTEMPT_KEY,
+      authenticated: true,
+      tracked: {
+        paymentAttemptId,
+        forType,
+        userId,
+        orgId,
+      },
+      untracked: {
+        args: {
+          id: paymentAttemptId ?? undefined,
+          orgId: orgId ?? undefined,
+        },
+      },
+    });
+  }, [paymentAttemptId, forType, userId, orgId]);
+}