Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/lucky-tables-learn.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add wizard steps for the `<__experimental_ConfigureSSO />` component
9 changes: 9 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1457,6 +1457,15 @@ export class Clerk implements ClerkInterface {
return;
}

if (noUserExists(this)) {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this one that got missed on the first PR

if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderConfigureSSOComponentWhenUserDoesNotExist, {
code: CANNOT_RENDER_USER_MISSING_ERROR_CODE,
});
}
return;
}

this.assertComponentsReady(this.#clerkUI);
const component = 'ConfigureSSO';
void this.#clerkUI
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/src/internal/clerk-js/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@ const warnings = {
'The <APIKeys/> component cannot be rendered when organization API keys are disabled. Since organization API keys are disabled, this is no-op.',
cannotRenderOAuthConsentComponentWhenUserDoesNotExist:
'<OAuthConsent/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
cannotRenderConfigureSSOComponentWhenUserDoesNotExist:
'<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.',
cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
Expand Down
112 changes: 102 additions & 10 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSO.tsx
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
import { useOrganization} from '@clerk/shared/react/index';
import { __internal_useUserEnterpriseConnections, useOrganization, useUser } from '@clerk/shared/react';
import type { __experimental_ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { useEnvironment, withCoreUserGuard } from '@/contexts';
import { Box, Col, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { Box, Col, descriptors, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { ApplicationLogo } from '@/elements/ApplicationLogo';
import { withCardStateProvider } from '@/elements/contexts';
import { NavBar, NavbarContextProvider } from '@/elements/Navbar';
import { ProfileCard } from '@/elements/ProfileCard';
import { BoxIcon } from '@/icons';
import { Route, Switch } from '@/router';

import { ConfigureSSOFlowProvider } from './ConfigureSSOContext';
import { ConfigureCreateApp, ConfirmationStep, ProvideEmail, TestConfigurationStep, VerifyDomainStep } from './steps';
import { ConfigureSSOWizard } from './wizard';

const ConfigureSSOInternal = () => {
return (
<Flow.Root flow='configureSSO'>
<Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Root>
);
};
Expand All@@ -32,6 +34,11 @@ const AuthenticatedContent = withCoreUserGuard(() => {
const { parsedOptions } = useAppearance();
const hasLogo = Boolean(parsedOptions.logoImageUrl || logoImageUrl);

const { data: enterpriseConnections, isLoading: isLoadingEnterpriseConnections } =
__internal_useUserEnterpriseConnections({ enabled: true });
// Currently FAPI only supports one enterprise connection per user
const enterpriseConnection = enterpriseConnections?.[0];

return (
<ProfileCard.Root
sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
Expand DownExpand Up@@ -89,12 +96,97 @@ const AuthenticatedContent = withCoreUserGuard(() => {
routes={[]}
contentRef={contentRef}
/>
<ProfileCard.Content contentRef={contentRef} />
<Col
ref={contentRef}
elementDescriptor={descriptors.scrollBox}
sx={t => ({
backgroundColor: t.colors.$colorBackground,
position: 'relative',
borderRadius: t.radii.$lg,
width: '100%',
overflow: 'hidden',
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$solid,
borderColor: t.colors.$borderAlpha150,
marginBlock: '-1px',
marginInlineEnd: '-1px',
flex: 1,
})}
>
<ConfigureSSOFlowProvider
enterpriseConnection={enterpriseConnection}
isLoading={isLoadingEnterpriseConnections}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think passing the initial isLoading down to the context and rendering it on the wizard might lead us to issues when invalidating the query, and also for instance, when we start determining the current step after a refresh I think it would be good to have the loading before the wizard even renders, so what do you think of lifting the initial loading state here to ConfigureSSO root? Something like:

constAuthenticatedContent=withCoreUserGuard(()=>{const{ data, isLoading }=__internal_useUserEnterpriseConnections({enabled: true});if(isLoading&&!data){return<FullSpinner/>;}return(// …existing layout…<ConfigureSSOFlowProviderenterpriseConnection={data?.[0]}><ConfigureSSOSteps/></ConfigureSSOFlowProvider>);});

Happy to take this as a separate PR if you'd rather keep this one tight.

>
<ConfigureSSOSteps />
</ConfigureSSOFlowProvider>
</Col>
</NavbarContextProvider>
</ProfileCard.Root>
);
});

const ConfigureSSOSteps = () => {
const { user } = useUser();

const primaryEmailAddress = user?.primaryEmailAddress;

return (
<ConfigureSSOWizard>
<ConfigureSSOWizard.Step
id='verify-email-domain'
path='verify-email-domain'
label='Verify domain'
>
<ConfigureSSOWizard>
{!primaryEmailAddress && (
<ConfigureSSOWizard.Step
id='provide-email'
path='provide-email'
>
<ProvideEmail />
</ConfigureSSOWizard.Step>
)}
<ConfigureSSOWizard.Step
id='verify-domain'
path='verify-domain'
>
<VerifyDomainStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='configure'
path='configure'
label='Configure'
>
<ConfigureSSOWizard>
{/* TODO: Implement configure steps */}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{/* TODO: Implement configure steps */}

<ConfigureSSOWizard.Step
id='create-app'
path='create-app'
>
<ConfigureCreateApp />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='test'
path='test'
label='Test'
>
<TestConfigurationStep />
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='confirmation'
path='confirmation'
label='Confirmation'
>
<ConfirmationStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
);
};

const OrganizationSidebarSubtitle = () => {
const { organization } = useOrganization();

Expand Down
52 changes: 52 additions & 0 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSOContext.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
import type { EnterpriseConnectionResource } from '@clerk/shared/types';
import React, { type PropsWithChildren } from 'react';

/**
* Shared form state for the ConfigureSSO wizard, persisted across steps
*/
export interface ConfigureSSOData {
/**
* The enterprise connection from the user's primary email address domain
*/
enterpriseConnection: EnterpriseConnectionResource | undefined;
}

export interface ConfigureSSOContextValue extends ConfigureSSOData {
/**
* `true` while the parent is still fetching the user's enterprise
* connection
*/
isLoading: boolean;
}

interface ConfigureSSOFlowProviderProps {
enterpriseConnection: EnterpriseConnectionResource | undefined;
isLoading: boolean;
}

const ConfigureSSOFlowContext = React.createContext<ConfigureSSOContextValue | null>(null);
ConfigureSSOFlowContext.displayName = 'ConfigureSSOFlowContext';

export const ConfigureSSOFlowProvider = ({
enterpriseConnection,
isLoading,
children,
}: PropsWithChildren<ConfigureSSOFlowProviderProps>): JSX.Element => {
const value = React.useMemo<ConfigureSSOContextValue>(
() => ({
enterpriseConnection,
isLoading,
}),
[enterpriseConnection, isLoading],
);

return <ConfigureSSOFlowContext.Provider value={value}>{children}</ConfigureSSOFlowContext.Provider>;
};

export const useConfigureSSOFlow = (): ConfigureSSOContextValue => {
const ctx = React.useContext(ConfigureSSOFlowContext);
if (!ctx) {
throw new Error('useConfigureSSOFlow called outside <ConfigureSSOFlowProvider>.');
}
return ctx;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ConfigureCreateApp = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => goNext(),
});

return (
<Flow.Part part='configureCreateApp'>
<StepLayout
title='Configure Okta Workforce'
subtitle='Create a new enterprise application in your Okta Dashboard.'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const ConfirmationStep = (): JSX.Element => {
return (
<Flow.Part part='sso-confirmation'>
<StepLayout>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ProvideEmail = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => {
return goNext();
},
});

return (
<Flow.Part part='provideEmail'>
<StepLayout
title='Verify your domain'
subtitle='Verify the domain you want to enable the enterprise connection on.'
>
<Text as='p'>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
69 changes: 69 additions & 0 deletions packages/ui/src/components/ConfigureSSO/steps/StepLayout.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import React from 'react';

import { Col, Flex, Heading, Text } from '@/customizables';

import { ConfigureSSOWizard } from '../wizard';

interface StepLayoutProps {
title?: React.ReactNode;
subtitle?: React.ReactNode;
children: React.ReactNode;
}

/**
* Renders the title row (with the Wizard's Step X/Y badge) on top, a divider, and the step body
* underneath. Each individual step file owns the body content
*
* The Step X/Y badge is rendered via `ConfigureSSOWizard.StepIndicator`,
* which self-hides on steps that have no inner sub-steps
*/
export const StepLayout = ({ title, subtitle, children }: StepLayoutProps): JSX.Element => {
return (
<Col
sx={{
flex: 1,
minHeight: 0,
}}
>
<Flex
align='center'
justify='between'
sx={theme => ({
gap: theme.space.$4,
padding: theme.space.$5,
})}
>
{title ? (
<Col sx={theme => ({ gap: theme.space.$1, minWidth: 0 })}>
<Heading
textVariant='h3'
sx={theme => ({ color: theme.colors.$colorForeground, fontSize: theme.fontSizes.$lg })}
>
{title}
</Heading>

{subtitle ? (
<Text
as='p'
variant='body'
sx={theme => ({ color: theme.colors.$colorMutedForeground })}
>
{subtitle}
</Text>
) : null}
</Col>
) : null}
<ConfigureSSOWizard.StepIndicator />
</Flex>
<Col
sx={theme => ({
flex: 1,
paddingInline: theme.space.$5,
overflowY: 'auto',
})}
>
{children}
</Col>
</Col>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const TestConfigurationStep = (): JSX.Element => {
return (
<Flow.Part part='test-sso'>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the convention for Flow.Part part= is camelCase across Sign-In / Sign-Up / SessionTasks / UserVerification (phoneCode2Fa, alternativeMethods, enterpriseConnections, chooseOrganization, etc.). The four other ConfigureSSO steps already follow that — only test-sso here and sso-confirmation in ConfirmationStep are kebab-case.

<StepLayout
title='Test your SSO connection'
subtitle='Test your SSO configuration to verify you can successfully authenticate via your identity provider'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/lucky-tables-learn.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add wizard steps for the `<__experimental_ConfigureSSO />` component
9 changes: 9 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1457,6 +1457,15 @@ export class Clerk implements ClerkInterface {
return;
}

if (noUserExists(this)) {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this one that got missed on the first PR

if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderConfigureSSOComponentWhenUserDoesNotExist, {
code: CANNOT_RENDER_USER_MISSING_ERROR_CODE,
});
}
return;
}

this.assertComponentsReady(this.#clerkUI);
const component = 'ConfigureSSO';
void this.#clerkUI
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/src/internal/clerk-js/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@ const warnings = {
'The <APIKeys/> component cannot be rendered when organization API keys are disabled. Since organization API keys are disabled, this is no-op.',
cannotRenderOAuthConsentComponentWhenUserDoesNotExist:
'<OAuthConsent/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
cannotRenderConfigureSSOComponentWhenUserDoesNotExist:
'<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.',
cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
Expand Down
112 changes: 102 additions & 10 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSO.tsx
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
import { useOrganization} from '@clerk/shared/react/index';
import { __internal_useUserEnterpriseConnections, useOrganization, useUser } from '@clerk/shared/react';
import type { __experimental_ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { useEnvironment, withCoreUserGuard } from '@/contexts';
import { Box, Col, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { Box, Col, descriptors, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { ApplicationLogo } from '@/elements/ApplicationLogo';
import { withCardStateProvider } from '@/elements/contexts';
import { NavBar, NavbarContextProvider } from '@/elements/Navbar';
import { ProfileCard } from '@/elements/ProfileCard';
import { BoxIcon } from '@/icons';
import { Route, Switch } from '@/router';

import { ConfigureSSOFlowProvider } from './ConfigureSSOContext';
import { ConfigureCreateApp, ConfirmationStep, ProvideEmail, TestConfigurationStep, VerifyDomainStep } from './steps';
import { ConfigureSSOWizard } from './wizard';

const ConfigureSSOInternal = () => {
return (
<Flow.Root flow='configureSSO'>
<Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Root>
);
};
Expand All@@ -32,6 +34,11 @@ const AuthenticatedContent = withCoreUserGuard(() => {
const { parsedOptions } = useAppearance();
const hasLogo = Boolean(parsedOptions.logoImageUrl || logoImageUrl);

const { data: enterpriseConnections, isLoading: isLoadingEnterpriseConnections } =
__internal_useUserEnterpriseConnections({ enabled: true });
// Currently FAPI only supports one enterprise connection per user
const enterpriseConnection = enterpriseConnections?.[0];

return (
<ProfileCard.Root
sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
Expand DownExpand Up@@ -89,12 +96,97 @@ const AuthenticatedContent = withCoreUserGuard(() => {
routes={[]}
contentRef={contentRef}
/>
<ProfileCard.Content contentRef={contentRef} />
<Col
ref={contentRef}
elementDescriptor={descriptors.scrollBox}
sx={t => ({
backgroundColor: t.colors.$colorBackground,
position: 'relative',
borderRadius: t.radii.$lg,
width: '100%',
overflow: 'hidden',
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$solid,
borderColor: t.colors.$borderAlpha150,
marginBlock: '-1px',
marginInlineEnd: '-1px',
flex: 1,
})}
>
<ConfigureSSOFlowProvider
enterpriseConnection={enterpriseConnection}
isLoading={isLoadingEnterpriseConnections}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think passing the initial isLoading down to the context and rendering it on the wizard might lead us to issues when invalidating the query, and also for instance, when we start determining the current step after a refresh I think it would be good to have the loading before the wizard even renders, so what do you think of lifting the initial loading state here to ConfigureSSO root? Something like:

constAuthenticatedContent=withCoreUserGuard(()=>{const{ data, isLoading }=__internal_useUserEnterpriseConnections({enabled: true});if(isLoading&&!data){return<FullSpinner/>;}return(// …existing layout…<ConfigureSSOFlowProviderenterpriseConnection={data?.[0]}><ConfigureSSOSteps/></ConfigureSSOFlowProvider>);});

Happy to take this as a separate PR if you'd rather keep this one tight.

>
<ConfigureSSOSteps />
</ConfigureSSOFlowProvider>
</Col>
</NavbarContextProvider>
</ProfileCard.Root>
);
});

const ConfigureSSOSteps = () => {
const { user } = useUser();

const primaryEmailAddress = user?.primaryEmailAddress;

return (
<ConfigureSSOWizard>
<ConfigureSSOWizard.Step
id='verify-email-domain'
path='verify-email-domain'
label='Verify domain'
>
<ConfigureSSOWizard>
{!primaryEmailAddress && (
<ConfigureSSOWizard.Step
id='provide-email'
path='provide-email'
>
<ProvideEmail />
</ConfigureSSOWizard.Step>
)}
<ConfigureSSOWizard.Step
id='verify-domain'
path='verify-domain'
>
<VerifyDomainStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='configure'
path='configure'
label='Configure'
>
<ConfigureSSOWizard>
{/* TODO: Implement configure steps */}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{/* TODO: Implement configure steps */}

<ConfigureSSOWizard.Step
id='create-app'
path='create-app'
>
<ConfigureCreateApp />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='test'
path='test'
label='Test'
>
<TestConfigurationStep />
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='confirmation'
path='confirmation'
label='Confirmation'
>
<ConfirmationStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
);
};

const OrganizationSidebarSubtitle = () => {
const { organization } = useOrganization();

Expand Down
52 changes: 52 additions & 0 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSOContext.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
import type { EnterpriseConnectionResource } from '@clerk/shared/types';
import React, { type PropsWithChildren } from 'react';

/**
* Shared form state for the ConfigureSSO wizard, persisted across steps
*/
export interface ConfigureSSOData {
/**
* The enterprise connection from the user's primary email address domain
*/
enterpriseConnection: EnterpriseConnectionResource | undefined;
}

export interface ConfigureSSOContextValue extends ConfigureSSOData {
/**
* `true` while the parent is still fetching the user's enterprise
* connection
*/
isLoading: boolean;
}

interface ConfigureSSOFlowProviderProps {
enterpriseConnection: EnterpriseConnectionResource | undefined;
isLoading: boolean;
}

const ConfigureSSOFlowContext = React.createContext<ConfigureSSOContextValue | null>(null);
ConfigureSSOFlowContext.displayName = 'ConfigureSSOFlowContext';

export const ConfigureSSOFlowProvider = ({
enterpriseConnection,
isLoading,
children,
}: PropsWithChildren<ConfigureSSOFlowProviderProps>): JSX.Element => {
const value = React.useMemo<ConfigureSSOContextValue>(
() => ({
enterpriseConnection,
isLoading,
}),
[enterpriseConnection, isLoading],
);

return <ConfigureSSOFlowContext.Provider value={value}>{children}</ConfigureSSOFlowContext.Provider>;
};

export const useConfigureSSOFlow = (): ConfigureSSOContextValue => {
const ctx = React.useContext(ConfigureSSOFlowContext);
if (!ctx) {
throw new Error('useConfigureSSOFlow called outside <ConfigureSSOFlowProvider>.');
}
return ctx;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ConfigureCreateApp = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => goNext(),
});

return (
<Flow.Part part='configureCreateApp'>
<StepLayout
title='Configure Okta Workforce'
subtitle='Create a new enterprise application in your Okta Dashboard.'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const ConfirmationStep = (): JSX.Element => {
return (
<Flow.Part part='sso-confirmation'>
<StepLayout>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ProvideEmail = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => {
return goNext();
},
});

return (
<Flow.Part part='provideEmail'>
<StepLayout
title='Verify your domain'
subtitle='Verify the domain you want to enable the enterprise connection on.'
>
<Text as='p'>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
69 changes: 69 additions & 0 deletions packages/ui/src/components/ConfigureSSO/steps/StepLayout.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import React from 'react';

import { Col, Flex, Heading, Text } from '@/customizables';

import { ConfigureSSOWizard } from '../wizard';

interface StepLayoutProps {
title?: React.ReactNode;
subtitle?: React.ReactNode;
children: React.ReactNode;
}

/**
* Renders the title row (with the Wizard's Step X/Y badge) on top, a divider, and the step body
* underneath. Each individual step file owns the body content
*
* The Step X/Y badge is rendered via `ConfigureSSOWizard.StepIndicator`,
* which self-hides on steps that have no inner sub-steps
*/
export const StepLayout = ({ title, subtitle, children }: StepLayoutProps): JSX.Element => {
return (
<Col
sx={{
flex: 1,
minHeight: 0,
}}
>
<Flex
align='center'
justify='between'
sx={theme => ({
gap: theme.space.$4,
padding: theme.space.$5,
})}
>
{title ? (
<Col sx={theme => ({ gap: theme.space.$1, minWidth: 0 })}>
<Heading
textVariant='h3'
sx={theme => ({ color: theme.colors.$colorForeground, fontSize: theme.fontSizes.$lg })}
>
{title}
</Heading>

{subtitle ? (
<Text
as='p'
variant='body'
sx={theme => ({ color: theme.colors.$colorMutedForeground })}
>
{subtitle}
</Text>
) : null}
</Col>
) : null}
<ConfigureSSOWizard.StepIndicator />
</Flex>
<Col
sx={theme => ({
flex: 1,
paddingInline: theme.space.$5,
overflowY: 'auto',
})}
>
{children}
</Col>
</Col>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const TestConfigurationStep = (): JSX.Element => {
return (
<Flow.Part part='test-sso'>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the convention for Flow.Part part= is camelCase across Sign-In / Sign-Up / SessionTasks / UserVerification (phoneCode2Fa, alternativeMethods, enterpriseConnections, chooseOrganization, etc.). The four other ConfigureSSO steps already follow that — only test-sso here and sso-confirmation in ConfirmationStep are kebab-case.

<StepLayout
title='Test your SSO connection'
subtitle='Test your SSO configuration to verify you can successfully authenticate via your identity provider'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/lucky-tables-learn.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add wizard steps for the `<__experimental_ConfigureSSO />` component
9 changes: 9 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1457,6 +1457,15 @@ export class Clerk implements ClerkInterface {
return;
}

if (noUserExists(this)) {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this one that got missed on the first PR

if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderConfigureSSOComponentWhenUserDoesNotExist, {
code: CANNOT_RENDER_USER_MISSING_ERROR_CODE,
});
}
return;
}

this.assertComponentsReady(this.#clerkUI);
const component = 'ConfigureSSO';
void this.#clerkUI
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/src/internal/clerk-js/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@ const warnings = {
'The <APIKeys/> component cannot be rendered when organization API keys are disabled. Since organization API keys are disabled, this is no-op.',
cannotRenderOAuthConsentComponentWhenUserDoesNotExist:
'<OAuthConsent/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
cannotRenderConfigureSSOComponentWhenUserDoesNotExist:
'<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.',
cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
Expand Down
112 changes: 102 additions & 10 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSO.tsx
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
import { useOrganization} from '@clerk/shared/react/index';
import { __internal_useUserEnterpriseConnections, useOrganization, useUser } from '@clerk/shared/react';
import type { __experimental_ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { useEnvironment, withCoreUserGuard } from '@/contexts';
import { Box, Col, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { Box, Col, descriptors, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { ApplicationLogo } from '@/elements/ApplicationLogo';
import { withCardStateProvider } from '@/elements/contexts';
import { NavBar, NavbarContextProvider } from '@/elements/Navbar';
import { ProfileCard } from '@/elements/ProfileCard';
import { BoxIcon } from '@/icons';
import { Route, Switch } from '@/router';

import { ConfigureSSOFlowProvider } from './ConfigureSSOContext';
import { ConfigureCreateApp, ConfirmationStep, ProvideEmail, TestConfigurationStep, VerifyDomainStep } from './steps';
import { ConfigureSSOWizard } from './wizard';

const ConfigureSSOInternal = () => {
return (
<Flow.Root flow='configureSSO'>
<Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Root>
);
};
Expand All@@ -32,6 +34,11 @@ const AuthenticatedContent = withCoreUserGuard(() => {
const { parsedOptions } = useAppearance();
const hasLogo = Boolean(parsedOptions.logoImageUrl || logoImageUrl);

const { data: enterpriseConnections, isLoading: isLoadingEnterpriseConnections } =
__internal_useUserEnterpriseConnections({ enabled: true });
// Currently FAPI only supports one enterprise connection per user
const enterpriseConnection = enterpriseConnections?.[0];

return (
<ProfileCard.Root
sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
Expand DownExpand Up@@ -89,12 +96,97 @@ const AuthenticatedContent = withCoreUserGuard(() => {
routes={[]}
contentRef={contentRef}
/>
<ProfileCard.Content contentRef={contentRef} />
<Col
ref={contentRef}
elementDescriptor={descriptors.scrollBox}
sx={t => ({
backgroundColor: t.colors.$colorBackground,
position: 'relative',
borderRadius: t.radii.$lg,
width: '100%',
overflow: 'hidden',
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$solid,
borderColor: t.colors.$borderAlpha150,
marginBlock: '-1px',
marginInlineEnd: '-1px',
flex: 1,
})}
>
<ConfigureSSOFlowProvider
enterpriseConnection={enterpriseConnection}
isLoading={isLoadingEnterpriseConnections}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think passing the initial isLoading down to the context and rendering it on the wizard might lead us to issues when invalidating the query, and also for instance, when we start determining the current step after a refresh I think it would be good to have the loading before the wizard even renders, so what do you think of lifting the initial loading state here to ConfigureSSO root? Something like:

constAuthenticatedContent=withCoreUserGuard(()=>{const{ data, isLoading }=__internal_useUserEnterpriseConnections({enabled: true});if(isLoading&&!data){return<FullSpinner/>;}return(// …existing layout…<ConfigureSSOFlowProviderenterpriseConnection={data?.[0]}><ConfigureSSOSteps/></ConfigureSSOFlowProvider>);});

Happy to take this as a separate PR if you'd rather keep this one tight.

>
<ConfigureSSOSteps />
</ConfigureSSOFlowProvider>
</Col>
</NavbarContextProvider>
</ProfileCard.Root>
);
});

const ConfigureSSOSteps = () => {
const { user } = useUser();

const primaryEmailAddress = user?.primaryEmailAddress;

return (
<ConfigureSSOWizard>
<ConfigureSSOWizard.Step
id='verify-email-domain'
path='verify-email-domain'
label='Verify domain'
>
<ConfigureSSOWizard>
{!primaryEmailAddress && (
<ConfigureSSOWizard.Step
id='provide-email'
path='provide-email'
>
<ProvideEmail />
</ConfigureSSOWizard.Step>
)}
<ConfigureSSOWizard.Step
id='verify-domain'
path='verify-domain'
>
<VerifyDomainStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='configure'
path='configure'
label='Configure'
>
<ConfigureSSOWizard>
{/* TODO: Implement configure steps */}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{/* TODO: Implement configure steps */}

<ConfigureSSOWizard.Step
id='create-app'
path='create-app'
>
<ConfigureCreateApp />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='test'
path='test'
label='Test'
>
<TestConfigurationStep />
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='confirmation'
path='confirmation'
label='Confirmation'
>
<ConfirmationStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
);
};

const OrganizationSidebarSubtitle = () => {
const { organization } = useOrganization();

Expand Down
52 changes: 52 additions & 0 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSOContext.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
import type { EnterpriseConnectionResource } from '@clerk/shared/types';
import React, { type PropsWithChildren } from 'react';

/**
* Shared form state for the ConfigureSSO wizard, persisted across steps
*/
export interface ConfigureSSOData {
/**
* The enterprise connection from the user's primary email address domain
*/
enterpriseConnection: EnterpriseConnectionResource | undefined;
}

export interface ConfigureSSOContextValue extends ConfigureSSOData {
/**
* `true` while the parent is still fetching the user's enterprise
* connection
*/
isLoading: boolean;
}

interface ConfigureSSOFlowProviderProps {
enterpriseConnection: EnterpriseConnectionResource | undefined;
isLoading: boolean;
}

const ConfigureSSOFlowContext = React.createContext<ConfigureSSOContextValue | null>(null);
ConfigureSSOFlowContext.displayName = 'ConfigureSSOFlowContext';

export const ConfigureSSOFlowProvider = ({
enterpriseConnection,
isLoading,
children,
}: PropsWithChildren<ConfigureSSOFlowProviderProps>): JSX.Element => {
const value = React.useMemo<ConfigureSSOContextValue>(
() => ({
enterpriseConnection,
isLoading,
}),
[enterpriseConnection, isLoading],
);

return <ConfigureSSOFlowContext.Provider value={value}>{children}</ConfigureSSOFlowContext.Provider>;
};

export const useConfigureSSOFlow = (): ConfigureSSOContextValue => {
const ctx = React.useContext(ConfigureSSOFlowContext);
if (!ctx) {
throw new Error('useConfigureSSOFlow called outside <ConfigureSSOFlowProvider>.');
}
return ctx;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ConfigureCreateApp = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => goNext(),
});

return (
<Flow.Part part='configureCreateApp'>
<StepLayout
title='Configure Okta Workforce'
subtitle='Create a new enterprise application in your Okta Dashboard.'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const ConfirmationStep = (): JSX.Element => {
return (
<Flow.Part part='sso-confirmation'>
<StepLayout>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ProvideEmail = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => {
return goNext();
},
});

return (
<Flow.Part part='provideEmail'>
<StepLayout
title='Verify your domain'
subtitle='Verify the domain you want to enable the enterprise connection on.'
>
<Text as='p'>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
69 changes: 69 additions & 0 deletions packages/ui/src/components/ConfigureSSO/steps/StepLayout.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import React from 'react';

import { Col, Flex, Heading, Text } from '@/customizables';

import { ConfigureSSOWizard } from '../wizard';

interface StepLayoutProps {
title?: React.ReactNode;
subtitle?: React.ReactNode;
children: React.ReactNode;
}

/**
* Renders the title row (with the Wizard's Step X/Y badge) on top, a divider, and the step body
* underneath. Each individual step file owns the body content
*
* The Step X/Y badge is rendered via `ConfigureSSOWizard.StepIndicator`,
* which self-hides on steps that have no inner sub-steps
*/
export const StepLayout = ({ title, subtitle, children }: StepLayoutProps): JSX.Element => {
return (
<Col
sx={{
flex: 1,
minHeight: 0,
}}
>
<Flex
align='center'
justify='between'
sx={theme => ({
gap: theme.space.$4,
padding: theme.space.$5,
})}
>
{title ? (
<Col sx={theme => ({ gap: theme.space.$1, minWidth: 0 })}>
<Heading
textVariant='h3'
sx={theme => ({ color: theme.colors.$colorForeground, fontSize: theme.fontSizes.$lg })}
>
{title}
</Heading>

{subtitle ? (
<Text
as='p'
variant='body'
sx={theme => ({ color: theme.colors.$colorMutedForeground })}
>
{subtitle}
</Text>
) : null}
</Col>
) : null}
<ConfigureSSOWizard.StepIndicator />
</Flex>
<Col
sx={theme => ({
flex: 1,
paddingInline: theme.space.$5,
overflowY: 'auto',
})}
>
{children}
</Col>
</Col>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const TestConfigurationStep = (): JSX.Element => {
return (
<Flow.Part part='test-sso'>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the convention for Flow.Part part= is camelCase across Sign-In / Sign-Up / SessionTasks / UserVerification (phoneCode2Fa, alternativeMethods, enterpriseConnections, chooseOrganization, etc.). The four other ConfigureSSO steps already follow that — only test-sso here and sso-confirmation in ConfirmationStep are kebab-case.

<StepLayout
title='Test your SSO connection'
subtitle='Test your SSO configuration to verify you can successfully authenticate via your identity provider'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/lucky-tables-learn.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add wizard steps for the `<__experimental_ConfigureSSO />` component
9 changes: 9 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1457,6 +1457,15 @@ export class Clerk implements ClerkInterface {
return;
}

if (noUserExists(this)) {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this one that got missed on the first PR

if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderConfigureSSOComponentWhenUserDoesNotExist, {
code: CANNOT_RENDER_USER_MISSING_ERROR_CODE,
});
}
return;
}

this.assertComponentsReady(this.#clerkUI);
const component = 'ConfigureSSO';
void this.#clerkUI
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/src/internal/clerk-js/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@ const warnings = {
'The <APIKeys/> component cannot be rendered when organization API keys are disabled. Since organization API keys are disabled, this is no-op.',
cannotRenderOAuthConsentComponentWhenUserDoesNotExist:
'<OAuthConsent/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
cannotRenderConfigureSSOComponentWhenUserDoesNotExist:
'<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.',
cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
Expand Down
112 changes: 102 additions & 10 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSO.tsx
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
import { useOrganization} from '@clerk/shared/react/index';
import { __internal_useUserEnterpriseConnections, useOrganization, useUser } from '@clerk/shared/react';
import type { __experimental_ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { useEnvironment, withCoreUserGuard } from '@/contexts';
import { Box, Col, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { Box, Col, descriptors, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { ApplicationLogo } from '@/elements/ApplicationLogo';
import { withCardStateProvider } from '@/elements/contexts';
import { NavBar, NavbarContextProvider } from '@/elements/Navbar';
import { ProfileCard } from '@/elements/ProfileCard';
import { BoxIcon } from '@/icons';
import { Route, Switch } from '@/router';

import { ConfigureSSOFlowProvider } from './ConfigureSSOContext';
import { ConfigureCreateApp, ConfirmationStep, ProvideEmail, TestConfigurationStep, VerifyDomainStep } from './steps';
import { ConfigureSSOWizard } from './wizard';

const ConfigureSSOInternal = () => {
return (
<Flow.Root flow='configureSSO'>
<Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Root>
);
};
Expand All@@ -32,6 +34,11 @@ const AuthenticatedContent = withCoreUserGuard(() => {
const { parsedOptions } = useAppearance();
const hasLogo = Boolean(parsedOptions.logoImageUrl || logoImageUrl);

const { data: enterpriseConnections, isLoading: isLoadingEnterpriseConnections } =
__internal_useUserEnterpriseConnections({ enabled: true });
// Currently FAPI only supports one enterprise connection per user
const enterpriseConnection = enterpriseConnections?.[0];

return (
<ProfileCard.Root
sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
Expand DownExpand Up@@ -89,12 +96,97 @@ const AuthenticatedContent = withCoreUserGuard(() => {
routes={[]}
contentRef={contentRef}
/>
<ProfileCard.Content contentRef={contentRef} />
<Col
ref={contentRef}
elementDescriptor={descriptors.scrollBox}
sx={t => ({
backgroundColor: t.colors.$colorBackground,
position: 'relative',
borderRadius: t.radii.$lg,
width: '100%',
overflow: 'hidden',
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$solid,
borderColor: t.colors.$borderAlpha150,
marginBlock: '-1px',
marginInlineEnd: '-1px',
flex: 1,
})}
>
<ConfigureSSOFlowProvider
enterpriseConnection={enterpriseConnection}
isLoading={isLoadingEnterpriseConnections}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think passing the initial isLoading down to the context and rendering it on the wizard might lead us to issues when invalidating the query, and also for instance, when we start determining the current step after a refresh I think it would be good to have the loading before the wizard even renders, so what do you think of lifting the initial loading state here to ConfigureSSO root? Something like:

constAuthenticatedContent=withCoreUserGuard(()=>{const{ data, isLoading }=__internal_useUserEnterpriseConnections({enabled: true});if(isLoading&&!data){return<FullSpinner/>;}return(// …existing layout…<ConfigureSSOFlowProviderenterpriseConnection={data?.[0]}><ConfigureSSOSteps/></ConfigureSSOFlowProvider>);});

Happy to take this as a separate PR if you'd rather keep this one tight.

>
<ConfigureSSOSteps />
</ConfigureSSOFlowProvider>
</Col>
</NavbarContextProvider>
</ProfileCard.Root>
);
});

const ConfigureSSOSteps = () => {
const { user } = useUser();

const primaryEmailAddress = user?.primaryEmailAddress;

return (
<ConfigureSSOWizard>
<ConfigureSSOWizard.Step
id='verify-email-domain'
path='verify-email-domain'
label='Verify domain'
>
<ConfigureSSOWizard>
{!primaryEmailAddress && (
<ConfigureSSOWizard.Step
id='provide-email'
path='provide-email'
>
<ProvideEmail />
</ConfigureSSOWizard.Step>
)}
<ConfigureSSOWizard.Step
id='verify-domain'
path='verify-domain'
>
<VerifyDomainStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='configure'
path='configure'
label='Configure'
>
<ConfigureSSOWizard>
{/* TODO: Implement configure steps */}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{/* TODO: Implement configure steps */}

<ConfigureSSOWizard.Step
id='create-app'
path='create-app'
>
<ConfigureCreateApp />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='test'
path='test'
label='Test'
>
<TestConfigurationStep />
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='confirmation'
path='confirmation'
label='Confirmation'
>
<ConfirmationStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
);
};

const OrganizationSidebarSubtitle = () => {
const { organization } = useOrganization();

Expand Down
52 changes: 52 additions & 0 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSOContext.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
import type { EnterpriseConnectionResource } from '@clerk/shared/types';
import React, { type PropsWithChildren } from 'react';

/**
* Shared form state for the ConfigureSSO wizard, persisted across steps
*/
export interface ConfigureSSOData {
/**
* The enterprise connection from the user's primary email address domain
*/
enterpriseConnection: EnterpriseConnectionResource | undefined;
}

export interface ConfigureSSOContextValue extends ConfigureSSOData {
/**
* `true` while the parent is still fetching the user's enterprise
* connection
*/
isLoading: boolean;
}

interface ConfigureSSOFlowProviderProps {
enterpriseConnection: EnterpriseConnectionResource | undefined;
isLoading: boolean;
}

const ConfigureSSOFlowContext = React.createContext<ConfigureSSOContextValue | null>(null);
ConfigureSSOFlowContext.displayName = 'ConfigureSSOFlowContext';

export const ConfigureSSOFlowProvider = ({
enterpriseConnection,
isLoading,
children,
}: PropsWithChildren<ConfigureSSOFlowProviderProps>): JSX.Element => {
const value = React.useMemo<ConfigureSSOContextValue>(
() => ({
enterpriseConnection,
isLoading,
}),
[enterpriseConnection, isLoading],
);

return <ConfigureSSOFlowContext.Provider value={value}>{children}</ConfigureSSOFlowContext.Provider>;
};

export const useConfigureSSOFlow = (): ConfigureSSOContextValue => {
const ctx = React.useContext(ConfigureSSOFlowContext);
if (!ctx) {
throw new Error('useConfigureSSOFlow called outside <ConfigureSSOFlowProvider>.');
}
return ctx;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ConfigureCreateApp = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => goNext(),
});

return (
<Flow.Part part='configureCreateApp'>
<StepLayout
title='Configure Okta Workforce'
subtitle='Create a new enterprise application in your Okta Dashboard.'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const ConfirmationStep = (): JSX.Element => {
return (
<Flow.Part part='sso-confirmation'>
<StepLayout>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ProvideEmail = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => {
return goNext();
},
});

return (
<Flow.Part part='provideEmail'>
<StepLayout
title='Verify your domain'
subtitle='Verify the domain you want to enable the enterprise connection on.'
>
<Text as='p'>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
69 changes: 69 additions & 0 deletions packages/ui/src/components/ConfigureSSO/steps/StepLayout.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import React from 'react';

import { Col, Flex, Heading, Text } from '@/customizables';

import { ConfigureSSOWizard } from '../wizard';

interface StepLayoutProps {
title?: React.ReactNode;
subtitle?: React.ReactNode;
children: React.ReactNode;
}

/**
* Renders the title row (with the Wizard's Step X/Y badge) on top, a divider, and the step body
* underneath. Each individual step file owns the body content
*
* The Step X/Y badge is rendered via `ConfigureSSOWizard.StepIndicator`,
* which self-hides on steps that have no inner sub-steps
*/
export const StepLayout = ({ title, subtitle, children }: StepLayoutProps): JSX.Element => {
return (
<Col
sx={{
flex: 1,
minHeight: 0,
}}
>
<Flex
align='center'
justify='between'
sx={theme => ({
gap: theme.space.$4,
padding: theme.space.$5,
})}
>
{title ? (
<Col sx={theme => ({ gap: theme.space.$1, minWidth: 0 })}>
<Heading
textVariant='h3'
sx={theme => ({ color: theme.colors.$colorForeground, fontSize: theme.fontSizes.$lg })}
>
{title}
</Heading>

{subtitle ? (
<Text
as='p'
variant='body'
sx={theme => ({ color: theme.colors.$colorMutedForeground })}
>
{subtitle}
</Text>
) : null}
</Col>
) : null}
<ConfigureSSOWizard.StepIndicator />
</Flex>
<Col
sx={theme => ({
flex: 1,
paddingInline: theme.space.$5,
overflowY: 'auto',
})}
>
{children}
</Col>
</Col>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const TestConfigurationStep = (): JSX.Element => {
return (
<Flow.Part part='test-sso'>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the convention for Flow.Part part= is camelCase across Sign-In / Sign-Up / SessionTasks / UserVerification (phoneCode2Fa, alternativeMethods, enterpriseConnections, chooseOrganization, etc.). The four other ConfigureSSO steps already follow that — only test-sso here and sso-confirmation in ConfirmationStep are kebab-case.

<StepLayout
title='Test your SSO connection'
subtitle='Test your SSO configuration to verify you can successfully authenticate via your identity provider'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/lucky-tables-learn.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add wizard steps for the `<__experimental_ConfigureSSO />` component
9 changes: 9 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1457,6 +1457,15 @@ export class Clerk implements ClerkInterface {
return;
}

if (noUserExists(this)) {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this one that got missed on the first PR

if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderConfigureSSOComponentWhenUserDoesNotExist, {
code: CANNOT_RENDER_USER_MISSING_ERROR_CODE,
});
}
return;
}

this.assertComponentsReady(this.#clerkUI);
const component = 'ConfigureSSO';
void this.#clerkUI
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/src/internal/clerk-js/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@ const warnings = {
'The <APIKeys/> component cannot be rendered when organization API keys are disabled. Since organization API keys are disabled, this is no-op.',
cannotRenderOAuthConsentComponentWhenUserDoesNotExist:
'<OAuthConsent/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
cannotRenderConfigureSSOComponentWhenUserDoesNotExist:
'<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.',
cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
Expand Down
112 changes: 102 additions & 10 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSO.tsx
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
import { useOrganization} from '@clerk/shared/react/index';
import { __internal_useUserEnterpriseConnections, useOrganization, useUser } from '@clerk/shared/react';
import type { __experimental_ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { useEnvironment, withCoreUserGuard } from '@/contexts';
import { Box, Col, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { Box, Col, descriptors, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { ApplicationLogo } from '@/elements/ApplicationLogo';
import { withCardStateProvider } from '@/elements/contexts';
import { NavBar, NavbarContextProvider } from '@/elements/Navbar';
import { ProfileCard } from '@/elements/ProfileCard';
import { BoxIcon } from '@/icons';
import { Route, Switch } from '@/router';

import { ConfigureSSOFlowProvider } from './ConfigureSSOContext';
import { ConfigureCreateApp, ConfirmationStep, ProvideEmail, TestConfigurationStep, VerifyDomainStep } from './steps';
import { ConfigureSSOWizard } from './wizard';

const ConfigureSSOInternal = () => {
return (
<Flow.Root flow='configureSSO'>
<Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Root>
);
};
Expand All@@ -32,6 +34,11 @@ const AuthenticatedContent = withCoreUserGuard(() => {
const { parsedOptions } = useAppearance();
const hasLogo = Boolean(parsedOptions.logoImageUrl || logoImageUrl);

const { data: enterpriseConnections, isLoading: isLoadingEnterpriseConnections } =
__internal_useUserEnterpriseConnections({ enabled: true });
// Currently FAPI only supports one enterprise connection per user
const enterpriseConnection = enterpriseConnections?.[0];

return (
<ProfileCard.Root
sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
Expand DownExpand Up@@ -89,12 +96,97 @@ const AuthenticatedContent = withCoreUserGuard(() => {
routes={[]}
contentRef={contentRef}
/>
<ProfileCard.Content contentRef={contentRef} />
<Col
ref={contentRef}
elementDescriptor={descriptors.scrollBox}
sx={t => ({
backgroundColor: t.colors.$colorBackground,
position: 'relative',
borderRadius: t.radii.$lg,
width: '100%',
overflow: 'hidden',
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$solid,
borderColor: t.colors.$borderAlpha150,
marginBlock: '-1px',
marginInlineEnd: '-1px',
flex: 1,
})}
>
<ConfigureSSOFlowProvider
enterpriseConnection={enterpriseConnection}
isLoading={isLoadingEnterpriseConnections}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think passing the initial isLoading down to the context and rendering it on the wizard might lead us to issues when invalidating the query, and also for instance, when we start determining the current step after a refresh I think it would be good to have the loading before the wizard even renders, so what do you think of lifting the initial loading state here to ConfigureSSO root? Something like:

constAuthenticatedContent=withCoreUserGuard(()=>{const{ data, isLoading }=__internal_useUserEnterpriseConnections({enabled: true});if(isLoading&&!data){return<FullSpinner/>;}return(// …existing layout…<ConfigureSSOFlowProviderenterpriseConnection={data?.[0]}><ConfigureSSOSteps/></ConfigureSSOFlowProvider>);});

Happy to take this as a separate PR if you'd rather keep this one tight.

>
<ConfigureSSOSteps />
</ConfigureSSOFlowProvider>
</Col>
</NavbarContextProvider>
</ProfileCard.Root>
);
});

const ConfigureSSOSteps = () => {
const { user } = useUser();

const primaryEmailAddress = user?.primaryEmailAddress;

return (
<ConfigureSSOWizard>
<ConfigureSSOWizard.Step
id='verify-email-domain'
path='verify-email-domain'
label='Verify domain'
>
<ConfigureSSOWizard>
{!primaryEmailAddress && (
<ConfigureSSOWizard.Step
id='provide-email'
path='provide-email'
>
<ProvideEmail />
</ConfigureSSOWizard.Step>
)}
<ConfigureSSOWizard.Step
id='verify-domain'
path='verify-domain'
>
<VerifyDomainStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='configure'
path='configure'
label='Configure'
>
<ConfigureSSOWizard>
{/* TODO: Implement configure steps */}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{/* TODO: Implement configure steps */}

<ConfigureSSOWizard.Step
id='create-app'
path='create-app'
>
<ConfigureCreateApp />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='test'
path='test'
label='Test'
>
<TestConfigurationStep />
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='confirmation'
path='confirmation'
label='Confirmation'
>
<ConfirmationStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
);
};

const OrganizationSidebarSubtitle = () => {
const { organization } = useOrganization();

Expand Down
52 changes: 52 additions & 0 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSOContext.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
import type { EnterpriseConnectionResource } from '@clerk/shared/types';
import React, { type PropsWithChildren } from 'react';

/**
* Shared form state for the ConfigureSSO wizard, persisted across steps
*/
export interface ConfigureSSOData {
/**
* The enterprise connection from the user's primary email address domain
*/
enterpriseConnection: EnterpriseConnectionResource | undefined;
}

export interface ConfigureSSOContextValue extends ConfigureSSOData {
/**
* `true` while the parent is still fetching the user's enterprise
* connection
*/
isLoading: boolean;
}

interface ConfigureSSOFlowProviderProps {
enterpriseConnection: EnterpriseConnectionResource | undefined;
isLoading: boolean;
}

const ConfigureSSOFlowContext = React.createContext<ConfigureSSOContextValue | null>(null);
ConfigureSSOFlowContext.displayName = 'ConfigureSSOFlowContext';

export const ConfigureSSOFlowProvider = ({
enterpriseConnection,
isLoading,
children,
}: PropsWithChildren<ConfigureSSOFlowProviderProps>): JSX.Element => {
const value = React.useMemo<ConfigureSSOContextValue>(
() => ({
enterpriseConnection,
isLoading,
}),
[enterpriseConnection, isLoading],
);

return <ConfigureSSOFlowContext.Provider value={value}>{children}</ConfigureSSOFlowContext.Provider>;
};

export const useConfigureSSOFlow = (): ConfigureSSOContextValue => {
const ctx = React.useContext(ConfigureSSOFlowContext);
if (!ctx) {
throw new Error('useConfigureSSOFlow called outside <ConfigureSSOFlowProvider>.');
}
return ctx;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ConfigureCreateApp = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => goNext(),
});

return (
<Flow.Part part='configureCreateApp'>
<StepLayout
title='Configure Okta Workforce'
subtitle='Create a new enterprise application in your Okta Dashboard.'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const ConfirmationStep = (): JSX.Element => {
return (
<Flow.Part part='sso-confirmation'>
<StepLayout>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ProvideEmail = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => {
return goNext();
},
});

return (
<Flow.Part part='provideEmail'>
<StepLayout
title='Verify your domain'
subtitle='Verify the domain you want to enable the enterprise connection on.'
>
<Text as='p'>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
69 changes: 69 additions & 0 deletions packages/ui/src/components/ConfigureSSO/steps/StepLayout.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import React from 'react';

import { Col, Flex, Heading, Text } from '@/customizables';

import { ConfigureSSOWizard } from '../wizard';

interface StepLayoutProps {
title?: React.ReactNode;
subtitle?: React.ReactNode;
children: React.ReactNode;
}

/**
* Renders the title row (with the Wizard's Step X/Y badge) on top, a divider, and the step body
* underneath. Each individual step file owns the body content
*
* The Step X/Y badge is rendered via `ConfigureSSOWizard.StepIndicator`,
* which self-hides on steps that have no inner sub-steps
*/
export const StepLayout = ({ title, subtitle, children }: StepLayoutProps): JSX.Element => {
return (
<Col
sx={{
flex: 1,
minHeight: 0,
}}
>
<Flex
align='center'
justify='between'
sx={theme => ({
gap: theme.space.$4,
padding: theme.space.$5,
})}
>
{title ? (
<Col sx={theme => ({ gap: theme.space.$1, minWidth: 0 })}>
<Heading
textVariant='h3'
sx={theme => ({ color: theme.colors.$colorForeground, fontSize: theme.fontSizes.$lg })}
>
{title}
</Heading>

{subtitle ? (
<Text
as='p'
variant='body'
sx={theme => ({ color: theme.colors.$colorMutedForeground })}
>
{subtitle}
</Text>
) : null}
</Col>
) : null}
<ConfigureSSOWizard.StepIndicator />
</Flex>
<Col
sx={theme => ({
flex: 1,
paddingInline: theme.space.$5,
overflowY: 'auto',
})}
>
{children}
</Col>
</Col>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const TestConfigurationStep = (): JSX.Element => {
return (
<Flow.Part part='test-sso'>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the convention for Flow.Part part= is camelCase across Sign-In / Sign-Up / SessionTasks / UserVerification (phoneCode2Fa, alternativeMethods, enterpriseConnections, chooseOrganization, etc.). The four other ConfigureSSO steps already follow that — only test-sso here and sso-confirmation in ConfirmationStep are kebab-case.

<StepLayout
title='Test your SSO connection'
subtitle='Test your SSO configuration to verify you can successfully authenticate via your identity provider'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/lucky-tables-learn.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add wizard steps for the `<__experimental_ConfigureSSO />` component
9 changes: 9 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1457,6 +1457,15 @@ export class Clerk implements ClerkInterface {
return;
}

if (noUserExists(this)) {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this one that got missed on the first PR

if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderConfigureSSOComponentWhenUserDoesNotExist, {
code: CANNOT_RENDER_USER_MISSING_ERROR_CODE,
});
}
return;
}

this.assertComponentsReady(this.#clerkUI);
const component = 'ConfigureSSO';
void this.#clerkUI
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/src/internal/clerk-js/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@ const warnings = {
'The <APIKeys/> component cannot be rendered when organization API keys are disabled. Since organization API keys are disabled, this is no-op.',
cannotRenderOAuthConsentComponentWhenUserDoesNotExist:
'<OAuthConsent/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
cannotRenderConfigureSSOComponentWhenUserDoesNotExist:
'<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.',
cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
Expand Down
112 changes: 102 additions & 10 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSO.tsx
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
import { useOrganization} from '@clerk/shared/react/index';
import { __internal_useUserEnterpriseConnections, useOrganization, useUser } from '@clerk/shared/react';
import type { __experimental_ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { useEnvironment, withCoreUserGuard } from '@/contexts';
import { Box, Col, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { Box, Col, descriptors, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { ApplicationLogo } from '@/elements/ApplicationLogo';
import { withCardStateProvider } from '@/elements/contexts';
import { NavBar, NavbarContextProvider } from '@/elements/Navbar';
import { ProfileCard } from '@/elements/ProfileCard';
import { BoxIcon } from '@/icons';
import { Route, Switch } from '@/router';

import { ConfigureSSOFlowProvider } from './ConfigureSSOContext';
import { ConfigureCreateApp, ConfirmationStep, ProvideEmail, TestConfigurationStep, VerifyDomainStep } from './steps';
import { ConfigureSSOWizard } from './wizard';

const ConfigureSSOInternal = () => {
return (
<Flow.Root flow='configureSSO'>
<Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Root>
);
};
Expand All@@ -32,6 +34,11 @@ const AuthenticatedContent = withCoreUserGuard(() => {
const { parsedOptions } = useAppearance();
const hasLogo = Boolean(parsedOptions.logoImageUrl || logoImageUrl);

const { data: enterpriseConnections, isLoading: isLoadingEnterpriseConnections } =
__internal_useUserEnterpriseConnections({ enabled: true });
// Currently FAPI only supports one enterprise connection per user
const enterpriseConnection = enterpriseConnections?.[0];

return (
<ProfileCard.Root
sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
Expand DownExpand Up@@ -89,12 +96,97 @@ const AuthenticatedContent = withCoreUserGuard(() => {
routes={[]}
contentRef={contentRef}
/>
<ProfileCard.Content contentRef={contentRef} />
<Col
ref={contentRef}
elementDescriptor={descriptors.scrollBox}
sx={t => ({
backgroundColor: t.colors.$colorBackground,
position: 'relative',
borderRadius: t.radii.$lg,
width: '100%',
overflow: 'hidden',
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$solid,
borderColor: t.colors.$borderAlpha150,
marginBlock: '-1px',
marginInlineEnd: '-1px',
flex: 1,
})}
>
<ConfigureSSOFlowProvider
enterpriseConnection={enterpriseConnection}
isLoading={isLoadingEnterpriseConnections}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think passing the initial isLoading down to the context and rendering it on the wizard might lead us to issues when invalidating the query, and also for instance, when we start determining the current step after a refresh I think it would be good to have the loading before the wizard even renders, so what do you think of lifting the initial loading state here to ConfigureSSO root? Something like:

constAuthenticatedContent=withCoreUserGuard(()=>{const{ data, isLoading }=__internal_useUserEnterpriseConnections({enabled: true});if(isLoading&&!data){return<FullSpinner/>;}return(// …existing layout…<ConfigureSSOFlowProviderenterpriseConnection={data?.[0]}><ConfigureSSOSteps/></ConfigureSSOFlowProvider>);});

Happy to take this as a separate PR if you'd rather keep this one tight.

>
<ConfigureSSOSteps />
</ConfigureSSOFlowProvider>
</Col>
</NavbarContextProvider>
</ProfileCard.Root>
);
});

const ConfigureSSOSteps = () => {
const { user } = useUser();

const primaryEmailAddress = user?.primaryEmailAddress;

return (
<ConfigureSSOWizard>
<ConfigureSSOWizard.Step
id='verify-email-domain'
path='verify-email-domain'
label='Verify domain'
>
<ConfigureSSOWizard>
{!primaryEmailAddress && (
<ConfigureSSOWizard.Step
id='provide-email'
path='provide-email'
>
<ProvideEmail />
</ConfigureSSOWizard.Step>
)}
<ConfigureSSOWizard.Step
id='verify-domain'
path='verify-domain'
>
<VerifyDomainStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='configure'
path='configure'
label='Configure'
>
<ConfigureSSOWizard>
{/* TODO: Implement configure steps */}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{/* TODO: Implement configure steps */}

<ConfigureSSOWizard.Step
id='create-app'
path='create-app'
>
<ConfigureCreateApp />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='test'
path='test'
label='Test'
>
<TestConfigurationStep />
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='confirmation'
path='confirmation'
label='Confirmation'
>
<ConfirmationStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
);
};

const OrganizationSidebarSubtitle = () => {
const { organization } = useOrganization();

Expand Down
52 changes: 52 additions & 0 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSOContext.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
import type { EnterpriseConnectionResource } from '@clerk/shared/types';
import React, { type PropsWithChildren } from 'react';

/**
* Shared form state for the ConfigureSSO wizard, persisted across steps
*/
export interface ConfigureSSOData {
/**
* The enterprise connection from the user's primary email address domain
*/
enterpriseConnection: EnterpriseConnectionResource | undefined;
}

export interface ConfigureSSOContextValue extends ConfigureSSOData {
/**
* `true` while the parent is still fetching the user's enterprise
* connection
*/
isLoading: boolean;
}

interface ConfigureSSOFlowProviderProps {
enterpriseConnection: EnterpriseConnectionResource | undefined;
isLoading: boolean;
}

const ConfigureSSOFlowContext = React.createContext<ConfigureSSOContextValue | null>(null);
ConfigureSSOFlowContext.displayName = 'ConfigureSSOFlowContext';

export const ConfigureSSOFlowProvider = ({
enterpriseConnection,
isLoading,
children,
}: PropsWithChildren<ConfigureSSOFlowProviderProps>): JSX.Element => {
const value = React.useMemo<ConfigureSSOContextValue>(
() => ({
enterpriseConnection,
isLoading,
}),
[enterpriseConnection, isLoading],
);

return <ConfigureSSOFlowContext.Provider value={value}>{children}</ConfigureSSOFlowContext.Provider>;
};

export const useConfigureSSOFlow = (): ConfigureSSOContextValue => {
const ctx = React.useContext(ConfigureSSOFlowContext);
if (!ctx) {
throw new Error('useConfigureSSOFlow called outside <ConfigureSSOFlowProvider>.');
}
return ctx;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ConfigureCreateApp = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => goNext(),
});

return (
<Flow.Part part='configureCreateApp'>
<StepLayout
title='Configure Okta Workforce'
subtitle='Create a new enterprise application in your Okta Dashboard.'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const ConfirmationStep = (): JSX.Element => {
return (
<Flow.Part part='sso-confirmation'>
<StepLayout>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ProvideEmail = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => {
return goNext();
},
});

return (
<Flow.Part part='provideEmail'>
<StepLayout
title='Verify your domain'
subtitle='Verify the domain you want to enable the enterprise connection on.'
>
<Text as='p'>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
69 changes: 69 additions & 0 deletions packages/ui/src/components/ConfigureSSO/steps/StepLayout.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import React from 'react';

import { Col, Flex, Heading, Text } from '@/customizables';

import { ConfigureSSOWizard } from '../wizard';

interface StepLayoutProps {
title?: React.ReactNode;
subtitle?: React.ReactNode;
children: React.ReactNode;
}

/**
* Renders the title row (with the Wizard's Step X/Y badge) on top, a divider, and the step body
* underneath. Each individual step file owns the body content
*
* The Step X/Y badge is rendered via `ConfigureSSOWizard.StepIndicator`,
* which self-hides on steps that have no inner sub-steps
*/
export const StepLayout = ({ title, subtitle, children }: StepLayoutProps): JSX.Element => {
return (
<Col
sx={{
flex: 1,
minHeight: 0,
}}
>
<Flex
align='center'
justify='between'
sx={theme => ({
gap: theme.space.$4,
padding: theme.space.$5,
})}
>
{title ? (
<Col sx={theme => ({ gap: theme.space.$1, minWidth: 0 })}>
<Heading
textVariant='h3'
sx={theme => ({ color: theme.colors.$colorForeground, fontSize: theme.fontSizes.$lg })}
>
{title}
</Heading>

{subtitle ? (
<Text
as='p'
variant='body'
sx={theme => ({ color: theme.colors.$colorMutedForeground })}
>
{subtitle}
</Text>
) : null}
</Col>
) : null}
<ConfigureSSOWizard.StepIndicator />
</Flex>
<Col
sx={theme => ({
flex: 1,
paddingInline: theme.space.$5,
overflowY: 'auto',
})}
>
{children}
</Col>
</Col>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const TestConfigurationStep = (): JSX.Element => {
return (
<Flow.Part part='test-sso'>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the convention for Flow.Part part= is camelCase across Sign-In / Sign-Up / SessionTasks / UserVerification (phoneCode2Fa, alternativeMethods, enterpriseConnections, chooseOrganization, etc.). The four other ConfigureSSO steps already follow that — only test-sso here and sso-confirmation in ConfirmationStep are kebab-case.

<StepLayout
title='Test your SSO connection'
subtitle='Test your SSO configuration to verify you can successfully authenticate via your identity provider'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/lucky-tables-learn.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add wizard steps for the `<__experimental_ConfigureSSO />` component
9 changes: 9 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1457,6 +1457,15 @@ export class Clerk implements ClerkInterface {
return;
}

if (noUserExists(this)) {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this one that got missed on the first PR

if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderConfigureSSOComponentWhenUserDoesNotExist, {
code: CANNOT_RENDER_USER_MISSING_ERROR_CODE,
});
}
return;
}

this.assertComponentsReady(this.#clerkUI);
const component = 'ConfigureSSO';
void this.#clerkUI
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/src/internal/clerk-js/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@ const warnings = {
'The <APIKeys/> component cannot be rendered when organization API keys are disabled. Since organization API keys are disabled, this is no-op.',
cannotRenderOAuthConsentComponentWhenUserDoesNotExist:
'<OAuthConsent/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
cannotRenderConfigureSSOComponentWhenUserDoesNotExist:
'<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.',
cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
Expand Down
112 changes: 102 additions & 10 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSO.tsx
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
import { useOrganization} from '@clerk/shared/react/index';
import { __internal_useUserEnterpriseConnections, useOrganization, useUser } from '@clerk/shared/react';
import type { __experimental_ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { useEnvironment, withCoreUserGuard } from '@/contexts';
import { Box, Col, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { Box, Col, descriptors, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { ApplicationLogo } from '@/elements/ApplicationLogo';
import { withCardStateProvider } from '@/elements/contexts';
import { NavBar, NavbarContextProvider } from '@/elements/Navbar';
import { ProfileCard } from '@/elements/ProfileCard';
import { BoxIcon } from '@/icons';
import { Route, Switch } from '@/router';

import { ConfigureSSOFlowProvider } from './ConfigureSSOContext';
import { ConfigureCreateApp, ConfirmationStep, ProvideEmail, TestConfigurationStep, VerifyDomainStep } from './steps';
import { ConfigureSSOWizard } from './wizard';

const ConfigureSSOInternal = () => {
return (
<Flow.Root flow='configureSSO'>
<Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Root>
);
};
Expand All@@ -32,6 +34,11 @@ const AuthenticatedContent = withCoreUserGuard(() => {
const { parsedOptions } = useAppearance();
const hasLogo = Boolean(parsedOptions.logoImageUrl || logoImageUrl);

const { data: enterpriseConnections, isLoading: isLoadingEnterpriseConnections } =
__internal_useUserEnterpriseConnections({ enabled: true });
// Currently FAPI only supports one enterprise connection per user
const enterpriseConnection = enterpriseConnections?.[0];

return (
<ProfileCard.Root
sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
Expand DownExpand Up@@ -89,12 +96,97 @@ const AuthenticatedContent = withCoreUserGuard(() => {
routes={[]}
contentRef={contentRef}
/>
<ProfileCard.Content contentRef={contentRef} />
<Col
ref={contentRef}
elementDescriptor={descriptors.scrollBox}
sx={t => ({
backgroundColor: t.colors.$colorBackground,
position: 'relative',
borderRadius: t.radii.$lg,
width: '100%',
overflow: 'hidden',
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$solid,
borderColor: t.colors.$borderAlpha150,
marginBlock: '-1px',
marginInlineEnd: '-1px',
flex: 1,
})}
>
<ConfigureSSOFlowProvider
enterpriseConnection={enterpriseConnection}
isLoading={isLoadingEnterpriseConnections}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think passing the initial isLoading down to the context and rendering it on the wizard might lead us to issues when invalidating the query, and also for instance, when we start determining the current step after a refresh I think it would be good to have the loading before the wizard even renders, so what do you think of lifting the initial loading state here to ConfigureSSO root? Something like:

constAuthenticatedContent=withCoreUserGuard(()=>{const{ data, isLoading }=__internal_useUserEnterpriseConnections({enabled: true});if(isLoading&&!data){return<FullSpinner/>;}return(// …existing layout…<ConfigureSSOFlowProviderenterpriseConnection={data?.[0]}><ConfigureSSOSteps/></ConfigureSSOFlowProvider>);});

Happy to take this as a separate PR if you'd rather keep this one tight.

>
<ConfigureSSOSteps />
</ConfigureSSOFlowProvider>
</Col>
</NavbarContextProvider>
</ProfileCard.Root>
);
});

const ConfigureSSOSteps = () => {
const { user } = useUser();

const primaryEmailAddress = user?.primaryEmailAddress;

return (
<ConfigureSSOWizard>
<ConfigureSSOWizard.Step
id='verify-email-domain'
path='verify-email-domain'
label='Verify domain'
>
<ConfigureSSOWizard>
{!primaryEmailAddress && (
<ConfigureSSOWizard.Step
id='provide-email'
path='provide-email'
>
<ProvideEmail />
</ConfigureSSOWizard.Step>
)}
<ConfigureSSOWizard.Step
id='verify-domain'
path='verify-domain'
>
<VerifyDomainStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='configure'
path='configure'
label='Configure'
>
<ConfigureSSOWizard>
{/* TODO: Implement configure steps */}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{/* TODO: Implement configure steps */}

<ConfigureSSOWizard.Step
id='create-app'
path='create-app'
>
<ConfigureCreateApp />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='test'
path='test'
label='Test'
>
<TestConfigurationStep />
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='confirmation'
path='confirmation'
label='Confirmation'
>
<ConfirmationStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
);
};

const OrganizationSidebarSubtitle = () => {
const { organization } = useOrganization();

Expand Down
52 changes: 52 additions & 0 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSOContext.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
import type { EnterpriseConnectionResource } from '@clerk/shared/types';
import React, { type PropsWithChildren } from 'react';

/**
* Shared form state for the ConfigureSSO wizard, persisted across steps
*/
export interface ConfigureSSOData {
/**
* The enterprise connection from the user's primary email address domain
*/
enterpriseConnection: EnterpriseConnectionResource | undefined;
}

export interface ConfigureSSOContextValue extends ConfigureSSOData {
/**
* `true` while the parent is still fetching the user's enterprise
* connection
*/
isLoading: boolean;
}

interface ConfigureSSOFlowProviderProps {
enterpriseConnection: EnterpriseConnectionResource | undefined;
isLoading: boolean;
}

const ConfigureSSOFlowContext = React.createContext<ConfigureSSOContextValue | null>(null);
ConfigureSSOFlowContext.displayName = 'ConfigureSSOFlowContext';

export const ConfigureSSOFlowProvider = ({
enterpriseConnection,
isLoading,
children,
}: PropsWithChildren<ConfigureSSOFlowProviderProps>): JSX.Element => {
const value = React.useMemo<ConfigureSSOContextValue>(
() => ({
enterpriseConnection,
isLoading,
}),
[enterpriseConnection, isLoading],
);

return <ConfigureSSOFlowContext.Provider value={value}>{children}</ConfigureSSOFlowContext.Provider>;
};

export const useConfigureSSOFlow = (): ConfigureSSOContextValue => {
const ctx = React.useContext(ConfigureSSOFlowContext);
if (!ctx) {
throw new Error('useConfigureSSOFlow called outside <ConfigureSSOFlowProvider>.');
}
return ctx;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ConfigureCreateApp = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => goNext(),
});

return (
<Flow.Part part='configureCreateApp'>
<StepLayout
title='Configure Okta Workforce'
subtitle='Create a new enterprise application in your Okta Dashboard.'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const ConfirmationStep = (): JSX.Element => {
return (
<Flow.Part part='sso-confirmation'>
<StepLayout>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ProvideEmail = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => {
return goNext();
},
});

return (
<Flow.Part part='provideEmail'>
<StepLayout
title='Verify your domain'
subtitle='Verify the domain you want to enable the enterprise connection on.'
>
<Text as='p'>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
69 changes: 69 additions & 0 deletions packages/ui/src/components/ConfigureSSO/steps/StepLayout.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import React from 'react';

import { Col, Flex, Heading, Text } from '@/customizables';

import { ConfigureSSOWizard } from '../wizard';

interface StepLayoutProps {
title?: React.ReactNode;
subtitle?: React.ReactNode;
children: React.ReactNode;
}

/**
* Renders the title row (with the Wizard's Step X/Y badge) on top, a divider, and the step body
* underneath. Each individual step file owns the body content
*
* The Step X/Y badge is rendered via `ConfigureSSOWizard.StepIndicator`,
* which self-hides on steps that have no inner sub-steps
*/
export const StepLayout = ({ title, subtitle, children }: StepLayoutProps): JSX.Element => {
return (
<Col
sx={{
flex: 1,
minHeight: 0,
}}
>
<Flex
align='center'
justify='between'
sx={theme => ({
gap: theme.space.$4,
padding: theme.space.$5,
})}
>
{title ? (
<Col sx={theme => ({ gap: theme.space.$1, minWidth: 0 })}>
<Heading
textVariant='h3'
sx={theme => ({ color: theme.colors.$colorForeground, fontSize: theme.fontSizes.$lg })}
>
{title}
</Heading>

{subtitle ? (
<Text
as='p'
variant='body'
sx={theme => ({ color: theme.colors.$colorMutedForeground })}
>
{subtitle}
</Text>
) : null}
</Col>
) : null}
<ConfigureSSOWizard.StepIndicator />
</Flex>
<Col
sx={theme => ({
flex: 1,
paddingInline: theme.space.$5,
overflowY: 'auto',
})}
>
{children}
</Col>
</Col>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const TestConfigurationStep = (): JSX.Element => {
return (
<Flow.Part part='test-sso'>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the convention for Flow.Part part= is camelCase across Sign-In / Sign-Up / SessionTasks / UserVerification (phoneCode2Fa, alternativeMethods, enterpriseConnections, chooseOrganization, etc.). The four other ConfigureSSO steps already follow that — only test-sso here and sso-confirmation in ConfirmationStep are kebab-case.

<StepLayout
title='Test your SSO connection'
subtitle='Test your SSO configuration to verify you can successfully authenticate via your identity provider'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/lucky-tables-learn.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Add wizard steps for the `<__experimental_ConfigureSSO />` component
9 changes: 9 additions & 0 deletions packages/clerk-js/src/core/clerk.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -1457,6 +1457,15 @@ export class Clerk implements ClerkInterface {
return;
}

if (noUserExists(this)) {

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added this one that got missed on the first PR

if (this.#instanceType === 'development') {
throw new ClerkRuntimeError(warnings.cannotRenderConfigureSSOComponentWhenUserDoesNotExist, {
code: CANNOT_RENDER_USER_MISSING_ERROR_CODE,
});
}
return;
}

this.assertComponentsReady(this.#clerkUI);
const component = 'ConfigureSSO';
void this.#clerkUI
Expand Down
2 changes: 2 additions & 0 deletions packages/shared/src/internal/clerk-js/warnings.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -64,6 +64,8 @@ const warnings = {
'The <APIKeys/> component cannot be rendered when organization API keys are disabled. Since organization API keys are disabled, this is no-op.',
cannotRenderOAuthConsentComponentWhenUserDoesNotExist:
'<OAuthConsent/> cannot render unless a user is signed in. Since no user is signed in, this is no-op.',
cannotRenderConfigureSSOComponentWhenUserDoesNotExist:
'<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.',
cannotRenderConfigureSSOComponentWhenEmailAddressDisabled:
Expand Down
112 changes: 102 additions & 10 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSO.tsx
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
import { useOrganization} from '@clerk/shared/react/index';
import { __internal_useUserEnterpriseConnections, useOrganization, useUser } from '@clerk/shared/react';
import type { __experimental_ConfigureSSOProps } from '@clerk/shared/types';
import React from 'react';

import { useEnvironment, withCoreUserGuard } from '@/contexts';
import { Box, Col, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { Box, Col, descriptors, Flex, Flow, Icon, localizationKeys, Text, useAppearance } from '@/customizables';
import { ApplicationLogo } from '@/elements/ApplicationLogo';
import { withCardStateProvider } from '@/elements/contexts';
import { NavBar, NavbarContextProvider } from '@/elements/Navbar';
import { ProfileCard } from '@/elements/ProfileCard';
import { BoxIcon } from '@/icons';
import { Route, Switch } from '@/router';

import { ConfigureSSOFlowProvider } from './ConfigureSSOContext';
import { ConfigureCreateApp, ConfirmationStep, ProvideEmail, TestConfigurationStep, VerifyDomainStep } from './steps';
import { ConfigureSSOWizard } from './wizard';

const ConfigureSSOInternal = () => {
return (
<Flow.Root flow='configureSSO'>
<Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Part>
<Switch>
<Route>
<AuthenticatedContent />
</Route>
</Switch>
</Flow.Root>
);
};
Expand All@@ -32,6 +34,11 @@ const AuthenticatedContent = withCoreUserGuard(() => {
const { parsedOptions } = useAppearance();
const hasLogo = Boolean(parsedOptions.logoImageUrl || logoImageUrl);

const { data: enterpriseConnections, isLoading: isLoadingEnterpriseConnections } =
__internal_useUserEnterpriseConnections({ enabled: true });
// Currently FAPI only supports one enterprise connection per user
const enterpriseConnection = enterpriseConnections?.[0];

return (
<ProfileCard.Root
sx={t => ({ display: 'grid', gridTemplateColumns: '1fr 3fr', height: t.sizes.$176, overflow: 'hidden' })}
Expand DownExpand Up@@ -89,12 +96,97 @@ const AuthenticatedContent = withCoreUserGuard(() => {
routes={[]}
contentRef={contentRef}
/>
<ProfileCard.Content contentRef={contentRef} />
<Col
ref={contentRef}
elementDescriptor={descriptors.scrollBox}
sx={t => ({
backgroundColor: t.colors.$colorBackground,
position: 'relative',
borderRadius: t.radii.$lg,
width: '100%',
overflow: 'hidden',
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$solid,
borderColor: t.colors.$borderAlpha150,
marginBlock: '-1px',
marginInlineEnd: '-1px',
flex: 1,
})}
>
<ConfigureSSOFlowProvider
enterpriseConnection={enterpriseConnection}
isLoading={isLoadingEnterpriseConnections}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think passing the initial isLoading down to the context and rendering it on the wizard might lead us to issues when invalidating the query, and also for instance, when we start determining the current step after a refresh I think it would be good to have the loading before the wizard even renders, so what do you think of lifting the initial loading state here to ConfigureSSO root? Something like:

constAuthenticatedContent=withCoreUserGuard(()=>{const{ data, isLoading }=__internal_useUserEnterpriseConnections({enabled: true});if(isLoading&&!data){return<FullSpinner/>;}return(// …existing layout…<ConfigureSSOFlowProviderenterpriseConnection={data?.[0]}><ConfigureSSOSteps/></ConfigureSSOFlowProvider>);});

Happy to take this as a separate PR if you'd rather keep this one tight.

>
<ConfigureSSOSteps />
</ConfigureSSOFlowProvider>
</Col>
</NavbarContextProvider>
</ProfileCard.Root>
);
});

const ConfigureSSOSteps = () => {
const { user } = useUser();

const primaryEmailAddress = user?.primaryEmailAddress;

return (
<ConfigureSSOWizard>
<ConfigureSSOWizard.Step
id='verify-email-domain'
path='verify-email-domain'
label='Verify domain'
>
<ConfigureSSOWizard>
{!primaryEmailAddress && (
<ConfigureSSOWizard.Step
id='provide-email'
path='provide-email'
>
<ProvideEmail />
</ConfigureSSOWizard.Step>
)}
<ConfigureSSOWizard.Step
id='verify-domain'
path='verify-domain'
>
<VerifyDomainStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='configure'
path='configure'
label='Configure'
>
<ConfigureSSOWizard>
{/* TODO: Implement configure steps */}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{/* TODO: Implement configure steps */}

<ConfigureSSOWizard.Step
id='create-app'
path='create-app'
>
<ConfigureCreateApp />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='test'
path='test'
label='Test'
>
<TestConfigurationStep />
</ConfigureSSOWizard.Step>
<ConfigureSSOWizard.Step
id='confirmation'
path='confirmation'
label='Confirmation'
>
<ConfirmationStep />
</ConfigureSSOWizard.Step>
</ConfigureSSOWizard>
);
};

const OrganizationSidebarSubtitle = () => {
const { organization } = useOrganization();

Expand Down
52 changes: 52 additions & 0 deletions packages/ui/src/components/ConfigureSSO/ConfigureSSOContext.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
import type { EnterpriseConnectionResource } from '@clerk/shared/types';
import React, { type PropsWithChildren } from 'react';

/**
* Shared form state for the ConfigureSSO wizard, persisted across steps
*/
export interface ConfigureSSOData {
/**
* The enterprise connection from the user's primary email address domain
*/
enterpriseConnection: EnterpriseConnectionResource | undefined;
}

export interface ConfigureSSOContextValue extends ConfigureSSOData {
/**
* `true` while the parent is still fetching the user's enterprise
* connection
*/
isLoading: boolean;
}

interface ConfigureSSOFlowProviderProps {
enterpriseConnection: EnterpriseConnectionResource | undefined;
isLoading: boolean;
}

const ConfigureSSOFlowContext = React.createContext<ConfigureSSOContextValue | null>(null);
ConfigureSSOFlowContext.displayName = 'ConfigureSSOFlowContext';

export const ConfigureSSOFlowProvider = ({
enterpriseConnection,
isLoading,
children,
}: PropsWithChildren<ConfigureSSOFlowProviderProps>): JSX.Element => {
const value = React.useMemo<ConfigureSSOContextValue>(
() => ({
enterpriseConnection,
isLoading,
}),
[enterpriseConnection, isLoading],
);

return <ConfigureSSOFlowContext.Provider value={value}>{children}</ConfigureSSOFlowContext.Provider>;
};

export const useConfigureSSOFlow = (): ConfigureSSOContextValue => {
const ctx = React.useContext(ConfigureSSOFlowContext);
if (!ctx) {
throw new Error('useConfigureSSOFlow called outside <ConfigureSSOFlowProvider>.');
}
return ctx;
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ConfigureCreateApp = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => goNext(),
});

return (
<Flow.Part part='configureCreateApp'>
<StepLayout
title='Configure Okta Workforce'
subtitle='Create a new enterprise application in your Okta Dashboard.'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const ConfirmationStep = (): JSX.Element => {
return (
<Flow.Part part='sso-confirmation'>
<StepLayout>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
import { Flow, Text } from '@/customizables';

import { useConfigureSSOWizard, useRegisterContinueAction } from '../wizard';
import { StepLayout } from './StepLayout';

export const ProvideEmail = (): JSX.Element => {
const { goNext } = useConfigureSSOWizard();

useRegisterContinueAction({
handler: () => {
return goNext();
},
});

return (
<Flow.Part part='provideEmail'>
<StepLayout
title='Verify your domain'
subtitle='Verify the domain you want to enable the enterprise connection on.'
>
<Text as='p'>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
69 changes: 69 additions & 0 deletions packages/ui/src/components/ConfigureSSO/steps/StepLayout.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
import React from 'react';

import { Col, Flex, Heading, Text } from '@/customizables';

import { ConfigureSSOWizard } from '../wizard';

interface StepLayoutProps {
title?: React.ReactNode;
subtitle?: React.ReactNode;
children: React.ReactNode;
}

/**
* Renders the title row (with the Wizard's Step X/Y badge) on top, a divider, and the step body
* underneath. Each individual step file owns the body content
*
* The Step X/Y badge is rendered via `ConfigureSSOWizard.StepIndicator`,
* which self-hides on steps that have no inner sub-steps
*/
export const StepLayout = ({ title, subtitle, children }: StepLayoutProps): JSX.Element => {
return (
<Col
sx={{
flex: 1,
minHeight: 0,
}}
>
<Flex
align='center'
justify='between'
sx={theme => ({
gap: theme.space.$4,
padding: theme.space.$5,
})}
>
{title ? (
<Col sx={theme => ({ gap: theme.space.$1, minWidth: 0 })}>
<Heading
textVariant='h3'
sx={theme => ({ color: theme.colors.$colorForeground, fontSize: theme.fontSizes.$lg })}
>
{title}
</Heading>

{subtitle ? (
<Text
as='p'
variant='body'
sx={theme => ({ color: theme.colors.$colorMutedForeground })}
>
{subtitle}
</Text>
) : null}
</Col>
) : null}
<ConfigureSSOWizard.StepIndicator />
</Flex>
<Col
sx={theme => ({
flex: 1,
paddingInline: theme.space.$5,
overflowY: 'auto',
})}
>
{children}
</Col>
</Col>
);
};
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
import { Flow, Text } from '@/customizables';

import { StepLayout } from './StepLayout';

export const TestConfigurationStep = (): JSX.Element => {
return (
<Flow.Part part='test-sso'>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the convention for Flow.Part part= is camelCase across Sign-In / Sign-Up / SessionTasks / UserVerification (phoneCode2Fa, alternativeMethods, enterpriseConnections, chooseOrganization, etc.). The four other ConfigureSSO steps already follow that — only test-sso here and sso-confirmation in ConfirmationStep are kebab-case.

<StepLayout
title='Test your SSO connection'
subtitle='Test your SSO configuration to verify you can successfully authenticate via your identity provider'
>
<Text>UI goes here</Text>
</StepLayout>
</Flow.Part>
);
};
Loading
Loading