@clerk/shared 3.43.2 → 3.44.0

package/dist/runtime/react/index.mjs

@@ -115,6 +115,7 @@ const MEMBERSHIP_REQUESTS_KEY = "membershipRequests";
 const MEMBERSHIPS_KEY = "memberships";
 const INVITATIONS_KEY = "invitations";
 const API_KEYS_KEY = "apiKeys";
+const ORGANIZATION_CREATION_DEFAULTS_KEY = "organizationCreationDefaults";
 const PLANS_KEY = "billing-plans";
 const SUBSCRIPTION_KEY = "billing-subscription";
 const PAYMENT_METHODS_KEY = "billing-payment-methods";
@@ -133,7 +134,8 @@ const STABLE_KEYS = {
 	PAYMENT_METHODS_KEY,
 	PAYMENT_ATTEMPTS_KEY,
 	STATEMENTS_KEY,
-	API_KEYS_KEY
+	API_KEYS_KEY,
+	ORGANIZATION_CREATION_DEFAULTS_KEY
 };
 /**
 * Internal stable keys for queries only used by our UI components.
@@ -868,6 +870,68 @@ function useOrganization(params) {
 	};
 }
 
+//#endregion
+//#region src/react/hooks/useOrganizationCreationDefaults.shared.ts
+function useOrganizationCreationDefaultsCacheKeys(params) {
+	const { userId } = params;
+	return useMemo(() => {
+		return createCacheKeys({
+			stablePrefix: STABLE_KEYS.ORGANIZATION_CREATION_DEFAULTS_KEY,
+			authenticated: Boolean(userId),
+			tracked: { userId: userId ?? null },
+			untracked: { args: {} }
+		});
+	}, [userId]);
+}
+
+//#endregion
+//#region src/react/hooks/useOrganizationCreationDefaults.swr.tsx
+/**
+* The `useOrganizationCreationDefaults()` hook retrieves the organization creation defaults for the current user.
+*
+* @example
+* ### Basic usage
+*
+* ```tsx
+* import { useOrganizationCreationDefaults } from '@clerk/clerk-react'
+*
+* export default function CreateOrganizationForm() {
+*   const { data, isLoading } = useOrganizationCreationDefaults()
+*
+*   if (isLoading) return <div>Loading...</div>
+*
+*   return (
+*     <form>
+*       <input defaultValue={data?.form.name} placeholder="Organization name" />
+*       <input defaultValue={data?.form.slug} placeholder="Slug" />
+*       <button type="submit">Create</button>
+*     </form>
+*   )
+* }
+* ```
+*/
+function useOrganizationCreationDefaultsHook(params = {}) {
+	const { keepPreviousData = true, enabled = true } = params;
+	const clerk = useClerkInstanceContext();
+	const user = useUserContext();
+	const featureEnabled = clerk.__unstable__environment?.organizationSettings?.organizationCreationDefaults?.enabled ?? false;
+	clerk.telemetry?.record(eventMethodCalled("useOrganizationCreationDefaults"));
+	const { queryKey } = useOrganizationCreationDefaultsCacheKeys({ userId: user?.id ?? null });
+	const swr = useSWR(Boolean(user) && enabled && featureEnabled && clerk.loaded ? queryKey : null, () => {
+		if (!user) throw new Error("User is required to fetch organization creation defaults");
+		return user.getOrganizationCreationDefaults();
+	}, {
+		dedupingInterval: 1e3 * 60,
+		keepPreviousData
+	});
+	return {
+		data: swr.data,
+		error: swr.error ?? null,
+		isLoading: swr.isLoading,
+		isFetching: swr.isValidating
+	};
+}
+
 //#endregion
 //#region src/react/hooks/useOrganizationList.tsx
 const undefinedPaginatedResource = {
@@ -2513,5 +2577,5 @@ const usePaymentElement = () => {
 };
 
 //#endregion
-export { ClerkInstanceContext, ClientContext, OptionsContext, OrganizationProvider, SessionContext, UserContext, __experimental_CheckoutProvider, PaymentElement as __experimental_PaymentElement, PaymentElementProvider as __experimental_PaymentElementProvider, useAPIKeys as __experimental_useAPIKeys, 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, __internal_usePaymentAttemptQuery, usePlanDetailsQuery as __internal_usePlanDetailsQuery, __internal_useStatementQuery, assertContextExists, createContextAndHook, isDeeplyEqual, useAssertWrappedByClerkProvider, useAttemptToEnableOrganizations, useClerk, useClerkInstanceContext, useClientContext, useDeepEqualMemo, useOptionsContext, useOrganization, useOrganizationContext, useOrganizationList, useReverification, useSafeLayoutEffect, useSession, useSessionContext, useSessionList, useUser, useUserContext };
+export { ClerkInstanceContext, ClientContext, OptionsContext, OrganizationProvider, SessionContext, UserContext, __experimental_CheckoutProvider, PaymentElement as __experimental_PaymentElement, PaymentElementProvider as __experimental_PaymentElementProvider, useAPIKeys as __experimental_useAPIKeys, 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, __internal_usePaymentAttemptQuery, usePlanDetailsQuery as __internal_usePlanDetailsQuery, __internal_useStatementQuery, assertContextExists, createContextAndHook, isDeeplyEqual, useAssertWrappedByClerkProvider, useAttemptToEnableOrganizations, useClerk, useClerkInstanceContext, useClientContext, useDeepEqualMemo, useOptionsContext, useOrganization, useOrganizationContext, useOrganizationCreationDefaultsHook as useOrganizationCreationDefaults, useOrganizationList, useReverification, useSafeLayoutEffect, useSession, useSessionContext, useSessionList, useUser, useUserContext };
 //# sourceMappingURL=index.mjs.map