Construct urls based on Organization or User <OrganizationSwitcher/>#1503

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

Merged
panteliselef merged 1 commit into from
Aug 8, 2023
Merged

Construct urls based on Organization or User <OrganizationSwitcher/> #1503

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions .changeset/strange-owls-behave.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

Construct urls based on context in <OrganizationSwitcher/>
- Deprecate `afterSwitchOrganizationUrl`
- Introduce `afterSelectOrganizationUrl` & `afterSelectPersonalUrl`

`afterSelectOrganizationUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/organizations'
- relative path -> with param '/organizations/:id'
- function that returns a string -> (org) => `/org/${org.slug}`
`afterSelectPersonalUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/users'
- relative path -> with param '/users/:username'
- function that returns a string -> (user) => `/users/${user.id}`
7 changes: 6 additions & 1 deletion packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { OrganizationResource } from '@clerk/types';
import React from 'react';

import { QuestionMark } from '../../../ui/icons';
Expand DownExpand Up@@ -27,6 +28,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
const { setActive, closeCreateOrganization } = useCoreClerk();
const { mode, navigateAfterCreateOrganization, skipInvitationScreen } = useCreateOrganizationContext();
const { organization } = useCoreOrganization();
const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);

const wizard = useWizard({ onNextStep: () => card.setError(undefined) });

Expand DownExpand Up@@ -61,6 +63,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
await organization.setLogo({ file });
}

lastCreatedOrganizationRef.current = organization;
await setActive({ organization });

if (skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
Expand All@@ -74,7 +77,9 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
};

const completeFlow = () => {
void navigateAfterCreateOrganization();
// We are confident that lastCreatedOrganizationRef.current will never be null
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
void navigateAfterCreateOrganization(lastCreatedOrganizationRef.current!);
if (mode === 'modal') {
closeCreateOrganization();
}
Expand Down
50 changes: 50 additions & 0 deletions packages/clerk-js/src/ui/components/CreateOrganization/__tests__/CreateOrganization.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,4 +158,54 @@ describe('CreateOrganization', () => {
expect(queryByText(/Invite members/i)).not.toBeInTheDocument();
});
});

describe('navigation', () => {
it('constructs afterCreateOrganizationUrl from function', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.dev'],
});
});

const createdOrg = getCreatedOrg({
maxAllowedMemberships: 1,
});

fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

props.setProps({ afterCreateOrganizationUrl: org => `/org/${org.id}` });
const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
wrapper,
});
await userEvent.type(getByLabelText(/Organization name/i), 'new org');
await userEvent.click(getByRole('button', { name: /create organization/i }));

expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.id}`);
});

it('constructs afterCreateOrganizationUrl from `:slug` ', async () => {
const { wrapper, fixtures, props } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.dev'],
});
});

const createdOrg = getCreatedOrg({
maxAllowedMemberships: 1,
});

fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

props.setProps({ afterCreateOrganizationUrl: '/org/:slug' });
const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
wrapper,
});
await userEvent.type(getByLabelText(/Organization name/i), 'new org');
await userEvent.click(getByRole('button', { name: /create organization/i }));

expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.slug}`);
});
});
});
14 changes: 11 additions & 3 deletions packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
afterCreateOrganizationUrl,
navigateCreateOrganization,
navigateOrganizationProfile,
navigateAfterSwitchOrganization,
navigateAfterSelectPersonal,
navigateAfterSelectOrganization,
} = useOrganizationSwitcherContext();

const user = useCoreUser();
Expand All@@ -60,12 +61,19 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
}

const handleOrganizationClicked = (organization: OrganizationResource) => {
return card.runAsync(() => setActive({ organization, beforeEmit: navigateAfterSwitchOrganization })).then(close);
return card
.runAsync(() =>
setActive({
organization,
beforeEmit: () => navigateAfterSelectOrganization(organization),
}),
)
.then(close);
};

const handlePersonalWorkspaceClicked = () => {
return card
.runAsync(() => setActive({ organization: null, beforeEmit: navigateAfterSwitchOrganization }))
.runAsync(() => setActive({ organization: null, beforeEmit: () => navigateAfterSelectPersonal(user) }))
.then(close);
};

Expand Down
52 changes: 51 additions & 1 deletion ...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,56 @@ describe('OrganizationSwitcher', () => {
expect(queryByRole('button', { name: 'Create Organization' })).not.toBeInTheDocument();
});

it.todo('switches between active organizations when one is clicked');
it("switches between active organizations when one is clicked'", async () => {
const { wrapper, props, fixtures } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.dev'],
organization_memberships: [
{ name: 'Org1', role: 'basic_member' },
{ name: 'Org2', role: 'admin' },
],
create_organization_enabled: false,
});
});
fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());

props.setProps({ hidePersonal: true });
const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
await userEvent.click(getByRole('button'));
await userEvent.click(getByText('Org2'));

expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
expect.objectContaining({
organization: expect.objectContaining({
name: 'Org2',
}),
}),
);
});

it("switches to personal workspace when clicked'", async () => {
const { wrapper, fixtures } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
email_addresses: ['test@clerk.dev'],
organization_memberships: [
{ name: 'Org1', role: 'basic_member' },
{ name: 'Org2', role: 'admin' },
],
});
});

fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());
const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
await userEvent.click(getByRole('button'));
await userEvent.click(getByText(/Personal workspace/i));

expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
expect.objectContaining({
organization: null,
}),
);
});
});
});
71 changes: 65 additions & 6 deletions packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { OrganizationResource, UserResource } from '@clerk/types';
import React from 'react';

import { buildAuthQueryString, buildURL, pickRedirectionProp } from '../../utils';
import { buildAuthQueryString, buildURL, createDynamicParamParser, pickRedirectionProp } from '../../utils';
import { useCoreClerk, useEnvironment, useOptions } from '../contexts';
import type { ParsedQs } from '../router';
import { useRouter } from '../router';
Expand All@@ -15,6 +16,8 @@ import type {
UserProfileCtx,
} from '../types';

const populateParamFromObject = createDynamicParamParser({ regex: /:(\w+)/ });

export const ComponentContext = React.createContext<AvailableComponentCtx | null>(null);

export type SignUpContextType = SignUpCtx & {
Expand DownExpand Up@@ -230,8 +233,50 @@ export const useOrganizationSwitcherContext = () => {
const navigateCreateOrganization = () => navigate(ctx.createOrganizationUrl || displayConfig.createOrganizationUrl);
const navigateOrganizationProfile = () =>
navigate(ctx.organizationProfileUrl || displayConfig.organizationProfileUrl);
const navigateAfterSwitchOrganization = () =>
ctx.afterSwitchOrganizationUrl ? navigate(ctx.afterSwitchOrganizationUrl) : Promise.resolve();

const navigateAfterSelectOrganizationOrPersonal = ({
organization,
user,
}: {
organization?: OrganizationResource;
user?: UserResource;
}) => {
if (typeof ctx.afterSelectPersonalUrl === 'function' && user) {
return navigate(ctx.afterSelectPersonalUrl(user));
}

if (typeof ctx.afterSelectOrganizationUrl === 'function' && organization) {
return navigate(ctx.afterSelectOrganizationUrl(organization));
}

if (ctx.afterSelectPersonalUrl && user) {
const parsedUrl = populateParamFromObject({
urlWithParam: ctx.afterSelectPersonalUrl as string,
entity: user,
});
return navigate(parsedUrl);
}

if (ctx.afterSelectOrganizationUrl && organization) {
const parsedUrl = populateParamFromObject({
urlWithParam: ctx.afterSelectOrganizationUrl as string,
entity: organization,
});
return navigate(parsedUrl);
}

// Continue to support afterSwitchOrganizationUrl
if (ctx.afterSwitchOrganizationUrl) {
return navigate(ctx.afterSwitchOrganizationUrl);
}

return Promise.resolve();
};

const navigateAfterSelectOrganization = (organization: OrganizationResource) =>
navigateAfterSelectOrganizationOrPersonal({ organization });

const navigateAfterSelectPersonal = (user: UserResource) => navigateAfterSelectOrganizationOrPersonal({ user });

return {
...ctx,
Expand All@@ -242,7 +287,8 @@ export const useOrganizationSwitcherContext = () => {
afterLeaveOrganizationUrl,
navigateOrganizationProfile,
navigateCreateOrganization,
navigateAfterSwitchOrganization,
navigateAfterSelectOrganization,
navigateAfterSelectPersonal,
componentName,
};
};
Expand DownExpand Up@@ -275,8 +321,21 @@ export const useCreateOrganizationContext = () => {
throw new Error('Clerk: useCreateOrganizationContext called outside CreateOrganization.');
}

const navigateAfterCreateOrganization = () =>
navigate(ctx.afterCreateOrganizationUrl || displayConfig.afterCreateOrganizationUrl);
const navigateAfterCreateOrganization = (organization: OrganizationResource) => {
if (typeof ctx.afterCreateOrganizationUrl === 'function') {
return navigate(ctx.afterCreateOrganizationUrl(organization));
}

if (ctx.afterCreateOrganizationUrl) {
const parsedUrl = populateParamFromObject({
urlWithParam: ctx.afterCreateOrganizationUrl,
entity: organization,
});
return navigate(parsedUrl);
}

return navigate(displayConfig.afterCreateOrganizationUrl);
};

return {
...ctx,
Expand Down
29 changes: 29 additions & 0 deletions packages/clerk-js/src/utils/__tests__/dynamicParamParser.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { describe } from '@jest/globals';

import { createDynamicParamParser } from '../dynamicParamParser';

const entity = {
foo: 'foo_string',
bar: 'bar_string',
};

describe('createDynamicParamParser', () => {
const testCases = [
[':foo', entity, 'foo_string'],
['/:foo', entity, '/foo_string'],
['/some/:bar/any', entity, '/some/bar_string/any'],
['/:notValid', entity, '/:notValid'],
] as const;

it.each(testCases)(
'replaces the dynamic param with the value assigned to the key inside the object. Url=(%s), Object=(%s), result=(%s)',
(urlWithParam, obj, result) => {
expect(
createDynamicParamParser({ regex: /:(\w+)/ })({
urlWithParam,
entity: obj,
}),
).toEqual(result);
},
);
});
14 changes: 14 additions & 0 deletions packages/clerk-js/src/utils/dynamicParamParser.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
export const createDynamicParamParser =
({ regex }: { regex: RegExp }) =>
<T extends Record<any, any>>({ urlWithParam, entity }: { urlWithParam: string; entity: T }) => {
const match = regex.exec(urlWithParam);

if (match) {
const key = match[1];
if (key in entity) {
const value = entity[key] as string;
return urlWithParam.replace(match[0], value);
}
}
return urlWithParam;
};
1 change: 1 addition & 0 deletions packages/clerk-js/src/utils/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './beforeUnloadTracker';
export * from './componentGuards';
export * from './cookies';
export * from './dynamicParamParser';
export * from './devBrowser';
export * from './email';
export * from './encoders';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Construct urls based on Organization or User <OrganizationSwitcher/>#1503

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

 Merged

panteliselef
merged 1 commit into

from

Aug 8, 2023
 Merged


Construct urls based on Organization or User <OrganizationSwitcher/>
#1503
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
.changeset/strange-owls-behave.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

Construct urls based on context in <OrganizationSwitcher/>
- Deprecate `afterSwitchOrganizationUrl`
- Introduce `afterSelectOrganizationUrl` & `afterSelectPersonalUrl`

`afterSelectOrganizationUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/organizations'
- relative path -> with param '/organizations/:id'
- function that returns a string -> (org) => `/org/${org.slug}`
`afterSelectPersonalUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/users'
- relative path -> with param '/users/:username'
- function that returns a string -> (user) => `/users/${user.id}`

7 changes: 6 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { OrganizationResource } from '@clerk/types';
import React from 'react';

import { QuestionMark } from '../../../ui/icons';
Expand DownExpand Up@@ -27,6 +28,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 const { setActive, closeCreateOrganization } = useCoreClerk();
 const { mode, navigateAfterCreateOrganization, skipInvitationScreen } = useCreateOrganizationContext();
 const { organization } = useCoreOrganization();
 const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);

 const wizard = useWizard({ onNextStep: () => card.setError(undefined) });

Expand DownExpand Up@@ -61,6 +63,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 await organization.setLogo({ file });
 }

 lastCreatedOrganizationRef.current = organization;
 await setActive({ organization });

 if (skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
Expand All@@ -74,7 +77,9 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 };

 const completeFlow = () => {
 void navigateAfterCreateOrganization();
 // We are confident that lastCreatedOrganizationRef.current will never be null
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 void navigateAfterCreateOrganization(lastCreatedOrganizationRef.current!);
 if (mode === 'modal') {
 closeCreateOrganization();
 }
Expand Down

50 changes: 50 additions & 0 deletions
packages/clerk-js/src/ui/components/CreateOrganization/__tests__/CreateOrganization.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,4 +158,54 @@ describe('CreateOrganization', () => {
 expect(queryByText(/Invite members/i)).not.toBeInTheDocument();
 });
 });

 describe('navigation', () => {
 it('constructs afterCreateOrganizationUrl from function', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: org => `/org/${org.id}` });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.id}`);
 });

 it('constructs afterCreateOrganizationUrl from `:slug` ', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: '/org/:slug' });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.slug}`);
 });
 });
});

14 changes: 11 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 afterCreateOrganizationUrl,
 navigateCreateOrganization,
 navigateOrganizationProfile,
 navigateAfterSwitchOrganization,
 navigateAfterSelectPersonal,
 navigateAfterSelectOrganization,
 } = useOrganizationSwitcherContext();

 const user = useCoreUser();
Expand All@@ -60,12 +61,19 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 }

 const handleOrganizationClicked = (organization: OrganizationResource) => {
 return card.runAsync(() => setActive({ organization, beforeEmit: navigateAfterSwitchOrganization })).then(close);
 return card
 .runAsync(() =>
 setActive({
 organization,
 beforeEmit: () => navigateAfterSelectOrganization(organization),
 }),
 )
 .then(close);
 };

 const handlePersonalWorkspaceClicked = () => {
 return card
 .runAsync(() => setActive({ organization: null, beforeEmit: navigateAfterSwitchOrganization }))
 .runAsync(() => setActive({ organization: null, beforeEmit: () => navigateAfterSelectPersonal(user) }))
 .then(close);
 };

Expand Down

52 changes: 51 additions & 1 deletion
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,56 @@ describe('OrganizationSwitcher', () => {
 expect(queryByRole('button', { name: 'Create Organization' })).not.toBeInTheDocument();
 });

 it.todo('switches between active organizations when one is clicked');
 it("switches between active organizations when one is clicked'", async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 create_organization_enabled: false,
 });
 });
 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());

 props.setProps({ hidePersonal: true });
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText('Org2'));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: expect.objectContaining({
 name: 'Org2',
 }),
 }),
 );
 });

 it("switches to personal workspace when clicked'", async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 });
 });

 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText(/Personal workspace/i));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: null,
 }),
 );
 });
 });
});

71 changes: 65 additions & 6 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { OrganizationResource, UserResource } from '@clerk/types';
import React from 'react';

import { buildAuthQueryString, buildURL, pickRedirectionProp } from '../../utils';
import { buildAuthQueryString, buildURL, createDynamicParamParser, pickRedirectionProp } from '../../utils';
import { useCoreClerk, useEnvironment, useOptions } from '../contexts';
import type { ParsedQs } from '../router';
import { useRouter } from '../router';
Expand All@@ -15,6 +16,8 @@ import type {
 UserProfileCtx,
} from '../types';

const populateParamFromObject = createDynamicParamParser({ regex: /:(\w+)/ });

export const ComponentContext = React.createContext<AvailableComponentCtx | null>(null);

export type SignUpContextType = SignUpCtx & {
Expand DownExpand Up@@ -230,8 +233,50 @@ export const useOrganizationSwitcherContext = () => {
 const navigateCreateOrganization = () => navigate(ctx.createOrganizationUrl || displayConfig.createOrganizationUrl);
 const navigateOrganizationProfile = () =>
 navigate(ctx.organizationProfileUrl || displayConfig.organizationProfileUrl);
 const navigateAfterSwitchOrganization = () =>
 ctx.afterSwitchOrganizationUrl ? navigate(ctx.afterSwitchOrganizationUrl) : Promise.resolve();

 const navigateAfterSelectOrganizationOrPersonal = ({
 organization,
 user,
 }: {
 organization?: OrganizationResource;
 user?: UserResource;
 }) => {
 if (typeof ctx.afterSelectPersonalUrl === 'function' && user) {
 return navigate(ctx.afterSelectPersonalUrl(user));
 }

 if (typeof ctx.afterSelectOrganizationUrl === 'function' && organization) {
 return navigate(ctx.afterSelectOrganizationUrl(organization));
 }

 if (ctx.afterSelectPersonalUrl && user) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectPersonalUrl as string,
 entity: user,
 });
 return navigate(parsedUrl);
 }

 if (ctx.afterSelectOrganizationUrl && organization) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectOrganizationUrl as string,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 // Continue to support afterSwitchOrganizationUrl
 if (ctx.afterSwitchOrganizationUrl) {
 return navigate(ctx.afterSwitchOrganizationUrl);
 }

 return Promise.resolve();
 };

 const navigateAfterSelectOrganization = (organization: OrganizationResource) =>
 navigateAfterSelectOrganizationOrPersonal({ organization });

 const navigateAfterSelectPersonal = (user: UserResource) => navigateAfterSelectOrganizationOrPersonal({ user });

 return {
 ...ctx,
Expand All@@ -242,7 +287,8 @@ export const useOrganizationSwitcherContext = () => {
 afterLeaveOrganizationUrl,
 navigateOrganizationProfile,
 navigateCreateOrganization,
 navigateAfterSwitchOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
 componentName,
 };
};
Expand DownExpand Up@@ -275,8 +321,21 @@ export const useCreateOrganizationContext = () => {
 throw new Error('Clerk: useCreateOrganizationContext called outside CreateOrganization.');
 }

 const navigateAfterCreateOrganization = () =>
 navigate(ctx.afterCreateOrganizationUrl || displayConfig.afterCreateOrganizationUrl);
 const navigateAfterCreateOrganization = (organization: OrganizationResource) => {
 if (typeof ctx.afterCreateOrganizationUrl === 'function') {
 return navigate(ctx.afterCreateOrganizationUrl(organization));
 }

 if (ctx.afterCreateOrganizationUrl) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterCreateOrganizationUrl,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 return navigate(displayConfig.afterCreateOrganizationUrl);
 };

 return {
 ...ctx,
Expand Down

29 changes: 29 additions & 0 deletions
packages/clerk-js/src/utils/__tests__/dynamicParamParser.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { describe } from '@jest/globals';

import { createDynamicParamParser } from '../dynamicParamParser';

const entity = {
 foo: 'foo_string',
 bar: 'bar_string',
};

describe('createDynamicParamParser', () => {
 const testCases = [
 [':foo', entity, 'foo_string'],
 ['/:foo', entity, '/foo_string'],
 ['/some/:bar/any', entity, '/some/bar_string/any'],
 ['/:notValid', entity, '/:notValid'],
 ] as const;

 it.each(testCases)(
 'replaces the dynamic param with the value assigned to the key inside the object. Url=(%s), Object=(%s), result=(%s)',
 (urlWithParam, obj, result) => {
 expect(
 createDynamicParamParser({ regex: /:(\w+)/ })({
 urlWithParam,
 entity: obj,
 }),
 ).toEqual(result);
 },
 );
});

14 changes: 14 additions & 0 deletions
packages/clerk-js/src/utils/dynamicParamParser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
export const createDynamicParamParser =
 ({ regex }: { regex: RegExp }) =>
 <T extends Record<any, any>>({ urlWithParam, entity }: { urlWithParam: string; entity: T }) => {
 const match = regex.exec(urlWithParam);

 if (match) {
 const key = match[1];
 if (key in entity) {
 const value = entity[key] as string;
 return urlWithParam.replace(match[0], value);
 }
 }
 return urlWithParam;
 };

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './beforeUnloadTracker';
export * from './componentGuards';
export * from './cookies';
export * from './dynamicParamParser';
export * from './devBrowser';
export * from './email';
export * from './encoders';
Expand Down
Loading

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

Skip to content
Construct urls based on Organization or User <OrganizationSwitcher/>#1503

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

 Merged

panteliselef
merged 1 commit into

from

Aug 8, 2023
 Merged


Construct urls based on Organization or User <OrganizationSwitcher/>
#1503
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
.changeset/strange-owls-behave.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

Construct urls based on context in <OrganizationSwitcher/>
- Deprecate `afterSwitchOrganizationUrl`
- Introduce `afterSelectOrganizationUrl` & `afterSelectPersonalUrl`

`afterSelectOrganizationUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/organizations'
- relative path -> with param '/organizations/:id'
- function that returns a string -> (org) => `/org/${org.slug}`
`afterSelectPersonalUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/users'
- relative path -> with param '/users/:username'
- function that returns a string -> (user) => `/users/${user.id}`

7 changes: 6 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { OrganizationResource } from '@clerk/types';
import React from 'react';

import { QuestionMark } from '../../../ui/icons';
Expand DownExpand Up@@ -27,6 +28,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 const { setActive, closeCreateOrganization } = useCoreClerk();
 const { mode, navigateAfterCreateOrganization, skipInvitationScreen } = useCreateOrganizationContext();
 const { organization } = useCoreOrganization();
 const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);

 const wizard = useWizard({ onNextStep: () => card.setError(undefined) });

Expand DownExpand Up@@ -61,6 +63,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 await organization.setLogo({ file });
 }

 lastCreatedOrganizationRef.current = organization;
 await setActive({ organization });

 if (skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
Expand All@@ -74,7 +77,9 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 };

 const completeFlow = () => {
 void navigateAfterCreateOrganization();
 // We are confident that lastCreatedOrganizationRef.current will never be null
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 void navigateAfterCreateOrganization(lastCreatedOrganizationRef.current!);
 if (mode === 'modal') {
 closeCreateOrganization();
 }
Expand Down

50 changes: 50 additions & 0 deletions
packages/clerk-js/src/ui/components/CreateOrganization/__tests__/CreateOrganization.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,4 +158,54 @@ describe('CreateOrganization', () => {
 expect(queryByText(/Invite members/i)).not.toBeInTheDocument();
 });
 });

 describe('navigation', () => {
 it('constructs afterCreateOrganizationUrl from function', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: org => `/org/${org.id}` });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.id}`);
 });

 it('constructs afterCreateOrganizationUrl from `:slug` ', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: '/org/:slug' });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.slug}`);
 });
 });
});

14 changes: 11 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 afterCreateOrganizationUrl,
 navigateCreateOrganization,
 navigateOrganizationProfile,
 navigateAfterSwitchOrganization,
 navigateAfterSelectPersonal,
 navigateAfterSelectOrganization,
 } = useOrganizationSwitcherContext();

 const user = useCoreUser();
Expand All@@ -60,12 +61,19 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 }

 const handleOrganizationClicked = (organization: OrganizationResource) => {
 return card.runAsync(() => setActive({ organization, beforeEmit: navigateAfterSwitchOrganization })).then(close);
 return card
 .runAsync(() =>
 setActive({
 organization,
 beforeEmit: () => navigateAfterSelectOrganization(organization),
 }),
 )
 .then(close);
 };

 const handlePersonalWorkspaceClicked = () => {
 return card
 .runAsync(() => setActive({ organization: null, beforeEmit: navigateAfterSwitchOrganization }))
 .runAsync(() => setActive({ organization: null, beforeEmit: () => navigateAfterSelectPersonal(user) }))
 .then(close);
 };

Expand Down

52 changes: 51 additions & 1 deletion
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,56 @@ describe('OrganizationSwitcher', () => {
 expect(queryByRole('button', { name: 'Create Organization' })).not.toBeInTheDocument();
 });

 it.todo('switches between active organizations when one is clicked');
 it("switches between active organizations when one is clicked'", async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 create_organization_enabled: false,
 });
 });
 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());

 props.setProps({ hidePersonal: true });
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText('Org2'));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: expect.objectContaining({
 name: 'Org2',
 }),
 }),
 );
 });

 it("switches to personal workspace when clicked'", async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 });
 });

 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText(/Personal workspace/i));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: null,
 }),
 );
 });
 });
});

71 changes: 65 additions & 6 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { OrganizationResource, UserResource } from '@clerk/types';
import React from 'react';

import { buildAuthQueryString, buildURL, pickRedirectionProp } from '../../utils';
import { buildAuthQueryString, buildURL, createDynamicParamParser, pickRedirectionProp } from '../../utils';
import { useCoreClerk, useEnvironment, useOptions } from '../contexts';
import type { ParsedQs } from '../router';
import { useRouter } from '../router';
Expand All@@ -15,6 +16,8 @@ import type {
 UserProfileCtx,
} from '../types';

const populateParamFromObject = createDynamicParamParser({ regex: /:(\w+)/ });

export const ComponentContext = React.createContext<AvailableComponentCtx | null>(null);

export type SignUpContextType = SignUpCtx & {
Expand DownExpand Up@@ -230,8 +233,50 @@ export const useOrganizationSwitcherContext = () => {
 const navigateCreateOrganization = () => navigate(ctx.createOrganizationUrl || displayConfig.createOrganizationUrl);
 const navigateOrganizationProfile = () =>
 navigate(ctx.organizationProfileUrl || displayConfig.organizationProfileUrl);
 const navigateAfterSwitchOrganization = () =>
 ctx.afterSwitchOrganizationUrl ? navigate(ctx.afterSwitchOrganizationUrl) : Promise.resolve();

 const navigateAfterSelectOrganizationOrPersonal = ({
 organization,
 user,
 }: {
 organization?: OrganizationResource;
 user?: UserResource;
 }) => {
 if (typeof ctx.afterSelectPersonalUrl === 'function' && user) {
 return navigate(ctx.afterSelectPersonalUrl(user));
 }

 if (typeof ctx.afterSelectOrganizationUrl === 'function' && organization) {
 return navigate(ctx.afterSelectOrganizationUrl(organization));
 }

 if (ctx.afterSelectPersonalUrl && user) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectPersonalUrl as string,
 entity: user,
 });
 return navigate(parsedUrl);
 }

 if (ctx.afterSelectOrganizationUrl && organization) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectOrganizationUrl as string,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 // Continue to support afterSwitchOrganizationUrl
 if (ctx.afterSwitchOrganizationUrl) {
 return navigate(ctx.afterSwitchOrganizationUrl);
 }

 return Promise.resolve();
 };

 const navigateAfterSelectOrganization = (organization: OrganizationResource) =>
 navigateAfterSelectOrganizationOrPersonal({ organization });

 const navigateAfterSelectPersonal = (user: UserResource) => navigateAfterSelectOrganizationOrPersonal({ user });

 return {
 ...ctx,
Expand All@@ -242,7 +287,8 @@ export const useOrganizationSwitcherContext = () => {
 afterLeaveOrganizationUrl,
 navigateOrganizationProfile,
 navigateCreateOrganization,
 navigateAfterSwitchOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
 componentName,
 };
};
Expand DownExpand Up@@ -275,8 +321,21 @@ export const useCreateOrganizationContext = () => {
 throw new Error('Clerk: useCreateOrganizationContext called outside CreateOrganization.');
 }

 const navigateAfterCreateOrganization = () =>
 navigate(ctx.afterCreateOrganizationUrl || displayConfig.afterCreateOrganizationUrl);
 const navigateAfterCreateOrganization = (organization: OrganizationResource) => {
 if (typeof ctx.afterCreateOrganizationUrl === 'function') {
 return navigate(ctx.afterCreateOrganizationUrl(organization));
 }

 if (ctx.afterCreateOrganizationUrl) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterCreateOrganizationUrl,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 return navigate(displayConfig.afterCreateOrganizationUrl);
 };

 return {
 ...ctx,
Expand Down

29 changes: 29 additions & 0 deletions
packages/clerk-js/src/utils/__tests__/dynamicParamParser.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { describe } from '@jest/globals';

import { createDynamicParamParser } from '../dynamicParamParser';

const entity = {
 foo: 'foo_string',
 bar: 'bar_string',
};

describe('createDynamicParamParser', () => {
 const testCases = [
 [':foo', entity, 'foo_string'],
 ['/:foo', entity, '/foo_string'],
 ['/some/:bar/any', entity, '/some/bar_string/any'],
 ['/:notValid', entity, '/:notValid'],
 ] as const;

 it.each(testCases)(
 'replaces the dynamic param with the value assigned to the key inside the object. Url=(%s), Object=(%s), result=(%s)',
 (urlWithParam, obj, result) => {
 expect(
 createDynamicParamParser({ regex: /:(\w+)/ })({
 urlWithParam,
 entity: obj,
 }),
 ).toEqual(result);
 },
 );
});

14 changes: 14 additions & 0 deletions
packages/clerk-js/src/utils/dynamicParamParser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
export const createDynamicParamParser =
 ({ regex }: { regex: RegExp }) =>
 <T extends Record<any, any>>({ urlWithParam, entity }: { urlWithParam: string; entity: T }) => {
 const match = regex.exec(urlWithParam);

 if (match) {
 const key = match[1];
 if (key in entity) {
 const value = entity[key] as string;
 return urlWithParam.replace(match[0], value);
 }
 }
 return urlWithParam;
 };

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './beforeUnloadTracker';
export * from './componentGuards';
export * from './cookies';
export * from './dynamicParamParser';
export * from './devBrowser';
export * from './email';
export * from './encoders';
Expand Down
Loading

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

Skip to content
Construct urls based on Organization or User <OrganizationSwitcher/>#1503

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

 Merged

panteliselef
merged 1 commit into

from

Aug 8, 2023
 Merged


Construct urls based on Organization or User <OrganizationSwitcher/>
#1503
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
.changeset/strange-owls-behave.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

Construct urls based on context in <OrganizationSwitcher/>
- Deprecate `afterSwitchOrganizationUrl`
- Introduce `afterSelectOrganizationUrl` & `afterSelectPersonalUrl`

`afterSelectOrganizationUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/organizations'
- relative path -> with param '/organizations/:id'
- function that returns a string -> (org) => `/org/${org.slug}`
`afterSelectPersonalUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/users'
- relative path -> with param '/users/:username'
- function that returns a string -> (user) => `/users/${user.id}`

7 changes: 6 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { OrganizationResource } from '@clerk/types';
import React from 'react';

import { QuestionMark } from '../../../ui/icons';
Expand DownExpand Up@@ -27,6 +28,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 const { setActive, closeCreateOrganization } = useCoreClerk();
 const { mode, navigateAfterCreateOrganization, skipInvitationScreen } = useCreateOrganizationContext();
 const { organization } = useCoreOrganization();
 const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);

 const wizard = useWizard({ onNextStep: () => card.setError(undefined) });

Expand DownExpand Up@@ -61,6 +63,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 await organization.setLogo({ file });
 }

 lastCreatedOrganizationRef.current = organization;
 await setActive({ organization });

 if (skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
Expand All@@ -74,7 +77,9 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 };

 const completeFlow = () => {
 void navigateAfterCreateOrganization();
 // We are confident that lastCreatedOrganizationRef.current will never be null
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 void navigateAfterCreateOrganization(lastCreatedOrganizationRef.current!);
 if (mode === 'modal') {
 closeCreateOrganization();
 }
Expand Down

50 changes: 50 additions & 0 deletions
packages/clerk-js/src/ui/components/CreateOrganization/__tests__/CreateOrganization.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,4 +158,54 @@ describe('CreateOrganization', () => {
 expect(queryByText(/Invite members/i)).not.toBeInTheDocument();
 });
 });

 describe('navigation', () => {
 it('constructs afterCreateOrganizationUrl from function', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: org => `/org/${org.id}` });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.id}`);
 });

 it('constructs afterCreateOrganizationUrl from `:slug` ', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: '/org/:slug' });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.slug}`);
 });
 });
});

14 changes: 11 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 afterCreateOrganizationUrl,
 navigateCreateOrganization,
 navigateOrganizationProfile,
 navigateAfterSwitchOrganization,
 navigateAfterSelectPersonal,
 navigateAfterSelectOrganization,
 } = useOrganizationSwitcherContext();

 const user = useCoreUser();
Expand All@@ -60,12 +61,19 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 }

 const handleOrganizationClicked = (organization: OrganizationResource) => {
 return card.runAsync(() => setActive({ organization, beforeEmit: navigateAfterSwitchOrganization })).then(close);
 return card
 .runAsync(() =>
 setActive({
 organization,
 beforeEmit: () => navigateAfterSelectOrganization(organization),
 }),
 )
 .then(close);
 };

 const handlePersonalWorkspaceClicked = () => {
 return card
 .runAsync(() => setActive({ organization: null, beforeEmit: navigateAfterSwitchOrganization }))
 .runAsync(() => setActive({ organization: null, beforeEmit: () => navigateAfterSelectPersonal(user) }))
 .then(close);
 };

Expand Down

52 changes: 51 additions & 1 deletion
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,56 @@ describe('OrganizationSwitcher', () => {
 expect(queryByRole('button', { name: 'Create Organization' })).not.toBeInTheDocument();
 });

 it.todo('switches between active organizations when one is clicked');
 it("switches between active organizations when one is clicked'", async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 create_organization_enabled: false,
 });
 });
 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());

 props.setProps({ hidePersonal: true });
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText('Org2'));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: expect.objectContaining({
 name: 'Org2',
 }),
 }),
 );
 });

 it("switches to personal workspace when clicked'", async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 });
 });

 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText(/Personal workspace/i));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: null,
 }),
 );
 });
 });
});

71 changes: 65 additions & 6 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { OrganizationResource, UserResource } from '@clerk/types';
import React from 'react';

import { buildAuthQueryString, buildURL, pickRedirectionProp } from '../../utils';
import { buildAuthQueryString, buildURL, createDynamicParamParser, pickRedirectionProp } from '../../utils';
import { useCoreClerk, useEnvironment, useOptions } from '../contexts';
import type { ParsedQs } from '../router';
import { useRouter } from '../router';
Expand All@@ -15,6 +16,8 @@ import type {
 UserProfileCtx,
} from '../types';

const populateParamFromObject = createDynamicParamParser({ regex: /:(\w+)/ });

export const ComponentContext = React.createContext<AvailableComponentCtx | null>(null);

export type SignUpContextType = SignUpCtx & {
Expand DownExpand Up@@ -230,8 +233,50 @@ export const useOrganizationSwitcherContext = () => {
 const navigateCreateOrganization = () => navigate(ctx.createOrganizationUrl || displayConfig.createOrganizationUrl);
 const navigateOrganizationProfile = () =>
 navigate(ctx.organizationProfileUrl || displayConfig.organizationProfileUrl);
 const navigateAfterSwitchOrganization = () =>
 ctx.afterSwitchOrganizationUrl ? navigate(ctx.afterSwitchOrganizationUrl) : Promise.resolve();

 const navigateAfterSelectOrganizationOrPersonal = ({
 organization,
 user,
 }: {
 organization?: OrganizationResource;
 user?: UserResource;
 }) => {
 if (typeof ctx.afterSelectPersonalUrl === 'function' && user) {
 return navigate(ctx.afterSelectPersonalUrl(user));
 }

 if (typeof ctx.afterSelectOrganizationUrl === 'function' && organization) {
 return navigate(ctx.afterSelectOrganizationUrl(organization));
 }

 if (ctx.afterSelectPersonalUrl && user) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectPersonalUrl as string,
 entity: user,
 });
 return navigate(parsedUrl);
 }

 if (ctx.afterSelectOrganizationUrl && organization) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectOrganizationUrl as string,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 // Continue to support afterSwitchOrganizationUrl
 if (ctx.afterSwitchOrganizationUrl) {
 return navigate(ctx.afterSwitchOrganizationUrl);
 }

 return Promise.resolve();
 };

 const navigateAfterSelectOrganization = (organization: OrganizationResource) =>
 navigateAfterSelectOrganizationOrPersonal({ organization });

 const navigateAfterSelectPersonal = (user: UserResource) => navigateAfterSelectOrganizationOrPersonal({ user });

 return {
 ...ctx,
Expand All@@ -242,7 +287,8 @@ export const useOrganizationSwitcherContext = () => {
 afterLeaveOrganizationUrl,
 navigateOrganizationProfile,
 navigateCreateOrganization,
 navigateAfterSwitchOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
 componentName,
 };
};
Expand DownExpand Up@@ -275,8 +321,21 @@ export const useCreateOrganizationContext = () => {
 throw new Error('Clerk: useCreateOrganizationContext called outside CreateOrganization.');
 }

 const navigateAfterCreateOrganization = () =>
 navigate(ctx.afterCreateOrganizationUrl || displayConfig.afterCreateOrganizationUrl);
 const navigateAfterCreateOrganization = (organization: OrganizationResource) => {
 if (typeof ctx.afterCreateOrganizationUrl === 'function') {
 return navigate(ctx.afterCreateOrganizationUrl(organization));
 }

 if (ctx.afterCreateOrganizationUrl) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterCreateOrganizationUrl,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 return navigate(displayConfig.afterCreateOrganizationUrl);
 };

 return {
 ...ctx,
Expand Down

29 changes: 29 additions & 0 deletions
packages/clerk-js/src/utils/__tests__/dynamicParamParser.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { describe } from '@jest/globals';

import { createDynamicParamParser } from '../dynamicParamParser';

const entity = {
 foo: 'foo_string',
 bar: 'bar_string',
};

describe('createDynamicParamParser', () => {
 const testCases = [
 [':foo', entity, 'foo_string'],
 ['/:foo', entity, '/foo_string'],
 ['/some/:bar/any', entity, '/some/bar_string/any'],
 ['/:notValid', entity, '/:notValid'],
 ] as const;

 it.each(testCases)(
 'replaces the dynamic param with the value assigned to the key inside the object. Url=(%s), Object=(%s), result=(%s)',
 (urlWithParam, obj, result) => {
 expect(
 createDynamicParamParser({ regex: /:(\w+)/ })({
 urlWithParam,
 entity: obj,
 }),
 ).toEqual(result);
 },
 );
});

14 changes: 14 additions & 0 deletions
packages/clerk-js/src/utils/dynamicParamParser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
export const createDynamicParamParser =
 ({ regex }: { regex: RegExp }) =>
 <T extends Record<any, any>>({ urlWithParam, entity }: { urlWithParam: string; entity: T }) => {
 const match = regex.exec(urlWithParam);

 if (match) {
 const key = match[1];
 if (key in entity) {
 const value = entity[key] as string;
 return urlWithParam.replace(match[0], value);
 }
 }
 return urlWithParam;
 };

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './beforeUnloadTracker';
export * from './componentGuards';
export * from './cookies';
export * from './dynamicParamParser';
export * from './devBrowser';
export * from './email';
export * from './encoders';
Expand Down
Loading

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

Skip to content
Construct urls based on Organization or User <OrganizationSwitcher/>#1503

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

 Merged

panteliselef
merged 1 commit into

from

Aug 8, 2023
 Merged


Construct urls based on Organization or User <OrganizationSwitcher/>
#1503
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
.changeset/strange-owls-behave.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

Construct urls based on context in <OrganizationSwitcher/>
- Deprecate `afterSwitchOrganizationUrl`
- Introduce `afterSelectOrganizationUrl` & `afterSelectPersonalUrl`

`afterSelectOrganizationUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/organizations'
- relative path -> with param '/organizations/:id'
- function that returns a string -> (org) => `/org/${org.slug}`
`afterSelectPersonalUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/users'
- relative path -> with param '/users/:username'
- function that returns a string -> (user) => `/users/${user.id}`

7 changes: 6 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { OrganizationResource } from '@clerk/types';
import React from 'react';

import { QuestionMark } from '../../../ui/icons';
Expand DownExpand Up@@ -27,6 +28,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 const { setActive, closeCreateOrganization } = useCoreClerk();
 const { mode, navigateAfterCreateOrganization, skipInvitationScreen } = useCreateOrganizationContext();
 const { organization } = useCoreOrganization();
 const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);

 const wizard = useWizard({ onNextStep: () => card.setError(undefined) });

Expand DownExpand Up@@ -61,6 +63,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 await organization.setLogo({ file });
 }

 lastCreatedOrganizationRef.current = organization;
 await setActive({ organization });

 if (skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
Expand All@@ -74,7 +77,9 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 };

 const completeFlow = () => {
 void navigateAfterCreateOrganization();
 // We are confident that lastCreatedOrganizationRef.current will never be null
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 void navigateAfterCreateOrganization(lastCreatedOrganizationRef.current!);
 if (mode === 'modal') {
 closeCreateOrganization();
 }
Expand Down

50 changes: 50 additions & 0 deletions
packages/clerk-js/src/ui/components/CreateOrganization/__tests__/CreateOrganization.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,4 +158,54 @@ describe('CreateOrganization', () => {
 expect(queryByText(/Invite members/i)).not.toBeInTheDocument();
 });
 });

 describe('navigation', () => {
 it('constructs afterCreateOrganizationUrl from function', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: org => `/org/${org.id}` });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.id}`);
 });

 it('constructs afterCreateOrganizationUrl from `:slug` ', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: '/org/:slug' });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.slug}`);
 });
 });
});

14 changes: 11 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 afterCreateOrganizationUrl,
 navigateCreateOrganization,
 navigateOrganizationProfile,
 navigateAfterSwitchOrganization,
 navigateAfterSelectPersonal,
 navigateAfterSelectOrganization,
 } = useOrganizationSwitcherContext();

 const user = useCoreUser();
Expand All@@ -60,12 +61,19 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 }

 const handleOrganizationClicked = (organization: OrganizationResource) => {
 return card.runAsync(() => setActive({ organization, beforeEmit: navigateAfterSwitchOrganization })).then(close);
 return card
 .runAsync(() =>
 setActive({
 organization,
 beforeEmit: () => navigateAfterSelectOrganization(organization),
 }),
 )
 .then(close);
 };

 const handlePersonalWorkspaceClicked = () => {
 return card
 .runAsync(() => setActive({ organization: null, beforeEmit: navigateAfterSwitchOrganization }))
 .runAsync(() => setActive({ organization: null, beforeEmit: () => navigateAfterSelectPersonal(user) }))
 .then(close);
 };

Expand Down

52 changes: 51 additions & 1 deletion
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,56 @@ describe('OrganizationSwitcher', () => {
 expect(queryByRole('button', { name: 'Create Organization' })).not.toBeInTheDocument();
 });

 it.todo('switches between active organizations when one is clicked');
 it("switches between active organizations when one is clicked'", async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 create_organization_enabled: false,
 });
 });
 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());

 props.setProps({ hidePersonal: true });
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText('Org2'));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: expect.objectContaining({
 name: 'Org2',
 }),
 }),
 );
 });

 it("switches to personal workspace when clicked'", async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 });
 });

 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText(/Personal workspace/i));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: null,
 }),
 );
 });
 });
});

71 changes: 65 additions & 6 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { OrganizationResource, UserResource } from '@clerk/types';
import React from 'react';

import { buildAuthQueryString, buildURL, pickRedirectionProp } from '../../utils';
import { buildAuthQueryString, buildURL, createDynamicParamParser, pickRedirectionProp } from '../../utils';
import { useCoreClerk, useEnvironment, useOptions } from '../contexts';
import type { ParsedQs } from '../router';
import { useRouter } from '../router';
Expand All@@ -15,6 +16,8 @@ import type {
 UserProfileCtx,
} from '../types';

const populateParamFromObject = createDynamicParamParser({ regex: /:(\w+)/ });

export const ComponentContext = React.createContext<AvailableComponentCtx | null>(null);

export type SignUpContextType = SignUpCtx & {
Expand DownExpand Up@@ -230,8 +233,50 @@ export const useOrganizationSwitcherContext = () => {
 const navigateCreateOrganization = () => navigate(ctx.createOrganizationUrl || displayConfig.createOrganizationUrl);
 const navigateOrganizationProfile = () =>
 navigate(ctx.organizationProfileUrl || displayConfig.organizationProfileUrl);
 const navigateAfterSwitchOrganization = () =>
 ctx.afterSwitchOrganizationUrl ? navigate(ctx.afterSwitchOrganizationUrl) : Promise.resolve();

 const navigateAfterSelectOrganizationOrPersonal = ({
 organization,
 user,
 }: {
 organization?: OrganizationResource;
 user?: UserResource;
 }) => {
 if (typeof ctx.afterSelectPersonalUrl === 'function' && user) {
 return navigate(ctx.afterSelectPersonalUrl(user));
 }

 if (typeof ctx.afterSelectOrganizationUrl === 'function' && organization) {
 return navigate(ctx.afterSelectOrganizationUrl(organization));
 }

 if (ctx.afterSelectPersonalUrl && user) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectPersonalUrl as string,
 entity: user,
 });
 return navigate(parsedUrl);
 }

 if (ctx.afterSelectOrganizationUrl && organization) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectOrganizationUrl as string,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 // Continue to support afterSwitchOrganizationUrl
 if (ctx.afterSwitchOrganizationUrl) {
 return navigate(ctx.afterSwitchOrganizationUrl);
 }

 return Promise.resolve();
 };

 const navigateAfterSelectOrganization = (organization: OrganizationResource) =>
 navigateAfterSelectOrganizationOrPersonal({ organization });

 const navigateAfterSelectPersonal = (user: UserResource) => navigateAfterSelectOrganizationOrPersonal({ user });

 return {
 ...ctx,
Expand All@@ -242,7 +287,8 @@ export const useOrganizationSwitcherContext = () => {
 afterLeaveOrganizationUrl,
 navigateOrganizationProfile,
 navigateCreateOrganization,
 navigateAfterSwitchOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
 componentName,
 };
};
Expand DownExpand Up@@ -275,8 +321,21 @@ export const useCreateOrganizationContext = () => {
 throw new Error('Clerk: useCreateOrganizationContext called outside CreateOrganization.');
 }

 const navigateAfterCreateOrganization = () =>
 navigate(ctx.afterCreateOrganizationUrl || displayConfig.afterCreateOrganizationUrl);
 const navigateAfterCreateOrganization = (organization: OrganizationResource) => {
 if (typeof ctx.afterCreateOrganizationUrl === 'function') {
 return navigate(ctx.afterCreateOrganizationUrl(organization));
 }

 if (ctx.afterCreateOrganizationUrl) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterCreateOrganizationUrl,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 return navigate(displayConfig.afterCreateOrganizationUrl);
 };

 return {
 ...ctx,
Expand Down

29 changes: 29 additions & 0 deletions
packages/clerk-js/src/utils/__tests__/dynamicParamParser.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { describe } from '@jest/globals';

import { createDynamicParamParser } from '../dynamicParamParser';

const entity = {
 foo: 'foo_string',
 bar: 'bar_string',
};

describe('createDynamicParamParser', () => {
 const testCases = [
 [':foo', entity, 'foo_string'],
 ['/:foo', entity, '/foo_string'],
 ['/some/:bar/any', entity, '/some/bar_string/any'],
 ['/:notValid', entity, '/:notValid'],
 ] as const;

 it.each(testCases)(
 'replaces the dynamic param with the value assigned to the key inside the object. Url=(%s), Object=(%s), result=(%s)',
 (urlWithParam, obj, result) => {
 expect(
 createDynamicParamParser({ regex: /:(\w+)/ })({
 urlWithParam,
 entity: obj,
 }),
 ).toEqual(result);
 },
 );
});

14 changes: 14 additions & 0 deletions
packages/clerk-js/src/utils/dynamicParamParser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
export const createDynamicParamParser =
 ({ regex }: { regex: RegExp }) =>
 <T extends Record<any, any>>({ urlWithParam, entity }: { urlWithParam: string; entity: T }) => {
 const match = regex.exec(urlWithParam);

 if (match) {
 const key = match[1];
 if (key in entity) {
 const value = entity[key] as string;
 return urlWithParam.replace(match[0], value);
 }
 }
 return urlWithParam;
 };

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './beforeUnloadTracker';
export * from './componentGuards';
export * from './cookies';
export * from './dynamicParamParser';
export * from './devBrowser';
export * from './email';
export * from './encoders';
Expand Down
Loading

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

Skip to content
Construct urls based on Organization or User <OrganizationSwitcher/>#1503

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

 Merged

panteliselef
merged 1 commit into

from

Aug 8, 2023
 Merged


Construct urls based on Organization or User <OrganizationSwitcher/>
#1503
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
.changeset/strange-owls-behave.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

Construct urls based on context in <OrganizationSwitcher/>
- Deprecate `afterSwitchOrganizationUrl`
- Introduce `afterSelectOrganizationUrl` & `afterSelectPersonalUrl`

`afterSelectOrganizationUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/organizations'
- relative path -> with param '/organizations/:id'
- function that returns a string -> (org) => `/org/${org.slug}`
`afterSelectPersonalUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/users'
- relative path -> with param '/users/:username'
- function that returns a string -> (user) => `/users/${user.id}`

7 changes: 6 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { OrganizationResource } from '@clerk/types';
import React from 'react';

import { QuestionMark } from '../../../ui/icons';
Expand DownExpand Up@@ -27,6 +28,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 const { setActive, closeCreateOrganization } = useCoreClerk();
 const { mode, navigateAfterCreateOrganization, skipInvitationScreen } = useCreateOrganizationContext();
 const { organization } = useCoreOrganization();
 const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);

 const wizard = useWizard({ onNextStep: () => card.setError(undefined) });

Expand DownExpand Up@@ -61,6 +63,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 await organization.setLogo({ file });
 }

 lastCreatedOrganizationRef.current = organization;
 await setActive({ organization });

 if (skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
Expand All@@ -74,7 +77,9 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 };

 const completeFlow = () => {
 void navigateAfterCreateOrganization();
 // We are confident that lastCreatedOrganizationRef.current will never be null
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 void navigateAfterCreateOrganization(lastCreatedOrganizationRef.current!);
 if (mode === 'modal') {
 closeCreateOrganization();
 }
Expand Down

50 changes: 50 additions & 0 deletions
packages/clerk-js/src/ui/components/CreateOrganization/__tests__/CreateOrganization.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,4 +158,54 @@ describe('CreateOrganization', () => {
 expect(queryByText(/Invite members/i)).not.toBeInTheDocument();
 });
 });

 describe('navigation', () => {
 it('constructs afterCreateOrganizationUrl from function', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: org => `/org/${org.id}` });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.id}`);
 });

 it('constructs afterCreateOrganizationUrl from `:slug` ', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: '/org/:slug' });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.slug}`);
 });
 });
});

14 changes: 11 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 afterCreateOrganizationUrl,
 navigateCreateOrganization,
 navigateOrganizationProfile,
 navigateAfterSwitchOrganization,
 navigateAfterSelectPersonal,
 navigateAfterSelectOrganization,
 } = useOrganizationSwitcherContext();

 const user = useCoreUser();
Expand All@@ -60,12 +61,19 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 }

 const handleOrganizationClicked = (organization: OrganizationResource) => {
 return card.runAsync(() => setActive({ organization, beforeEmit: navigateAfterSwitchOrganization })).then(close);
 return card
 .runAsync(() =>
 setActive({
 organization,
 beforeEmit: () => navigateAfterSelectOrganization(organization),
 }),
 )
 .then(close);
 };

 const handlePersonalWorkspaceClicked = () => {
 return card
 .runAsync(() => setActive({ organization: null, beforeEmit: navigateAfterSwitchOrganization }))
 .runAsync(() => setActive({ organization: null, beforeEmit: () => navigateAfterSelectPersonal(user) }))
 .then(close);
 };

Expand Down

52 changes: 51 additions & 1 deletion
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,56 @@ describe('OrganizationSwitcher', () => {
 expect(queryByRole('button', { name: 'Create Organization' })).not.toBeInTheDocument();
 });

 it.todo('switches between active organizations when one is clicked');
 it("switches between active organizations when one is clicked'", async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 create_organization_enabled: false,
 });
 });
 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());

 props.setProps({ hidePersonal: true });
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText('Org2'));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: expect.objectContaining({
 name: 'Org2',
 }),
 }),
 );
 });

 it("switches to personal workspace when clicked'", async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 });
 });

 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText(/Personal workspace/i));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: null,
 }),
 );
 });
 });
});

71 changes: 65 additions & 6 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { OrganizationResource, UserResource } from '@clerk/types';
import React from 'react';

import { buildAuthQueryString, buildURL, pickRedirectionProp } from '../../utils';
import { buildAuthQueryString, buildURL, createDynamicParamParser, pickRedirectionProp } from '../../utils';
import { useCoreClerk, useEnvironment, useOptions } from '../contexts';
import type { ParsedQs } from '../router';
import { useRouter } from '../router';
Expand All@@ -15,6 +16,8 @@ import type {
 UserProfileCtx,
} from '../types';

const populateParamFromObject = createDynamicParamParser({ regex: /:(\w+)/ });

export const ComponentContext = React.createContext<AvailableComponentCtx | null>(null);

export type SignUpContextType = SignUpCtx & {
Expand DownExpand Up@@ -230,8 +233,50 @@ export const useOrganizationSwitcherContext = () => {
 const navigateCreateOrganization = () => navigate(ctx.createOrganizationUrl || displayConfig.createOrganizationUrl);
 const navigateOrganizationProfile = () =>
 navigate(ctx.organizationProfileUrl || displayConfig.organizationProfileUrl);
 const navigateAfterSwitchOrganization = () =>
 ctx.afterSwitchOrganizationUrl ? navigate(ctx.afterSwitchOrganizationUrl) : Promise.resolve();

 const navigateAfterSelectOrganizationOrPersonal = ({
 organization,
 user,
 }: {
 organization?: OrganizationResource;
 user?: UserResource;
 }) => {
 if (typeof ctx.afterSelectPersonalUrl === 'function' && user) {
 return navigate(ctx.afterSelectPersonalUrl(user));
 }

 if (typeof ctx.afterSelectOrganizationUrl === 'function' && organization) {
 return navigate(ctx.afterSelectOrganizationUrl(organization));
 }

 if (ctx.afterSelectPersonalUrl && user) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectPersonalUrl as string,
 entity: user,
 });
 return navigate(parsedUrl);
 }

 if (ctx.afterSelectOrganizationUrl && organization) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectOrganizationUrl as string,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 // Continue to support afterSwitchOrganizationUrl
 if (ctx.afterSwitchOrganizationUrl) {
 return navigate(ctx.afterSwitchOrganizationUrl);
 }

 return Promise.resolve();
 };

 const navigateAfterSelectOrganization = (organization: OrganizationResource) =>
 navigateAfterSelectOrganizationOrPersonal({ organization });

 const navigateAfterSelectPersonal = (user: UserResource) => navigateAfterSelectOrganizationOrPersonal({ user });

 return {
 ...ctx,
Expand All@@ -242,7 +287,8 @@ export const useOrganizationSwitcherContext = () => {
 afterLeaveOrganizationUrl,
 navigateOrganizationProfile,
 navigateCreateOrganization,
 navigateAfterSwitchOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
 componentName,
 };
};
Expand DownExpand Up@@ -275,8 +321,21 @@ export const useCreateOrganizationContext = () => {
 throw new Error('Clerk: useCreateOrganizationContext called outside CreateOrganization.');
 }

 const navigateAfterCreateOrganization = () =>
 navigate(ctx.afterCreateOrganizationUrl || displayConfig.afterCreateOrganizationUrl);
 const navigateAfterCreateOrganization = (organization: OrganizationResource) => {
 if (typeof ctx.afterCreateOrganizationUrl === 'function') {
 return navigate(ctx.afterCreateOrganizationUrl(organization));
 }

 if (ctx.afterCreateOrganizationUrl) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterCreateOrganizationUrl,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 return navigate(displayConfig.afterCreateOrganizationUrl);
 };

 return {
 ...ctx,
Expand Down

29 changes: 29 additions & 0 deletions
packages/clerk-js/src/utils/__tests__/dynamicParamParser.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { describe } from '@jest/globals';

import { createDynamicParamParser } from '../dynamicParamParser';

const entity = {
 foo: 'foo_string',
 bar: 'bar_string',
};

describe('createDynamicParamParser', () => {
 const testCases = [
 [':foo', entity, 'foo_string'],
 ['/:foo', entity, '/foo_string'],
 ['/some/:bar/any', entity, '/some/bar_string/any'],
 ['/:notValid', entity, '/:notValid'],
 ] as const;

 it.each(testCases)(
 'replaces the dynamic param with the value assigned to the key inside the object. Url=(%s), Object=(%s), result=(%s)',
 (urlWithParam, obj, result) => {
 expect(
 createDynamicParamParser({ regex: /:(\w+)/ })({
 urlWithParam,
 entity: obj,
 }),
 ).toEqual(result);
 },
 );
});

14 changes: 14 additions & 0 deletions
packages/clerk-js/src/utils/dynamicParamParser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
export const createDynamicParamParser =
 ({ regex }: { regex: RegExp }) =>
 <T extends Record<any, any>>({ urlWithParam, entity }: { urlWithParam: string; entity: T }) => {
 const match = regex.exec(urlWithParam);

 if (match) {
 const key = match[1];
 if (key in entity) {
 const value = entity[key] as string;
 return urlWithParam.replace(match[0], value);
 }
 }
 return urlWithParam;
 };

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './beforeUnloadTracker';
export * from './componentGuards';
export * from './cookies';
export * from './dynamicParamParser';
export * from './devBrowser';
export * from './email';
export * from './encoders';
Expand Down
Loading

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

Skip to content
Construct urls based on Organization or User <OrganizationSwitcher/>#1503

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

 Merged

panteliselef
merged 1 commit into

from

Aug 8, 2023
 Merged


Construct urls based on Organization or User <OrganizationSwitcher/>
#1503
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
.changeset/strange-owls-behave.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

Construct urls based on context in <OrganizationSwitcher/>
- Deprecate `afterSwitchOrganizationUrl`
- Introduce `afterSelectOrganizationUrl` & `afterSelectPersonalUrl`

`afterSelectOrganizationUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/organizations'
- relative path -> with param '/organizations/:id'
- function that returns a string -> (org) => `/org/${org.slug}`
`afterSelectPersonalUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/users'
- relative path -> with param '/users/:username'
- function that returns a string -> (user) => `/users/${user.id}`

7 changes: 6 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { OrganizationResource } from '@clerk/types';
import React from 'react';

import { QuestionMark } from '../../../ui/icons';
Expand DownExpand Up@@ -27,6 +28,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 const { setActive, closeCreateOrganization } = useCoreClerk();
 const { mode, navigateAfterCreateOrganization, skipInvitationScreen } = useCreateOrganizationContext();
 const { organization } = useCoreOrganization();
 const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);

 const wizard = useWizard({ onNextStep: () => card.setError(undefined) });

Expand DownExpand Up@@ -61,6 +63,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 await organization.setLogo({ file });
 }

 lastCreatedOrganizationRef.current = organization;
 await setActive({ organization });

 if (skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
Expand All@@ -74,7 +77,9 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 };

 const completeFlow = () => {
 void navigateAfterCreateOrganization();
 // We are confident that lastCreatedOrganizationRef.current will never be null
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 void navigateAfterCreateOrganization(lastCreatedOrganizationRef.current!);
 if (mode === 'modal') {
 closeCreateOrganization();
 }
Expand Down

50 changes: 50 additions & 0 deletions
packages/clerk-js/src/ui/components/CreateOrganization/__tests__/CreateOrganization.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,4 +158,54 @@ describe('CreateOrganization', () => {
 expect(queryByText(/Invite members/i)).not.toBeInTheDocument();
 });
 });

 describe('navigation', () => {
 it('constructs afterCreateOrganizationUrl from function', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: org => `/org/${org.id}` });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.id}`);
 });

 it('constructs afterCreateOrganizationUrl from `:slug` ', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: '/org/:slug' });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.slug}`);
 });
 });
});

14 changes: 11 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 afterCreateOrganizationUrl,
 navigateCreateOrganization,
 navigateOrganizationProfile,
 navigateAfterSwitchOrganization,
 navigateAfterSelectPersonal,
 navigateAfterSelectOrganization,
 } = useOrganizationSwitcherContext();

 const user = useCoreUser();
Expand All@@ -60,12 +61,19 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 }

 const handleOrganizationClicked = (organization: OrganizationResource) => {
 return card.runAsync(() => setActive({ organization, beforeEmit: navigateAfterSwitchOrganization })).then(close);
 return card
 .runAsync(() =>
 setActive({
 organization,
 beforeEmit: () => navigateAfterSelectOrganization(organization),
 }),
 )
 .then(close);
 };

 const handlePersonalWorkspaceClicked = () => {
 return card
 .runAsync(() => setActive({ organization: null, beforeEmit: navigateAfterSwitchOrganization }))
 .runAsync(() => setActive({ organization: null, beforeEmit: () => navigateAfterSelectPersonal(user) }))
 .then(close);
 };

Expand Down

52 changes: 51 additions & 1 deletion
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,56 @@ describe('OrganizationSwitcher', () => {
 expect(queryByRole('button', { name: 'Create Organization' })).not.toBeInTheDocument();
 });

 it.todo('switches between active organizations when one is clicked');
 it("switches between active organizations when one is clicked'", async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 create_organization_enabled: false,
 });
 });
 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());

 props.setProps({ hidePersonal: true });
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText('Org2'));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: expect.objectContaining({
 name: 'Org2',
 }),
 }),
 );
 });

 it("switches to personal workspace when clicked'", async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 });
 });

 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText(/Personal workspace/i));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: null,
 }),
 );
 });
 });
});

71 changes: 65 additions & 6 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { OrganizationResource, UserResource } from '@clerk/types';
import React from 'react';

import { buildAuthQueryString, buildURL, pickRedirectionProp } from '../../utils';
import { buildAuthQueryString, buildURL, createDynamicParamParser, pickRedirectionProp } from '../../utils';
import { useCoreClerk, useEnvironment, useOptions } from '../contexts';
import type { ParsedQs } from '../router';
import { useRouter } from '../router';
Expand All@@ -15,6 +16,8 @@ import type {
 UserProfileCtx,
} from '../types';

const populateParamFromObject = createDynamicParamParser({ regex: /:(\w+)/ });

export const ComponentContext = React.createContext<AvailableComponentCtx | null>(null);

export type SignUpContextType = SignUpCtx & {
Expand DownExpand Up@@ -230,8 +233,50 @@ export const useOrganizationSwitcherContext = () => {
 const navigateCreateOrganization = () => navigate(ctx.createOrganizationUrl || displayConfig.createOrganizationUrl);
 const navigateOrganizationProfile = () =>
 navigate(ctx.organizationProfileUrl || displayConfig.organizationProfileUrl);
 const navigateAfterSwitchOrganization = () =>
 ctx.afterSwitchOrganizationUrl ? navigate(ctx.afterSwitchOrganizationUrl) : Promise.resolve();

 const navigateAfterSelectOrganizationOrPersonal = ({
 organization,
 user,
 }: {
 organization?: OrganizationResource;
 user?: UserResource;
 }) => {
 if (typeof ctx.afterSelectPersonalUrl === 'function' && user) {
 return navigate(ctx.afterSelectPersonalUrl(user));
 }

 if (typeof ctx.afterSelectOrganizationUrl === 'function' && organization) {
 return navigate(ctx.afterSelectOrganizationUrl(organization));
 }

 if (ctx.afterSelectPersonalUrl && user) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectPersonalUrl as string,
 entity: user,
 });
 return navigate(parsedUrl);
 }

 if (ctx.afterSelectOrganizationUrl && organization) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectOrganizationUrl as string,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 // Continue to support afterSwitchOrganizationUrl
 if (ctx.afterSwitchOrganizationUrl) {
 return navigate(ctx.afterSwitchOrganizationUrl);
 }

 return Promise.resolve();
 };

 const navigateAfterSelectOrganization = (organization: OrganizationResource) =>
 navigateAfterSelectOrganizationOrPersonal({ organization });

 const navigateAfterSelectPersonal = (user: UserResource) => navigateAfterSelectOrganizationOrPersonal({ user });

 return {
 ...ctx,
Expand All@@ -242,7 +287,8 @@ export const useOrganizationSwitcherContext = () => {
 afterLeaveOrganizationUrl,
 navigateOrganizationProfile,
 navigateCreateOrganization,
 navigateAfterSwitchOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
 componentName,
 };
};
Expand DownExpand Up@@ -275,8 +321,21 @@ export const useCreateOrganizationContext = () => {
 throw new Error('Clerk: useCreateOrganizationContext called outside CreateOrganization.');
 }

 const navigateAfterCreateOrganization = () =>
 navigate(ctx.afterCreateOrganizationUrl || displayConfig.afterCreateOrganizationUrl);
 const navigateAfterCreateOrganization = (organization: OrganizationResource) => {
 if (typeof ctx.afterCreateOrganizationUrl === 'function') {
 return navigate(ctx.afterCreateOrganizationUrl(organization));
 }

 if (ctx.afterCreateOrganizationUrl) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterCreateOrganizationUrl,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 return navigate(displayConfig.afterCreateOrganizationUrl);
 };

 return {
 ...ctx,
Expand Down

29 changes: 29 additions & 0 deletions
packages/clerk-js/src/utils/__tests__/dynamicParamParser.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { describe } from '@jest/globals';

import { createDynamicParamParser } from '../dynamicParamParser';

const entity = {
 foo: 'foo_string',
 bar: 'bar_string',
};

describe('createDynamicParamParser', () => {
 const testCases = [
 [':foo', entity, 'foo_string'],
 ['/:foo', entity, '/foo_string'],
 ['/some/:bar/any', entity, '/some/bar_string/any'],
 ['/:notValid', entity, '/:notValid'],
 ] as const;

 it.each(testCases)(
 'replaces the dynamic param with the value assigned to the key inside the object. Url=(%s), Object=(%s), result=(%s)',
 (urlWithParam, obj, result) => {
 expect(
 createDynamicParamParser({ regex: /:(\w+)/ })({
 urlWithParam,
 entity: obj,
 }),
 ).toEqual(result);
 },
 );
});

14 changes: 14 additions & 0 deletions
packages/clerk-js/src/utils/dynamicParamParser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
export const createDynamicParamParser =
 ({ regex }: { regex: RegExp }) =>
 <T extends Record<any, any>>({ urlWithParam, entity }: { urlWithParam: string; entity: T }) => {
 const match = regex.exec(urlWithParam);

 if (match) {
 const key = match[1];
 if (key in entity) {
 const value = entity[key] as string;
 return urlWithParam.replace(match[0], value);
 }
 }
 return urlWithParam;
 };

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './beforeUnloadTracker';
export * from './componentGuards';
export * from './cookies';
export * from './dynamicParamParser';
export * from './devBrowser';
export * from './email';
export * from './encoders';
Expand Down
Loading

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

Skip to content
Construct urls based on Organization or User <OrganizationSwitcher/>#1503

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

 Merged

panteliselef
merged 1 commit into

from

Aug 8, 2023
 Merged


Construct urls based on Organization or User <OrganizationSwitcher/>
#1503
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


19 changes: 19 additions & 0 deletions
.changeset/strange-owls-behave.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

Construct urls based on context in <OrganizationSwitcher/>
- Deprecate `afterSwitchOrganizationUrl`
- Introduce `afterSelectOrganizationUrl` & `afterSelectPersonalUrl`

`afterSelectOrganizationUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/organizations'
- relative path -> with param '/organizations/:id'
- function that returns a string -> (org) => `/org/${org.slug}`
`afterSelectPersonalUrl` accepts
- Full URL -> 'https://clerk.com/'
- relative path -> '/users'
- relative path -> with param '/users/:username'
- function that returns a string -> (user) => `/users/${user.id}`

7 changes: 6 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
import type { OrganizationResource } from '@clerk/types';
import React from 'react';

import { QuestionMark } from '../../../ui/icons';
Expand DownExpand Up@@ -27,6 +28,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 const { setActive, closeCreateOrganization } = useCoreClerk();
 const { mode, navigateAfterCreateOrganization, skipInvitationScreen } = useCreateOrganizationContext();
 const { organization } = useCoreOrganization();
 const lastCreatedOrganizationRef = React.useRef<OrganizationResource | null>(null);

 const wizard = useWizard({ onNextStep: () => card.setError(undefined) });

Expand DownExpand Up@@ -61,6 +63,7 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 await organization.setLogo({ file });
 }

 lastCreatedOrganizationRef.current = organization;
 await setActive({ organization });

 if (skipInvitationScreen ?? organization.maxAllowedMemberships === 1) {
Expand All@@ -74,7 +77,9 @@ export const CreateOrganizationPage = withCardStateProvider(() => {
 };

 const completeFlow = () => {
 void navigateAfterCreateOrganization();
 // We are confident that lastCreatedOrganizationRef.current will never be null
 // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 void navigateAfterCreateOrganization(lastCreatedOrganizationRef.current!);
 if (mode === 'modal') {
 closeCreateOrganization();
 }
Expand Down

50 changes: 50 additions & 0 deletions
packages/clerk-js/src/ui/components/CreateOrganization/__tests__/CreateOrganization.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -158,4 +158,54 @@ describe('CreateOrganization', () => {
 expect(queryByText(/Invite members/i)).not.toBeInTheDocument();
 });
 });

 describe('navigation', () => {
 it('constructs afterCreateOrganizationUrl from function', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: org => `/org/${org.id}` });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.id}`);
 });

 it('constructs afterCreateOrganizationUrl from `:slug` ', async () => {
 const { wrapper, fixtures, props } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 });
 });

 const createdOrg = getCreatedOrg({
 maxAllowedMemberships: 1,
 });

 fixtures.clerk.createOrganization.mockReturnValue(Promise.resolve(createdOrg));

 props.setProps({ afterCreateOrganizationUrl: '/org/:slug' });
 const { getByRole, userEvent, getByLabelText } = render(<CreateOrganization />, {
 wrapper,
 });
 await userEvent.type(getByLabelText(/Organization name/i), 'new org');
 await userEvent.click(getByRole('button', { name: /create organization/i }));

 expect(fixtures.router.navigate).toHaveBeenCalledWith(`/org/${createdOrg.slug}`);
 });
 });
});

14 changes: 11 additions & 3 deletions
packages/clerk-js/src/ui/components/OrganizationSwitcher/OrganizationSwitcherPopover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -48,7 +48,8 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 afterCreateOrganizationUrl,
 navigateCreateOrganization,
 navigateOrganizationProfile,
 navigateAfterSwitchOrganization,
 navigateAfterSelectPersonal,
 navigateAfterSelectOrganization,
 } = useOrganizationSwitcherContext();

 const user = useCoreUser();
Expand All@@ -60,12 +61,19 @@ export const OrganizationSwitcherPopover = React.forwardRef<HTMLDivElement, Orga
 }

 const handleOrganizationClicked = (organization: OrganizationResource) => {
 return card.runAsync(() => setActive({ organization, beforeEmit: navigateAfterSwitchOrganization })).then(close);
 return card
 .runAsync(() =>
 setActive({
 organization,
 beforeEmit: () => navigateAfterSelectOrganization(organization),
 }),
 )
 .then(close);
 };

 const handlePersonalWorkspaceClicked = () => {
 return card
 .runAsync(() => setActive({ organization: null, beforeEmit: navigateAfterSwitchOrganization }))
 .runAsync(() => setActive({ organization: null, beforeEmit: () => navigateAfterSelectPersonal(user) }))
 .then(close);
 };

Expand Down

52 changes: 51 additions & 1 deletion
...s/clerk-js/src/ui/components/OrganizationSwitcher/__tests__/OrganizationSwitcher.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -131,6 +131,56 @@ describe('OrganizationSwitcher', () => {
 expect(queryByRole('button', { name: 'Create Organization' })).not.toBeInTheDocument();
 });

 it.todo('switches between active organizations when one is clicked');
 it("switches between active organizations when one is clicked'", async () => {
 const { wrapper, props, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 create_organization_enabled: false,
 });
 });
 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());

 props.setProps({ hidePersonal: true });
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText('Org2'));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: expect.objectContaining({
 name: 'Org2',
 }),
 }),
 );
 });

 it("switches to personal workspace when clicked'", async () => {
 const { wrapper, fixtures } = await createFixtures(f => {
 f.withOrganizations();
 f.withUser({
 email_addresses: ['test@clerk.dev'],
 organization_memberships: [
 { name: 'Org1', role: 'basic_member' },
 { name: 'Org2', role: 'admin' },
 ],
 });
 });

 fixtures.clerk.setActive.mockReturnValueOnce(Promise.resolve());
 const { getByRole, getByText, userEvent } = render(<OrganizationSwitcher />, { wrapper });
 await userEvent.click(getByRole('button'));
 await userEvent.click(getByText(/Personal workspace/i));

 expect(fixtures.clerk.setActive).toHaveBeenCalledWith(
 expect.objectContaining({
 organization: null,
 }),
 );
 });
 });
});

71 changes: 65 additions & 6 deletions
packages/clerk-js/src/ui/contexts/ClerkUIComponentsContext.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { OrganizationResource, UserResource } from '@clerk/types';
import React from 'react';

import { buildAuthQueryString, buildURL, pickRedirectionProp } from '../../utils';
import { buildAuthQueryString, buildURL, createDynamicParamParser, pickRedirectionProp } from '../../utils';
import { useCoreClerk, useEnvironment, useOptions } from '../contexts';
import type { ParsedQs } from '../router';
import { useRouter } from '../router';
Expand All@@ -15,6 +16,8 @@ import type {
 UserProfileCtx,
} from '../types';

const populateParamFromObject = createDynamicParamParser({ regex: /:(\w+)/ });

export const ComponentContext = React.createContext<AvailableComponentCtx | null>(null);

export type SignUpContextType = SignUpCtx & {
Expand DownExpand Up@@ -230,8 +233,50 @@ export const useOrganizationSwitcherContext = () => {
 const navigateCreateOrganization = () => navigate(ctx.createOrganizationUrl || displayConfig.createOrganizationUrl);
 const navigateOrganizationProfile = () =>
 navigate(ctx.organizationProfileUrl || displayConfig.organizationProfileUrl);
 const navigateAfterSwitchOrganization = () =>
 ctx.afterSwitchOrganizationUrl ? navigate(ctx.afterSwitchOrganizationUrl) : Promise.resolve();

 const navigateAfterSelectOrganizationOrPersonal = ({
 organization,
 user,
 }: {
 organization?: OrganizationResource;
 user?: UserResource;
 }) => {
 if (typeof ctx.afterSelectPersonalUrl === 'function' && user) {
 return navigate(ctx.afterSelectPersonalUrl(user));
 }

 if (typeof ctx.afterSelectOrganizationUrl === 'function' && organization) {
 return navigate(ctx.afterSelectOrganizationUrl(organization));
 }

 if (ctx.afterSelectPersonalUrl && user) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectPersonalUrl as string,
 entity: user,
 });
 return navigate(parsedUrl);
 }

 if (ctx.afterSelectOrganizationUrl && organization) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterSelectOrganizationUrl as string,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 // Continue to support afterSwitchOrganizationUrl
 if (ctx.afterSwitchOrganizationUrl) {
 return navigate(ctx.afterSwitchOrganizationUrl);
 }

 return Promise.resolve();
 };

 const navigateAfterSelectOrganization = (organization: OrganizationResource) =>
 navigateAfterSelectOrganizationOrPersonal({ organization });

 const navigateAfterSelectPersonal = (user: UserResource) => navigateAfterSelectOrganizationOrPersonal({ user });

 return {
 ...ctx,
Expand All@@ -242,7 +287,8 @@ export const useOrganizationSwitcherContext = () => {
 afterLeaveOrganizationUrl,
 navigateOrganizationProfile,
 navigateCreateOrganization,
 navigateAfterSwitchOrganization,
 navigateAfterSelectOrganization,
 navigateAfterSelectPersonal,
 componentName,
 };
};
Expand DownExpand Up@@ -275,8 +321,21 @@ export const useCreateOrganizationContext = () => {
 throw new Error('Clerk: useCreateOrganizationContext called outside CreateOrganization.');
 }

 const navigateAfterCreateOrganization = () =>
 navigate(ctx.afterCreateOrganizationUrl || displayConfig.afterCreateOrganizationUrl);
 const navigateAfterCreateOrganization = (organization: OrganizationResource) => {
 if (typeof ctx.afterCreateOrganizationUrl === 'function') {
 return navigate(ctx.afterCreateOrganizationUrl(organization));
 }

 if (ctx.afterCreateOrganizationUrl) {
 const parsedUrl = populateParamFromObject({
 urlWithParam: ctx.afterCreateOrganizationUrl,
 entity: organization,
 });
 return navigate(parsedUrl);
 }

 return navigate(displayConfig.afterCreateOrganizationUrl);
 };

 return {
 ...ctx,
Expand Down

29 changes: 29 additions & 0 deletions
packages/clerk-js/src/utils/__tests__/dynamicParamParser.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
import { describe } from '@jest/globals';

import { createDynamicParamParser } from '../dynamicParamParser';

const entity = {
 foo: 'foo_string',
 bar: 'bar_string',
};

describe('createDynamicParamParser', () => {
 const testCases = [
 [':foo', entity, 'foo_string'],
 ['/:foo', entity, '/foo_string'],
 ['/some/:bar/any', entity, '/some/bar_string/any'],
 ['/:notValid', entity, '/:notValid'],
 ] as const;

 it.each(testCases)(
 'replaces the dynamic param with the value assigned to the key inside the object. Url=(%s), Object=(%s), result=(%s)',
 (urlWithParam, obj, result) => {
 expect(
 createDynamicParamParser({ regex: /:(\w+)/ })({
 urlWithParam,
 entity: obj,
 }),
 ).toEqual(result);
 },
 );
});

14 changes: 14 additions & 0 deletions
packages/clerk-js/src/utils/dynamicParamParser.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
export const createDynamicParamParser =
 ({ regex }: { regex: RegExp }) =>
 <T extends Record<any, any>>({ urlWithParam, entity }: { urlWithParam: string; entity: T }) => {
 const match = regex.exec(urlWithParam);

 if (match) {
 const key = match[1];
 if (key in entity) {
 const value = entity[key] as string;
 return urlWithParam.replace(match[0], value);
 }
 }
 return urlWithParam;
 };

1 change: 1 addition & 0 deletions
packages/clerk-js/src/utils/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
export * from './beforeUnloadTracker';
export * from './componentGuards';
export * from './cookies';
export * from './dynamicParamParser';
export * from './devBrowser';
export * from './email';
export * from './encoders';
Expand Down
Loading