@clerk/shared 4.22.2-snapshot.v20260630200444 → 4.23.0

package/dist/react/index.mjs

@@ -126,6 +126,7 @@ const SUBSCRIPTION_KEY = "billing-subscription";
 const PAYMENT_METHODS_KEY = "billing-payment-methods";
 const PAYMENT_ATTEMPTS_KEY = "billing-payment-attempts";
 const STATEMENTS_KEY = "billing-statements";
+const CREDIT_BALANCE_KEY = "billing-credit-balance";
 const STABLE_KEYS = {
 	USER_MEMBERSHIPS_KEY,
 	USER_INVITATIONS_KEY,
@@ -141,7 +142,8 @@ const STABLE_KEYS = {
 	STATEMENTS_KEY,
 	API_KEYS_KEY,
 	ORGANIZATION_CREATION_DEFAULTS_KEY,
-	OAUTH_CONSENT_INFO_KEY
+	OAUTH_CONSENT_INFO_KEY,
+	CREDIT_BALANCE_KEY
 };
 /**
 * Internal stable keys for queries only used by our UI components.
@@ -155,10 +157,12 @@ const ENTERPRISE_CONNECTION_TEST_RUNS_KEY = "enterpriseConnectionTestRuns";
 const ORGANIZATION_ENTERPRISE_CONNECTIONS_KEY = "organizationEnterpriseConnections";
 const ORGANIZATION_ENTERPRISE_CONNECTION_TEST_RUNS_KEY = "organizationEnterpriseConnectionTestRuns";
 const ORGANIZATION_DOMAINS_KEY = "organizationDomains";
+const CREDIT_HISTORY_KEY = "billing-credit-history";
 const INTERNAL_STABLE_KEYS = {
 	PAYMENT_ATTEMPT_KEY,
 	BILLING_PLANS_KEY,
 	BILLING_STATEMENTS_KEY,
+	CREDIT_HISTORY_KEY,
 	USER_ENTERPRISE_CONNECTIONS_KEY,
 	ENTERPRISE_CONNECTION_TEST_RUNS_KEY,
 	ORGANIZATION_ENTERPRISE_CONNECTIONS_KEY,
@@ -846,7 +850,7 @@ function useOAuthConsentCacheKeys(params) {
 
 //#endregion
 //#region src/react/hooks/useOAuthConsent.tsx
-const HOOK_NAME$2 = "useOAuthConsent";
+const HOOK_NAME$4 = "useOAuthConsent";
 /**
 * The `useOAuthConsent()` hook loads OAuth application consent metadata for the **signed-in** user
 * (`GET /me/oauth/consent/{oauthClientId}`). Ensure the user is authenticated before relying on this hook
@@ -863,12 +867,12 @@ const HOOK_NAME$2 = "useOAuthConsent";
 * ```
 */
 function useOAuthConsent(params) {
-	useAssertWrappedByClerkProvider(HOOK_NAME$2);
+	useAssertWrappedByClerkProvider(HOOK_NAME$4);
 	const { oauthClientId: oauthClientIdParam, scope, redirectUri, keepPreviousData = true, enabled = true } = params;
 	const clerk = useClerkInstanceContext();
 	const user = useUserBase();
 	const oauthClientId = (oauthClientIdParam ?? "").trim();
-	clerk.telemetry?.record(eventMethodCalled(HOOK_NAME$2));
+	clerk.telemetry?.record(eventMethodCalled(HOOK_NAME$4));
 	const { queryKey } = useOAuthConsentCacheKeys({
 		userId: user?.id ?? null,
 		oauthClientId,
@@ -1319,7 +1323,7 @@ function useOrganizationCreationDefaultsCacheKeys(params) {
 
 //#endregion
 //#region src/react/hooks/useOrganizationCreationDefaults.tsx
-const HOOK_NAME$1 = "useOrganizationCreationDefaults";
+const HOOK_NAME$3 = "useOrganizationCreationDefaults";
 /**
 * The `useOrganizationCreationDefaults()` hook retrieves the organization creation defaults for the current user.
 *
@@ -1345,12 +1349,12 @@ const HOOK_NAME$1 = "useOrganizationCreationDefaults";
 * ```
 */
 function useOrganizationCreationDefaults(params = {}) {
-	useAssertWrappedByClerkProvider(HOOK_NAME$1);
+	useAssertWrappedByClerkProvider(HOOK_NAME$3);
 	const { keepPreviousData = true, enabled = true } = params;
 	const clerk = useClerkInstanceContext();
 	const user = useUserBase();
 	const featureEnabled = clerk.__internal_environment?.organizationSettings?.organizationCreationDefaults?.enabled ?? false;
-	clerk.telemetry?.record(eventMethodCalled(HOOK_NAME$1));
+	clerk.telemetry?.record(eventMethodCalled(HOOK_NAME$3));
 	const { queryKey } = useOrganizationCreationDefaultsCacheKeys({ userId: user?.id ?? null });
 	const queryEnabled = Boolean(user) && enabled && featureEnabled && clerk.loaded;
 	const query = useClerkQuery({
@@ -2375,12 +2379,12 @@ function useSubscriptionCacheKeys(params) {
 
 //#endregion
 //#region src/react/hooks/useSubscription.tsx
-const HOOK_NAME = "useSubscription";
+const HOOK_NAME$2 = "useSubscription";
 /**
 * @internal
 */
 function useSubscription(params) {
-	useAssertWrappedByClerkProvider(HOOK_NAME);
+	useAssertWrappedByClerkProvider(HOOK_NAME$2);
 	const clerk = useClerkInstanceContext();
 	const user = useUserBase();
 	const organization = useOrganizationBase();
@@ -2388,7 +2392,7 @@ function useSubscription(params) {
 	const recordedRef = useRef(false);
 	useEffect(() => {
 		if (!recordedRef.current && clerk?.telemetry) {
-			clerk.telemetry.record(eventMethodCalled(HOOK_NAME));
+			clerk.telemetry.record(eventMethodCalled(HOOK_NAME$2));
 			recordedRef.current = true;
 		}
 	}, [clerk]);
@@ -2476,6 +2480,130 @@ const useCheckout = (options) => {
 	return useSyncExternalStore(subscribe, getSnapshot, getSnapshot);
 };
 
+//#endregion
+//#region src/react/hooks/useCreditBalance.tsx
+const HOOK_NAME$1 = "useCreditBalance";
+/**
+* @internal
+*/
+function __internal_useCreditBalanceQuery(params) {
+	useAssertWrappedByClerkProvider(HOOK_NAME$1);
+	const clerk = useClerkInstanceContext();
+	const user = useUserBase();
+	const organization = useOrganizationBase();
+	const billingEnabled = useBillingIsEnabled(params);
+	const recordedRef = useRef(false);
+	useEffect(() => {
+		if (!recordedRef.current && clerk?.telemetry) {
+			clerk.telemetry.record(eventMethodCalled(HOOK_NAME$1));
+			recordedRef.current = true;
+		}
+	}, [clerk]);
+	const keepPreviousData = params?.keepPreviousData ?? false;
+	const [queryClient] = useClerkQueryClient();
+	const { queryKey, invalidationKey, stableKey, authenticated } = useMemo(() => {
+		const safeOrgId = params?.for === "organization" ? organization?.id : void 0;
+		return createCacheKeys({
+			stablePrefix: STABLE_KEYS.CREDIT_BALANCE_KEY,
+			authenticated: true,
+			tracked: {
+				userId: user?.id,
+				orgId: safeOrgId
+			},
+			untracked: { args: { orgId: safeOrgId } }
+		});
+	}, [
+		user?.id,
+		organization?.id,
+		params?.for
+	]);
+	const queriesEnabled = Boolean(user?.id && billingEnabled && (params?.enabled ?? true));
+	useClearQueriesOnSignOut({
+		isSignedOut: user === null,
+		authenticated,
+		stableKeys: stableKey
+	});
+	const query = useClerkQuery({
+		queryKey,
+		queryFn: ({ queryKey }) => {
+			const obj = queryKey[3];
+			return clerk.billing.getCreditBalance(obj.args);
+		},
+		staleTime: 1e3 * 60,
+		enabled: queriesEnabled,
+		placeholderData: defineKeepPreviousDataFn(keepPreviousData && queriesEnabled)
+	});
+	const revalidate = useCallback(() => queryClient.invalidateQueries({ queryKey: invalidationKey }), [queryClient, invalidationKey]);
+	return {
+		data: query.data,
+		error: query.error ?? void 0,
+		isLoading: query.isLoading,
+		isFetching: query.isFetching,
+		revalidate
+	};
+}
+
+//#endregion
+//#region src/react/hooks/useCreditHistory.tsx
+const HOOK_NAME = "useCreditHistory";
+/**
+* @internal
+*/
+function __internal_useCreditHistoryQuery(params) {
+	useAssertWrappedByClerkProvider(HOOK_NAME);
+	const clerk = useClerkInstanceContext();
+	const user = useUserBase();
+	const organization = useOrganizationBase();
+	const billingEnabled = useBillingIsEnabled(params);
+	const recordedRef = useRef(false);
+	useEffect(() => {
+		if (!recordedRef.current && clerk?.telemetry) {
+			clerk.telemetry.record(eventMethodCalled(HOOK_NAME));
+			recordedRef.current = true;
+		}
+	}, [clerk]);
+	const [queryClient] = useClerkQueryClient();
+	const { queryKey, invalidationKey, stableKey, authenticated } = useMemo(() => {
+		const safeOrgId = params?.for === "organization" ? organization?.id : void 0;
+		return createCacheKeys({
+			stablePrefix: INTERNAL_STABLE_KEYS.CREDIT_HISTORY_KEY,
+			authenticated: true,
+			tracked: {
+				userId: user?.id,
+				orgId: safeOrgId
+			},
+			untracked: { args: { orgId: safeOrgId } }
+		});
+	}, [
+		user?.id,
+		organization?.id,
+		params?.for
+	]);
+	const queriesEnabled = Boolean(user?.id && billingEnabled && (params?.enabled ?? true));
+	useClearQueriesOnSignOut({
+		isSignedOut: user === null,
+		authenticated,
+		stableKeys: stableKey
+	});
+	const query = useClerkQuery({
+		queryKey,
+		queryFn: ({ queryKey }) => {
+			const obj = queryKey[3];
+			return clerk.billing.getCreditHistory(obj.args);
+		},
+		staleTime: 1e3 * 60,
+		enabled: queriesEnabled
+	});
+	const revalidate = useCallback(() => queryClient.invalidateQueries({ queryKey: invalidationKey }), [queryClient, invalidationKey]);
+	return {
+		data: query.data,
+		error: query.error ?? void 0,
+		isLoading: query.isLoading,
+		isFetching: query.isFetching,
+		revalidate
+	};
+}
+
 //#endregion
 //#region src/react/hooks/useStatementQuery.shared.ts
 function useStatementQueryCacheKeys(params) {
@@ -3581,5 +3709,5 @@ const usePortalRoot = () => {
 };
 
 //#endregion
-export { ClerkContextProvider, ClerkInstanceContext, InitialStateProvider, OptionsContext, UNSAFE_PortalProvider, __createClerkTestQueryClient, __experimental_CheckoutProvider, PaymentElement as __experimental_PaymentElement, PaymentElementProvider as __experimental_PaymentElementProvider, useCheckout as __experimental_useCheckout, usePaymentAttempts as __experimental_usePaymentAttempts, usePaymentElement as __experimental_usePaymentElement, usePaymentMethods as __experimental_usePaymentMethods, usePlans as __experimental_usePlans, useStatements as __experimental_useStatements, useSubscription as __experimental_useSubscription, useClientBase as __internal_useClientBase, useOrganizationBase as __internal_useOrganizationBase, useOrganizationDomains as __internal_useOrganizationDomains, useOrganizationEnterpriseConnectionTestRuns as __internal_useOrganizationEnterpriseConnectionTestRuns, useOrganizationEnterpriseConnections as __internal_useOrganizationEnterpriseConnections, usePaymentAttemptQuery as __internal_usePaymentAttemptQuery, __internal_usePlanDetailsQuery, useSessionBase as __internal_useSessionBase, useStatementQuery as __internal_useStatementQuery, useUserBase as __internal_useUserBase, useUserEnterpriseConnections as __internal_useUserEnterpriseConnections, __resetClerkQueryClientForTest, __setClerkQueryClientForTest, assertContextExists, createContextAndHook, getClerkQueryClient, isDeeplyEqual, useAPIKeys, useAssertWrappedByClerkProvider, useAttemptToEnableOrganizations, useClerk, useClerkInstanceContext, useDeepEqualMemo, useInitialStateContext, useOAuthConsent, useOptionsContext, useOrganization, useOrganizationCreationDefaults, useOrganizationList, usePortalRoot, useReverification, useSafeLayoutEffect, useSession, useSessionList, useUser };
+export { ClerkContextProvider, ClerkInstanceContext, InitialStateProvider, OptionsContext, UNSAFE_PortalProvider, __createClerkTestQueryClient, __experimental_CheckoutProvider, PaymentElement as __experimental_PaymentElement, PaymentElementProvider as __experimental_PaymentElementProvider, useCheckout as __experimental_useCheckout, usePaymentAttempts as __experimental_usePaymentAttempts, usePaymentElement as __experimental_usePaymentElement, usePaymentMethods as __experimental_usePaymentMethods, usePlans as __experimental_usePlans, useStatements as __experimental_useStatements, useSubscription as __experimental_useSubscription, useClientBase as __internal_useClientBase, __internal_useCreditBalanceQuery, __internal_useCreditHistoryQuery, useOrganizationBase as __internal_useOrganizationBase, useOrganizationDomains as __internal_useOrganizationDomains, useOrganizationEnterpriseConnectionTestRuns as __internal_useOrganizationEnterpriseConnectionTestRuns, useOrganizationEnterpriseConnections as __internal_useOrganizationEnterpriseConnections, usePaymentAttemptQuery as __internal_usePaymentAttemptQuery, __internal_usePlanDetailsQuery, useSessionBase as __internal_useSessionBase, useStatementQuery as __internal_useStatementQuery, useUserBase as __internal_useUserBase, useUserEnterpriseConnections as __internal_useUserEnterpriseConnections, __resetClerkQueryClientForTest, __setClerkQueryClientForTest, assertContextExists, createContextAndHook, getClerkQueryClient, isDeeplyEqual, useAPIKeys, useAssertWrappedByClerkProvider, useAttemptToEnableOrganizations, useClerk, useClerkInstanceContext, useDeepEqualMemo, useInitialStateContext, useOAuthConsent, useOptionsContext, useOrganization, useOrganizationCreationDefaults, useOrganizationList, usePortalRoot, useReverification, useSafeLayoutEffect, useSession, useSessionList, useUser };
 //# sourceMappingURL=index.mjs.map