@clerk/shared 4.32.0-snapshot.v20260904162929 → 4.32.0

package/dist/react/index.js

@@ -4,7 +4,7 @@ const require_authorization_errors = require('../authorization-errors.js');
 const require_authorization = require('../authorization.js');
 const require_deriveState = require('../deriveState.js');
 const require_clerkRuntimeError = require('../_chunks/clerkRuntimeError-CYZdTZ_x.js');
-const require_error = require('../_chunks/error-C-B61RHn.js');
+const require_error = require('../_chunks/error-CdWUgmMd.js');
 const require_logger = require('../logger.js');
 const require_organization = require('../organization.js');
 const require_telemetry = require('../_chunks/telemetry-DZp9OI1j.js');
@@ -159,6 +159,8 @@ 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 ORGANIZATION_DIRECTORY_SYNC_KEY = "organizationDirectorySync";
+const ORGANIZATION_DIRECTORY_SYNC_USERS_KEY = "organizationDirectorySyncUsers";
 const CREDIT_HISTORY_KEY = "billing-credit-history";
 const INTERNAL_STABLE_KEYS = {
 	PAYMENT_ATTEMPT_KEY,
@@ -169,7 +171,9 @@ const INTERNAL_STABLE_KEYS = {
 	ENTERPRISE_CONNECTION_TEST_RUNS_KEY,
 	ORGANIZATION_ENTERPRISE_CONNECTIONS_KEY,
 	ORGANIZATION_ENTERPRISE_CONNECTION_TEST_RUNS_KEY,
-	ORGANIZATION_DOMAINS_KEY
+	ORGANIZATION_DOMAINS_KEY,
+	ORGANIZATION_DIRECTORY_SYNC_KEY,
+	ORGANIZATION_DIRECTORY_SYNC_USERS_KEY
 };
 
 //#endregion
@@ -1079,7 +1083,7 @@ function useSessionBase() {
 *
 * @example
 *
-* The following example uses the `useClerk()` hook to access the `clerk` object. The `clerk` object is used to call the [`openSignIn()`](https://clerk.com/docs/reference/objects/clerk#sign-in) method to open the sign-in modal.
+* The following example uses the `useClerk()` hook to access the `clerk` object. The `clerk` object is used to call the [`openSignIn()`](https://clerk.com/docs/reference/objects/clerk#opensignin) method to open the sign-in modal.
 *
 * <Tabs items='React,Next.js'>
 * <Tab>
@@ -3179,6 +3183,189 @@ function useOrganizationDomains(params = {}) {
 	};
 }
 
+//#endregion
+//#region src/react/hooks/useOrganizationDirectorySync.shared.ts
+/**
+* @internal
+*/
+function useOrganizationDirectorySyncCacheKeys(params) {
+	const { organizationId, enterpriseConnectionId } = params;
+	return (0, react.useMemo)(() => {
+		return createCacheKeys({
+			stablePrefix: INTERNAL_STABLE_KEYS.ORGANIZATION_DIRECTORY_SYNC_KEY,
+			authenticated: Boolean(organizationId),
+			tracked: {
+				organizationId: organizationId ?? null,
+				enterpriseConnectionId: enterpriseConnectionId ?? null
+			},
+			untracked: { args: {} }
+		});
+	}, [organizationId, enterpriseConnectionId]);
+}
+/**
+* @internal
+*/
+function useOrganizationDirectorySyncUsersCacheKeys(params) {
+	const { organizationId, enterpriseConnectionId, directoryId, args } = params;
+	return (0, react.useMemo)(() => {
+		return createCacheKeys({
+			stablePrefix: INTERNAL_STABLE_KEYS.ORGANIZATION_DIRECTORY_SYNC_USERS_KEY,
+			authenticated: Boolean(organizationId),
+			tracked: {
+				organizationId: organizationId ?? null,
+				enterpriseConnectionId: enterpriseConnectionId ?? null,
+				directoryId: directoryId ?? null
+			},
+			untracked: { args }
+		});
+	}, [
+		organizationId,
+		enterpriseConnectionId,
+		directoryId,
+		JSON.stringify(args)
+	]);
+}
+
+//#endregion
+//#region src/react/hooks/useOrganizationDirectorySync.tsx
+/**
+* The Directory Sync directory bound to an enterprise connection of the active organization.
+*
+* @internal
+*/
+function useOrganizationDirectorySync(params) {
+	const { enterpriseConnectionId, enabled = true } = params;
+	const clerk = useClerkInstanceContext();
+	const organization = useOrganizationBase();
+	const [queryClient] = useClerkQueryClient();
+	const { queryKey, invalidationKey, stableKey, authenticated } = useOrganizationDirectorySyncCacheKeys({
+		organizationId: organization?.id ?? null,
+		enterpriseConnectionId
+	});
+	const queryEnabled = enabled && clerk.loaded && Boolean(organization) && Boolean(enterpriseConnectionId);
+	useClearQueriesOnSignOut({
+		isSignedOut: organization === null,
+		authenticated,
+		stableKeys: stableKey
+	});
+	const query = useClerkQuery({
+		queryKey,
+		queryFn: async () => {
+			if (!enterpriseConnectionId) throw new Error("enterpriseConnectionId is required to fetch the directory");
+			try {
+				return await organization?.getDirectorySync(enterpriseConnectionId) ?? null;
+			} catch (err) {
+				if (require_error.isClerkAPIResponseError(err) && err.status === 404) return null;
+				throw err;
+			}
+		},
+		enabled: queryEnabled
+	});
+	const revalidate = (0, react.useCallback)(() => queryClient.invalidateQueries({ queryKey: invalidationKey }), [queryClient, invalidationKey]);
+	const createDirectorySync = (0, react.useCallback)(async (createParams) => {
+		if (!enterpriseConnectionId) return;
+		const created = await organization?.createDirectorySync(enterpriseConnectionId, createParams);
+		await revalidate();
+		return created;
+	}, [
+		organization,
+		enterpriseConnectionId,
+		revalidate
+	]);
+	const directory = query.data;
+	const updateDirectorySync = (0, react.useCallback)(async (updateParams) => {
+		if (!directory) return;
+		const updated = await directory.update(updateParams);
+		await revalidate();
+		return updated;
+	}, [directory, revalidate]);
+	const rotateDirectorySyncToken = (0, react.useCallback)(async () => {
+		if (!directory) return;
+		const rotated = await directory.rotateToken();
+		await revalidate();
+		return rotated;
+	}, [directory, revalidate]);
+	const deleteDirectorySync = (0, react.useCallback)(async () => {
+		if (!directory) return;
+		const deleted = await directory.delete();
+		await revalidate();
+		return deleted;
+	}, [directory, revalidate]);
+	return {
+		data: query.data,
+		error: query.error ?? null,
+		isLoading: query.isLoading,
+		isFetching: query.isFetching,
+		createDirectorySync,
+		updateDirectorySync,
+		rotateDirectorySyncToken,
+		deleteDirectorySync,
+		revalidate
+	};
+}
+
+//#endregion
+//#region src/react/hooks/useOrganizationDirectorySyncUsers.tsx
+const DEFAULT_POLL_INTERVAL_MS$1 = 2e3;
+/**
+* The users provisioned into an enterprise connection's Directory Sync
+* directory, most recently touched first. Polling is opt-in via `poll`, which
+* lets the setup flow use the list as a live activity feed.
+*
+* @internal
+*/
+function useOrganizationDirectorySyncUsers(params) {
+	const { directory, params: fetchParams = {
+		initialPage: 1,
+		pageSize: 10
+	}, poll = false, pollIntervalMs = DEFAULT_POLL_INTERVAL_MS$1, enabled = true, keepPreviousData = true } = params;
+	const clerk = useClerkInstanceContext();
+	const organization = useOrganizationBase();
+	const [queryClient] = useClerkQueryClient();
+	const enterpriseConnectionId = directory?.enterpriseConnectionId ?? null;
+	const directoryId = directory?.id ?? null;
+	const { queryKey, invalidationKey, stableKey, authenticated } = useOrganizationDirectorySyncUsersCacheKeys({
+		organizationId: organization?.id ?? null,
+		enterpriseConnectionId,
+		directoryId,
+		args: fetchParams
+	});
+	useClearQueriesOnSignOut({
+		isSignedOut: organization === null,
+		authenticated,
+		stableKeys: stableKey
+	});
+	const queryEnabled = enabled && clerk.loaded && Boolean(organization) && Boolean(directory);
+	const currentTracked = queryKey[2];
+	const query = useClerkQuery({
+		queryKey,
+		queryFn: () => {
+			if (!directory) throw new Error("directory is required to fetch directory users");
+			return directory.getUsers(fetchParams);
+		},
+		refetchInterval: () => poll ? pollIntervalMs : false,
+		enabled: queryEnabled,
+		refetchIntervalInBackground: false,
+		placeholderData: keepPreviousData ? (previousData, previousQuery) => {
+			const previousTracked = previousQuery?.queryKey[2];
+			return Boolean(currentTracked.organizationId) && Boolean(currentTracked.directoryId) && previousTracked?.organizationId === currentTracked.organizationId && previousTracked?.directoryId === currentTracked.directoryId ? previousData : void 0;
+		} : void 0
+	});
+	const revalidate = (0, react.useCallback)(async () => {
+		await queryClient.invalidateQueries({ queryKey: invalidationKey });
+	}, [queryClient, invalidationKey]);
+	const isPolling = queryEnabled && poll;
+	return {
+		data: queryEnabled ? query.data?.data : void 0,
+		totalCount: queryEnabled ? query.data?.total_count : void 0,
+		error: query.error ?? null,
+		isLoading: query.isLoading,
+		isFetching: query.isFetching,
+		isPolling,
+		revalidate
+	};
+}
+
 //#endregion
 //#region src/react/hooks/useOrganizationEnterpriseConnectionTestRuns.shared.ts
 /**
@@ -3230,9 +3417,10 @@ function useOrganizationEnterpriseConnectionTestRuns(params) {
 		stableKeys: stableKey
 	});
 	const queryEnabled = enabled && clerk.loaded && Boolean(organization) && Boolean(enterpriseConnectionId);
-	const [shouldPoll, setShouldPoll] = (0, react.useState)(false);
+	const [pollingConnectionId, setPollingConnectionId] = (0, react.useState)(null);
+	const shouldPoll = pollingConnectionId !== null && pollingConnectionId === enterpriseConnectionId;
 	(0, react.useEffect)(() => {
-		setShouldPoll(false);
+		setPollingConnectionId((current) => current !== null && current !== enterpriseConnectionId ? null : current);
 	}, [enterpriseConnectionId]);
 	const query = useClerkQuery({
 		queryKey,
@@ -3250,10 +3438,10 @@ function useOrganizationEnterpriseConnectionTestRuns(params) {
 	});
 	const hasRows = (query.data?.data?.length ?? 0) > 0;
 	(0, react.useEffect)(() => {
-		if (shouldPoll && hasRows) setShouldPoll(false);
+		if (shouldPoll && hasRows) setPollingConnectionId(null);
 	}, [shouldPoll, hasRows]);
 	const revalidate = (0, react.useCallback)(async (options) => {
-		if ((options?.armPolling ?? true) && !hasRows) setShouldPoll(true);
+		if ((options?.armPolling ?? true) && !hasRows) setPollingConnectionId(enterpriseConnectionId);
 		if (options?.exact) await queryClient.invalidateQueries({
 			queryKey,
 			exact: true
@@ -3268,7 +3456,8 @@ function useOrganizationEnterpriseConnectionTestRuns(params) {
 		queryClient,
 		invalidationKey,
 		queryKey,
-		hasRows
+		hasRows,
+		enterpriseConnectionId
 	]);
 	const isPolling = queryEnabled && shouldPoll && !hasRows;
 	return {
@@ -3880,6 +4069,8 @@ exports.__internal_useClientBase = useClientBase;
 exports.__internal_useCreditBalanceQuery = __internal_useCreditBalanceQuery;
 exports.__internal_useCreditHistoryQuery = __internal_useCreditHistoryQuery;
 exports.__internal_useOrganizationBase = useOrganizationBase;
+exports.__internal_useOrganizationDirectorySync = useOrganizationDirectorySync;
+exports.__internal_useOrganizationDirectorySyncUsers = useOrganizationDirectorySyncUsers;
 exports.__internal_useOrganizationDomains = useOrganizationDomains;
 exports.__internal_useOrganizationEnterpriseConnectionTestRuns = useOrganizationEnterpriseConnectionTestRuns;
 exports.__internal_useOrganizationEnterpriseConnections = useOrganizationEnterpriseConnections;