feat(js,ui): mount and render the directory sync setup flow#9592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kalafut wants to merge 8 commits into from
Open

feat(js,ui): mount and render the directory sync setup flow #9592

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4debfb7
feat(self-serve-ds): mount and render ConfigureDirectorySync
kalafut Aug 27, 2026
5d8c0ab
Add a note about email domain restrictions
kalafut Aug 28, 2026
ab2907e
feat(self-serve-ds): pass the directory resource to the users hook
kalafut Aug 29, 2026
e375e69
Misc UI fixes
kalafut Sep 1, 2026
996e966
Initial UI review updates
kalafut Sep 2, 2026
a70f54f
Remove activation step
kalafut Sep 2, 2026
0899648
Tweak IdP instructions
kalafut Sep 2, 2026
cc51deb
Fix sandbox
kalafut Sep 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .changeset/dir-sync-self-serve-wiring.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/localizations': minor
'@clerk/react': minor
'@clerk/shared': minor
'@clerk/ui': minor
---
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/bundlewatch.config.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"files": [
{ "path": "./dist/clerk.js", "maxSize": "553KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "79.5KB" },
{ "path": "./dist/clerk.js", "maxSize": "554KB" },
{ "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
{ "path": "./dist/clerk.legacy.browser.js", "maxSize": "122KB" },
{ "path": "./dist/clerk.no-rhc.js", "maxSize": "320KB" },
{ "path": "./dist/clerk.native.js", "maxSize": "79KB" },
Expand Down
6 changes: 6 additions & 0 deletions packages/clerk-js/sandbox/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
'pricingTable',
'apiKeys',
'configureSSO',
'configureDirectorySync',
'oauthConsent',
'oauthDeviceVerification',
'taskChooseOrganization',
Expand DownExpand Up@@ -154,6 +155,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
pricingTable: buildComponentControls('pricingTable'),
apiKeys: buildComponentControls('apiKeys'),
configureSSO: buildComponentControls('configureSSO'),
configureDirectorySync: buildComponentControls('configureDirectorySync'),
oauthConsent: buildComponentControls('oauthConsent'),
oauthDeviceVerification: buildComponentControls('oauthDeviceVerification'),
taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
Expand DownExpand Up@@ -431,6 +433,10 @@ void (async () => {
mount: '__internal_mountOAuthDeviceVerification',
component: 'oauthDeviceVerification',
},
'/configure-directory-sync': {
mount: '__internal_mountConfigureDirectorySync',
component: 'configureDirectorySync',
},
'/task-choose-organization': {
mount: 'mountTaskChooseOrganization',
component: 'taskChooseOrganization',
Expand Down
5 changes: 5 additions & 0 deletions packages/clerk-js/sandbox/template.html
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -313,6 +313,11 @@
label="Configure SSO"
component="<ConfigureSSO />"
></nav-link>
<nav-link
href="/configure-directory-sync"
label="Configure Directory Sync"
component="<ConfigureDirectorySync />"
></nav-link>
<nav-link
href="/open-invite-members"
label="Open invite members"
Expand Down
71 changes: 71 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
disabledEmailAddressAttribute,
disabledOrganizationAPIKeysFeature,
disabledOrganizationsFeature,
disabledSelfServeDirectorySyncFeature,
disabledSelfServeSSOFeature,
disabledUserAPIKeysFeature,
isSignedInAndSingleSessionModeEnabled,
Expand DownExpand Up@@ -1712,6 +1713,76 @@ export class Clerk implements ClerkInterface {
void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
};

/**
* Mount the Directory Sync onboarding component at the target element.
* Directory Sync rides on the self-serve SSO gates: it provisions through
* the organization's SSO connection, so the same preconditions apply.
*
* @param targetNode Target to mount the ConfigureDirectorySync component.
* @param props Configuration parameters.
* @hidden
*/
public __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps) => {
const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
for: 'organizations',
caller: 'ConfigureDirectorySync',
onClose: () => {
throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('ConfigureDirectorySync'), {
code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
});
},
});

if (!isOrganizationsEnabled) {
return;
}

const userExists = !noUserExists(this);
if (noOrganizationExists(this) && userExists) {
if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.createCannotRenderComponentWhenOrgDoesNotExist('ConfigureDirectorySync'), {
code: CANNOT_RENDER_ORGANIZATION_MISSING_ERROR_CODE,
});
}
return;
}

if (disabledSelfServeDirectorySyncFeature(this, this.environment)) {
if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderConfigureDirectorySyncComponentWhenDisabled, {
code: CANNOT_RENDER_SELF_SERVE_SSO_DISABLED_ERROR_CODE,
});
}
return;
}

this.assertComponentsReady(this.#clerkUI);
const component = 'ConfigureDirectorySync';
void this.#clerkUI
.then(ui => ui.ensureMounted({ preloadHint: component }))
.then(controls =>
controls.mountComponent({
name: component,
appearanceKey: 'configureSSO',
node,
props,
}),
);

this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
};

/**
* Unmount the Directory Sync onboarding component from the target element.
* If there is no component mounted at the target node, results in a noop.
*
* @param targetNode Target node to unmount the ConfigureDirectorySync component from.
* @hidden
*/
public __internal_unmountConfigureDirectorySync = (node: HTMLDivElement) => {
void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
};

public mountTaskChooseOrganization = (node: HTMLDivElement, props?: TaskChooseOrganizationProps) => {
const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
for: 'organizations',
Expand Down
21 changes: 21 additions & 0 deletions packages/react/src/isomorphicClerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -166,6 +166,7 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
private premountPricingTableNodes = new Map<HTMLDivElement, PricingTableProps | undefined>();
private premountAPIKeysNodes = new Map<HTMLDivElement, APIKeysProps | undefined>();
private premountConfigureSSONodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
private premountConfigureDirectorySyncNodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
private premountOAuthConsentNodes = new Map<HTMLDivElement, __internal_OAuthConsentProps | undefined>();
private premountOAuthDeviceVerificationNodes = new Map<HTMLDivElement, OAuthDeviceVerificationProps | undefined>();
private premountTaskChooseOrganizationNodes = new Map<HTMLDivElement, TaskChooseOrganizationProps | undefined>();
Expand DownExpand Up@@ -801,6 +802,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
clerkjs.__internal_mountConfigureSSO(node, props);
});

this.premountConfigureDirectorySyncNodes.forEach((props, node) => {
clerkjs.__internal_mountConfigureDirectorySync(node, props);
});

this.premountOAuthConsentNodes.forEach((props, node) => {
clerkjs.__internal_mountOAuthConsent(node, props);
});
Expand DownExpand Up@@ -1387,6 +1392,22 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
}
};

__internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps): void => {
if (this.clerkjs && this.loaded) {
this.clerkjs.__internal_mountConfigureDirectorySync(node, props);
} else {
this.premountConfigureDirectorySyncNodes.set(node, props);
}
};

__internal_unmountConfigureDirectorySync = (node: HTMLDivElement): void => {
if (this.clerkjs && this.loaded) {
this.clerkjs.__internal_unmountConfigureDirectorySync(node);
} else {
this.premountConfigureDirectorySyncNodes.delete(node);
}
};

__internal_mountOAuthConsent = (node: HTMLDivElement, props?: OAuthConsentProps) => {
if (this.clerkjs && this.loaded) {
this.clerkjs.__internal_mountOAuthConsent(node, props);
Expand Down
7 changes: 7 additions & 0 deletions packages/shared/src/internal/clerk-js/componentGuards.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,13 @@ export const disabledSelfServeSSOFeature: ComponentGuard = (clerk, environment)
return !environment?.userSettings.enterpriseSSO.self_serve_sso || !clerk.organization?.selfServeSSOEnabled;
};

export const disabledSelfServeDirectorySyncFeature: ComponentGuard = (clerk, environment) => {
return (
disabledSelfServeSSOFeature(clerk, environment) ||
!environment?.userSettings.enterpriseSSO.self_serve_directory_sync
);
};

export const disabledEmailAddressAttribute: ComponentGuard = (_, environment) => {
return !environment?.userSettings.attributes.email_address?.enabled;
};
7 changes: 5 additions & 2 deletions packages/shared/src/internal/clerk-js/warnings.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ const createMessageForDisabledOrganizations = (
| 'OrganizationList'
| 'CreateOrganization'
| 'TaskChooseOrganization'
| 'ConfigureSSO',
| 'ConfigureSSO'
| 'ConfigureDirectorySync',
) => {
return formatWarning(
`The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
);
};

const createCannotRenderComponentWhenOrgDoesNotExist = (
componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO',
componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO' | 'ConfigureDirectorySync',
) => {
return formatWarning(
`<${componentName}/> cannot render unless an organization is active. Since no organization is currently active, this is no-op.`,
Expand DownExpand Up@@ -88,6 +89,8 @@ const warnings = {
'<ConfigureSSO/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
cannotRenderConfigureSSOComponentWhenDisabled:
'The <ConfigureSSO/> component cannot be rendered when self-serve SSO is disabled. Visit `https://dashboard.clerk.com` to enable the feature. Since self-serve SSO is disabled, this is no-op.',
cannotRenderConfigureDirectorySyncComponentWhenDisabled:
'The <ConfigureDirectorySync/> component cannot be rendered when self-serve Directory Sync is disabled. Since self-serve Directory Sync is disabled, this is no-op.',
cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
'The <ConfigureSSO/> component cannot be rendered when email addresses are disabled on the instance. Visit `https://dashboard.clerk.com` to enable email addresses. Since email addresses are disabled, this is no-op.',
};
Expand Down
19 changes: 19 additions & 0 deletions packages/shared/src/types/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -816,6 +816,24 @@ export interface Clerk {
*/
__internal_unmountConfigureSSO: (targetNode: HTMLDivElement) => void;

/**
* Mount a configure Directory Sync component at the target element.
*
* @param targetNode - Target to mount the ConfigureDirectorySync component.
* @param props - Configuration parameters.
* @hidden
*/
__internal_mountConfigureDirectorySync: (targetNode: HTMLDivElement, props?: ConfigureSSOProps) => void;

/**
* Unmount a configure Directory Sync component from the target element.
* If there is no component mounted at the target node, results in a noop.
*
* @param targetNode - Target node to unmount the ConfigureDirectorySync component from.
* @hidden
*/
__internal_unmountConfigureDirectorySync: (targetNode: HTMLDivElement) => void;

/**
* Mounts a OAuth consent component at the target element.
*
Expand DownExpand Up@@ -1984,6 +2002,7 @@ export type __internal_AttemptToEnableEnvironmentSettingParams = {
| 'CreateOrganization'
| 'TaskChooseOrganization'
| 'ConfigureSSO'
| 'ConfigureDirectorySync'
| 'useOrganizationList'
| 'useOrganization';
onClose?: () => void;
Expand Down
1 change: 1 addition & 0 deletions packages/shared/src/types/elementIds.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,7 @@ export type ProfileSectionId =
| 'subscriptionsList'
| 'paymentMethods'
| 'sso'
| 'directorySync'
| 'ssoStatus'
| 'enableSso'
| 'ssoDomain'
Expand Down
18 changes: 18 additions & 0 deletions packages/shared/src/types/localization.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1206,6 +1206,24 @@ export type __internal_LocalizationResource = {
tooltip__noRole: LocalizationValue;
tooltipLabel: LocalizationValue;
};
directorySyncSection: {
title: LocalizationValue;
badge__unconfigured: LocalizationValue;
badge__ssoRequired: LocalizationValue;
badge__active: LocalizationValue;
badge__inactive: LocalizationValue;
description: LocalizationValue;
primaryButton__startConfiguration: LocalizationValue;
menuAction__edit: LocalizationValue;
menuAction__activate: LocalizationValue;
menuAction__deactivate: LocalizationValue;
menuAction__remove: LocalizationValue;
removeDialog: {
title: LocalizationValue;
subtitle: LocalizationValue;
confirmButton: LocalizationValue;
};
};
};
membersPage: {
detailsTitle__emptyRow: LocalizationValue;
Expand Down
48 changes: 48 additions & 0 deletions packages/ui/src/components/ConfigureDirectorySync/ConfigureDirectorySync.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import type { ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { withCoreUserGuard } from '@/contexts';
import { Flow } from '@/customizables';
import { withCardStateProvider } from '@/elements/contexts';
import { ProfileCard } from '@/elements/ProfileCard';
import { Route, Switch } from '@/router';

import { ConfigureSSOProtect } from '../ConfigureSSO/ConfigureSSO';
import { ConfigureDirectorySyncWizard } from './ConfigureDirectorySyncWizard';
import { DirectorySyncNavbar } from './DirectorySyncNavbar';

/**
* Standalone host for the Directory Sync onboarding wizard, mirroring
* ConfigureSSO's shell. Reuses the configureSSO flow id/appearance until the
* flow gets its own appearance surface.
*/
const ConfigureDirectorySyncInternal = (): JSX.Element => {
return (
<Flow.Root flow='configureSSO'>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Root>
);
};

const AuthenticatedContent = withCoreUserGuard(() => {
const contentRef = React.useRef<HTMLDivElement>(null);

return (
<ProfileCard.Root
sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
>
<DirectorySyncNavbar contentRef={contentRef}>
<ConfigureSSOProtect>
<ConfigureDirectorySyncWizard />
</ConfigureSSOProtect>
</DirectorySyncNavbar>
</ProfileCard.Root>
);
});

export const ConfigureDirectorySync: React.ComponentType<ConfigureSSOProps> =
withCardStateProvider(ConfigureDirectorySyncInternal);
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(js,ui): mount and render the directory sync setup flow#9592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

kalafut
wants to merge
8
commits into

from

 Open


feat(js,ui): mount and render the directory sync setup flow
#9592
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
4debfb7

feat(self-serve-ds): mount and render ConfigureDirectorySync


kalafut Aug 27, 2026
5d8c0ab

Add a note about email domain restrictions


kalafut Aug 28, 2026
ab2907e

feat(self-serve-ds): pass the directory resource to the users hook


kalafut Aug 29, 2026
e375e69

Misc UI fixes


kalafut Sep 1, 2026
996e966

Initial UI review updates


kalafut Sep 2, 2026
a70f54f

Remove activation step


kalafut Sep 2, 2026
0899648

Tweak IdP instructions


kalafut Sep 2, 2026
cc51deb

Fix sandbox


kalafut Sep 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
.changeset/dir-sync-self-serve-wiring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/localizations': minor
'@clerk/react': minor
'@clerk/shared': minor
'@clerk/ui': minor
---
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "553KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "79.5KB" },
 { "path": "./dist/clerk.js", "maxSize": "554KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "122KB" },
 { "path": "./dist/clerk.no-rhc.js", "maxSize": "320KB" },
 { "path": "./dist/clerk.native.js", "maxSize": "79KB" },
Expand Down

6 changes: 6 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'pricingTable',
 'apiKeys',
 'configureSSO',
 'configureDirectorySync',
 'oauthConsent',
 'oauthDeviceVerification',
 'taskChooseOrganization',
Expand DownExpand Up@@ -154,6 +155,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 pricingTable: buildComponentControls('pricingTable'),
 apiKeys: buildComponentControls('apiKeys'),
 configureSSO: buildComponentControls('configureSSO'),
 configureDirectorySync: buildComponentControls('configureDirectorySync'),
 oauthConsent: buildComponentControls('oauthConsent'),
 oauthDeviceVerification: buildComponentControls('oauthDeviceVerification'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
Expand DownExpand Up@@ -431,6 +433,10 @@ void (async () => {
 mount: '__internal_mountOAuthDeviceVerification',
 component: 'oauthDeviceVerification',
 },
 '/configure-directory-sync': {
 mount: '__internal_mountConfigureDirectorySync',
 component: 'configureDirectorySync',
 },
 '/task-choose-organization': {
 mount: 'mountTaskChooseOrganization',
 component: 'taskChooseOrganization',
Expand Down

5 changes: 5 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -313,6 +313,11 @@
 label="Configure SSO"
 component="<ConfigureSSO />"
 ></nav-link>
 <nav-link
 href="/configure-directory-sync"
 label="Configure Directory Sync"
 component="<ConfigureDirectorySync />"
 ></nav-link>
 <nav-link
 href="/open-invite-members"
 label="Open invite members"
Expand Down

71 changes: 71 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
 disabledEmailAddressAttribute,
 disabledOrganizationAPIKeysFeature,
 disabledOrganizationsFeature,
 disabledSelfServeDirectorySyncFeature,
 disabledSelfServeSSOFeature,
 disabledUserAPIKeysFeature,
 isSignedInAndSingleSessionModeEnabled,
Expand DownExpand Up@@ -1712,6 +1713,76 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * Mount the Directory Sync onboarding component at the target element.
 * Directory Sync rides on the self-serve SSO gates: it provisions through
 * the organization's SSO connection, so the same preconditions apply.
 *
 * @param targetNode Target to mount the ConfigureDirectorySync component.
 * @param props Configuration parameters.
 * @hidden
 */
 public __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
 caller: 'ConfigureDirectorySync',
 onClose: () => {
 throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
 });
 },
 });

 if (!isOrganizationsEnabled) {
 return;
 }

 const userExists = !noUserExists(this);
 if (noOrganizationExists(this) && userExists) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.createCannotRenderComponentWhenOrgDoesNotExist('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATION_MISSING_ERROR_CODE,
 });
 }
 return;
 }

 if (disabledSelfServeDirectorySyncFeature(this, this.environment)) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.cannotRenderConfigureDirectorySyncComponentWhenDisabled, {
 code: CANNOT_RENDER_SELF_SERVE_SSO_DISABLED_ERROR_CODE,
 });
 }
 return;
 }

 this.assertComponentsReady(this.#clerkUI);
 const component = 'ConfigureDirectorySync';
 void this.#clerkUI
 .then(ui => ui.ensureMounted({ preloadHint: component }))
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'configureSSO',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 /**
 * Unmount the Directory Sync onboarding component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 public __internal_unmountConfigureDirectorySync = (node: HTMLDivElement) => {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskChooseOrganization = (node: HTMLDivElement, props?: TaskChooseOrganizationProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
Expand Down

21 changes: 21 additions & 0 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,6 +166,7 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 private premountPricingTableNodes = new Map<HTMLDivElement, PricingTableProps | undefined>();
 private premountAPIKeysNodes = new Map<HTMLDivElement, APIKeysProps | undefined>();
 private premountConfigureSSONodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountConfigureDirectorySyncNodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountOAuthConsentNodes = new Map<HTMLDivElement, __internal_OAuthConsentProps | undefined>();
 private premountOAuthDeviceVerificationNodes = new Map<HTMLDivElement, OAuthDeviceVerificationProps | undefined>();
 private premountTaskChooseOrganizationNodes = new Map<HTMLDivElement, TaskChooseOrganizationProps | undefined>();
Expand DownExpand Up@@ -801,6 +802,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 clerkjs.__internal_mountConfigureSSO(node, props);
 });

 this.premountConfigureDirectorySyncNodes.forEach((props, node) => {
 clerkjs.__internal_mountConfigureDirectorySync(node, props);
 });

 this.premountOAuthConsentNodes.forEach((props, node) => {
 clerkjs.__internal_mountOAuthConsent(node, props);
 });
Expand DownExpand Up@@ -1387,6 +1392,22 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 }
 };

 __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountConfigureDirectorySync(node, props);
 } else {
 this.premountConfigureDirectorySyncNodes.set(node, props);
 }
 };

 __internal_unmountConfigureDirectorySync = (node: HTMLDivElement): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_unmountConfigureDirectorySync(node);
 } else {
 this.premountConfigureDirectorySyncNodes.delete(node);
 }
 };

 __internal_mountOAuthConsent = (node: HTMLDivElement, props?: OAuthConsentProps) => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountOAuthConsent(node, props);
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/src/internal/clerk-js/componentGuards.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,13 @@ export const disabledSelfServeSSOFeature: ComponentGuard = (clerk, environment)
 return !environment?.userSettings.enterpriseSSO.self_serve_sso || !clerk.organization?.selfServeSSOEnabled;
};

export const disabledSelfServeDirectorySyncFeature: ComponentGuard = (clerk, environment) => {
 return (
 disabledSelfServeSSOFeature(clerk, environment) ||
 !environment?.userSettings.enterpriseSSO.self_serve_directory_sync
 );
};

export const disabledEmailAddressAttribute: ComponentGuard = (_, environment) => {
 return !environment?.userSettings.attributes.email_address?.enabled;
};

7 changes: 5 additions & 2 deletions
packages/shared/src/internal/clerk-js/warnings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ const createMessageForDisabledOrganizations = (
 | 'OrganizationList'
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO',
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
 );
};

const createCannotRenderComponentWhenOrgDoesNotExist = (
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO',
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO' | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `<${componentName}/> cannot render unless an organization is active. Since no organization is currently active, this is no-op.`,
Expand DownExpand Up@@ -88,6 +89,8 @@ const warnings = {
 '<ConfigureSSO/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
 cannotRenderConfigureSSOComponentWhenDisabled:
 'The <ConfigureSSO/> component cannot be rendered when self-serve SSO is disabled. Visit `https://dashboard.clerk.com` to enable the feature. Since self-serve SSO is disabled, this is no-op.',
 cannotRenderConfigureDirectorySyncComponentWhenDisabled:
 'The <ConfigureDirectorySync/> component cannot be rendered when self-serve Directory Sync is disabled. Since self-serve Directory Sync is disabled, this is no-op.',
 cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
 'The <ConfigureSSO/> component cannot be rendered when email addresses are disabled on the instance. Visit `https://dashboard.clerk.com` to enable email addresses. Since email addresses are disabled, this is no-op.',
};
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -816,6 +816,24 @@ export interface Clerk {
 */
 __internal_unmountConfigureSSO: (targetNode: HTMLDivElement) => void;

 /**
 * Mount a configure Directory Sync component at the target element.
 *
 * @param targetNode - Target to mount the ConfigureDirectorySync component.
 * @param props - Configuration parameters.
 * @hidden
 */
 __internal_mountConfigureDirectorySync: (targetNode: HTMLDivElement, props?: ConfigureSSOProps) => void;

 /**
 * Unmount a configure Directory Sync component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode - Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 __internal_unmountConfigureDirectorySync: (targetNode: HTMLDivElement) => void;

 /**
 * Mounts a OAuth consent component at the target element.
 *
Expand DownExpand Up@@ -1984,6 +2002,7 @@ export type __internal_AttemptToEnableEnvironmentSettingParams = {
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync'
 | 'useOrganizationList'
 | 'useOrganization';
 onClose?: () => void;
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/elementIds.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,7 @@ export type ProfileSectionId =
 | 'subscriptionsList'
 | 'paymentMethods'
 | 'sso'
 | 'directorySync'
 | 'ssoStatus'
 | 'enableSso'
 | 'ssoDomain'
Expand Down

18 changes: 18 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1206,6 +1206,24 @@ export type __internal_LocalizationResource = {
 tooltip__noRole: LocalizationValue;
 tooltipLabel: LocalizationValue;
 };
 directorySyncSection: {
 title: LocalizationValue;
 badge__unconfigured: LocalizationValue;
 badge__ssoRequired: LocalizationValue;
 badge__active: LocalizationValue;
 badge__inactive: LocalizationValue;
 description: LocalizationValue;
 primaryButton__startConfiguration: LocalizationValue;
 menuAction__edit: LocalizationValue;
 menuAction__activate: LocalizationValue;
 menuAction__deactivate: LocalizationValue;
 menuAction__remove: LocalizationValue;
 removeDialog: {
 title: LocalizationValue;
 subtitle: LocalizationValue;
 confirmButton: LocalizationValue;
 };
 };
 };
 membersPage: {
 detailsTitle__emptyRow: LocalizationValue;
Expand Down

48 changes: 48 additions & 0 deletions
packages/ui/src/components/ConfigureDirectorySync/ConfigureDirectorySync.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import type { ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { withCoreUserGuard } from '@/contexts';
import { Flow } from '@/customizables';
import { withCardStateProvider } from '@/elements/contexts';
import { ProfileCard } from '@/elements/ProfileCard';
import { Route, Switch } from '@/router';

import { ConfigureSSOProtect } from '../ConfigureSSO/ConfigureSSO';
import { ConfigureDirectorySyncWizard } from './ConfigureDirectorySyncWizard';
import { DirectorySyncNavbar } from './DirectorySyncNavbar';

/**
 * Standalone host for the Directory Sync onboarding wizard, mirroring
 * ConfigureSSO's shell. Reuses the configureSSO flow id/appearance until the
 * flow gets its own appearance surface.
 */
const ConfigureDirectorySyncInternal = (): JSX.Element => {
 return (
 <Flow.Root flow='configureSSO'>
 <Switch>
 <Route>
 <AuthenticatedContent />
 </Route>
 </Switch>
 </Flow.Root>
 );
};

const AuthenticatedContent = withCoreUserGuard(() => {
 const contentRef = React.useRef<HTMLDivElement>(null);

 return (
 <ProfileCard.Root
 sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
 >
 <DirectorySyncNavbar contentRef={contentRef}>
 <ConfigureSSOProtect>
 <ConfigureDirectorySyncWizard />
 </ConfigureSSOProtect>
 </DirectorySyncNavbar>
 </ProfileCard.Root>
 );
});

export const ConfigureDirectorySync: React.ComponentType<ConfigureSSOProps> =
 withCardStateProvider(ConfigureDirectorySyncInternal);
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(js,ui): mount and render the directory sync setup flow#9592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

kalafut
wants to merge
8
commits into

from

 Open


feat(js,ui): mount and render the directory sync setup flow
#9592
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
4debfb7

feat(self-serve-ds): mount and render ConfigureDirectorySync


kalafut Aug 27, 2026
5d8c0ab

Add a note about email domain restrictions


kalafut Aug 28, 2026
ab2907e

feat(self-serve-ds): pass the directory resource to the users hook


kalafut Aug 29, 2026
e375e69

Misc UI fixes


kalafut Sep 1, 2026
996e966

Initial UI review updates


kalafut Sep 2, 2026
a70f54f

Remove activation step


kalafut Sep 2, 2026
0899648

Tweak IdP instructions


kalafut Sep 2, 2026
cc51deb

Fix sandbox


kalafut Sep 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
.changeset/dir-sync-self-serve-wiring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/localizations': minor
'@clerk/react': minor
'@clerk/shared': minor
'@clerk/ui': minor
---
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "553KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "79.5KB" },
 { "path": "./dist/clerk.js", "maxSize": "554KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "122KB" },
 { "path": "./dist/clerk.no-rhc.js", "maxSize": "320KB" },
 { "path": "./dist/clerk.native.js", "maxSize": "79KB" },
Expand Down

6 changes: 6 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'pricingTable',
 'apiKeys',
 'configureSSO',
 'configureDirectorySync',
 'oauthConsent',
 'oauthDeviceVerification',
 'taskChooseOrganization',
Expand DownExpand Up@@ -154,6 +155,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 pricingTable: buildComponentControls('pricingTable'),
 apiKeys: buildComponentControls('apiKeys'),
 configureSSO: buildComponentControls('configureSSO'),
 configureDirectorySync: buildComponentControls('configureDirectorySync'),
 oauthConsent: buildComponentControls('oauthConsent'),
 oauthDeviceVerification: buildComponentControls('oauthDeviceVerification'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
Expand DownExpand Up@@ -431,6 +433,10 @@ void (async () => {
 mount: '__internal_mountOAuthDeviceVerification',
 component: 'oauthDeviceVerification',
 },
 '/configure-directory-sync': {
 mount: '__internal_mountConfigureDirectorySync',
 component: 'configureDirectorySync',
 },
 '/task-choose-organization': {
 mount: 'mountTaskChooseOrganization',
 component: 'taskChooseOrganization',
Expand Down

5 changes: 5 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -313,6 +313,11 @@
 label="Configure SSO"
 component="<ConfigureSSO />"
 ></nav-link>
 <nav-link
 href="/configure-directory-sync"
 label="Configure Directory Sync"
 component="<ConfigureDirectorySync />"
 ></nav-link>
 <nav-link
 href="/open-invite-members"
 label="Open invite members"
Expand Down

71 changes: 71 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
 disabledEmailAddressAttribute,
 disabledOrganizationAPIKeysFeature,
 disabledOrganizationsFeature,
 disabledSelfServeDirectorySyncFeature,
 disabledSelfServeSSOFeature,
 disabledUserAPIKeysFeature,
 isSignedInAndSingleSessionModeEnabled,
Expand DownExpand Up@@ -1712,6 +1713,76 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * Mount the Directory Sync onboarding component at the target element.
 * Directory Sync rides on the self-serve SSO gates: it provisions through
 * the organization's SSO connection, so the same preconditions apply.
 *
 * @param targetNode Target to mount the ConfigureDirectorySync component.
 * @param props Configuration parameters.
 * @hidden
 */
 public __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
 caller: 'ConfigureDirectorySync',
 onClose: () => {
 throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
 });
 },
 });

 if (!isOrganizationsEnabled) {
 return;
 }

 const userExists = !noUserExists(this);
 if (noOrganizationExists(this) && userExists) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.createCannotRenderComponentWhenOrgDoesNotExist('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATION_MISSING_ERROR_CODE,
 });
 }
 return;
 }

 if (disabledSelfServeDirectorySyncFeature(this, this.environment)) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.cannotRenderConfigureDirectorySyncComponentWhenDisabled, {
 code: CANNOT_RENDER_SELF_SERVE_SSO_DISABLED_ERROR_CODE,
 });
 }
 return;
 }

 this.assertComponentsReady(this.#clerkUI);
 const component = 'ConfigureDirectorySync';
 void this.#clerkUI
 .then(ui => ui.ensureMounted({ preloadHint: component }))
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'configureSSO',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 /**
 * Unmount the Directory Sync onboarding component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 public __internal_unmountConfigureDirectorySync = (node: HTMLDivElement) => {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskChooseOrganization = (node: HTMLDivElement, props?: TaskChooseOrganizationProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
Expand Down

21 changes: 21 additions & 0 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,6 +166,7 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 private premountPricingTableNodes = new Map<HTMLDivElement, PricingTableProps | undefined>();
 private premountAPIKeysNodes = new Map<HTMLDivElement, APIKeysProps | undefined>();
 private premountConfigureSSONodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountConfigureDirectorySyncNodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountOAuthConsentNodes = new Map<HTMLDivElement, __internal_OAuthConsentProps | undefined>();
 private premountOAuthDeviceVerificationNodes = new Map<HTMLDivElement, OAuthDeviceVerificationProps | undefined>();
 private premountTaskChooseOrganizationNodes = new Map<HTMLDivElement, TaskChooseOrganizationProps | undefined>();
Expand DownExpand Up@@ -801,6 +802,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 clerkjs.__internal_mountConfigureSSO(node, props);
 });

 this.premountConfigureDirectorySyncNodes.forEach((props, node) => {
 clerkjs.__internal_mountConfigureDirectorySync(node, props);
 });

 this.premountOAuthConsentNodes.forEach((props, node) => {
 clerkjs.__internal_mountOAuthConsent(node, props);
 });
Expand DownExpand Up@@ -1387,6 +1392,22 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 }
 };

 __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountConfigureDirectorySync(node, props);
 } else {
 this.premountConfigureDirectorySyncNodes.set(node, props);
 }
 };

 __internal_unmountConfigureDirectorySync = (node: HTMLDivElement): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_unmountConfigureDirectorySync(node);
 } else {
 this.premountConfigureDirectorySyncNodes.delete(node);
 }
 };

 __internal_mountOAuthConsent = (node: HTMLDivElement, props?: OAuthConsentProps) => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountOAuthConsent(node, props);
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/src/internal/clerk-js/componentGuards.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,13 @@ export const disabledSelfServeSSOFeature: ComponentGuard = (clerk, environment)
 return !environment?.userSettings.enterpriseSSO.self_serve_sso || !clerk.organization?.selfServeSSOEnabled;
};

export const disabledSelfServeDirectorySyncFeature: ComponentGuard = (clerk, environment) => {
 return (
 disabledSelfServeSSOFeature(clerk, environment) ||
 !environment?.userSettings.enterpriseSSO.self_serve_directory_sync
 );
};

export const disabledEmailAddressAttribute: ComponentGuard = (_, environment) => {
 return !environment?.userSettings.attributes.email_address?.enabled;
};

7 changes: 5 additions & 2 deletions
packages/shared/src/internal/clerk-js/warnings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ const createMessageForDisabledOrganizations = (
 | 'OrganizationList'
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO',
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
 );
};

const createCannotRenderComponentWhenOrgDoesNotExist = (
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO',
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO' | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `<${componentName}/> cannot render unless an organization is active. Since no organization is currently active, this is no-op.`,
Expand DownExpand Up@@ -88,6 +89,8 @@ const warnings = {
 '<ConfigureSSO/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
 cannotRenderConfigureSSOComponentWhenDisabled:
 'The <ConfigureSSO/> component cannot be rendered when self-serve SSO is disabled. Visit `https://dashboard.clerk.com` to enable the feature. Since self-serve SSO is disabled, this is no-op.',
 cannotRenderConfigureDirectorySyncComponentWhenDisabled:
 'The <ConfigureDirectorySync/> component cannot be rendered when self-serve Directory Sync is disabled. Since self-serve Directory Sync is disabled, this is no-op.',
 cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
 'The <ConfigureSSO/> component cannot be rendered when email addresses are disabled on the instance. Visit `https://dashboard.clerk.com` to enable email addresses. Since email addresses are disabled, this is no-op.',
};
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -816,6 +816,24 @@ export interface Clerk {
 */
 __internal_unmountConfigureSSO: (targetNode: HTMLDivElement) => void;

 /**
 * Mount a configure Directory Sync component at the target element.
 *
 * @param targetNode - Target to mount the ConfigureDirectorySync component.
 * @param props - Configuration parameters.
 * @hidden
 */
 __internal_mountConfigureDirectorySync: (targetNode: HTMLDivElement, props?: ConfigureSSOProps) => void;

 /**
 * Unmount a configure Directory Sync component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode - Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 __internal_unmountConfigureDirectorySync: (targetNode: HTMLDivElement) => void;

 /**
 * Mounts a OAuth consent component at the target element.
 *
Expand DownExpand Up@@ -1984,6 +2002,7 @@ export type __internal_AttemptToEnableEnvironmentSettingParams = {
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync'
 | 'useOrganizationList'
 | 'useOrganization';
 onClose?: () => void;
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/elementIds.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,7 @@ export type ProfileSectionId =
 | 'subscriptionsList'
 | 'paymentMethods'
 | 'sso'
 | 'directorySync'
 | 'ssoStatus'
 | 'enableSso'
 | 'ssoDomain'
Expand Down

18 changes: 18 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1206,6 +1206,24 @@ export type __internal_LocalizationResource = {
 tooltip__noRole: LocalizationValue;
 tooltipLabel: LocalizationValue;
 };
 directorySyncSection: {
 title: LocalizationValue;
 badge__unconfigured: LocalizationValue;
 badge__ssoRequired: LocalizationValue;
 badge__active: LocalizationValue;
 badge__inactive: LocalizationValue;
 description: LocalizationValue;
 primaryButton__startConfiguration: LocalizationValue;
 menuAction__edit: LocalizationValue;
 menuAction__activate: LocalizationValue;
 menuAction__deactivate: LocalizationValue;
 menuAction__remove: LocalizationValue;
 removeDialog: {
 title: LocalizationValue;
 subtitle: LocalizationValue;
 confirmButton: LocalizationValue;
 };
 };
 };
 membersPage: {
 detailsTitle__emptyRow: LocalizationValue;
Expand Down

48 changes: 48 additions & 0 deletions
packages/ui/src/components/ConfigureDirectorySync/ConfigureDirectorySync.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import type { ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { withCoreUserGuard } from '@/contexts';
import { Flow } from '@/customizables';
import { withCardStateProvider } from '@/elements/contexts';
import { ProfileCard } from '@/elements/ProfileCard';
import { Route, Switch } from '@/router';

import { ConfigureSSOProtect } from '../ConfigureSSO/ConfigureSSO';
import { ConfigureDirectorySyncWizard } from './ConfigureDirectorySyncWizard';
import { DirectorySyncNavbar } from './DirectorySyncNavbar';

/**
 * Standalone host for the Directory Sync onboarding wizard, mirroring
 * ConfigureSSO's shell. Reuses the configureSSO flow id/appearance until the
 * flow gets its own appearance surface.
 */
const ConfigureDirectorySyncInternal = (): JSX.Element => {
 return (
 <Flow.Root flow='configureSSO'>
 <Switch>
 <Route>
 <AuthenticatedContent />
 </Route>
 </Switch>
 </Flow.Root>
 );
};

const AuthenticatedContent = withCoreUserGuard(() => {
 const contentRef = React.useRef<HTMLDivElement>(null);

 return (
 <ProfileCard.Root
 sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
 >
 <DirectorySyncNavbar contentRef={contentRef}>
 <ConfigureSSOProtect>
 <ConfigureDirectorySyncWizard />
 </ConfigureSSOProtect>
 </DirectorySyncNavbar>
 </ProfileCard.Root>
 );
});

export const ConfigureDirectorySync: React.ComponentType<ConfigureSSOProps> =
 withCardStateProvider(ConfigureDirectorySyncInternal);
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(js,ui): mount and render the directory sync setup flow#9592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

kalafut
wants to merge
8
commits into

from

 Open


feat(js,ui): mount and render the directory sync setup flow
#9592
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
4debfb7

feat(self-serve-ds): mount and render ConfigureDirectorySync


kalafut Aug 27, 2026
5d8c0ab

Add a note about email domain restrictions


kalafut Aug 28, 2026
ab2907e

feat(self-serve-ds): pass the directory resource to the users hook


kalafut Aug 29, 2026
e375e69

Misc UI fixes


kalafut Sep 1, 2026
996e966

Initial UI review updates


kalafut Sep 2, 2026
a70f54f

Remove activation step


kalafut Sep 2, 2026
0899648

Tweak IdP instructions


kalafut Sep 2, 2026
cc51deb

Fix sandbox


kalafut Sep 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
.changeset/dir-sync-self-serve-wiring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/localizations': minor
'@clerk/react': minor
'@clerk/shared': minor
'@clerk/ui': minor
---
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "553KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "79.5KB" },
 { "path": "./dist/clerk.js", "maxSize": "554KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "122KB" },
 { "path": "./dist/clerk.no-rhc.js", "maxSize": "320KB" },
 { "path": "./dist/clerk.native.js", "maxSize": "79KB" },
Expand Down

6 changes: 6 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'pricingTable',
 'apiKeys',
 'configureSSO',
 'configureDirectorySync',
 'oauthConsent',
 'oauthDeviceVerification',
 'taskChooseOrganization',
Expand DownExpand Up@@ -154,6 +155,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 pricingTable: buildComponentControls('pricingTable'),
 apiKeys: buildComponentControls('apiKeys'),
 configureSSO: buildComponentControls('configureSSO'),
 configureDirectorySync: buildComponentControls('configureDirectorySync'),
 oauthConsent: buildComponentControls('oauthConsent'),
 oauthDeviceVerification: buildComponentControls('oauthDeviceVerification'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
Expand DownExpand Up@@ -431,6 +433,10 @@ void (async () => {
 mount: '__internal_mountOAuthDeviceVerification',
 component: 'oauthDeviceVerification',
 },
 '/configure-directory-sync': {
 mount: '__internal_mountConfigureDirectorySync',
 component: 'configureDirectorySync',
 },
 '/task-choose-organization': {
 mount: 'mountTaskChooseOrganization',
 component: 'taskChooseOrganization',
Expand Down

5 changes: 5 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -313,6 +313,11 @@
 label="Configure SSO"
 component="<ConfigureSSO />"
 ></nav-link>
 <nav-link
 href="/configure-directory-sync"
 label="Configure Directory Sync"
 component="<ConfigureDirectorySync />"
 ></nav-link>
 <nav-link
 href="/open-invite-members"
 label="Open invite members"
Expand Down

71 changes: 71 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
 disabledEmailAddressAttribute,
 disabledOrganizationAPIKeysFeature,
 disabledOrganizationsFeature,
 disabledSelfServeDirectorySyncFeature,
 disabledSelfServeSSOFeature,
 disabledUserAPIKeysFeature,
 isSignedInAndSingleSessionModeEnabled,
Expand DownExpand Up@@ -1712,6 +1713,76 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * Mount the Directory Sync onboarding component at the target element.
 * Directory Sync rides on the self-serve SSO gates: it provisions through
 * the organization's SSO connection, so the same preconditions apply.
 *
 * @param targetNode Target to mount the ConfigureDirectorySync component.
 * @param props Configuration parameters.
 * @hidden
 */
 public __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
 caller: 'ConfigureDirectorySync',
 onClose: () => {
 throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
 });
 },
 });

 if (!isOrganizationsEnabled) {
 return;
 }

 const userExists = !noUserExists(this);
 if (noOrganizationExists(this) && userExists) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.createCannotRenderComponentWhenOrgDoesNotExist('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATION_MISSING_ERROR_CODE,
 });
 }
 return;
 }

 if (disabledSelfServeDirectorySyncFeature(this, this.environment)) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.cannotRenderConfigureDirectorySyncComponentWhenDisabled, {
 code: CANNOT_RENDER_SELF_SERVE_SSO_DISABLED_ERROR_CODE,
 });
 }
 return;
 }

 this.assertComponentsReady(this.#clerkUI);
 const component = 'ConfigureDirectorySync';
 void this.#clerkUI
 .then(ui => ui.ensureMounted({ preloadHint: component }))
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'configureSSO',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 /**
 * Unmount the Directory Sync onboarding component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 public __internal_unmountConfigureDirectorySync = (node: HTMLDivElement) => {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskChooseOrganization = (node: HTMLDivElement, props?: TaskChooseOrganizationProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
Expand Down

21 changes: 21 additions & 0 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,6 +166,7 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 private premountPricingTableNodes = new Map<HTMLDivElement, PricingTableProps | undefined>();
 private premountAPIKeysNodes = new Map<HTMLDivElement, APIKeysProps | undefined>();
 private premountConfigureSSONodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountConfigureDirectorySyncNodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountOAuthConsentNodes = new Map<HTMLDivElement, __internal_OAuthConsentProps | undefined>();
 private premountOAuthDeviceVerificationNodes = new Map<HTMLDivElement, OAuthDeviceVerificationProps | undefined>();
 private premountTaskChooseOrganizationNodes = new Map<HTMLDivElement, TaskChooseOrganizationProps | undefined>();
Expand DownExpand Up@@ -801,6 +802,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 clerkjs.__internal_mountConfigureSSO(node, props);
 });

 this.premountConfigureDirectorySyncNodes.forEach((props, node) => {
 clerkjs.__internal_mountConfigureDirectorySync(node, props);
 });

 this.premountOAuthConsentNodes.forEach((props, node) => {
 clerkjs.__internal_mountOAuthConsent(node, props);
 });
Expand DownExpand Up@@ -1387,6 +1392,22 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 }
 };

 __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountConfigureDirectorySync(node, props);
 } else {
 this.premountConfigureDirectorySyncNodes.set(node, props);
 }
 };

 __internal_unmountConfigureDirectorySync = (node: HTMLDivElement): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_unmountConfigureDirectorySync(node);
 } else {
 this.premountConfigureDirectorySyncNodes.delete(node);
 }
 };

 __internal_mountOAuthConsent = (node: HTMLDivElement, props?: OAuthConsentProps) => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountOAuthConsent(node, props);
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/src/internal/clerk-js/componentGuards.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,13 @@ export const disabledSelfServeSSOFeature: ComponentGuard = (clerk, environment)
 return !environment?.userSettings.enterpriseSSO.self_serve_sso || !clerk.organization?.selfServeSSOEnabled;
};

export const disabledSelfServeDirectorySyncFeature: ComponentGuard = (clerk, environment) => {
 return (
 disabledSelfServeSSOFeature(clerk, environment) ||
 !environment?.userSettings.enterpriseSSO.self_serve_directory_sync
 );
};

export const disabledEmailAddressAttribute: ComponentGuard = (_, environment) => {
 return !environment?.userSettings.attributes.email_address?.enabled;
};

7 changes: 5 additions & 2 deletions
packages/shared/src/internal/clerk-js/warnings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ const createMessageForDisabledOrganizations = (
 | 'OrganizationList'
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO',
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
 );
};

const createCannotRenderComponentWhenOrgDoesNotExist = (
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO',
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO' | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `<${componentName}/> cannot render unless an organization is active. Since no organization is currently active, this is no-op.`,
Expand DownExpand Up@@ -88,6 +89,8 @@ const warnings = {
 '<ConfigureSSO/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
 cannotRenderConfigureSSOComponentWhenDisabled:
 'The <ConfigureSSO/> component cannot be rendered when self-serve SSO is disabled. Visit `https://dashboard.clerk.com` to enable the feature. Since self-serve SSO is disabled, this is no-op.',
 cannotRenderConfigureDirectorySyncComponentWhenDisabled:
 'The <ConfigureDirectorySync/> component cannot be rendered when self-serve Directory Sync is disabled. Since self-serve Directory Sync is disabled, this is no-op.',
 cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
 'The <ConfigureSSO/> component cannot be rendered when email addresses are disabled on the instance. Visit `https://dashboard.clerk.com` to enable email addresses. Since email addresses are disabled, this is no-op.',
};
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -816,6 +816,24 @@ export interface Clerk {
 */
 __internal_unmountConfigureSSO: (targetNode: HTMLDivElement) => void;

 /**
 * Mount a configure Directory Sync component at the target element.
 *
 * @param targetNode - Target to mount the ConfigureDirectorySync component.
 * @param props - Configuration parameters.
 * @hidden
 */
 __internal_mountConfigureDirectorySync: (targetNode: HTMLDivElement, props?: ConfigureSSOProps) => void;

 /**
 * Unmount a configure Directory Sync component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode - Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 __internal_unmountConfigureDirectorySync: (targetNode: HTMLDivElement) => void;

 /**
 * Mounts a OAuth consent component at the target element.
 *
Expand DownExpand Up@@ -1984,6 +2002,7 @@ export type __internal_AttemptToEnableEnvironmentSettingParams = {
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync'
 | 'useOrganizationList'
 | 'useOrganization';
 onClose?: () => void;
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/elementIds.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,7 @@ export type ProfileSectionId =
 | 'subscriptionsList'
 | 'paymentMethods'
 | 'sso'
 | 'directorySync'
 | 'ssoStatus'
 | 'enableSso'
 | 'ssoDomain'
Expand Down

18 changes: 18 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1206,6 +1206,24 @@ export type __internal_LocalizationResource = {
 tooltip__noRole: LocalizationValue;
 tooltipLabel: LocalizationValue;
 };
 directorySyncSection: {
 title: LocalizationValue;
 badge__unconfigured: LocalizationValue;
 badge__ssoRequired: LocalizationValue;
 badge__active: LocalizationValue;
 badge__inactive: LocalizationValue;
 description: LocalizationValue;
 primaryButton__startConfiguration: LocalizationValue;
 menuAction__edit: LocalizationValue;
 menuAction__activate: LocalizationValue;
 menuAction__deactivate: LocalizationValue;
 menuAction__remove: LocalizationValue;
 removeDialog: {
 title: LocalizationValue;
 subtitle: LocalizationValue;
 confirmButton: LocalizationValue;
 };
 };
 };
 membersPage: {
 detailsTitle__emptyRow: LocalizationValue;
Expand Down

48 changes: 48 additions & 0 deletions
packages/ui/src/components/ConfigureDirectorySync/ConfigureDirectorySync.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import type { ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { withCoreUserGuard } from '@/contexts';
import { Flow } from '@/customizables';
import { withCardStateProvider } from '@/elements/contexts';
import { ProfileCard } from '@/elements/ProfileCard';
import { Route, Switch } from '@/router';

import { ConfigureSSOProtect } from '../ConfigureSSO/ConfigureSSO';
import { ConfigureDirectorySyncWizard } from './ConfigureDirectorySyncWizard';
import { DirectorySyncNavbar } from './DirectorySyncNavbar';

/**
 * Standalone host for the Directory Sync onboarding wizard, mirroring
 * ConfigureSSO's shell. Reuses the configureSSO flow id/appearance until the
 * flow gets its own appearance surface.
 */
const ConfigureDirectorySyncInternal = (): JSX.Element => {
 return (
 <Flow.Root flow='configureSSO'>
 <Switch>
 <Route>
 <AuthenticatedContent />
 </Route>
 </Switch>
 </Flow.Root>
 );
};

const AuthenticatedContent = withCoreUserGuard(() => {
 const contentRef = React.useRef<HTMLDivElement>(null);

 return (
 <ProfileCard.Root
 sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
 >
 <DirectorySyncNavbar contentRef={contentRef}>
 <ConfigureSSOProtect>
 <ConfigureDirectorySyncWizard />
 </ConfigureSSOProtect>
 </DirectorySyncNavbar>
 </ProfileCard.Root>
 );
});

export const ConfigureDirectorySync: React.ComponentType<ConfigureSSOProps> =
 withCardStateProvider(ConfigureDirectorySyncInternal);
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(js,ui): mount and render the directory sync setup flow#9592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

kalafut
wants to merge
8
commits into

from

 Open


feat(js,ui): mount and render the directory sync setup flow
#9592
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
4debfb7

feat(self-serve-ds): mount and render ConfigureDirectorySync


kalafut Aug 27, 2026
5d8c0ab

Add a note about email domain restrictions


kalafut Aug 28, 2026
ab2907e

feat(self-serve-ds): pass the directory resource to the users hook


kalafut Aug 29, 2026
e375e69

Misc UI fixes


kalafut Sep 1, 2026
996e966

Initial UI review updates


kalafut Sep 2, 2026
a70f54f

Remove activation step


kalafut Sep 2, 2026
0899648

Tweak IdP instructions


kalafut Sep 2, 2026
cc51deb

Fix sandbox


kalafut Sep 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
.changeset/dir-sync-self-serve-wiring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/localizations': minor
'@clerk/react': minor
'@clerk/shared': minor
'@clerk/ui': minor
---
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "553KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "79.5KB" },
 { "path": "./dist/clerk.js", "maxSize": "554KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "122KB" },
 { "path": "./dist/clerk.no-rhc.js", "maxSize": "320KB" },
 { "path": "./dist/clerk.native.js", "maxSize": "79KB" },
Expand Down

6 changes: 6 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'pricingTable',
 'apiKeys',
 'configureSSO',
 'configureDirectorySync',
 'oauthConsent',
 'oauthDeviceVerification',
 'taskChooseOrganization',
Expand DownExpand Up@@ -154,6 +155,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 pricingTable: buildComponentControls('pricingTable'),
 apiKeys: buildComponentControls('apiKeys'),
 configureSSO: buildComponentControls('configureSSO'),
 configureDirectorySync: buildComponentControls('configureDirectorySync'),
 oauthConsent: buildComponentControls('oauthConsent'),
 oauthDeviceVerification: buildComponentControls('oauthDeviceVerification'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
Expand DownExpand Up@@ -431,6 +433,10 @@ void (async () => {
 mount: '__internal_mountOAuthDeviceVerification',
 component: 'oauthDeviceVerification',
 },
 '/configure-directory-sync': {
 mount: '__internal_mountConfigureDirectorySync',
 component: 'configureDirectorySync',
 },
 '/task-choose-organization': {
 mount: 'mountTaskChooseOrganization',
 component: 'taskChooseOrganization',
Expand Down

5 changes: 5 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -313,6 +313,11 @@
 label="Configure SSO"
 component="<ConfigureSSO />"
 ></nav-link>
 <nav-link
 href="/configure-directory-sync"
 label="Configure Directory Sync"
 component="<ConfigureDirectorySync />"
 ></nav-link>
 <nav-link
 href="/open-invite-members"
 label="Open invite members"
Expand Down

71 changes: 71 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
 disabledEmailAddressAttribute,
 disabledOrganizationAPIKeysFeature,
 disabledOrganizationsFeature,
 disabledSelfServeDirectorySyncFeature,
 disabledSelfServeSSOFeature,
 disabledUserAPIKeysFeature,
 isSignedInAndSingleSessionModeEnabled,
Expand DownExpand Up@@ -1712,6 +1713,76 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * Mount the Directory Sync onboarding component at the target element.
 * Directory Sync rides on the self-serve SSO gates: it provisions through
 * the organization's SSO connection, so the same preconditions apply.
 *
 * @param targetNode Target to mount the ConfigureDirectorySync component.
 * @param props Configuration parameters.
 * @hidden
 */
 public __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
 caller: 'ConfigureDirectorySync',
 onClose: () => {
 throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
 });
 },
 });

 if (!isOrganizationsEnabled) {
 return;
 }

 const userExists = !noUserExists(this);
 if (noOrganizationExists(this) && userExists) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.createCannotRenderComponentWhenOrgDoesNotExist('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATION_MISSING_ERROR_CODE,
 });
 }
 return;
 }

 if (disabledSelfServeDirectorySyncFeature(this, this.environment)) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.cannotRenderConfigureDirectorySyncComponentWhenDisabled, {
 code: CANNOT_RENDER_SELF_SERVE_SSO_DISABLED_ERROR_CODE,
 });
 }
 return;
 }

 this.assertComponentsReady(this.#clerkUI);
 const component = 'ConfigureDirectorySync';
 void this.#clerkUI
 .then(ui => ui.ensureMounted({ preloadHint: component }))
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'configureSSO',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 /**
 * Unmount the Directory Sync onboarding component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 public __internal_unmountConfigureDirectorySync = (node: HTMLDivElement) => {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskChooseOrganization = (node: HTMLDivElement, props?: TaskChooseOrganizationProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
Expand Down

21 changes: 21 additions & 0 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,6 +166,7 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 private premountPricingTableNodes = new Map<HTMLDivElement, PricingTableProps | undefined>();
 private premountAPIKeysNodes = new Map<HTMLDivElement, APIKeysProps | undefined>();
 private premountConfigureSSONodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountConfigureDirectorySyncNodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountOAuthConsentNodes = new Map<HTMLDivElement, __internal_OAuthConsentProps | undefined>();
 private premountOAuthDeviceVerificationNodes = new Map<HTMLDivElement, OAuthDeviceVerificationProps | undefined>();
 private premountTaskChooseOrganizationNodes = new Map<HTMLDivElement, TaskChooseOrganizationProps | undefined>();
Expand DownExpand Up@@ -801,6 +802,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 clerkjs.__internal_mountConfigureSSO(node, props);
 });

 this.premountConfigureDirectorySyncNodes.forEach((props, node) => {
 clerkjs.__internal_mountConfigureDirectorySync(node, props);
 });

 this.premountOAuthConsentNodes.forEach((props, node) => {
 clerkjs.__internal_mountOAuthConsent(node, props);
 });
Expand DownExpand Up@@ -1387,6 +1392,22 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 }
 };

 __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountConfigureDirectorySync(node, props);
 } else {
 this.premountConfigureDirectorySyncNodes.set(node, props);
 }
 };

 __internal_unmountConfigureDirectorySync = (node: HTMLDivElement): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_unmountConfigureDirectorySync(node);
 } else {
 this.premountConfigureDirectorySyncNodes.delete(node);
 }
 };

 __internal_mountOAuthConsent = (node: HTMLDivElement, props?: OAuthConsentProps) => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountOAuthConsent(node, props);
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/src/internal/clerk-js/componentGuards.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,13 @@ export const disabledSelfServeSSOFeature: ComponentGuard = (clerk, environment)
 return !environment?.userSettings.enterpriseSSO.self_serve_sso || !clerk.organization?.selfServeSSOEnabled;
};

export const disabledSelfServeDirectorySyncFeature: ComponentGuard = (clerk, environment) => {
 return (
 disabledSelfServeSSOFeature(clerk, environment) ||
 !environment?.userSettings.enterpriseSSO.self_serve_directory_sync
 );
};

export const disabledEmailAddressAttribute: ComponentGuard = (_, environment) => {
 return !environment?.userSettings.attributes.email_address?.enabled;
};

7 changes: 5 additions & 2 deletions
packages/shared/src/internal/clerk-js/warnings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ const createMessageForDisabledOrganizations = (
 | 'OrganizationList'
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO',
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
 );
};

const createCannotRenderComponentWhenOrgDoesNotExist = (
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO',
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO' | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `<${componentName}/> cannot render unless an organization is active. Since no organization is currently active, this is no-op.`,
Expand DownExpand Up@@ -88,6 +89,8 @@ const warnings = {
 '<ConfigureSSO/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
 cannotRenderConfigureSSOComponentWhenDisabled:
 'The <ConfigureSSO/> component cannot be rendered when self-serve SSO is disabled. Visit `https://dashboard.clerk.com` to enable the feature. Since self-serve SSO is disabled, this is no-op.',
 cannotRenderConfigureDirectorySyncComponentWhenDisabled:
 'The <ConfigureDirectorySync/> component cannot be rendered when self-serve Directory Sync is disabled. Since self-serve Directory Sync is disabled, this is no-op.',
 cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
 'The <ConfigureSSO/> component cannot be rendered when email addresses are disabled on the instance. Visit `https://dashboard.clerk.com` to enable email addresses. Since email addresses are disabled, this is no-op.',
};
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -816,6 +816,24 @@ export interface Clerk {
 */
 __internal_unmountConfigureSSO: (targetNode: HTMLDivElement) => void;

 /**
 * Mount a configure Directory Sync component at the target element.
 *
 * @param targetNode - Target to mount the ConfigureDirectorySync component.
 * @param props - Configuration parameters.
 * @hidden
 */
 __internal_mountConfigureDirectorySync: (targetNode: HTMLDivElement, props?: ConfigureSSOProps) => void;

 /**
 * Unmount a configure Directory Sync component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode - Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 __internal_unmountConfigureDirectorySync: (targetNode: HTMLDivElement) => void;

 /**
 * Mounts a OAuth consent component at the target element.
 *
Expand DownExpand Up@@ -1984,6 +2002,7 @@ export type __internal_AttemptToEnableEnvironmentSettingParams = {
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync'
 | 'useOrganizationList'
 | 'useOrganization';
 onClose?: () => void;
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/elementIds.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,7 @@ export type ProfileSectionId =
 | 'subscriptionsList'
 | 'paymentMethods'
 | 'sso'
 | 'directorySync'
 | 'ssoStatus'
 | 'enableSso'
 | 'ssoDomain'
Expand Down

18 changes: 18 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1206,6 +1206,24 @@ export type __internal_LocalizationResource = {
 tooltip__noRole: LocalizationValue;
 tooltipLabel: LocalizationValue;
 };
 directorySyncSection: {
 title: LocalizationValue;
 badge__unconfigured: LocalizationValue;
 badge__ssoRequired: LocalizationValue;
 badge__active: LocalizationValue;
 badge__inactive: LocalizationValue;
 description: LocalizationValue;
 primaryButton__startConfiguration: LocalizationValue;
 menuAction__edit: LocalizationValue;
 menuAction__activate: LocalizationValue;
 menuAction__deactivate: LocalizationValue;
 menuAction__remove: LocalizationValue;
 removeDialog: {
 title: LocalizationValue;
 subtitle: LocalizationValue;
 confirmButton: LocalizationValue;
 };
 };
 };
 membersPage: {
 detailsTitle__emptyRow: LocalizationValue;
Expand Down

48 changes: 48 additions & 0 deletions
packages/ui/src/components/ConfigureDirectorySync/ConfigureDirectorySync.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import type { ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { withCoreUserGuard } from '@/contexts';
import { Flow } from '@/customizables';
import { withCardStateProvider } from '@/elements/contexts';
import { ProfileCard } from '@/elements/ProfileCard';
import { Route, Switch } from '@/router';

import { ConfigureSSOProtect } from '../ConfigureSSO/ConfigureSSO';
import { ConfigureDirectorySyncWizard } from './ConfigureDirectorySyncWizard';
import { DirectorySyncNavbar } from './DirectorySyncNavbar';

/**
 * Standalone host for the Directory Sync onboarding wizard, mirroring
 * ConfigureSSO's shell. Reuses the configureSSO flow id/appearance until the
 * flow gets its own appearance surface.
 */
const ConfigureDirectorySyncInternal = (): JSX.Element => {
 return (
 <Flow.Root flow='configureSSO'>
 <Switch>
 <Route>
 <AuthenticatedContent />
 </Route>
 </Switch>
 </Flow.Root>
 );
};

const AuthenticatedContent = withCoreUserGuard(() => {
 const contentRef = React.useRef<HTMLDivElement>(null);

 return (
 <ProfileCard.Root
 sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
 >
 <DirectorySyncNavbar contentRef={contentRef}>
 <ConfigureSSOProtect>
 <ConfigureDirectorySyncWizard />
 </ConfigureSSOProtect>
 </DirectorySyncNavbar>
 </ProfileCard.Root>
 );
});

export const ConfigureDirectorySync: React.ComponentType<ConfigureSSOProps> =
 withCardStateProvider(ConfigureDirectorySyncInternal);
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(js,ui): mount and render the directory sync setup flow#9592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

kalafut
wants to merge
8
commits into

from

 Open


feat(js,ui): mount and render the directory sync setup flow
#9592
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
4debfb7

feat(self-serve-ds): mount and render ConfigureDirectorySync


kalafut Aug 27, 2026
5d8c0ab

Add a note about email domain restrictions


kalafut Aug 28, 2026
ab2907e

feat(self-serve-ds): pass the directory resource to the users hook


kalafut Aug 29, 2026
e375e69

Misc UI fixes


kalafut Sep 1, 2026
996e966

Initial UI review updates


kalafut Sep 2, 2026
a70f54f

Remove activation step


kalafut Sep 2, 2026
0899648

Tweak IdP instructions


kalafut Sep 2, 2026
cc51deb

Fix sandbox


kalafut Sep 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
.changeset/dir-sync-self-serve-wiring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/localizations': minor
'@clerk/react': minor
'@clerk/shared': minor
'@clerk/ui': minor
---
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "553KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "79.5KB" },
 { "path": "./dist/clerk.js", "maxSize": "554KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "122KB" },
 { "path": "./dist/clerk.no-rhc.js", "maxSize": "320KB" },
 { "path": "./dist/clerk.native.js", "maxSize": "79KB" },
Expand Down

6 changes: 6 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'pricingTable',
 'apiKeys',
 'configureSSO',
 'configureDirectorySync',
 'oauthConsent',
 'oauthDeviceVerification',
 'taskChooseOrganization',
Expand DownExpand Up@@ -154,6 +155,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 pricingTable: buildComponentControls('pricingTable'),
 apiKeys: buildComponentControls('apiKeys'),
 configureSSO: buildComponentControls('configureSSO'),
 configureDirectorySync: buildComponentControls('configureDirectorySync'),
 oauthConsent: buildComponentControls('oauthConsent'),
 oauthDeviceVerification: buildComponentControls('oauthDeviceVerification'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
Expand DownExpand Up@@ -431,6 +433,10 @@ void (async () => {
 mount: '__internal_mountOAuthDeviceVerification',
 component: 'oauthDeviceVerification',
 },
 '/configure-directory-sync': {
 mount: '__internal_mountConfigureDirectorySync',
 component: 'configureDirectorySync',
 },
 '/task-choose-organization': {
 mount: 'mountTaskChooseOrganization',
 component: 'taskChooseOrganization',
Expand Down

5 changes: 5 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -313,6 +313,11 @@
 label="Configure SSO"
 component="<ConfigureSSO />"
 ></nav-link>
 <nav-link
 href="/configure-directory-sync"
 label="Configure Directory Sync"
 component="<ConfigureDirectorySync />"
 ></nav-link>
 <nav-link
 href="/open-invite-members"
 label="Open invite members"
Expand Down

71 changes: 71 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
 disabledEmailAddressAttribute,
 disabledOrganizationAPIKeysFeature,
 disabledOrganizationsFeature,
 disabledSelfServeDirectorySyncFeature,
 disabledSelfServeSSOFeature,
 disabledUserAPIKeysFeature,
 isSignedInAndSingleSessionModeEnabled,
Expand DownExpand Up@@ -1712,6 +1713,76 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * Mount the Directory Sync onboarding component at the target element.
 * Directory Sync rides on the self-serve SSO gates: it provisions through
 * the organization's SSO connection, so the same preconditions apply.
 *
 * @param targetNode Target to mount the ConfigureDirectorySync component.
 * @param props Configuration parameters.
 * @hidden
 */
 public __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
 caller: 'ConfigureDirectorySync',
 onClose: () => {
 throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
 });
 },
 });

 if (!isOrganizationsEnabled) {
 return;
 }

 const userExists = !noUserExists(this);
 if (noOrganizationExists(this) && userExists) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.createCannotRenderComponentWhenOrgDoesNotExist('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATION_MISSING_ERROR_CODE,
 });
 }
 return;
 }

 if (disabledSelfServeDirectorySyncFeature(this, this.environment)) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.cannotRenderConfigureDirectorySyncComponentWhenDisabled, {
 code: CANNOT_RENDER_SELF_SERVE_SSO_DISABLED_ERROR_CODE,
 });
 }
 return;
 }

 this.assertComponentsReady(this.#clerkUI);
 const component = 'ConfigureDirectorySync';
 void this.#clerkUI
 .then(ui => ui.ensureMounted({ preloadHint: component }))
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'configureSSO',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 /**
 * Unmount the Directory Sync onboarding component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 public __internal_unmountConfigureDirectorySync = (node: HTMLDivElement) => {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskChooseOrganization = (node: HTMLDivElement, props?: TaskChooseOrganizationProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
Expand Down

21 changes: 21 additions & 0 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,6 +166,7 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 private premountPricingTableNodes = new Map<HTMLDivElement, PricingTableProps | undefined>();
 private premountAPIKeysNodes = new Map<HTMLDivElement, APIKeysProps | undefined>();
 private premountConfigureSSONodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountConfigureDirectorySyncNodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountOAuthConsentNodes = new Map<HTMLDivElement, __internal_OAuthConsentProps | undefined>();
 private premountOAuthDeviceVerificationNodes = new Map<HTMLDivElement, OAuthDeviceVerificationProps | undefined>();
 private premountTaskChooseOrganizationNodes = new Map<HTMLDivElement, TaskChooseOrganizationProps | undefined>();
Expand DownExpand Up@@ -801,6 +802,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 clerkjs.__internal_mountConfigureSSO(node, props);
 });

 this.premountConfigureDirectorySyncNodes.forEach((props, node) => {
 clerkjs.__internal_mountConfigureDirectorySync(node, props);
 });

 this.premountOAuthConsentNodes.forEach((props, node) => {
 clerkjs.__internal_mountOAuthConsent(node, props);
 });
Expand DownExpand Up@@ -1387,6 +1392,22 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 }
 };

 __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountConfigureDirectorySync(node, props);
 } else {
 this.premountConfigureDirectorySyncNodes.set(node, props);
 }
 };

 __internal_unmountConfigureDirectorySync = (node: HTMLDivElement): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_unmountConfigureDirectorySync(node);
 } else {
 this.premountConfigureDirectorySyncNodes.delete(node);
 }
 };

 __internal_mountOAuthConsent = (node: HTMLDivElement, props?: OAuthConsentProps) => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountOAuthConsent(node, props);
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/src/internal/clerk-js/componentGuards.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,13 @@ export const disabledSelfServeSSOFeature: ComponentGuard = (clerk, environment)
 return !environment?.userSettings.enterpriseSSO.self_serve_sso || !clerk.organization?.selfServeSSOEnabled;
};

export const disabledSelfServeDirectorySyncFeature: ComponentGuard = (clerk, environment) => {
 return (
 disabledSelfServeSSOFeature(clerk, environment) ||
 !environment?.userSettings.enterpriseSSO.self_serve_directory_sync
 );
};

export const disabledEmailAddressAttribute: ComponentGuard = (_, environment) => {
 return !environment?.userSettings.attributes.email_address?.enabled;
};

7 changes: 5 additions & 2 deletions
packages/shared/src/internal/clerk-js/warnings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ const createMessageForDisabledOrganizations = (
 | 'OrganizationList'
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO',
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
 );
};

const createCannotRenderComponentWhenOrgDoesNotExist = (
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO',
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO' | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `<${componentName}/> cannot render unless an organization is active. Since no organization is currently active, this is no-op.`,
Expand DownExpand Up@@ -88,6 +89,8 @@ const warnings = {
 '<ConfigureSSO/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
 cannotRenderConfigureSSOComponentWhenDisabled:
 'The <ConfigureSSO/> component cannot be rendered when self-serve SSO is disabled. Visit `https://dashboard.clerk.com` to enable the feature. Since self-serve SSO is disabled, this is no-op.',
 cannotRenderConfigureDirectorySyncComponentWhenDisabled:
 'The <ConfigureDirectorySync/> component cannot be rendered when self-serve Directory Sync is disabled. Since self-serve Directory Sync is disabled, this is no-op.',
 cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
 'The <ConfigureSSO/> component cannot be rendered when email addresses are disabled on the instance. Visit `https://dashboard.clerk.com` to enable email addresses. Since email addresses are disabled, this is no-op.',
};
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -816,6 +816,24 @@ export interface Clerk {
 */
 __internal_unmountConfigureSSO: (targetNode: HTMLDivElement) => void;

 /**
 * Mount a configure Directory Sync component at the target element.
 *
 * @param targetNode - Target to mount the ConfigureDirectorySync component.
 * @param props - Configuration parameters.
 * @hidden
 */
 __internal_mountConfigureDirectorySync: (targetNode: HTMLDivElement, props?: ConfigureSSOProps) => void;

 /**
 * Unmount a configure Directory Sync component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode - Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 __internal_unmountConfigureDirectorySync: (targetNode: HTMLDivElement) => void;

 /**
 * Mounts a OAuth consent component at the target element.
 *
Expand DownExpand Up@@ -1984,6 +2002,7 @@ export type __internal_AttemptToEnableEnvironmentSettingParams = {
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync'
 | 'useOrganizationList'
 | 'useOrganization';
 onClose?: () => void;
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/elementIds.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,7 @@ export type ProfileSectionId =
 | 'subscriptionsList'
 | 'paymentMethods'
 | 'sso'
 | 'directorySync'
 | 'ssoStatus'
 | 'enableSso'
 | 'ssoDomain'
Expand Down

18 changes: 18 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1206,6 +1206,24 @@ export type __internal_LocalizationResource = {
 tooltip__noRole: LocalizationValue;
 tooltipLabel: LocalizationValue;
 };
 directorySyncSection: {
 title: LocalizationValue;
 badge__unconfigured: LocalizationValue;
 badge__ssoRequired: LocalizationValue;
 badge__active: LocalizationValue;
 badge__inactive: LocalizationValue;
 description: LocalizationValue;
 primaryButton__startConfiguration: LocalizationValue;
 menuAction__edit: LocalizationValue;
 menuAction__activate: LocalizationValue;
 menuAction__deactivate: LocalizationValue;
 menuAction__remove: LocalizationValue;
 removeDialog: {
 title: LocalizationValue;
 subtitle: LocalizationValue;
 confirmButton: LocalizationValue;
 };
 };
 };
 membersPage: {
 detailsTitle__emptyRow: LocalizationValue;
Expand Down

48 changes: 48 additions & 0 deletions
packages/ui/src/components/ConfigureDirectorySync/ConfigureDirectorySync.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import type { ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { withCoreUserGuard } from '@/contexts';
import { Flow } from '@/customizables';
import { withCardStateProvider } from '@/elements/contexts';
import { ProfileCard } from '@/elements/ProfileCard';
import { Route, Switch } from '@/router';

import { ConfigureSSOProtect } from '../ConfigureSSO/ConfigureSSO';
import { ConfigureDirectorySyncWizard } from './ConfigureDirectorySyncWizard';
import { DirectorySyncNavbar } from './DirectorySyncNavbar';

/**
 * Standalone host for the Directory Sync onboarding wizard, mirroring
 * ConfigureSSO's shell. Reuses the configureSSO flow id/appearance until the
 * flow gets its own appearance surface.
 */
const ConfigureDirectorySyncInternal = (): JSX.Element => {
 return (
 <Flow.Root flow='configureSSO'>
 <Switch>
 <Route>
 <AuthenticatedContent />
 </Route>
 </Switch>
 </Flow.Root>
 );
};

const AuthenticatedContent = withCoreUserGuard(() => {
 const contentRef = React.useRef<HTMLDivElement>(null);

 return (
 <ProfileCard.Root
 sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
 >
 <DirectorySyncNavbar contentRef={contentRef}>
 <ConfigureSSOProtect>
 <ConfigureDirectorySyncWizard />
 </ConfigureSSOProtect>
 </DirectorySyncNavbar>
 </ProfileCard.Root>
 );
});

export const ConfigureDirectorySync: React.ComponentType<ConfigureSSOProps> =
 withCardStateProvider(ConfigureDirectorySyncInternal);
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(js,ui): mount and render the directory sync setup flow#9592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

kalafut
wants to merge
8
commits into

from

 Open


feat(js,ui): mount and render the directory sync setup flow
#9592
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
4debfb7

feat(self-serve-ds): mount and render ConfigureDirectorySync


kalafut Aug 27, 2026
5d8c0ab

Add a note about email domain restrictions


kalafut Aug 28, 2026
ab2907e

feat(self-serve-ds): pass the directory resource to the users hook


kalafut Aug 29, 2026
e375e69

Misc UI fixes


kalafut Sep 1, 2026
996e966

Initial UI review updates


kalafut Sep 2, 2026
a70f54f

Remove activation step


kalafut Sep 2, 2026
0899648

Tweak IdP instructions


kalafut Sep 2, 2026
cc51deb

Fix sandbox


kalafut Sep 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
.changeset/dir-sync-self-serve-wiring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/localizations': minor
'@clerk/react': minor
'@clerk/shared': minor
'@clerk/ui': minor
---
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "553KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "79.5KB" },
 { "path": "./dist/clerk.js", "maxSize": "554KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "122KB" },
 { "path": "./dist/clerk.no-rhc.js", "maxSize": "320KB" },
 { "path": "./dist/clerk.native.js", "maxSize": "79KB" },
Expand Down

6 changes: 6 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'pricingTable',
 'apiKeys',
 'configureSSO',
 'configureDirectorySync',
 'oauthConsent',
 'oauthDeviceVerification',
 'taskChooseOrganization',
Expand DownExpand Up@@ -154,6 +155,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 pricingTable: buildComponentControls('pricingTable'),
 apiKeys: buildComponentControls('apiKeys'),
 configureSSO: buildComponentControls('configureSSO'),
 configureDirectorySync: buildComponentControls('configureDirectorySync'),
 oauthConsent: buildComponentControls('oauthConsent'),
 oauthDeviceVerification: buildComponentControls('oauthDeviceVerification'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
Expand DownExpand Up@@ -431,6 +433,10 @@ void (async () => {
 mount: '__internal_mountOAuthDeviceVerification',
 component: 'oauthDeviceVerification',
 },
 '/configure-directory-sync': {
 mount: '__internal_mountConfigureDirectorySync',
 component: 'configureDirectorySync',
 },
 '/task-choose-organization': {
 mount: 'mountTaskChooseOrganization',
 component: 'taskChooseOrganization',
Expand Down

5 changes: 5 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -313,6 +313,11 @@
 label="Configure SSO"
 component="<ConfigureSSO />"
 ></nav-link>
 <nav-link
 href="/configure-directory-sync"
 label="Configure Directory Sync"
 component="<ConfigureDirectorySync />"
 ></nav-link>
 <nav-link
 href="/open-invite-members"
 label="Open invite members"
Expand Down

71 changes: 71 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
 disabledEmailAddressAttribute,
 disabledOrganizationAPIKeysFeature,
 disabledOrganizationsFeature,
 disabledSelfServeDirectorySyncFeature,
 disabledSelfServeSSOFeature,
 disabledUserAPIKeysFeature,
 isSignedInAndSingleSessionModeEnabled,
Expand DownExpand Up@@ -1712,6 +1713,76 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * Mount the Directory Sync onboarding component at the target element.
 * Directory Sync rides on the self-serve SSO gates: it provisions through
 * the organization's SSO connection, so the same preconditions apply.
 *
 * @param targetNode Target to mount the ConfigureDirectorySync component.
 * @param props Configuration parameters.
 * @hidden
 */
 public __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
 caller: 'ConfigureDirectorySync',
 onClose: () => {
 throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
 });
 },
 });

 if (!isOrganizationsEnabled) {
 return;
 }

 const userExists = !noUserExists(this);
 if (noOrganizationExists(this) && userExists) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.createCannotRenderComponentWhenOrgDoesNotExist('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATION_MISSING_ERROR_CODE,
 });
 }
 return;
 }

 if (disabledSelfServeDirectorySyncFeature(this, this.environment)) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.cannotRenderConfigureDirectorySyncComponentWhenDisabled, {
 code: CANNOT_RENDER_SELF_SERVE_SSO_DISABLED_ERROR_CODE,
 });
 }
 return;
 }

 this.assertComponentsReady(this.#clerkUI);
 const component = 'ConfigureDirectorySync';
 void this.#clerkUI
 .then(ui => ui.ensureMounted({ preloadHint: component }))
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'configureSSO',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 /**
 * Unmount the Directory Sync onboarding component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 public __internal_unmountConfigureDirectorySync = (node: HTMLDivElement) => {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskChooseOrganization = (node: HTMLDivElement, props?: TaskChooseOrganizationProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
Expand Down

21 changes: 21 additions & 0 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,6 +166,7 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 private premountPricingTableNodes = new Map<HTMLDivElement, PricingTableProps | undefined>();
 private premountAPIKeysNodes = new Map<HTMLDivElement, APIKeysProps | undefined>();
 private premountConfigureSSONodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountConfigureDirectorySyncNodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountOAuthConsentNodes = new Map<HTMLDivElement, __internal_OAuthConsentProps | undefined>();
 private premountOAuthDeviceVerificationNodes = new Map<HTMLDivElement, OAuthDeviceVerificationProps | undefined>();
 private premountTaskChooseOrganizationNodes = new Map<HTMLDivElement, TaskChooseOrganizationProps | undefined>();
Expand DownExpand Up@@ -801,6 +802,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 clerkjs.__internal_mountConfigureSSO(node, props);
 });

 this.premountConfigureDirectorySyncNodes.forEach((props, node) => {
 clerkjs.__internal_mountConfigureDirectorySync(node, props);
 });

 this.premountOAuthConsentNodes.forEach((props, node) => {
 clerkjs.__internal_mountOAuthConsent(node, props);
 });
Expand DownExpand Up@@ -1387,6 +1392,22 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 }
 };

 __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountConfigureDirectorySync(node, props);
 } else {
 this.premountConfigureDirectorySyncNodes.set(node, props);
 }
 };

 __internal_unmountConfigureDirectorySync = (node: HTMLDivElement): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_unmountConfigureDirectorySync(node);
 } else {
 this.premountConfigureDirectorySyncNodes.delete(node);
 }
 };

 __internal_mountOAuthConsent = (node: HTMLDivElement, props?: OAuthConsentProps) => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountOAuthConsent(node, props);
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/src/internal/clerk-js/componentGuards.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,13 @@ export const disabledSelfServeSSOFeature: ComponentGuard = (clerk, environment)
 return !environment?.userSettings.enterpriseSSO.self_serve_sso || !clerk.organization?.selfServeSSOEnabled;
};

export const disabledSelfServeDirectorySyncFeature: ComponentGuard = (clerk, environment) => {
 return (
 disabledSelfServeSSOFeature(clerk, environment) ||
 !environment?.userSettings.enterpriseSSO.self_serve_directory_sync
 );
};

export const disabledEmailAddressAttribute: ComponentGuard = (_, environment) => {
 return !environment?.userSettings.attributes.email_address?.enabled;
};

7 changes: 5 additions & 2 deletions
packages/shared/src/internal/clerk-js/warnings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ const createMessageForDisabledOrganizations = (
 | 'OrganizationList'
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO',
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
 );
};

const createCannotRenderComponentWhenOrgDoesNotExist = (
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO',
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO' | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `<${componentName}/> cannot render unless an organization is active. Since no organization is currently active, this is no-op.`,
Expand DownExpand Up@@ -88,6 +89,8 @@ const warnings = {
 '<ConfigureSSO/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
 cannotRenderConfigureSSOComponentWhenDisabled:
 'The <ConfigureSSO/> component cannot be rendered when self-serve SSO is disabled. Visit `https://dashboard.clerk.com` to enable the feature. Since self-serve SSO is disabled, this is no-op.',
 cannotRenderConfigureDirectorySyncComponentWhenDisabled:
 'The <ConfigureDirectorySync/> component cannot be rendered when self-serve Directory Sync is disabled. Since self-serve Directory Sync is disabled, this is no-op.',
 cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
 'The <ConfigureSSO/> component cannot be rendered when email addresses are disabled on the instance. Visit `https://dashboard.clerk.com` to enable email addresses. Since email addresses are disabled, this is no-op.',
};
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -816,6 +816,24 @@ export interface Clerk {
 */
 __internal_unmountConfigureSSO: (targetNode: HTMLDivElement) => void;

 /**
 * Mount a configure Directory Sync component at the target element.
 *
 * @param targetNode - Target to mount the ConfigureDirectorySync component.
 * @param props - Configuration parameters.
 * @hidden
 */
 __internal_mountConfigureDirectorySync: (targetNode: HTMLDivElement, props?: ConfigureSSOProps) => void;

 /**
 * Unmount a configure Directory Sync component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode - Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 __internal_unmountConfigureDirectorySync: (targetNode: HTMLDivElement) => void;

 /**
 * Mounts a OAuth consent component at the target element.
 *
Expand DownExpand Up@@ -1984,6 +2002,7 @@ export type __internal_AttemptToEnableEnvironmentSettingParams = {
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync'
 | 'useOrganizationList'
 | 'useOrganization';
 onClose?: () => void;
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/elementIds.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,7 @@ export type ProfileSectionId =
 | 'subscriptionsList'
 | 'paymentMethods'
 | 'sso'
 | 'directorySync'
 | 'ssoStatus'
 | 'enableSso'
 | 'ssoDomain'
Expand Down

18 changes: 18 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1206,6 +1206,24 @@ export type __internal_LocalizationResource = {
 tooltip__noRole: LocalizationValue;
 tooltipLabel: LocalizationValue;
 };
 directorySyncSection: {
 title: LocalizationValue;
 badge__unconfigured: LocalizationValue;
 badge__ssoRequired: LocalizationValue;
 badge__active: LocalizationValue;
 badge__inactive: LocalizationValue;
 description: LocalizationValue;
 primaryButton__startConfiguration: LocalizationValue;
 menuAction__edit: LocalizationValue;
 menuAction__activate: LocalizationValue;
 menuAction__deactivate: LocalizationValue;
 menuAction__remove: LocalizationValue;
 removeDialog: {
 title: LocalizationValue;
 subtitle: LocalizationValue;
 confirmButton: LocalizationValue;
 };
 };
 };
 membersPage: {
 detailsTitle__emptyRow: LocalizationValue;
Expand Down

48 changes: 48 additions & 0 deletions
packages/ui/src/components/ConfigureDirectorySync/ConfigureDirectorySync.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import type { ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { withCoreUserGuard } from '@/contexts';
import { Flow } from '@/customizables';
import { withCardStateProvider } from '@/elements/contexts';
import { ProfileCard } from '@/elements/ProfileCard';
import { Route, Switch } from '@/router';

import { ConfigureSSOProtect } from '../ConfigureSSO/ConfigureSSO';
import { ConfigureDirectorySyncWizard } from './ConfigureDirectorySyncWizard';
import { DirectorySyncNavbar } from './DirectorySyncNavbar';

/**
 * Standalone host for the Directory Sync onboarding wizard, mirroring
 * ConfigureSSO's shell. Reuses the configureSSO flow id/appearance until the
 * flow gets its own appearance surface.
 */
const ConfigureDirectorySyncInternal = (): JSX.Element => {
 return (
 <Flow.Root flow='configureSSO'>
 <Switch>
 <Route>
 <AuthenticatedContent />
 </Route>
 </Switch>
 </Flow.Root>
 );
};

const AuthenticatedContent = withCoreUserGuard(() => {
 const contentRef = React.useRef<HTMLDivElement>(null);

 return (
 <ProfileCard.Root
 sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
 >
 <DirectorySyncNavbar contentRef={contentRef}>
 <ConfigureSSOProtect>
 <ConfigureDirectorySyncWizard />
 </ConfigureSSOProtect>
 </DirectorySyncNavbar>
 </ProfileCard.Root>
 );
});

export const ConfigureDirectorySync: React.ComponentType<ConfigureSSOProps> =
 withCardStateProvider(ConfigureDirectorySyncInternal);
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(js,ui): mount and render the directory sync setup flow#9592

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

kalafut
wants to merge
8
commits into

from

 Open


feat(js,ui): mount and render the directory sync setup flow
#9592
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
4debfb7

feat(self-serve-ds): mount and render ConfigureDirectorySync


kalafut Aug 27, 2026
5d8c0ab

Add a note about email domain restrictions


kalafut Aug 28, 2026
ab2907e

feat(self-serve-ds): pass the directory resource to the users hook


kalafut Aug 29, 2026
e375e69

Misc UI fixes


kalafut Sep 1, 2026
996e966

Initial UI review updates


kalafut Sep 2, 2026
a70f54f

Remove activation step


kalafut Sep 2, 2026
0899648

Tweak IdP instructions


kalafut Sep 2, 2026
cc51deb

Fix sandbox


kalafut Sep 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
.changeset/dir-sync-self-serve-wiring.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
---
'@clerk/clerk-js': minor
'@clerk/localizations': minor
'@clerk/react': minor
'@clerk/shared': minor
'@clerk/ui': minor
---
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/bundlewatch.config.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
 "files": [
 { "path": "./dist/clerk.js", "maxSize": "553KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "79.5KB" },
 { "path": "./dist/clerk.js", "maxSize": "554KB" },
 { "path": "./dist/clerk.browser.js", "maxSize": "81KB" },
 { "path": "./dist/clerk.legacy.browser.js", "maxSize": "122KB" },
 { "path": "./dist/clerk.no-rhc.js", "maxSize": "320KB" },
 { "path": "./dist/clerk.native.js", "maxSize": "79KB" },
Expand Down

6 changes: 6 additions & 0 deletions
packages/clerk-js/sandbox/app.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,6 +34,7 @@ const AVAILABLE_COMPONENTS = [
 'pricingTable',
 'apiKeys',
 'configureSSO',
 'configureDirectorySync',
 'oauthConsent',
 'oauthDeviceVerification',
 'taskChooseOrganization',
Expand DownExpand Up@@ -154,6 +155,7 @@ const componentControls: Record<AvailableComponent, ComponentPropsControl> = {
 pricingTable: buildComponentControls('pricingTable'),
 apiKeys: buildComponentControls('apiKeys'),
 configureSSO: buildComponentControls('configureSSO'),
 configureDirectorySync: buildComponentControls('configureDirectorySync'),
 oauthConsent: buildComponentControls('oauthConsent'),
 oauthDeviceVerification: buildComponentControls('oauthDeviceVerification'),
 taskChooseOrganization: buildComponentControls('taskChooseOrganization'),
Expand DownExpand Up@@ -431,6 +433,10 @@ void (async () => {
 mount: '__internal_mountOAuthDeviceVerification',
 component: 'oauthDeviceVerification',
 },
 '/configure-directory-sync': {
 mount: '__internal_mountConfigureDirectorySync',
 component: 'configureDirectorySync',
 },
 '/task-choose-organization': {
 mount: 'mountTaskChooseOrganization',
 component: 'taskChooseOrganization',
Expand Down

5 changes: 5 additions & 0 deletions
packages/clerk-js/sandbox/template.html

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -313,6 +313,11 @@
 label="Configure SSO"
 component="<ConfigureSSO />"
 ></nav-link>
 <nav-link
 href="/configure-directory-sync"
 label="Configure Directory Sync"
 component="<ConfigureDirectorySync />"
 ></nav-link>
 <nav-link
 href="/open-invite-members"
 label="Open invite members"
Expand Down

71 changes: 71 additions & 0 deletions
packages/clerk-js/src/core/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ import {
 disabledEmailAddressAttribute,
 disabledOrganizationAPIKeysFeature,
 disabledOrganizationsFeature,
 disabledSelfServeDirectorySyncFeature,
 disabledSelfServeSSOFeature,
 disabledUserAPIKeysFeature,
 isSignedInAndSingleSessionModeEnabled,
Expand DownExpand Up@@ -1712,6 +1713,76 @@ export class Clerk implements ClerkInterface {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 /**
 * Mount the Directory Sync onboarding component at the target element.
 * Directory Sync rides on the self-serve SSO gates: it provisions through
 * the organization's SSO connection, so the same preconditions apply.
 *
 * @param targetNode Target to mount the ConfigureDirectorySync component.
 * @param props Configuration parameters.
 * @hidden
 */
 public __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
 caller: 'ConfigureDirectorySync',
 onClose: () => {
 throw new ClerkRuntimeError(warnings.cannotRenderAnyOrganizationComponent('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATIONS_DISABLED_ERROR_CODE,
 });
 },
 });

 if (!isOrganizationsEnabled) {
 return;
 }

 const userExists = !noUserExists(this);
 if (noOrganizationExists(this) && userExists) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.createCannotRenderComponentWhenOrgDoesNotExist('ConfigureDirectorySync'), {
 code: CANNOT_RENDER_ORGANIZATION_MISSING_ERROR_CODE,
 });
 }
 return;
 }

 if (disabledSelfServeDirectorySyncFeature(this, this.environment)) {
 if (this.#instanceType === 'development') {
 throw new ClerkRuntimeError(warnings.cannotRenderConfigureDirectorySyncComponentWhenDisabled, {
 code: CANNOT_RENDER_SELF_SERVE_SSO_DISABLED_ERROR_CODE,
 });
 }
 return;
 }

 this.assertComponentsReady(this.#clerkUI);
 const component = 'ConfigureDirectorySync';
 void this.#clerkUI
 .then(ui => ui.ensureMounted({ preloadHint: component }))
 .then(controls =>
 controls.mountComponent({
 name: component,
 appearanceKey: 'configureSSO',
 node,
 props,
 }),
 );

 this.telemetry?.record(eventPrebuiltComponentMounted(component, props));
 };

 /**
 * Unmount the Directory Sync onboarding component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 public __internal_unmountConfigureDirectorySync = (node: HTMLDivElement) => {
 void this.#clerkUI?.then(ui => ui.ensureMounted()).then(controls => controls.unmountComponent({ node }));
 };

 public mountTaskChooseOrganization = (node: HTMLDivElement, props?: TaskChooseOrganizationProps) => {
 const { isEnabled: isOrganizationsEnabled } = this.__internal_attemptToEnableEnvironmentSetting({
 for: 'organizations',
Expand Down

21 changes: 21 additions & 0 deletions
packages/react/src/isomorphicClerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -166,6 +166,7 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 private premountPricingTableNodes = new Map<HTMLDivElement, PricingTableProps | undefined>();
 private premountAPIKeysNodes = new Map<HTMLDivElement, APIKeysProps | undefined>();
 private premountConfigureSSONodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountConfigureDirectorySyncNodes = new Map<HTMLDivElement, ConfigureSSOProps | undefined>();
 private premountOAuthConsentNodes = new Map<HTMLDivElement, __internal_OAuthConsentProps | undefined>();
 private premountOAuthDeviceVerificationNodes = new Map<HTMLDivElement, OAuthDeviceVerificationProps | undefined>();
 private premountTaskChooseOrganizationNodes = new Map<HTMLDivElement, TaskChooseOrganizationProps | undefined>();
Expand DownExpand Up@@ -801,6 +802,10 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 clerkjs.__internal_mountConfigureSSO(node, props);
 });

 this.premountConfigureDirectorySyncNodes.forEach((props, node) => {
 clerkjs.__internal_mountConfigureDirectorySync(node, props);
 });

 this.premountOAuthConsentNodes.forEach((props, node) => {
 clerkjs.__internal_mountOAuthConsent(node, props);
 });
Expand DownExpand Up@@ -1387,6 +1392,22 @@ export class IsomorphicClerk implements IsomorphicLoadedClerk {
 }
 };

 __internal_mountConfigureDirectorySync = (node: HTMLDivElement, props?: ConfigureSSOProps): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountConfigureDirectorySync(node, props);
 } else {
 this.premountConfigureDirectorySyncNodes.set(node, props);
 }
 };

 __internal_unmountConfigureDirectorySync = (node: HTMLDivElement): void => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_unmountConfigureDirectorySync(node);
 } else {
 this.premountConfigureDirectorySyncNodes.delete(node);
 }
 };

 __internal_mountOAuthConsent = (node: HTMLDivElement, props?: OAuthConsentProps) => {
 if (this.clerkjs && this.loaded) {
 this.clerkjs.__internal_mountOAuthConsent(node, props);
Expand Down

7 changes: 7 additions & 0 deletions
packages/shared/src/internal/clerk-js/componentGuards.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,13 @@ export const disabledSelfServeSSOFeature: ComponentGuard = (clerk, environment)
 return !environment?.userSettings.enterpriseSSO.self_serve_sso || !clerk.organization?.selfServeSSOEnabled;
};

export const disabledSelfServeDirectorySyncFeature: ComponentGuard = (clerk, environment) => {
 return (
 disabledSelfServeSSOFeature(clerk, environment) ||
 !environment?.userSettings.enterpriseSSO.self_serve_directory_sync
 );
};

export const disabledEmailAddressAttribute: ComponentGuard = (_, environment) => {
 return !environment?.userSettings.attributes.email_address?.enabled;
};

7 changes: 5 additions & 2 deletions
packages/shared/src/internal/clerk-js/warnings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -12,15 +12,16 @@ const createMessageForDisabledOrganizations = (
 | 'OrganizationList'
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO',
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `The <${componentName}/> cannot be rendered when the feature is turned off. Visit 'dashboard.clerk.com' to enable the feature. Since the feature is turned off, this is no-op.`,
 );
};

const createCannotRenderComponentWhenOrgDoesNotExist = (
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO',
 componentName: 'OrganizationProfile' | 'InviteMembers' | 'ConfigureSSO' | 'ConfigureDirectorySync',
) => {
 return formatWarning(
 `<${componentName}/> cannot render unless an organization is active. Since no organization is currently active, this is no-op.`,
Expand DownExpand Up@@ -88,6 +89,8 @@ const warnings = {
 '<ConfigureSSO/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
 cannotRenderConfigureSSOComponentWhenDisabled:
 'The <ConfigureSSO/> component cannot be rendered when self-serve SSO is disabled. Visit `https://dashboard.clerk.com` to enable the feature. Since self-serve SSO is disabled, this is no-op.',
 cannotRenderConfigureDirectorySyncComponentWhenDisabled:
 'The <ConfigureDirectorySync/> component cannot be rendered when self-serve Directory Sync is disabled. Since self-serve Directory Sync is disabled, this is no-op.',
 cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
 'The <ConfigureSSO/> component cannot be rendered when email addresses are disabled on the instance. Visit `https://dashboard.clerk.com` to enable email addresses. Since email addresses are disabled, this is no-op.',
};
Expand Down

19 changes: 19 additions & 0 deletions
packages/shared/src/types/clerk.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -816,6 +816,24 @@ export interface Clerk {
 */
 __internal_unmountConfigureSSO: (targetNode: HTMLDivElement) => void;

 /**
 * Mount a configure Directory Sync component at the target element.
 *
 * @param targetNode - Target to mount the ConfigureDirectorySync component.
 * @param props - Configuration parameters.
 * @hidden
 */
 __internal_mountConfigureDirectorySync: (targetNode: HTMLDivElement, props?: ConfigureSSOProps) => void;

 /**
 * Unmount a configure Directory Sync component from the target element.
 * If there is no component mounted at the target node, results in a noop.
 *
 * @param targetNode - Target node to unmount the ConfigureDirectorySync component from.
 * @hidden
 */
 __internal_unmountConfigureDirectorySync: (targetNode: HTMLDivElement) => void;

 /**
 * Mounts a OAuth consent component at the target element.
 *
Expand DownExpand Up@@ -1984,6 +2002,7 @@ export type __internal_AttemptToEnableEnvironmentSettingParams = {
 | 'CreateOrganization'
 | 'TaskChooseOrganization'
 | 'ConfigureSSO'
 | 'ConfigureDirectorySync'
 | 'useOrganizationList'
 | 'useOrganization';
 onClose?: () => void;
Expand Down

1 change: 1 addition & 0 deletions
packages/shared/src/types/elementIds.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -63,6 +63,7 @@ export type ProfileSectionId =
 | 'subscriptionsList'
 | 'paymentMethods'
 | 'sso'
 | 'directorySync'
 | 'ssoStatus'
 | 'enableSso'
 | 'ssoDomain'
Expand Down

18 changes: 18 additions & 0 deletions
packages/shared/src/types/localization.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1206,6 +1206,24 @@ export type __internal_LocalizationResource = {
 tooltip__noRole: LocalizationValue;
 tooltipLabel: LocalizationValue;
 };
 directorySyncSection: {
 title: LocalizationValue;
 badge__unconfigured: LocalizationValue;
 badge__ssoRequired: LocalizationValue;
 badge__active: LocalizationValue;
 badge__inactive: LocalizationValue;
 description: LocalizationValue;
 primaryButton__startConfiguration: LocalizationValue;
 menuAction__edit: LocalizationValue;
 menuAction__activate: LocalizationValue;
 menuAction__deactivate: LocalizationValue;
 menuAction__remove: LocalizationValue;
 removeDialog: {
 title: LocalizationValue;
 subtitle: LocalizationValue;
 confirmButton: LocalizationValue;
 };
 };
 };
 membersPage: {
 detailsTitle__emptyRow: LocalizationValue;
Expand Down

48 changes: 48 additions & 0 deletions
packages/ui/src/components/ConfigureDirectorySync/ConfigureDirectorySync.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
import type { ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { withCoreUserGuard } from '@/contexts';
import { Flow } from '@/customizables';
import { withCardStateProvider } from '@/elements/contexts';
import { ProfileCard } from '@/elements/ProfileCard';
import { Route, Switch } from '@/router';

import { ConfigureSSOProtect } from '../ConfigureSSO/ConfigureSSO';
import { ConfigureDirectorySyncWizard } from './ConfigureDirectorySyncWizard';
import { DirectorySyncNavbar } from './DirectorySyncNavbar';

/**
 * Standalone host for the Directory Sync onboarding wizard, mirroring
 * ConfigureSSO's shell. Reuses the configureSSO flow id/appearance until the
 * flow gets its own appearance surface.
 */
const ConfigureDirectorySyncInternal = (): JSX.Element => {
 return (
 <Flow.Root flow='configureSSO'>
 <Switch>
 <Route>
 <AuthenticatedContent />
 </Route>
 </Switch>
 </Flow.Root>
 );
};

const AuthenticatedContent = withCoreUserGuard(() => {
 const contentRef = React.useRef<HTMLDivElement>(null);

 return (
 <ProfileCard.Root
 sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
 >
 <DirectorySyncNavbar contentRef={contentRef}>
 <ConfigureSSOProtect>
 <ConfigureDirectorySyncWizard />
 </ConfigureSSOProtect>
 </DirectorySyncNavbar>
 </ProfileCard.Root>
 );
});

export const ConfigureDirectorySync: React.ComponentType<ConfigureSSOProps> =
 withCardStateProvider(ConfigureDirectorySyncInternal);
Loading
Loading