[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
LauraBeatris wants to merge 3 commits into from
Closed

[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
781539c
Update environment types
LauraBeatris Mar 12, 2025
351cb81
Trigger lazy loading based on environment settings
LauraBeatris Mar 12, 2025
572ede5
Enforce hiding personal workspace
LauraBeatris Mar 12, 2025
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
2 changes: 0 additions & 2 deletions integration/templates/next-app-router/src/app/layout.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,6 @@ export default function RootLayout({ children }: { children: React.ReactNode })
persistClient: process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT
? process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT === 'true'
: undefined,
// `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
withSessionTasks: true,
}}
>
<html lang='en'>
Expand Down
4 changes: 4 additions & 0 deletions packages/clerk-js/src/core/resources/Environment.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -83,4 +83,8 @@ export class Environment extends BaseResource implements EnvironmentResource {
maintenance_mode: this.maintenanceMode,
};
}

public get hasTasksEnabled() {
return !!this.organizationSettings.forceOrganizationSelection;
}
}
10 changes: 9 additions & 1 deletion packages/clerk-js/src/core/resources/OrganizationSettings.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { BaseResource } from './internal';
export class OrganizationSettings extends BaseResource implements OrganizationSettingsResource {
enabled!: boolean;
maxAllowedMemberships!: number;
forceOrganizationSelection!: boolean;
actions!: {
adminDelete: boolean;
};
Expand All@@ -25,9 +26,16 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
}

protected fromJSON(data: OrganizationSettingsJSON | OrganizationSettingsJSONSnapshot | null): this {
const { enabled = false, max_allowed_memberships = 0, actions, domains } = data || {};
const {
enabled = false,
max_allowed_memberships = 0,
force_organization_selection = false,
actions,
domains,
} = data || {};
this.enabled = enabled;
this.maxAllowedMemberships = max_allowed_memberships;
this.forceOrganizationSelection = force_organization_selection;
this.actions = { adminDelete: actions?.admin_delete || false };
this.domains = {
enabled: domains?.enabled || false,
Expand Down
7 changes: 3 additions & 4 deletions packages/clerk-js/src/ui/components/SignIn/SignIn.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ function SignInRoutes(): JSX.Element {
>
<LazySignUpVerifyPhone />
</Route>
{signInContext.withSessionTasks && (
{signInContext.hasTasksEnabled && (
<Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
<SessionTask task='org' />
</Route>
Expand All@@ -144,7 +144,7 @@ function SignInRoutes(): JSX.Element {
</Route>
</Route>
)}
{signInContext.withSessionTasks && (
{signInContext.hasTasksEnabled && (

@LauraBeatrisLauraBeatrisMar 12, 2025

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.

We could improve even further by lazy loading individual tasks as well - I'll explore a better solution tomorrow!

<Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
<SessionTask task='org' />
</Route>
Expand DownExpand Up@@ -187,8 +187,7 @@ function SignInRoot() {
*/
usePreloadSignUp(signInContext.isCombinedFlow);

// `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
usePreloadSessionTask(signInContext.withSessionTasks);
usePreloadSessionTask(signInContext.hasTasksEnabled);

React.useEffect(() => {
return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand Down
5 changes: 2 additions & 3 deletions packages/clerk-js/src/ui/components/SignUp/SignUp.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,8 +31,7 @@ function SignUpRoutes(): JSX.Element {
const { navigate, basePath } = useRouter();
const signUpContext = useSignUpContext();

// `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
usePreloadSessionTask(signUpContext.withSessionTasks);
usePreloadSessionTask(signUpContext.hasTasksEnabled);

React.useEffect(() => {
return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand DownExpand Up@@ -89,7 +88,7 @@ function SignUpRoutes(): JSX.Element {
<SignUpContinue />
</Route>
</Route>
{signUpContext.withSessionTasks && (
{signUpContext.hasTasksEnabled && (
<Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
<SessionTask task='org' />
</Route>
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/ui/contexts/components/OrganizationList.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationListContext = createContext<OrganizationListCtx | null>
export const useOrganizationListContext = () => {
const context = useContext(OrganizationListContext);
const { navigate } = useRouter();
const { displayConfig } = useEnvironment();
const { displayConfig, organizationSettings } = useEnvironment();

if (!context || context.componentName !== 'OrganizationList') {
throw new Error('Clerk: useOrganizationListContext called outside OrganizationList.');
Expand DownExpand Up@@ -80,7 +80,7 @@ export const useOrganizationListContext = () => {
afterCreateOrganizationUrl,
skipInvitationScreen: ctx.skipInvitationScreen || false,
hideSlug: ctx.hideSlug || false,
hidePersonal: ctx.hidePersonal || false,
hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
navigateAfterCreateOrganization,
navigateAfterSelectOrganization,
navigateAfterSelectPersonal,
Expand Down
4 changes: 2 additions & 2 deletions packages/clerk-js/src/ui/contexts/components/OrganizationSwitcher.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationSwitcherContext = createContext<OrganizationSwitcherCtx
export const useOrganizationSwitcherContext = () => {
const context = useContext(OrganizationSwitcherContext);
const { navigate } = useRouter();
const { displayConfig } = useEnvironment();
const { displayConfig, organizationSettings } = useEnvironment();

if (!context || context.componentName !== 'OrganizationSwitcher') {
throw new Error('Clerk: useOrganizationSwitcherContext called outside OrganizationSwitcher.');
Expand DownExpand Up@@ -96,7 +96,7 @@ export const useOrganizationSwitcherContext = () => {

return {
...ctx,
hidePersonal: ctx.hidePersonal || false,
hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
organizationProfileMode: organizationProfileMode || 'modal',
createOrganizationMode: createOrganizationMode || 'modal',
skipInvitationScreen: ctx.skipInvitationScreen || false,
Expand Down
6 changes: 3 additions & 3 deletions packages/clerk-js/src/ui/contexts/components/SignIn.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@ export type SignInContextType = SignInCtx & {
emailLinkRedirectUrl: string;
ssoCallbackUrl: string;
isCombinedFlow: boolean;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignInContext = createContext<SignInCtx | null>(null);

export const useSignInContext = (): SignInContextType => {
const context = useContext(SignInContext);
const { navigate } = useRouter();
const { displayConfig, userSettings } = useEnvironment();
const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
const { queryParams, queryString } = useRouter();
const signUpMode = userSettings.signUp.mode;
const options = useOptions();
Expand DownExpand Up@@ -144,6 +144,6 @@ export const useSignInContext = (): SignInContextType => {
initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
authQueryString,
isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
};
};
6 changes: 3 additions & 3 deletions packages/clerk-js/src/ui/contexts/components/SignUp.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -31,15 +31,15 @@ export type SignUpContextType = SignUpCtx & {
isCombinedFlow: boolean;
emailLinkRedirectUrl: string;
ssoCallbackUrl: string;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignUpContext = createContext<SignUpCtx | null>(null);

export const useSignUpContext = (): SignUpContextType => {
const context = useContext(SignUpContext);
const { navigate } = useRouter();
const { displayConfig, userSettings } = useEnvironment();
const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
const { queryParams, queryString } = useRouter();
const signUpMode = userSettings.signUp.mode;
const options = useOptions();
Expand DownExpand Up@@ -138,6 +138,6 @@ export const useSignUpContext = (): SignUpContextType => {
initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
authQueryString,
isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
};
};
2 changes: 0 additions & 2 deletions packages/types/src/clerk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -818,8 +818,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
*/
rethrowOfflineNetworkErrors: boolean;
commerce: boolean;
// `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
withSessionTasks: boolean;
},
Record<string, any>
>;
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/environment.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,4 +18,5 @@ export interface EnvironmentResource extends ClerkResource {
onWindowLocationHost: () => boolean;
maintenanceMode: boolean;
__internal_toSnapshot: () => EnvironmentJSONSnapshot;
hasTasksEnabled: boolean;
}
2 changes: 2 additions & 0 deletions packages/types/src/organizationSettings.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
object: never;
enabled: boolean;
max_allowed_memberships: number;
force_organization_selection: boolean;
actions: {
admin_delete: boolean;
};
Expand All@@ -21,6 +22,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
export interface OrganizationSettingsResource extends ClerkResource {
enabled: boolean;
maxAllowedMemberships: number;
forceOrganizationSelection: boolean;
actions: {
adminDelete: boolean;
};
Expand Down
, '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
[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

LauraBeatris
wants to merge
3
commits into

from

 Closed


[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
781539c

Update environment types


LauraBeatris Mar 12, 2025
351cb81

Trigger lazy loading based on environment settings


LauraBeatris Mar 12, 2025
572ede5

Enforce hiding personal workspace


LauraBeatris Mar 12, 2025

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


2 changes: 0 additions & 2 deletions
integration/templates/next-app-router/src/app/layout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,6 @@ export default function RootLayout({ children }: { children: React.ReactNode })
 persistClient: process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT
 ? process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT === 'true'
 : undefined,
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: true,
 }}
 >
 <html lang='en'>
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/core/resources/Environment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,4 +83,8 @@ export class Environment extends BaseResource implements EnvironmentResource {
 maintenance_mode: this.maintenanceMode,
 };
 }

 public get hasTasksEnabled() {
 return !!this.organizationSettings.forceOrganizationSelection;
 }
}

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/OrganizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { BaseResource } from './internal';
export class OrganizationSettings extends BaseResource implements OrganizationSettingsResource {
 enabled!: boolean;
 maxAllowedMemberships!: number;
 forceOrganizationSelection!: boolean;
 actions!: {
 adminDelete: boolean;
 };
Expand All@@ -25,9 +26,16 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
 }

 protected fromJSON(data: OrganizationSettingsJSON | OrganizationSettingsJSONSnapshot | null): this {
 const { enabled = false, max_allowed_memberships = 0, actions, domains } = data || {};
 const {
 enabled = false,
 max_allowed_memberships = 0,
 force_organization_selection = false,
 actions,
 domains,
 } = data || {};
 this.enabled = enabled;
 this.maxAllowedMemberships = max_allowed_memberships;
 this.forceOrganizationSelection = force_organization_selection;
 this.actions = { adminDelete: actions?.admin_delete || false };
 this.domains = {
 enabled: domains?.enabled || false,
Expand Down

7 changes: 3 additions & 4 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ function SignInRoutes(): JSX.Element {
 >
 <LazySignUpVerifyPhone />
 </Route>
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand All@@ -144,7 +144,7 @@ function SignInRoutes(): JSX.Element {
 </Route>
 </Route>
 )}
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
@LauraBeatrisLauraBeatrisMar 12, 2025

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.

We could improve even further by lazy loading individual tasks as well - I'll explore a better solution tomorrow!
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand DownExpand Up@@ -187,8 +187,7 @@ function SignInRoot() {
 */
 usePreloadSignUp(signInContext.isCombinedFlow);

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signInContext.withSessionTasks);
 usePreloadSessionTask(signInContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand Down

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,8 +31,7 @@ function SignUpRoutes(): JSX.Element {
 const { navigate, basePath } = useRouter();
 const signUpContext = useSignUpContext();

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signUpContext.withSessionTasks);
 usePreloadSessionTask(signUpContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand DownExpand Up@@ -89,7 +88,7 @@ function SignUpRoutes(): JSX.Element {
 <SignUpContinue />
 </Route>
 </Route>
 {signUpContext.withSessionTasks && (
 {signUpContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationList.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationListContext = createContext<OrganizationListCtx | null>
export const useOrganizationListContext = () => {
 const context = useContext(OrganizationListContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationList') {
 throw new Error('Clerk: useOrganizationListContext called outside OrganizationList.');
Expand DownExpand Up@@ -80,7 +80,7 @@ export const useOrganizationListContext = () => {
 afterCreateOrganizationUrl,
 skipInvitationScreen: ctx.skipInvitationScreen || false,
 hideSlug: ctx.hideSlug || false,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 navigateAfterCreateOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationSwitcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationSwitcherContext = createContext<OrganizationSwitcherCtx
export const useOrganizationSwitcherContext = () => {
 const context = useContext(OrganizationSwitcherContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationSwitcher') {
 throw new Error('Clerk: useOrganizationSwitcherContext called outside OrganizationSwitcher.');
Expand DownExpand Up@@ -96,7 +96,7 @@ export const useOrganizationSwitcherContext = () => {

 return {
 ...ctx,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 organizationProfileMode: organizationProfileMode || 'modal',
 createOrganizationMode: createOrganizationMode || 'modal',
 skipInvitationScreen: ctx.skipInvitationScreen || false,
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@ export type SignInContextType = SignInCtx & {
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
 isCombinedFlow: boolean;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignInContext = createContext<SignInCtx | null>(null);

export const useSignInContext = (): SignInContextType => {
 const context = useContext(SignInContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -144,6 +144,6 @@ export const useSignInContext = (): SignInContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,15 +31,15 @@ export type SignUpContextType = SignUpCtx & {
 isCombinedFlow: boolean;
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignUpContext = createContext<SignUpCtx | null>(null);

export const useSignUpContext = (): SignUpContextType => {
 const context = useContext(SignUpContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -138,6 +138,6 @@ export const useSignUpContext = (): SignUpContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -818,8 +818,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
 Record<string, any>
 >;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,4 +18,5 @@ export interface EnvironmentResource extends ClerkResource {
 onWindowLocationHost: () => boolean;
 maintenanceMode: boolean;
 __internal_toSnapshot: () => EnvironmentJSONSnapshot;
 hasTasksEnabled: boolean;
}

2 changes: 2 additions & 0 deletions
packages/types/src/organizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
 object: never;
 enabled: boolean;
 max_allowed_memberships: number;
 force_organization_selection: boolean;
 actions: {
 admin_delete: boolean;
 };
Expand All@@ -21,6 +22,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
export interface OrganizationSettingsResource extends ClerkResource {
 enabled: boolean;
 maxAllowedMemberships: number;
 forceOrganizationSelection: boolean;
 actions: {
 adminDelete: boolean;
 };
Expand Down

, '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
[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

LauraBeatris
wants to merge
3
commits into

from

 Closed


[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
781539c

Update environment types


LauraBeatris Mar 12, 2025
351cb81

Trigger lazy loading based on environment settings


LauraBeatris Mar 12, 2025
572ede5

Enforce hiding personal workspace


LauraBeatris Mar 12, 2025

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


2 changes: 0 additions & 2 deletions
integration/templates/next-app-router/src/app/layout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,6 @@ export default function RootLayout({ children }: { children: React.ReactNode })
 persistClient: process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT
 ? process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT === 'true'
 : undefined,
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: true,
 }}
 >
 <html lang='en'>
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/core/resources/Environment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,4 +83,8 @@ export class Environment extends BaseResource implements EnvironmentResource {
 maintenance_mode: this.maintenanceMode,
 };
 }

 public get hasTasksEnabled() {
 return !!this.organizationSettings.forceOrganizationSelection;
 }
}

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/OrganizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { BaseResource } from './internal';
export class OrganizationSettings extends BaseResource implements OrganizationSettingsResource {
 enabled!: boolean;
 maxAllowedMemberships!: number;
 forceOrganizationSelection!: boolean;
 actions!: {
 adminDelete: boolean;
 };
Expand All@@ -25,9 +26,16 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
 }

 protected fromJSON(data: OrganizationSettingsJSON | OrganizationSettingsJSONSnapshot | null): this {
 const { enabled = false, max_allowed_memberships = 0, actions, domains } = data || {};
 const {
 enabled = false,
 max_allowed_memberships = 0,
 force_organization_selection = false,
 actions,
 domains,
 } = data || {};
 this.enabled = enabled;
 this.maxAllowedMemberships = max_allowed_memberships;
 this.forceOrganizationSelection = force_organization_selection;
 this.actions = { adminDelete: actions?.admin_delete || false };
 this.domains = {
 enabled: domains?.enabled || false,
Expand Down

7 changes: 3 additions & 4 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ function SignInRoutes(): JSX.Element {
 >
 <LazySignUpVerifyPhone />
 </Route>
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand All@@ -144,7 +144,7 @@ function SignInRoutes(): JSX.Element {
 </Route>
 </Route>
 )}
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
@LauraBeatrisLauraBeatrisMar 12, 2025

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.

We could improve even further by lazy loading individual tasks as well - I'll explore a better solution tomorrow!
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand DownExpand Up@@ -187,8 +187,7 @@ function SignInRoot() {
 */
 usePreloadSignUp(signInContext.isCombinedFlow);

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signInContext.withSessionTasks);
 usePreloadSessionTask(signInContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand Down

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,8 +31,7 @@ function SignUpRoutes(): JSX.Element {
 const { navigate, basePath } = useRouter();
 const signUpContext = useSignUpContext();

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signUpContext.withSessionTasks);
 usePreloadSessionTask(signUpContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand DownExpand Up@@ -89,7 +88,7 @@ function SignUpRoutes(): JSX.Element {
 <SignUpContinue />
 </Route>
 </Route>
 {signUpContext.withSessionTasks && (
 {signUpContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationList.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationListContext = createContext<OrganizationListCtx | null>
export const useOrganizationListContext = () => {
 const context = useContext(OrganizationListContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationList') {
 throw new Error('Clerk: useOrganizationListContext called outside OrganizationList.');
Expand DownExpand Up@@ -80,7 +80,7 @@ export const useOrganizationListContext = () => {
 afterCreateOrganizationUrl,
 skipInvitationScreen: ctx.skipInvitationScreen || false,
 hideSlug: ctx.hideSlug || false,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 navigateAfterCreateOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationSwitcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationSwitcherContext = createContext<OrganizationSwitcherCtx
export const useOrganizationSwitcherContext = () => {
 const context = useContext(OrganizationSwitcherContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationSwitcher') {
 throw new Error('Clerk: useOrganizationSwitcherContext called outside OrganizationSwitcher.');
Expand DownExpand Up@@ -96,7 +96,7 @@ export const useOrganizationSwitcherContext = () => {

 return {
 ...ctx,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 organizationProfileMode: organizationProfileMode || 'modal',
 createOrganizationMode: createOrganizationMode || 'modal',
 skipInvitationScreen: ctx.skipInvitationScreen || false,
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@ export type SignInContextType = SignInCtx & {
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
 isCombinedFlow: boolean;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignInContext = createContext<SignInCtx | null>(null);

export const useSignInContext = (): SignInContextType => {
 const context = useContext(SignInContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -144,6 +144,6 @@ export const useSignInContext = (): SignInContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,15 +31,15 @@ export type SignUpContextType = SignUpCtx & {
 isCombinedFlow: boolean;
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignUpContext = createContext<SignUpCtx | null>(null);

export const useSignUpContext = (): SignUpContextType => {
 const context = useContext(SignUpContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -138,6 +138,6 @@ export const useSignUpContext = (): SignUpContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -818,8 +818,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
 Record<string, any>
 >;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,4 +18,5 @@ export interface EnvironmentResource extends ClerkResource {
 onWindowLocationHost: () => boolean;
 maintenanceMode: boolean;
 __internal_toSnapshot: () => EnvironmentJSONSnapshot;
 hasTasksEnabled: boolean;
}

2 changes: 2 additions & 0 deletions
packages/types/src/organizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
 object: never;
 enabled: boolean;
 max_allowed_memberships: number;
 force_organization_selection: boolean;
 actions: {
 admin_delete: boolean;
 };
Expand All@@ -21,6 +22,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
export interface OrganizationSettingsResource extends ClerkResource {
 enabled: boolean;
 maxAllowedMemberships: number;
 forceOrganizationSelection: boolean;
 actions: {
 adminDelete: boolean;
 };
Expand Down

, '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
[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

LauraBeatris
wants to merge
3
commits into

from

 Closed


[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
781539c

Update environment types


LauraBeatris Mar 12, 2025
351cb81

Trigger lazy loading based on environment settings


LauraBeatris Mar 12, 2025
572ede5

Enforce hiding personal workspace


LauraBeatris Mar 12, 2025

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


2 changes: 0 additions & 2 deletions
integration/templates/next-app-router/src/app/layout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,6 @@ export default function RootLayout({ children }: { children: React.ReactNode })
 persistClient: process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT
 ? process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT === 'true'
 : undefined,
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: true,
 }}
 >
 <html lang='en'>
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/core/resources/Environment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,4 +83,8 @@ export class Environment extends BaseResource implements EnvironmentResource {
 maintenance_mode: this.maintenanceMode,
 };
 }

 public get hasTasksEnabled() {
 return !!this.organizationSettings.forceOrganizationSelection;
 }
}

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/OrganizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { BaseResource } from './internal';
export class OrganizationSettings extends BaseResource implements OrganizationSettingsResource {
 enabled!: boolean;
 maxAllowedMemberships!: number;
 forceOrganizationSelection!: boolean;
 actions!: {
 adminDelete: boolean;
 };
Expand All@@ -25,9 +26,16 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
 }

 protected fromJSON(data: OrganizationSettingsJSON | OrganizationSettingsJSONSnapshot | null): this {
 const { enabled = false, max_allowed_memberships = 0, actions, domains } = data || {};
 const {
 enabled = false,
 max_allowed_memberships = 0,
 force_organization_selection = false,
 actions,
 domains,
 } = data || {};
 this.enabled = enabled;
 this.maxAllowedMemberships = max_allowed_memberships;
 this.forceOrganizationSelection = force_organization_selection;
 this.actions = { adminDelete: actions?.admin_delete || false };
 this.domains = {
 enabled: domains?.enabled || false,
Expand Down

7 changes: 3 additions & 4 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ function SignInRoutes(): JSX.Element {
 >
 <LazySignUpVerifyPhone />
 </Route>
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand All@@ -144,7 +144,7 @@ function SignInRoutes(): JSX.Element {
 </Route>
 </Route>
 )}
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
@LauraBeatrisLauraBeatrisMar 12, 2025

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.

We could improve even further by lazy loading individual tasks as well - I'll explore a better solution tomorrow!
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand DownExpand Up@@ -187,8 +187,7 @@ function SignInRoot() {
 */
 usePreloadSignUp(signInContext.isCombinedFlow);

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signInContext.withSessionTasks);
 usePreloadSessionTask(signInContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand Down

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,8 +31,7 @@ function SignUpRoutes(): JSX.Element {
 const { navigate, basePath } = useRouter();
 const signUpContext = useSignUpContext();

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signUpContext.withSessionTasks);
 usePreloadSessionTask(signUpContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand DownExpand Up@@ -89,7 +88,7 @@ function SignUpRoutes(): JSX.Element {
 <SignUpContinue />
 </Route>
 </Route>
 {signUpContext.withSessionTasks && (
 {signUpContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationList.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationListContext = createContext<OrganizationListCtx | null>
export const useOrganizationListContext = () => {
 const context = useContext(OrganizationListContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationList') {
 throw new Error('Clerk: useOrganizationListContext called outside OrganizationList.');
Expand DownExpand Up@@ -80,7 +80,7 @@ export const useOrganizationListContext = () => {
 afterCreateOrganizationUrl,
 skipInvitationScreen: ctx.skipInvitationScreen || false,
 hideSlug: ctx.hideSlug || false,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 navigateAfterCreateOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationSwitcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationSwitcherContext = createContext<OrganizationSwitcherCtx
export const useOrganizationSwitcherContext = () => {
 const context = useContext(OrganizationSwitcherContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationSwitcher') {
 throw new Error('Clerk: useOrganizationSwitcherContext called outside OrganizationSwitcher.');
Expand DownExpand Up@@ -96,7 +96,7 @@ export const useOrganizationSwitcherContext = () => {

 return {
 ...ctx,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 organizationProfileMode: organizationProfileMode || 'modal',
 createOrganizationMode: createOrganizationMode || 'modal',
 skipInvitationScreen: ctx.skipInvitationScreen || false,
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@ export type SignInContextType = SignInCtx & {
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
 isCombinedFlow: boolean;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignInContext = createContext<SignInCtx | null>(null);

export const useSignInContext = (): SignInContextType => {
 const context = useContext(SignInContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -144,6 +144,6 @@ export const useSignInContext = (): SignInContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,15 +31,15 @@ export type SignUpContextType = SignUpCtx & {
 isCombinedFlow: boolean;
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignUpContext = createContext<SignUpCtx | null>(null);

export const useSignUpContext = (): SignUpContextType => {
 const context = useContext(SignUpContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -138,6 +138,6 @@ export const useSignUpContext = (): SignUpContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -818,8 +818,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
 Record<string, any>
 >;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,4 +18,5 @@ export interface EnvironmentResource extends ClerkResource {
 onWindowLocationHost: () => boolean;
 maintenanceMode: boolean;
 __internal_toSnapshot: () => EnvironmentJSONSnapshot;
 hasTasksEnabled: boolean;
}

2 changes: 2 additions & 0 deletions
packages/types/src/organizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
 object: never;
 enabled: boolean;
 max_allowed_memberships: number;
 force_organization_selection: boolean;
 actions: {
 admin_delete: boolean;
 };
Expand All@@ -21,6 +22,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
export interface OrganizationSettingsResource extends ClerkResource {
 enabled: boolean;
 maxAllowedMemberships: number;
 forceOrganizationSelection: boolean;
 actions: {
 adminDelete: boolean;
 };
Expand Down

, '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
[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

LauraBeatris
wants to merge
3
commits into

from

 Closed


[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
781539c

Update environment types


LauraBeatris Mar 12, 2025
351cb81

Trigger lazy loading based on environment settings


LauraBeatris Mar 12, 2025
572ede5

Enforce hiding personal workspace


LauraBeatris Mar 12, 2025

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


2 changes: 0 additions & 2 deletions
integration/templates/next-app-router/src/app/layout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,6 @@ export default function RootLayout({ children }: { children: React.ReactNode })
 persistClient: process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT
 ? process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT === 'true'
 : undefined,
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: true,
 }}
 >
 <html lang='en'>
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/core/resources/Environment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,4 +83,8 @@ export class Environment extends BaseResource implements EnvironmentResource {
 maintenance_mode: this.maintenanceMode,
 };
 }

 public get hasTasksEnabled() {
 return !!this.organizationSettings.forceOrganizationSelection;
 }
}

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/OrganizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { BaseResource } from './internal';
export class OrganizationSettings extends BaseResource implements OrganizationSettingsResource {
 enabled!: boolean;
 maxAllowedMemberships!: number;
 forceOrganizationSelection!: boolean;
 actions!: {
 adminDelete: boolean;
 };
Expand All@@ -25,9 +26,16 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
 }

 protected fromJSON(data: OrganizationSettingsJSON | OrganizationSettingsJSONSnapshot | null): this {
 const { enabled = false, max_allowed_memberships = 0, actions, domains } = data || {};
 const {
 enabled = false,
 max_allowed_memberships = 0,
 force_organization_selection = false,
 actions,
 domains,
 } = data || {};
 this.enabled = enabled;
 this.maxAllowedMemberships = max_allowed_memberships;
 this.forceOrganizationSelection = force_organization_selection;
 this.actions = { adminDelete: actions?.admin_delete || false };
 this.domains = {
 enabled: domains?.enabled || false,
Expand Down

7 changes: 3 additions & 4 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ function SignInRoutes(): JSX.Element {
 >
 <LazySignUpVerifyPhone />
 </Route>
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand All@@ -144,7 +144,7 @@ function SignInRoutes(): JSX.Element {
 </Route>
 </Route>
 )}
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
@LauraBeatrisLauraBeatrisMar 12, 2025

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.

We could improve even further by lazy loading individual tasks as well - I'll explore a better solution tomorrow!
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand DownExpand Up@@ -187,8 +187,7 @@ function SignInRoot() {
 */
 usePreloadSignUp(signInContext.isCombinedFlow);

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signInContext.withSessionTasks);
 usePreloadSessionTask(signInContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand Down

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,8 +31,7 @@ function SignUpRoutes(): JSX.Element {
 const { navigate, basePath } = useRouter();
 const signUpContext = useSignUpContext();

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signUpContext.withSessionTasks);
 usePreloadSessionTask(signUpContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand DownExpand Up@@ -89,7 +88,7 @@ function SignUpRoutes(): JSX.Element {
 <SignUpContinue />
 </Route>
 </Route>
 {signUpContext.withSessionTasks && (
 {signUpContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationList.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationListContext = createContext<OrganizationListCtx | null>
export const useOrganizationListContext = () => {
 const context = useContext(OrganizationListContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationList') {
 throw new Error('Clerk: useOrganizationListContext called outside OrganizationList.');
Expand DownExpand Up@@ -80,7 +80,7 @@ export const useOrganizationListContext = () => {
 afterCreateOrganizationUrl,
 skipInvitationScreen: ctx.skipInvitationScreen || false,
 hideSlug: ctx.hideSlug || false,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 navigateAfterCreateOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationSwitcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationSwitcherContext = createContext<OrganizationSwitcherCtx
export const useOrganizationSwitcherContext = () => {
 const context = useContext(OrganizationSwitcherContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationSwitcher') {
 throw new Error('Clerk: useOrganizationSwitcherContext called outside OrganizationSwitcher.');
Expand DownExpand Up@@ -96,7 +96,7 @@ export const useOrganizationSwitcherContext = () => {

 return {
 ...ctx,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 organizationProfileMode: organizationProfileMode || 'modal',
 createOrganizationMode: createOrganizationMode || 'modal',
 skipInvitationScreen: ctx.skipInvitationScreen || false,
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@ export type SignInContextType = SignInCtx & {
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
 isCombinedFlow: boolean;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignInContext = createContext<SignInCtx | null>(null);

export const useSignInContext = (): SignInContextType => {
 const context = useContext(SignInContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -144,6 +144,6 @@ export const useSignInContext = (): SignInContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,15 +31,15 @@ export type SignUpContextType = SignUpCtx & {
 isCombinedFlow: boolean;
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignUpContext = createContext<SignUpCtx | null>(null);

export const useSignUpContext = (): SignUpContextType => {
 const context = useContext(SignUpContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -138,6 +138,6 @@ export const useSignUpContext = (): SignUpContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -818,8 +818,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
 Record<string, any>
 >;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,4 +18,5 @@ export interface EnvironmentResource extends ClerkResource {
 onWindowLocationHost: () => boolean;
 maintenanceMode: boolean;
 __internal_toSnapshot: () => EnvironmentJSONSnapshot;
 hasTasksEnabled: boolean;
}

2 changes: 2 additions & 0 deletions
packages/types/src/organizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
 object: never;
 enabled: boolean;
 max_allowed_memberships: number;
 force_organization_selection: boolean;
 actions: {
 admin_delete: boolean;
 };
Expand All@@ -21,6 +22,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
export interface OrganizationSettingsResource extends ClerkResource {
 enabled: boolean;
 maxAllowedMemberships: number;
 forceOrganizationSelection: boolean;
 actions: {
 adminDelete: boolean;
 };
Expand Down

, '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
[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

LauraBeatris
wants to merge
3
commits into

from

 Closed


[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
781539c

Update environment types


LauraBeatris Mar 12, 2025
351cb81

Trigger lazy loading based on environment settings


LauraBeatris Mar 12, 2025
572ede5

Enforce hiding personal workspace


LauraBeatris Mar 12, 2025

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


2 changes: 0 additions & 2 deletions
integration/templates/next-app-router/src/app/layout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,6 @@ export default function RootLayout({ children }: { children: React.ReactNode })
 persistClient: process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT
 ? process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT === 'true'
 : undefined,
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: true,
 }}
 >
 <html lang='en'>
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/core/resources/Environment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,4 +83,8 @@ export class Environment extends BaseResource implements EnvironmentResource {
 maintenance_mode: this.maintenanceMode,
 };
 }

 public get hasTasksEnabled() {
 return !!this.organizationSettings.forceOrganizationSelection;
 }
}

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/OrganizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { BaseResource } from './internal';
export class OrganizationSettings extends BaseResource implements OrganizationSettingsResource {
 enabled!: boolean;
 maxAllowedMemberships!: number;
 forceOrganizationSelection!: boolean;
 actions!: {
 adminDelete: boolean;
 };
Expand All@@ -25,9 +26,16 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
 }

 protected fromJSON(data: OrganizationSettingsJSON | OrganizationSettingsJSONSnapshot | null): this {
 const { enabled = false, max_allowed_memberships = 0, actions, domains } = data || {};
 const {
 enabled = false,
 max_allowed_memberships = 0,
 force_organization_selection = false,
 actions,
 domains,
 } = data || {};
 this.enabled = enabled;
 this.maxAllowedMemberships = max_allowed_memberships;
 this.forceOrganizationSelection = force_organization_selection;
 this.actions = { adminDelete: actions?.admin_delete || false };
 this.domains = {
 enabled: domains?.enabled || false,
Expand Down

7 changes: 3 additions & 4 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ function SignInRoutes(): JSX.Element {
 >
 <LazySignUpVerifyPhone />
 </Route>
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand All@@ -144,7 +144,7 @@ function SignInRoutes(): JSX.Element {
 </Route>
 </Route>
 )}
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
@LauraBeatrisLauraBeatrisMar 12, 2025

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.

We could improve even further by lazy loading individual tasks as well - I'll explore a better solution tomorrow!
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand DownExpand Up@@ -187,8 +187,7 @@ function SignInRoot() {
 */
 usePreloadSignUp(signInContext.isCombinedFlow);

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signInContext.withSessionTasks);
 usePreloadSessionTask(signInContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand Down

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,8 +31,7 @@ function SignUpRoutes(): JSX.Element {
 const { navigate, basePath } = useRouter();
 const signUpContext = useSignUpContext();

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signUpContext.withSessionTasks);
 usePreloadSessionTask(signUpContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand DownExpand Up@@ -89,7 +88,7 @@ function SignUpRoutes(): JSX.Element {
 <SignUpContinue />
 </Route>
 </Route>
 {signUpContext.withSessionTasks && (
 {signUpContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationList.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationListContext = createContext<OrganizationListCtx | null>
export const useOrganizationListContext = () => {
 const context = useContext(OrganizationListContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationList') {
 throw new Error('Clerk: useOrganizationListContext called outside OrganizationList.');
Expand DownExpand Up@@ -80,7 +80,7 @@ export const useOrganizationListContext = () => {
 afterCreateOrganizationUrl,
 skipInvitationScreen: ctx.skipInvitationScreen || false,
 hideSlug: ctx.hideSlug || false,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 navigateAfterCreateOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationSwitcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationSwitcherContext = createContext<OrganizationSwitcherCtx
export const useOrganizationSwitcherContext = () => {
 const context = useContext(OrganizationSwitcherContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationSwitcher') {
 throw new Error('Clerk: useOrganizationSwitcherContext called outside OrganizationSwitcher.');
Expand DownExpand Up@@ -96,7 +96,7 @@ export const useOrganizationSwitcherContext = () => {

 return {
 ...ctx,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 organizationProfileMode: organizationProfileMode || 'modal',
 createOrganizationMode: createOrganizationMode || 'modal',
 skipInvitationScreen: ctx.skipInvitationScreen || false,
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@ export type SignInContextType = SignInCtx & {
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
 isCombinedFlow: boolean;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignInContext = createContext<SignInCtx | null>(null);

export const useSignInContext = (): SignInContextType => {
 const context = useContext(SignInContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -144,6 +144,6 @@ export const useSignInContext = (): SignInContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,15 +31,15 @@ export type SignUpContextType = SignUpCtx & {
 isCombinedFlow: boolean;
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignUpContext = createContext<SignUpCtx | null>(null);

export const useSignUpContext = (): SignUpContextType => {
 const context = useContext(SignUpContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -138,6 +138,6 @@ export const useSignUpContext = (): SignUpContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -818,8 +818,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
 Record<string, any>
 >;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,4 +18,5 @@ export interface EnvironmentResource extends ClerkResource {
 onWindowLocationHost: () => boolean;
 maintenanceMode: boolean;
 __internal_toSnapshot: () => EnvironmentJSONSnapshot;
 hasTasksEnabled: boolean;
}

2 changes: 2 additions & 0 deletions
packages/types/src/organizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
 object: never;
 enabled: boolean;
 max_allowed_memberships: number;
 force_organization_selection: boolean;
 actions: {
 admin_delete: boolean;
 };
Expand All@@ -21,6 +22,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
export interface OrganizationSettingsResource extends ClerkResource {
 enabled: boolean;
 maxAllowedMemberships: number;
 forceOrganizationSelection: boolean;
 actions: {
 adminDelete: boolean;
 };
Expand Down

, '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
[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

LauraBeatris
wants to merge
3
commits into

from

 Closed


[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
781539c

Update environment types


LauraBeatris Mar 12, 2025
351cb81

Trigger lazy loading based on environment settings


LauraBeatris Mar 12, 2025
572ede5

Enforce hiding personal workspace


LauraBeatris Mar 12, 2025

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


2 changes: 0 additions & 2 deletions
integration/templates/next-app-router/src/app/layout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,6 @@ export default function RootLayout({ children }: { children: React.ReactNode })
 persistClient: process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT
 ? process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT === 'true'
 : undefined,
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: true,
 }}
 >
 <html lang='en'>
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/core/resources/Environment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,4 +83,8 @@ export class Environment extends BaseResource implements EnvironmentResource {
 maintenance_mode: this.maintenanceMode,
 };
 }

 public get hasTasksEnabled() {
 return !!this.organizationSettings.forceOrganizationSelection;
 }
}

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/OrganizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { BaseResource } from './internal';
export class OrganizationSettings extends BaseResource implements OrganizationSettingsResource {
 enabled!: boolean;
 maxAllowedMemberships!: number;
 forceOrganizationSelection!: boolean;
 actions!: {
 adminDelete: boolean;
 };
Expand All@@ -25,9 +26,16 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
 }

 protected fromJSON(data: OrganizationSettingsJSON | OrganizationSettingsJSONSnapshot | null): this {
 const { enabled = false, max_allowed_memberships = 0, actions, domains } = data || {};
 const {
 enabled = false,
 max_allowed_memberships = 0,
 force_organization_selection = false,
 actions,
 domains,
 } = data || {};
 this.enabled = enabled;
 this.maxAllowedMemberships = max_allowed_memberships;
 this.forceOrganizationSelection = force_organization_selection;
 this.actions = { adminDelete: actions?.admin_delete || false };
 this.domains = {
 enabled: domains?.enabled || false,
Expand Down

7 changes: 3 additions & 4 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ function SignInRoutes(): JSX.Element {
 >
 <LazySignUpVerifyPhone />
 </Route>
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand All@@ -144,7 +144,7 @@ function SignInRoutes(): JSX.Element {
 </Route>
 </Route>
 )}
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
@LauraBeatrisLauraBeatrisMar 12, 2025

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.

We could improve even further by lazy loading individual tasks as well - I'll explore a better solution tomorrow!
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand DownExpand Up@@ -187,8 +187,7 @@ function SignInRoot() {
 */
 usePreloadSignUp(signInContext.isCombinedFlow);

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signInContext.withSessionTasks);
 usePreloadSessionTask(signInContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand Down

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,8 +31,7 @@ function SignUpRoutes(): JSX.Element {
 const { navigate, basePath } = useRouter();
 const signUpContext = useSignUpContext();

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signUpContext.withSessionTasks);
 usePreloadSessionTask(signUpContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand DownExpand Up@@ -89,7 +88,7 @@ function SignUpRoutes(): JSX.Element {
 <SignUpContinue />
 </Route>
 </Route>
 {signUpContext.withSessionTasks && (
 {signUpContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationList.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationListContext = createContext<OrganizationListCtx | null>
export const useOrganizationListContext = () => {
 const context = useContext(OrganizationListContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationList') {
 throw new Error('Clerk: useOrganizationListContext called outside OrganizationList.');
Expand DownExpand Up@@ -80,7 +80,7 @@ export const useOrganizationListContext = () => {
 afterCreateOrganizationUrl,
 skipInvitationScreen: ctx.skipInvitationScreen || false,
 hideSlug: ctx.hideSlug || false,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 navigateAfterCreateOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationSwitcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationSwitcherContext = createContext<OrganizationSwitcherCtx
export const useOrganizationSwitcherContext = () => {
 const context = useContext(OrganizationSwitcherContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationSwitcher') {
 throw new Error('Clerk: useOrganizationSwitcherContext called outside OrganizationSwitcher.');
Expand DownExpand Up@@ -96,7 +96,7 @@ export const useOrganizationSwitcherContext = () => {

 return {
 ...ctx,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 organizationProfileMode: organizationProfileMode || 'modal',
 createOrganizationMode: createOrganizationMode || 'modal',
 skipInvitationScreen: ctx.skipInvitationScreen || false,
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@ export type SignInContextType = SignInCtx & {
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
 isCombinedFlow: boolean;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignInContext = createContext<SignInCtx | null>(null);

export const useSignInContext = (): SignInContextType => {
 const context = useContext(SignInContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -144,6 +144,6 @@ export const useSignInContext = (): SignInContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,15 +31,15 @@ export type SignUpContextType = SignUpCtx & {
 isCombinedFlow: boolean;
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignUpContext = createContext<SignUpCtx | null>(null);

export const useSignUpContext = (): SignUpContextType => {
 const context = useContext(SignUpContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -138,6 +138,6 @@ export const useSignUpContext = (): SignUpContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -818,8 +818,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
 Record<string, any>
 >;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,4 +18,5 @@ export interface EnvironmentResource extends ClerkResource {
 onWindowLocationHost: () => boolean;
 maintenanceMode: boolean;
 __internal_toSnapshot: () => EnvironmentJSONSnapshot;
 hasTasksEnabled: boolean;
}

2 changes: 2 additions & 0 deletions
packages/types/src/organizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
 object: never;
 enabled: boolean;
 max_allowed_memberships: number;
 force_organization_selection: boolean;
 actions: {
 admin_delete: boolean;
 };
Expand All@@ -21,6 +22,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
export interface OrganizationSettingsResource extends ClerkResource {
 enabled: boolean;
 maxAllowedMemberships: number;
 forceOrganizationSelection: boolean;
 actions: {
 adminDelete: boolean;
 };
Expand Down

, '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
[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344

New issue

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

 Sign up for GitHub

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

Already on GitHub?
Sign in
to your account

 Closed

LauraBeatris
wants to merge
3
commits into

from

 Closed


[wip] chore(clerk-js,types): Handle task enablement from environment resource #5344
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
781539c

Update environment types


LauraBeatris Mar 12, 2025
351cb81

Trigger lazy loading based on environment settings


LauraBeatris Mar 12, 2025
572ede5

Enforce hiding personal workspace


LauraBeatris Mar 12, 2025

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


2 changes: 0 additions & 2 deletions
integration/templates/next-app-router/src/app/layout.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -24,8 +24,6 @@ export default function RootLayout({ children }: { children: React.ReactNode })
 persistClient: process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT
 ? process.env.NEXT_PUBLIC_EXPERIMENTAL_PERSIST_CLIENT === 'true'
 : undefined,
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: true,
 }}
 >
 <html lang='en'>
Expand Down

4 changes: 4 additions & 0 deletions
packages/clerk-js/src/core/resources/Environment.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -83,4 +83,8 @@ export class Environment extends BaseResource implements EnvironmentResource {
 maintenance_mode: this.maintenanceMode,
 };
 }

 public get hasTasksEnabled() {
 return !!this.organizationSettings.forceOrganizationSelection;
 }
}

10 changes: 9 additions & 1 deletion
packages/clerk-js/src/core/resources/OrganizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ import { BaseResource } from './internal';
export class OrganizationSettings extends BaseResource implements OrganizationSettingsResource {
 enabled!: boolean;
 maxAllowedMemberships!: number;
 forceOrganizationSelection!: boolean;
 actions!: {
 adminDelete: boolean;
 };
Expand All@@ -25,9 +26,16 @@ export class OrganizationSettings extends BaseResource implements OrganizationSe
 }

 protected fromJSON(data: OrganizationSettingsJSON | OrganizationSettingsJSONSnapshot | null): this {
 const { enabled = false, max_allowed_memberships = 0, actions, domains } = data || {};
 const {
 enabled = false,
 max_allowed_memberships = 0,
 force_organization_selection = false,
 actions,
 domains,
 } = data || {};
 this.enabled = enabled;
 this.maxAllowedMemberships = max_allowed_memberships;
 this.forceOrganizationSelection = force_organization_selection;
 this.actions = { adminDelete: actions?.admin_delete || false };
 this.domains = {
 enabled: domains?.enabled || false,
Expand Down

7 changes: 3 additions & 4 deletions
packages/clerk-js/src/ui/components/SignIn/SignIn.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -130,7 +130,7 @@ function SignInRoutes(): JSX.Element {
 >
 <LazySignUpVerifyPhone />
 </Route>
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand All@@ -144,7 +144,7 @@ function SignInRoutes(): JSX.Element {
 </Route>
 </Route>
 )}
 {signInContext.withSessionTasks && (
 {signInContext.hasTasksEnabled && (
@LauraBeatrisLauraBeatrisMar 12, 2025

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.

We could improve even further by lazy loading individual tasks as well - I'll explore a better solution tomorrow!
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand DownExpand Up@@ -187,8 +187,7 @@ function SignInRoot() {
 */
 usePreloadSignUp(signInContext.isCombinedFlow);

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signInContext.withSessionTasks);
 usePreloadSessionTask(signInContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand Down

5 changes: 2 additions & 3 deletions
packages/clerk-js/src/ui/components/SignUp/SignUp.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,8 +31,7 @@ function SignUpRoutes(): JSX.Element {
 const { navigate, basePath } = useRouter();
 const signUpContext = useSignUpContext();

 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 usePreloadSessionTask(signUpContext.withSessionTasks);
 usePreloadSessionTask(signUpContext.hasTasksEnabled);

 React.useEffect(() => {
 return __internal_setComponentNavigationContext?.({ basePath, navigate });
Expand DownExpand Up@@ -89,7 +88,7 @@ function SignUpRoutes(): JSX.Element {
 <SignUpContinue />
 </Route>
 </Route>
 {signUpContext.withSessionTasks && (
 {signUpContext.hasTasksEnabled && (
 <Route path={SESSION_TASK_ROUTE_BY_KEY['org']}>
 <SessionTask task='org' />
 </Route>
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationList.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationListContext = createContext<OrganizationListCtx | null>
export const useOrganizationListContext = () => {
 const context = useContext(OrganizationListContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationList') {
 throw new Error('Clerk: useOrganizationListContext called outside OrganizationList.');
Expand DownExpand Up@@ -80,7 +80,7 @@ export const useOrganizationListContext = () => {
 afterCreateOrganizationUrl,
 skipInvitationScreen: ctx.skipInvitationScreen || false,
 hideSlug: ctx.hideSlug || false,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 navigateAfterCreateOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
Expand Down

4 changes: 2 additions & 2 deletions
packages/clerk-js/src/ui/contexts/components/OrganizationSwitcher.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@ export const OrganizationSwitcherContext = createContext<OrganizationSwitcherCtx
export const useOrganizationSwitcherContext = () => {
 const context = useContext(OrganizationSwitcherContext);
 const { navigate } = useRouter();
 const { displayConfig } = useEnvironment();
 const { displayConfig, organizationSettings } = useEnvironment();

 if (!context || context.componentName !== 'OrganizationSwitcher') {
 throw new Error('Clerk: useOrganizationSwitcherContext called outside OrganizationSwitcher.');
Expand DownExpand Up@@ -96,7 +96,7 @@ export const useOrganizationSwitcherContext = () => {

 return {
 ...ctx,
 hidePersonal: ctx.hidePersonal || false,
 hidePersonal: organizationSettings.forceOrganizationSelection || ctx.hidePersonal || false,
 organizationProfileMode: organizationProfileMode || 'modal',
 createOrganizationMode: createOrganizationMode || 'modal',
 skipInvitationScreen: ctx.skipInvitationScreen || false,
Expand Down

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignIn.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,15 +32,15 @@ export type SignInContextType = SignInCtx & {
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
 isCombinedFlow: boolean;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignInContext = createContext<SignInCtx | null>(null);

export const useSignInContext = (): SignInContextType => {
 const context = useContext(SignInContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -144,6 +144,6 @@ export const useSignInContext = (): SignInContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

6 changes: 3 additions & 3 deletions
packages/clerk-js/src/ui/contexts/components/SignUp.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -31,15 +31,15 @@ export type SignUpContextType = SignUpCtx & {
 isCombinedFlow: boolean;
 emailLinkRedirectUrl: string;
 ssoCallbackUrl: string;
withSessionTasks: boolean;
hasTasksEnabled: boolean;
};

export const SignUpContext = createContext<SignUpCtx | null>(null);

export const useSignUpContext = (): SignUpContextType => {
 const context = useContext(SignUpContext);
 const { navigate } = useRouter();
 const { displayConfig, userSettings } = useEnvironment();
 const { displayConfig, userSettings, hasTasksEnabled } = useEnvironment();
 const { queryParams, queryString } = useRouter();
 const signUpMode = userSettings.signUp.mode;
 const options = useOptions();
Expand DownExpand Up@@ -138,6 +138,6 @@ export const useSignUpContext = (): SignUpContextType => {
 initialValues: { ...ctx.initialValues, ...initialValuesFromQueryParams },
 authQueryString,
 isCombinedFlow,
withSessionTasks: !!options.experimental?.withSessionTasks,
hasTasksEnabled,
 };
};

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -818,8 +818,6 @@ export type ClerkOptions = ClerkOptionsNavigation &
 */
 rethrowOfflineNetworkErrors: boolean;
 commerce: boolean;
 // `experimental.withSessionTasks` will be removed soon in favor of checking via environment response
 withSessionTasks: boolean;
 },
 Record<string, any>
 >;
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -18,4 +18,5 @@ export interface EnvironmentResource extends ClerkResource {
 onWindowLocationHost: () => boolean;
 maintenanceMode: boolean;
 __internal_toSnapshot: () => EnvironmentJSONSnapshot;
 hasTasksEnabled: boolean;
}

2 changes: 2 additions & 0 deletions
packages/types/src/organizationSettings.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
 object: never;
 enabled: boolean;
 max_allowed_memberships: number;
 force_organization_selection: boolean;
 actions: {
 admin_delete: boolean;
 };
Expand All@@ -21,6 +22,7 @@ export interface OrganizationSettingsJSON extends ClerkResourceJSON {
export interface OrganizationSettingsResource extends ClerkResource {
 enabled: boolean;
 maxAllowedMemberships: number;
 forceOrganizationSelection: boolean;
 actions: {
 adminDelete: boolean;
 };
Expand Down