Skip to content

feat(clerk-js,types): Fetch custom roles and localize them#2004

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 8 commits into from
Nov 3, 2023
Merged

feat(clerk-js,types): Fetch custom roles and localize them #2004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7462464
feat(clerk-js,types): Fetch custom roles and localize them
panteliselef Oct 30, 2023
b11830a
test(clerk-js): Fetch custom roles and localize them
panteliselef Oct 31, 2023
997a175
feat(clerk-js,types): Create PermissionResource
panteliselef Nov 1, 2023
8eedd2e
chore(clerk-js): Add changeset
panteliselef Nov 1, 2023
f207d48
chore(clerk-js): Add experimental tags
panteliselef Nov 1, 2023
b015e2b
test(clerk-js): Add test case for displaying custom roles in select menu
panteliselef Nov 1, 2023
6ef966f
chore(clerk-js): Improve types & add comments
panteliselef Nov 2, 2023
bc8b4d6
chore(clerk-js): Address PR comments
panteliselef Nov 3, 2023
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
8 changes: 8 additions & 0 deletions .changeset/famous-forks-buy.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

Add support for custom roles in `<OrganizationProfile/>`.

The previous roles (`admin` and `basic_member`), are still kept as a fallback.
18 changes: 18 additions & 0 deletions packages/clerk-js/src/core/resources/Organization.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
GetMembershipRequestParams,
GetMemberships,
GetPendingInvitationsParams,
GetRolesParams,
InviteMemberParams,
InviteMembersParams,
OrganizationDomainJSON,
Expand All@@ -20,6 +21,7 @@ import type {
OrganizationMembershipRequestJSON,
OrganizationMembershipRequestResource,
OrganizationResource,
RoleJSON,
SetOrganizationLogoParams,
UpdateMembershipParams,
UpdateOrganizationParams,
Expand All@@ -31,6 +33,7 @@ import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';

export class Organization extends BaseResource implements OrganizationResource {
pathRoot = '/organizations';
Expand DownExpand Up@@ -105,6 +108,21 @@ export class Organization extends BaseResource implements OrganizationResource {
});
};

getRoles = async (getRolesParams?: GetRolesParams) => {
return await BaseResource._fetch({
path: `/organizations/${this.id}/roles`,
method: 'GET',
search: convertPageToOffset(getRolesParams) as any,
}).then(res => {
const { data: roles, total_count } = res?.response as unknown as ClerkPaginatedResponse<RoleJSON>;

return {
total_count,
data: roles.map(role => new Role(role)),
};
});
};

getDomains = async (
getDomainParams?: GetDomainsParams,
): Promise<ClerkPaginatedResponse<OrganizationDomainResource>> => {
Expand Down
37 changes: 37 additions & 0 deletions packages/clerk-js/src/core/resources/Permission.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import type { PermissionJSON, PermissionResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';

/**
* @experimental
*/
export class Permission extends BaseResource implements PermissionResource {
id!: string;
key!: string;
name!: string;
description!: string;
type!: 'system' | 'user';
createdAt!: Date;
updatedAt!: Date;

constructor(data: PermissionJSON) {
super();
this.fromJSON(data);
}

protected fromJSON(data: PermissionJSON | null): this {
if (!data) {
return this;
}

this.id = data.id;
this.key = data.key;
this.name = data.name;
this.description = data.description;
this.type = data.type;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}
38 changes: 38 additions & 0 deletions packages/clerk-js/src/core/resources/Role.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import type { RoleJSON, RoleResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';
import { Permission } from './Permission';

/**
* @experimental
*/
export class Role extends BaseResource implements RoleResource {
id!: string;
key!: string;
name!: string;
description!: string;
permissions: Permission[] = [];
createdAt!: Date;
updatedAt!: Date;

constructor(data: RoleJSON) {
super();
this.fromJSON(data);
}

protected fromJSON(data: RoleJSON | null): this {
if (!data) {
return this;
}

this.id = data.id;
this.key = data.key;
this.name = data.name;
this.description = data.description;
this.permissions = data.permissions.map(perm => new Permission(perm));
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
}
}
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ Organization {
"getMembershipRequests": [Function],
"getMemberships": [Function],
"getPendingInvitations": [Function],
"getRoles": [Function],
"hasImage": true,
"id": "test_id",
"imageUrl": "https://clerk.com",
Expand Down
1 change: 1 addition & 0 deletions packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ OrganizationMembership {
"getMembershipRequests": [Function],
"getMemberships": [Function],
"getPendingInvitations": [Function],
"getRoles": [Function],
"hasImage": true,
"id": "test_org_id",
"imageUrl": "https://clerk.com",
Expand Down
1 change: 0 additions & 1 deletion packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,6 @@ export const CreateOrganizationForm = (props: CreateOrganizationFormProps) => {
>
{organization && (
<InviteMembersForm
organization={organization}
resetButtonLabel={localizationKeys('createOrganization.invitePage.formButtonReset')}
onSuccess={wizard.nextStep}
onReset={completeFlow}
Expand Down
26 changes: 14 additions & 12 deletions packages/clerk-js/src/ui/components/OrganizationProfile/ActiveMembersList.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import type { MembershipRole, OrganizationMembershipResource } from '@clerk/types';
import type { OrganizationMembershipResource } from '@clerk/types';

import { Gate } from '../../common/Gate';
import { useCoreOrganization, useCoreUser } from '../../contexts';
import { Badge, localizationKeys, Td, Text } from '../../customizables';
import { ThreeDotsMenu, useCardState, UserPreview } from '../../elements';
import { handleError, roleLocalizationKey } from '../../utils';
import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles';
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

export const ActiveMembersList = () => {
Expand All@@ -13,11 +14,13 @@ export const ActiveMembersList = () => {
memberships: true,
});

const { options, isLoading: loadingRoles } = useFetchRoles();

if (!organization) {
return null;
}

const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: MembershipRole) => {
const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: string) => {
return card
.runAsync(async () => {
return await membership.update({ role: newRole });
Expand All@@ -41,7 +44,7 @@ export const ActiveMembersList = () => {
onPageChange={n => memberships?.fetchPage?.(n)}
itemCount={memberships?.count || 0}
pageCount={memberships?.pageCount || 0}
isLoading={memberships?.isLoading}
isLoading={memberships?.isLoading || loadingRoles}
emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
headers={[
localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand All@@ -53,6 +56,7 @@ export const ActiveMembersList = () => {
<MemberRow
key={m.id}
membership={m}
options={options}
onRoleChange={handleRoleChange(m)}
onRemove={handleRemove(m)}
/>
Expand All@@ -65,9 +69,11 @@ export const ActiveMembersList = () => {
const MemberRow = (props: {
membership: OrganizationMembershipResource;
onRemove: () => unknown;
onRoleChange?: (role: MembershipRole) => unknown;
options: Parameters<typeof RoleSelect>[0]['roles'];
onRoleChange: (role: string) => unknown;
}) => {
const { membership, onRemove, onRoleChange } = props;
const { membership, onRemove, onRoleChange, options } = props;
const { localizeCustomRole } = useLocalizeCustomRoles();
const card = useCardState();
const user = useCoreUser();

Expand All@@ -94,17 +100,13 @@ const MemberRow = (props: {
<Td>
<Gate
permission={'org:sys_memberships:manage'}
fallback={
<Text
sx={t => ({ opacity: t.opacity.$inactive })}
localizationKey={roleLocalizationKey(membership.role)}
/>
}
fallback={<Text sx={t => ({ opacity: t.opacity.$inactive })}>{localizeCustomRole(membership.role)}</Text>}
>
<RoleSelect
isDisabled={card.isLoading || !onRoleChange}
value={membership.role}
onChange={onRoleChange}
roles={options}
/>
</Gate>
</Td>
Expand Down
92 changes: 45 additions & 47 deletions packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,21 @@
import { isClerkAPIResponseError } from '@clerk/shared/error';
import type { ClerkAPIError, MembershipRole, OrganizationResource } from '@clerk/types';
import React from 'react';
import type { ClerkAPIError, MembershipRole } from '@clerk/types';
import type { FormEvent } from 'react';
import { useState } from 'react';

import { useCoreOrganization } from '../../contexts';
import { Flex, Text } from '../../customizables';
import {
Form,
FormButtonContainer,
Select,
SelectButton,
SelectOptionList,
TagInput,
useCardState,
} from '../../elements';
import { Form, FormButtonContainer, TagInput, useCardState } from '../../elements';
import { useFetchRoles } from '../../hooks/useFetchRoles';
import type { LocalizationKey } from '../../localization';
import { localizationKeys, useLocalizations } from '../../localization';
import { useRouter } from '../../router';
import { createListFormat, handleError, roleLocalizationKey, useFormControl } from '../../utils';
import { createListFormat, handleError, useFormControl } from '../../utils';
import { RoleSelect } from './MemberListTable';

const isEmail = (str: string) => /^\S+@\S+\.\S+$/.test(str);

type InviteMembersFormProps = {
organization: OrganizationResource;
onSuccess: () => void;
onReset?: () => void;
primaryButtonLabel?: LocalizationKey;
Expand All@@ -29,22 +24,18 @@ type InviteMembersFormProps = {

export const InviteMembersForm = (props: InviteMembersFormProps) => {
const { navigate } = useRouter();
const { onSuccess, onReset = () => navigate('..'), resetButtonLabel, organization } = props;
const { onSuccess, onReset = () => navigate('..'), resetButtonLabel } = props;
const { organization } = useCoreOrganization();
const card = useCardState();
const { t, locale } = useLocalizations();
const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = React.useState(false);
const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = useState(false);

if (!organization) {
return null;
}

const validateUnsubmittedEmail = (value: string) => setIsValidUnsubmittedEmail(isEmail(value));

const roles: Array<{ label: string; value: MembershipRole }> = [
{ label: t(roleLocalizationKey('admin')), value: 'admin' },
{ label: t(roleLocalizationKey('basic_member')), value: 'basic_member' },
];

const emailAddressField = useFormControl('emailAddress', '', {
type: 'text',
label: localizationKeys('formFieldLabel__emailAddresses'),
Expand All@@ -67,18 +58,17 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
},
} = emailAddressField;

const roleField = useFormControl('role', 'basic_member', {
options: roles,
label: localizationKeys('formFieldLabel__role'),
placeholder: '',
});

const canSubmit = !!emailAddressField.value.length || isValidUnsubmittedEmail;

const onSubmit = async (e: React.FormEvent) => {
const onSubmit = (e: FormEvent<HTMLFormElement>) => {
e.preventDefault();

const submittedData = new FormData(e.currentTarget);
return organization
.inviteMembers({ emailAddresses: emailAddressField.value.split(','), role: roleField.value as MembershipRole })
.inviteMembers({
emailAddresses: emailAddressField.value.split(','),
role: submittedData.get('role') as MembershipRole,
})
.then(onSuccess)
.catch(err => {
if (isClerkAPIResponseError(err)) {
Expand DownExpand Up@@ -132,25 +122,7 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
/>
</Flex>
</Form.ControlRow>
<Form.ControlRow elementId={roleField.id}>
<Flex
direction='col'
gap={2}
>
<Text localizationKey={roleField.label} />
{/*@ts-expect-error Select expects options to be an array but useFormControl returns an optional field. */}
<Select
elementId='role'
{...roleField.props}
onChange={option => roleField.setValue(option.value)}
>
<SelectButton sx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}>
{roleField.props.options?.find(o => o.value === roleField.value)?.label}
</SelectButton>
<SelectOptionList sx={t => ({ minWidth: t.sizes.$48 })} />
</Select>
</Flex>
</Form.ControlRow>
<AsyncRoleSelect />
<FormButtonContainer>
<Form.SubmitButton
block={false}
Expand All@@ -166,3 +138,29 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
</Form.Root>
);
};

const AsyncRoleSelect = () => {
const { options, isLoading } = useFetchRoles();
const roleField = useFormControl('role', '', {
label: localizationKeys('formFieldLabel__role'),
});

return (
<Form.ControlRow elementId={roleField.id}>
<Flex
direction='col'
gap={2}
>
<Text localizationKey={roleField.label} />
<RoleSelect
{...roleField.props}
roles={options}
isDisabled={isLoading}
onChange={value => roleField.setValue(value)}
triggerSx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}
optionListSx={t => ({ minWidth: t.sizes.$48 })}
/>
</Flex>
</Form.ControlRow>
);
};
5 changes: 1 addition & 4 deletions packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersPage.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,10 +40,7 @@ export const InviteMembersPage = withCardStateProvider(() => {
__unstable_manageBillingMembersLimit={__unstable_manageBillingMembersLimit}
/>
)}
<InviteMembersForm
organization={organization}
onSuccess={wizard.nextStep}
/>
<InviteMembersForm onSuccess={wizard.nextStep} />
</ContentPage>
<SuccessPage
title={title}
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(clerk-js,types): Fetch custom roles and localize them by panteliselef · Pull Request #2004 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,types): Fetch custom roles and localize them#2004

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 8 commits into

from

Nov 3, 2023
 Merged


feat(clerk-js,types): Fetch custom roles and localize them
#2004
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
7462464

feat(clerk-js,types): Fetch custom roles and localize them


panteliselef Oct 30, 2023
b11830a

test(clerk-js): Fetch custom roles and localize them


panteliselef Oct 31, 2023
997a175

feat(clerk-js,types): Create PermissionResource


panteliselef Nov 1, 2023
8eedd2e

chore(clerk-js): Add changeset


panteliselef Nov 1, 2023
f207d48

chore(clerk-js): Add experimental tags


panteliselef Nov 1, 2023
b015e2b

test(clerk-js): Add test case for displaying custom roles in select menu


panteliselef Nov 1, 2023
6ef966f

chore(clerk-js): Improve types & add comments


panteliselef Nov 2, 2023
bc8b4d6

chore(clerk-js): Address PR comments


panteliselef Nov 3, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/famous-forks-buy.md

View file


Open in desktop

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

Add support for custom roles in `<OrganizationProfile/>`.

The previous roles (`admin` and `basic_member`), are still kept as a fallback.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
 GetMembershipRequestParams,
 GetMemberships,
 GetPendingInvitationsParams,
 GetRolesParams,
 InviteMemberParams,
 InviteMembersParams,
 OrganizationDomainJSON,
Expand All@@ -20,6 +21,7 @@ import type {
 OrganizationMembershipRequestJSON,
 OrganizationMembershipRequestResource,
 OrganizationResource,
 RoleJSON,
 SetOrganizationLogoParams,
 UpdateMembershipParams,
 UpdateOrganizationParams,
Expand All@@ -31,6 +33,7 @@ import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';

export class Organization extends BaseResource implements OrganizationResource {
 pathRoot = '/organizations';
Expand DownExpand Up@@ -105,6 +108,21 @@ export class Organization extends BaseResource implements OrganizationResource {
 });
 };

 getRoles = async (getRolesParams?: GetRolesParams) => {
 return await BaseResource._fetch({
 path: `/organizations/${this.id}/roles`,
 method: 'GET',
 search: convertPageToOffset(getRolesParams) as any,
 }).then(res => {
 const { data: roles, total_count } = res?.response as unknown as ClerkPaginatedResponse<RoleJSON>;

 return {
 total_count,
 data: roles.map(role => new Role(role)),
 };
 });
 };

 getDomains = async (
 getDomainParams?: GetDomainsParams,
 ): Promise<ClerkPaginatedResponse<OrganizationDomainResource>> => {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import type { PermissionJSON, PermissionResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';

/**
 * @experimental
 */
export class Permission extends BaseResource implements PermissionResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 type!: 'system' | 'user';
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: PermissionJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: PermissionJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.type = data.type;
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import type { RoleJSON, RoleResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';
import { Permission } from './Permission';

/**
 * @experimental
 */
export class Role extends BaseResource implements RoleResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 permissions: Permission[] = [];
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: RoleJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: RoleJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.permissions = data.permissions.map(perm => new Permission(perm));
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ Organization {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ OrganizationMembership {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,6 @@ export const CreateOrganizationForm = (props: CreateOrganizationFormProps) => {
 >
 {organization && (
 <InviteMembersForm
 organization={organization}
 resetButtonLabel={localizationKeys('createOrganization.invitePage.formButtonReset')}
 onSuccess={wizard.nextStep}
 onReset={completeFlow}
Expand Down

26 changes: 14 additions & 12 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActiveMembersList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import type { MembershipRole, OrganizationMembershipResource } from '@clerk/types';
import type { OrganizationMembershipResource } from '@clerk/types';

import { Gate } from '../../common/Gate';
import { useCoreOrganization, useCoreUser } from '../../contexts';
import { Badge, localizationKeys, Td, Text } from '../../customizables';
import { ThreeDotsMenu, useCardState, UserPreview } from '../../elements';
import { handleError, roleLocalizationKey } from '../../utils';
import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles';
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

export const ActiveMembersList = () => {
Expand All@@ -13,11 +14,13 @@ export const ActiveMembersList = () => {
 memberships: true,
 });

 const { options, isLoading: loadingRoles } = useFetchRoles();

 if (!organization) {
 return null;
 }

 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: MembershipRole) => {
 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: string) => {
 return card
 .runAsync(async () => {
 return await membership.update({ role: newRole });
Expand All@@ -41,7 +44,7 @@ export const ActiveMembersList = () => {
 onPageChange={n => memberships?.fetchPage?.(n)}
 itemCount={memberships?.count || 0}
 pageCount={memberships?.pageCount || 0}
 isLoading={memberships?.isLoading}
 isLoading={memberships?.isLoading || loadingRoles}
 emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
 headers={[
 localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand All@@ -53,6 +56,7 @@ export const ActiveMembersList = () => {
 <MemberRow
 key={m.id}
 membership={m}
 options={options}
 onRoleChange={handleRoleChange(m)}
 onRemove={handleRemove(m)}
 />
Expand All@@ -65,9 +69,11 @@ export const ActiveMembersList = () => {
const MemberRow = (props: {
 membership: OrganizationMembershipResource;
 onRemove: () => unknown;
 onRoleChange?: (role: MembershipRole) => unknown;
 options: Parameters<typeof RoleSelect>[0]['roles'];
 onRoleChange: (role: string) => unknown;
}) => {
 const { membership, onRemove, onRoleChange } = props;
 const { membership, onRemove, onRoleChange, options } = props;
 const { localizeCustomRole } = useLocalizeCustomRoles();
 const card = useCardState();
 const user = useCoreUser();

Expand All@@ -94,17 +100,13 @@ const MemberRow = (props: {
 <Td>
 <Gate
 permission={'org:sys_memberships:manage'}
 fallback={
 <Text
 sx={t => ({ opacity: t.opacity.$inactive })}
 localizationKey={roleLocalizationKey(membership.role)}
 />
 }
 fallback={<Text sx={t => ({ opacity: t.opacity.$inactive })}>{localizeCustomRole(membership.role)}</Text>}
 >
 <RoleSelect
 isDisabled={card.isLoading || !onRoleChange}
 value={membership.role}
 onChange={onRoleChange}
 roles={options}
 />
 </Gate>
 </Td>
Expand Down

92 changes: 45 additions & 47 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,26 +1,21 @@
import { isClerkAPIResponseError } from '@clerk/shared/error';
import type { ClerkAPIError, MembershipRole, OrganizationResource } from '@clerk/types';
import React from 'react';
import type { ClerkAPIError, MembershipRole } from '@clerk/types';
import type { FormEvent } from 'react';
import { useState } from 'react';

import { useCoreOrganization } from '../../contexts';
import { Flex, Text } from '../../customizables';
import {
 Form,
 FormButtonContainer,
 Select,
 SelectButton,
 SelectOptionList,
 TagInput,
 useCardState,
} from '../../elements';
import { Form, FormButtonContainer, TagInput, useCardState } from '../../elements';
import { useFetchRoles } from '../../hooks/useFetchRoles';
import type { LocalizationKey } from '../../localization';
import { localizationKeys, useLocalizations } from '../../localization';
import { useRouter } from '../../router';
import { createListFormat, handleError, roleLocalizationKey, useFormControl } from '../../utils';
import { createListFormat, handleError, useFormControl } from '../../utils';
import { RoleSelect } from './MemberListTable';

const isEmail = (str: string) => /^\S+@\S+\.\S+$/.test(str);

type InviteMembersFormProps = {
 organization: OrganizationResource;
 onSuccess: () => void;
 onReset?: () => void;
 primaryButtonLabel?: LocalizationKey;
Expand All@@ -29,22 +24,18 @@ type InviteMembersFormProps = {

export const InviteMembersForm = (props: InviteMembersFormProps) => {
 const { navigate } = useRouter();
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel, organization } = props;
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel } = props;
 const { organization } = useCoreOrganization();
 const card = useCardState();
 const { t, locale } = useLocalizations();
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = React.useState(false);
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = useState(false);

 if (!organization) {
 return null;
 }

 const validateUnsubmittedEmail = (value: string) => setIsValidUnsubmittedEmail(isEmail(value));

 const roles: Array<{ label: string; value: MembershipRole }> = [
 { label: t(roleLocalizationKey('admin')), value: 'admin' },
 { label: t(roleLocalizationKey('basic_member')), value: 'basic_member' },
 ];

 const emailAddressField = useFormControl('emailAddress', '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__emailAddresses'),
Expand All@@ -67,18 +58,17 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 },
 } = emailAddressField;

 const roleField = useFormControl('role', 'basic_member', {
 options: roles,
 label: localizationKeys('formFieldLabel__role'),
 placeholder: '',
 });

 const canSubmit = !!emailAddressField.value.length || isValidUnsubmittedEmail;

 const onSubmit = async (e: React.FormEvent) => {
 const onSubmit = (e: FormEvent<HTMLFormElement>) => {
 e.preventDefault();

 const submittedData = new FormData(e.currentTarget);
 return organization
 .inviteMembers({ emailAddresses: emailAddressField.value.split(','), role: roleField.value as MembershipRole })
 .inviteMembers({
 emailAddresses: emailAddressField.value.split(','),
 role: submittedData.get('role') as MembershipRole,
 })
 .then(onSuccess)
 .catch(err => {
 if (isClerkAPIResponseError(err)) {
Expand DownExpand Up@@ -132,25 +122,7 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 />
 </Flex>
 </Form.ControlRow>
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 {/*@ts-expect-error Select expects options to be an array but useFormControl returns an optional field. */}
 <Select
 elementId='role'
 {...roleField.props}
 onChange={option => roleField.setValue(option.value)}
 >
 <SelectButton sx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}>
 {roleField.props.options?.find(o => o.value === roleField.value)?.label}
 </SelectButton>
 <SelectOptionList sx={t => ({ minWidth: t.sizes.$48 })} />
 </Select>
 </Flex>
 </Form.ControlRow>
 <AsyncRoleSelect />
 <FormButtonContainer>
 <Form.SubmitButton
 block={false}
Expand All@@ -166,3 +138,29 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 </Form.Root>
 );
};

const AsyncRoleSelect = () => {
 const { options, isLoading } = useFetchRoles();
 const roleField = useFormControl('role', '', {
 label: localizationKeys('formFieldLabel__role'),
 });

 return (
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 <RoleSelect
 {...roleField.props}
 roles={options}
 isDisabled={isLoading}
 onChange={value => roleField.setValue(value)}
 triggerSx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}
 optionListSx={t => ({ minWidth: t.sizes.$48 })}
 />
 </Flex>
 </Form.ControlRow>
 );
};

5 changes: 1 addition & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,10 +40,7 @@ export const InviteMembersPage = withCardStateProvider(() => {
 __unstable_manageBillingMembersLimit={__unstable_manageBillingMembersLimit}
 />
 )}
 <InviteMembersForm
 organization={organization}
 onSuccess={wizard.nextStep}
 />
 <InviteMembersForm onSuccess={wizard.nextStep} />
 </ContentPage>
 <SuccessPage
 title={title}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js,types): Fetch custom roles and localize them by panteliselef · Pull Request #2004 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,types): Fetch custom roles and localize them#2004

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 8 commits into

from

Nov 3, 2023
 Merged


feat(clerk-js,types): Fetch custom roles and localize them
#2004
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
7462464

feat(clerk-js,types): Fetch custom roles and localize them


panteliselef Oct 30, 2023
b11830a

test(clerk-js): Fetch custom roles and localize them


panteliselef Oct 31, 2023
997a175

feat(clerk-js,types): Create PermissionResource


panteliselef Nov 1, 2023
8eedd2e

chore(clerk-js): Add changeset


panteliselef Nov 1, 2023
f207d48

chore(clerk-js): Add experimental tags


panteliselef Nov 1, 2023
b015e2b

test(clerk-js): Add test case for displaying custom roles in select menu


panteliselef Nov 1, 2023
6ef966f

chore(clerk-js): Improve types & add comments


panteliselef Nov 2, 2023
bc8b4d6

chore(clerk-js): Address PR comments


panteliselef Nov 3, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/famous-forks-buy.md

View file


Open in desktop

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

Add support for custom roles in `<OrganizationProfile/>`.

The previous roles (`admin` and `basic_member`), are still kept as a fallback.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
 GetMembershipRequestParams,
 GetMemberships,
 GetPendingInvitationsParams,
 GetRolesParams,
 InviteMemberParams,
 InviteMembersParams,
 OrganizationDomainJSON,
Expand All@@ -20,6 +21,7 @@ import type {
 OrganizationMembershipRequestJSON,
 OrganizationMembershipRequestResource,
 OrganizationResource,
 RoleJSON,
 SetOrganizationLogoParams,
 UpdateMembershipParams,
 UpdateOrganizationParams,
Expand All@@ -31,6 +33,7 @@ import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';

export class Organization extends BaseResource implements OrganizationResource {
 pathRoot = '/organizations';
Expand DownExpand Up@@ -105,6 +108,21 @@ export class Organization extends BaseResource implements OrganizationResource {
 });
 };

 getRoles = async (getRolesParams?: GetRolesParams) => {
 return await BaseResource._fetch({
 path: `/organizations/${this.id}/roles`,
 method: 'GET',
 search: convertPageToOffset(getRolesParams) as any,
 }).then(res => {
 const { data: roles, total_count } = res?.response as unknown as ClerkPaginatedResponse<RoleJSON>;

 return {
 total_count,
 data: roles.map(role => new Role(role)),
 };
 });
 };

 getDomains = async (
 getDomainParams?: GetDomainsParams,
 ): Promise<ClerkPaginatedResponse<OrganizationDomainResource>> => {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import type { PermissionJSON, PermissionResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';

/**
 * @experimental
 */
export class Permission extends BaseResource implements PermissionResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 type!: 'system' | 'user';
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: PermissionJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: PermissionJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.type = data.type;
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import type { RoleJSON, RoleResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';
import { Permission } from './Permission';

/**
 * @experimental
 */
export class Role extends BaseResource implements RoleResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 permissions: Permission[] = [];
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: RoleJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: RoleJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.permissions = data.permissions.map(perm => new Permission(perm));
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ Organization {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ OrganizationMembership {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,6 @@ export const CreateOrganizationForm = (props: CreateOrganizationFormProps) => {
 >
 {organization && (
 <InviteMembersForm
 organization={organization}
 resetButtonLabel={localizationKeys('createOrganization.invitePage.formButtonReset')}
 onSuccess={wizard.nextStep}
 onReset={completeFlow}
Expand Down

26 changes: 14 additions & 12 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActiveMembersList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import type { MembershipRole, OrganizationMembershipResource } from '@clerk/types';
import type { OrganizationMembershipResource } from '@clerk/types';

import { Gate } from '../../common/Gate';
import { useCoreOrganization, useCoreUser } from '../../contexts';
import { Badge, localizationKeys, Td, Text } from '../../customizables';
import { ThreeDotsMenu, useCardState, UserPreview } from '../../elements';
import { handleError, roleLocalizationKey } from '../../utils';
import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles';
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

export const ActiveMembersList = () => {
Expand All@@ -13,11 +14,13 @@ export const ActiveMembersList = () => {
 memberships: true,
 });

 const { options, isLoading: loadingRoles } = useFetchRoles();

 if (!organization) {
 return null;
 }

 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: MembershipRole) => {
 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: string) => {
 return card
 .runAsync(async () => {
 return await membership.update({ role: newRole });
Expand All@@ -41,7 +44,7 @@ export const ActiveMembersList = () => {
 onPageChange={n => memberships?.fetchPage?.(n)}
 itemCount={memberships?.count || 0}
 pageCount={memberships?.pageCount || 0}
 isLoading={memberships?.isLoading}
 isLoading={memberships?.isLoading || loadingRoles}
 emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
 headers={[
 localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand All@@ -53,6 +56,7 @@ export const ActiveMembersList = () => {
 <MemberRow
 key={m.id}
 membership={m}
 options={options}
 onRoleChange={handleRoleChange(m)}
 onRemove={handleRemove(m)}
 />
Expand All@@ -65,9 +69,11 @@ export const ActiveMembersList = () => {
const MemberRow = (props: {
 membership: OrganizationMembershipResource;
 onRemove: () => unknown;
 onRoleChange?: (role: MembershipRole) => unknown;
 options: Parameters<typeof RoleSelect>[0]['roles'];
 onRoleChange: (role: string) => unknown;
}) => {
 const { membership, onRemove, onRoleChange } = props;
 const { membership, onRemove, onRoleChange, options } = props;
 const { localizeCustomRole } = useLocalizeCustomRoles();
 const card = useCardState();
 const user = useCoreUser();

Expand All@@ -94,17 +100,13 @@ const MemberRow = (props: {
 <Td>
 <Gate
 permission={'org:sys_memberships:manage'}
 fallback={
 <Text
 sx={t => ({ opacity: t.opacity.$inactive })}
 localizationKey={roleLocalizationKey(membership.role)}
 />
 }
 fallback={<Text sx={t => ({ opacity: t.opacity.$inactive })}>{localizeCustomRole(membership.role)}</Text>}
 >
 <RoleSelect
 isDisabled={card.isLoading || !onRoleChange}
 value={membership.role}
 onChange={onRoleChange}
 roles={options}
 />
 </Gate>
 </Td>
Expand Down

92 changes: 45 additions & 47 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,26 +1,21 @@
import { isClerkAPIResponseError } from '@clerk/shared/error';
import type { ClerkAPIError, MembershipRole, OrganizationResource } from '@clerk/types';
import React from 'react';
import type { ClerkAPIError, MembershipRole } from '@clerk/types';
import type { FormEvent } from 'react';
import { useState } from 'react';

import { useCoreOrganization } from '../../contexts';
import { Flex, Text } from '../../customizables';
import {
 Form,
 FormButtonContainer,
 Select,
 SelectButton,
 SelectOptionList,
 TagInput,
 useCardState,
} from '../../elements';
import { Form, FormButtonContainer, TagInput, useCardState } from '../../elements';
import { useFetchRoles } from '../../hooks/useFetchRoles';
import type { LocalizationKey } from '../../localization';
import { localizationKeys, useLocalizations } from '../../localization';
import { useRouter } from '../../router';
import { createListFormat, handleError, roleLocalizationKey, useFormControl } from '../../utils';
import { createListFormat, handleError, useFormControl } from '../../utils';
import { RoleSelect } from './MemberListTable';

const isEmail = (str: string) => /^\S+@\S+\.\S+$/.test(str);

type InviteMembersFormProps = {
 organization: OrganizationResource;
 onSuccess: () => void;
 onReset?: () => void;
 primaryButtonLabel?: LocalizationKey;
Expand All@@ -29,22 +24,18 @@ type InviteMembersFormProps = {

export const InviteMembersForm = (props: InviteMembersFormProps) => {
 const { navigate } = useRouter();
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel, organization } = props;
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel } = props;
 const { organization } = useCoreOrganization();
 const card = useCardState();
 const { t, locale } = useLocalizations();
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = React.useState(false);
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = useState(false);

 if (!organization) {
 return null;
 }

 const validateUnsubmittedEmail = (value: string) => setIsValidUnsubmittedEmail(isEmail(value));

 const roles: Array<{ label: string; value: MembershipRole }> = [
 { label: t(roleLocalizationKey('admin')), value: 'admin' },
 { label: t(roleLocalizationKey('basic_member')), value: 'basic_member' },
 ];

 const emailAddressField = useFormControl('emailAddress', '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__emailAddresses'),
Expand All@@ -67,18 +58,17 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 },
 } = emailAddressField;

 const roleField = useFormControl('role', 'basic_member', {
 options: roles,
 label: localizationKeys('formFieldLabel__role'),
 placeholder: '',
 });

 const canSubmit = !!emailAddressField.value.length || isValidUnsubmittedEmail;

 const onSubmit = async (e: React.FormEvent) => {
 const onSubmit = (e: FormEvent<HTMLFormElement>) => {
 e.preventDefault();

 const submittedData = new FormData(e.currentTarget);
 return organization
 .inviteMembers({ emailAddresses: emailAddressField.value.split(','), role: roleField.value as MembershipRole })
 .inviteMembers({
 emailAddresses: emailAddressField.value.split(','),
 role: submittedData.get('role') as MembershipRole,
 })
 .then(onSuccess)
 .catch(err => {
 if (isClerkAPIResponseError(err)) {
Expand DownExpand Up@@ -132,25 +122,7 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 />
 </Flex>
 </Form.ControlRow>
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 {/*@ts-expect-error Select expects options to be an array but useFormControl returns an optional field. */}
 <Select
 elementId='role'
 {...roleField.props}
 onChange={option => roleField.setValue(option.value)}
 >
 <SelectButton sx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}>
 {roleField.props.options?.find(o => o.value === roleField.value)?.label}
 </SelectButton>
 <SelectOptionList sx={t => ({ minWidth: t.sizes.$48 })} />
 </Select>
 </Flex>
 </Form.ControlRow>
 <AsyncRoleSelect />
 <FormButtonContainer>
 <Form.SubmitButton
 block={false}
Expand All@@ -166,3 +138,29 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 </Form.Root>
 );
};

const AsyncRoleSelect = () => {
 const { options, isLoading } = useFetchRoles();
 const roleField = useFormControl('role', '', {
 label: localizationKeys('formFieldLabel__role'),
 });

 return (
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 <RoleSelect
 {...roleField.props}
 roles={options}
 isDisabled={isLoading}
 onChange={value => roleField.setValue(value)}
 triggerSx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}
 optionListSx={t => ({ minWidth: t.sizes.$48 })}
 />
 </Flex>
 </Form.ControlRow>
 );
};

5 changes: 1 addition & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,10 +40,7 @@ export const InviteMembersPage = withCardStateProvider(() => {
 __unstable_manageBillingMembersLimit={__unstable_manageBillingMembersLimit}
 />
 )}
 <InviteMembersForm
 organization={organization}
 onSuccess={wizard.nextStep}
 />
 <InviteMembersForm onSuccess={wizard.nextStep} />
 </ContentPage>
 <SuccessPage
 title={title}
Expand Down
Loading

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

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 8 commits into

from

Nov 3, 2023
 Merged


feat(clerk-js,types): Fetch custom roles and localize them
#2004
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
7462464

feat(clerk-js,types): Fetch custom roles and localize them


panteliselef Oct 30, 2023
b11830a

test(clerk-js): Fetch custom roles and localize them


panteliselef Oct 31, 2023
997a175

feat(clerk-js,types): Create PermissionResource


panteliselef Nov 1, 2023
8eedd2e

chore(clerk-js): Add changeset


panteliselef Nov 1, 2023
f207d48

chore(clerk-js): Add experimental tags


panteliselef Nov 1, 2023
b015e2b

test(clerk-js): Add test case for displaying custom roles in select menu


panteliselef Nov 1, 2023
6ef966f

chore(clerk-js): Improve types & add comments


panteliselef Nov 2, 2023
bc8b4d6

chore(clerk-js): Address PR comments


panteliselef Nov 3, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/famous-forks-buy.md

View file


Open in desktop

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

Add support for custom roles in `<OrganizationProfile/>`.

The previous roles (`admin` and `basic_member`), are still kept as a fallback.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
 GetMembershipRequestParams,
 GetMemberships,
 GetPendingInvitationsParams,
 GetRolesParams,
 InviteMemberParams,
 InviteMembersParams,
 OrganizationDomainJSON,
Expand All@@ -20,6 +21,7 @@ import type {
 OrganizationMembershipRequestJSON,
 OrganizationMembershipRequestResource,
 OrganizationResource,
 RoleJSON,
 SetOrganizationLogoParams,
 UpdateMembershipParams,
 UpdateOrganizationParams,
Expand All@@ -31,6 +33,7 @@ import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';

export class Organization extends BaseResource implements OrganizationResource {
 pathRoot = '/organizations';
Expand DownExpand Up@@ -105,6 +108,21 @@ export class Organization extends BaseResource implements OrganizationResource {
 });
 };

 getRoles = async (getRolesParams?: GetRolesParams) => {
 return await BaseResource._fetch({
 path: `/organizations/${this.id}/roles`,
 method: 'GET',
 search: convertPageToOffset(getRolesParams) as any,
 }).then(res => {
 const { data: roles, total_count } = res?.response as unknown as ClerkPaginatedResponse<RoleJSON>;

 return {
 total_count,
 data: roles.map(role => new Role(role)),
 };
 });
 };

 getDomains = async (
 getDomainParams?: GetDomainsParams,
 ): Promise<ClerkPaginatedResponse<OrganizationDomainResource>> => {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import type { PermissionJSON, PermissionResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';

/**
 * @experimental
 */
export class Permission extends BaseResource implements PermissionResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 type!: 'system' | 'user';
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: PermissionJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: PermissionJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.type = data.type;
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import type { RoleJSON, RoleResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';
import { Permission } from './Permission';

/**
 * @experimental
 */
export class Role extends BaseResource implements RoleResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 permissions: Permission[] = [];
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: RoleJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: RoleJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.permissions = data.permissions.map(perm => new Permission(perm));
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ Organization {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ OrganizationMembership {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,6 @@ export const CreateOrganizationForm = (props: CreateOrganizationFormProps) => {
 >
 {organization && (
 <InviteMembersForm
 organization={organization}
 resetButtonLabel={localizationKeys('createOrganization.invitePage.formButtonReset')}
 onSuccess={wizard.nextStep}
 onReset={completeFlow}
Expand Down

26 changes: 14 additions & 12 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActiveMembersList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import type { MembershipRole, OrganizationMembershipResource } from '@clerk/types';
import type { OrganizationMembershipResource } from '@clerk/types';

import { Gate } from '../../common/Gate';
import { useCoreOrganization, useCoreUser } from '../../contexts';
import { Badge, localizationKeys, Td, Text } from '../../customizables';
import { ThreeDotsMenu, useCardState, UserPreview } from '../../elements';
import { handleError, roleLocalizationKey } from '../../utils';
import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles';
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

export const ActiveMembersList = () => {
Expand All@@ -13,11 +14,13 @@ export const ActiveMembersList = () => {
 memberships: true,
 });

 const { options, isLoading: loadingRoles } = useFetchRoles();

 if (!organization) {
 return null;
 }

 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: MembershipRole) => {
 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: string) => {
 return card
 .runAsync(async () => {
 return await membership.update({ role: newRole });
Expand All@@ -41,7 +44,7 @@ export const ActiveMembersList = () => {
 onPageChange={n => memberships?.fetchPage?.(n)}
 itemCount={memberships?.count || 0}
 pageCount={memberships?.pageCount || 0}
 isLoading={memberships?.isLoading}
 isLoading={memberships?.isLoading || loadingRoles}
 emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
 headers={[
 localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand All@@ -53,6 +56,7 @@ export const ActiveMembersList = () => {
 <MemberRow
 key={m.id}
 membership={m}
 options={options}
 onRoleChange={handleRoleChange(m)}
 onRemove={handleRemove(m)}
 />
Expand All@@ -65,9 +69,11 @@ export const ActiveMembersList = () => {
const MemberRow = (props: {
 membership: OrganizationMembershipResource;
 onRemove: () => unknown;
 onRoleChange?: (role: MembershipRole) => unknown;
 options: Parameters<typeof RoleSelect>[0]['roles'];
 onRoleChange: (role: string) => unknown;
}) => {
 const { membership, onRemove, onRoleChange } = props;
 const { membership, onRemove, onRoleChange, options } = props;
 const { localizeCustomRole } = useLocalizeCustomRoles();
 const card = useCardState();
 const user = useCoreUser();

Expand All@@ -94,17 +100,13 @@ const MemberRow = (props: {
 <Td>
 <Gate
 permission={'org:sys_memberships:manage'}
 fallback={
 <Text
 sx={t => ({ opacity: t.opacity.$inactive })}
 localizationKey={roleLocalizationKey(membership.role)}
 />
 }
 fallback={<Text sx={t => ({ opacity: t.opacity.$inactive })}>{localizeCustomRole(membership.role)}</Text>}
 >
 <RoleSelect
 isDisabled={card.isLoading || !onRoleChange}
 value={membership.role}
 onChange={onRoleChange}
 roles={options}
 />
 </Gate>
 </Td>
Expand Down

92 changes: 45 additions & 47 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,26 +1,21 @@
import { isClerkAPIResponseError } from '@clerk/shared/error';
import type { ClerkAPIError, MembershipRole, OrganizationResource } from '@clerk/types';
import React from 'react';
import type { ClerkAPIError, MembershipRole } from '@clerk/types';
import type { FormEvent } from 'react';
import { useState } from 'react';

import { useCoreOrganization } from '../../contexts';
import { Flex, Text } from '../../customizables';
import {
 Form,
 FormButtonContainer,
 Select,
 SelectButton,
 SelectOptionList,
 TagInput,
 useCardState,
} from '../../elements';
import { Form, FormButtonContainer, TagInput, useCardState } from '../../elements';
import { useFetchRoles } from '../../hooks/useFetchRoles';
import type { LocalizationKey } from '../../localization';
import { localizationKeys, useLocalizations } from '../../localization';
import { useRouter } from '../../router';
import { createListFormat, handleError, roleLocalizationKey, useFormControl } from '../../utils';
import { createListFormat, handleError, useFormControl } from '../../utils';
import { RoleSelect } from './MemberListTable';

const isEmail = (str: string) => /^\S+@\S+\.\S+$/.test(str);

type InviteMembersFormProps = {
 organization: OrganizationResource;
 onSuccess: () => void;
 onReset?: () => void;
 primaryButtonLabel?: LocalizationKey;
Expand All@@ -29,22 +24,18 @@ type InviteMembersFormProps = {

export const InviteMembersForm = (props: InviteMembersFormProps) => {
 const { navigate } = useRouter();
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel, organization } = props;
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel } = props;
 const { organization } = useCoreOrganization();
 const card = useCardState();
 const { t, locale } = useLocalizations();
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = React.useState(false);
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = useState(false);

 if (!organization) {
 return null;
 }

 const validateUnsubmittedEmail = (value: string) => setIsValidUnsubmittedEmail(isEmail(value));

 const roles: Array<{ label: string; value: MembershipRole }> = [
 { label: t(roleLocalizationKey('admin')), value: 'admin' },
 { label: t(roleLocalizationKey('basic_member')), value: 'basic_member' },
 ];

 const emailAddressField = useFormControl('emailAddress', '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__emailAddresses'),
Expand All@@ -67,18 +58,17 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 },
 } = emailAddressField;

 const roleField = useFormControl('role', 'basic_member', {
 options: roles,
 label: localizationKeys('formFieldLabel__role'),
 placeholder: '',
 });

 const canSubmit = !!emailAddressField.value.length || isValidUnsubmittedEmail;

 const onSubmit = async (e: React.FormEvent) => {
 const onSubmit = (e: FormEvent<HTMLFormElement>) => {
 e.preventDefault();

 const submittedData = new FormData(e.currentTarget);
 return organization
 .inviteMembers({ emailAddresses: emailAddressField.value.split(','), role: roleField.value as MembershipRole })
 .inviteMembers({
 emailAddresses: emailAddressField.value.split(','),
 role: submittedData.get('role') as MembershipRole,
 })
 .then(onSuccess)
 .catch(err => {
 if (isClerkAPIResponseError(err)) {
Expand DownExpand Up@@ -132,25 +122,7 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 />
 </Flex>
 </Form.ControlRow>
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 {/*@ts-expect-error Select expects options to be an array but useFormControl returns an optional field. */}
 <Select
 elementId='role'
 {...roleField.props}
 onChange={option => roleField.setValue(option.value)}
 >
 <SelectButton sx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}>
 {roleField.props.options?.find(o => o.value === roleField.value)?.label}
 </SelectButton>
 <SelectOptionList sx={t => ({ minWidth: t.sizes.$48 })} />
 </Select>
 </Flex>
 </Form.ControlRow>
 <AsyncRoleSelect />
 <FormButtonContainer>
 <Form.SubmitButton
 block={false}
Expand All@@ -166,3 +138,29 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 </Form.Root>
 );
};

const AsyncRoleSelect = () => {
 const { options, isLoading } = useFetchRoles();
 const roleField = useFormControl('role', '', {
 label: localizationKeys('formFieldLabel__role'),
 });

 return (
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 <RoleSelect
 {...roleField.props}
 roles={options}
 isDisabled={isLoading}
 onChange={value => roleField.setValue(value)}
 triggerSx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}
 optionListSx={t => ({ minWidth: t.sizes.$48 })}
 />
 </Flex>
 </Form.ControlRow>
 );
};

5 changes: 1 addition & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,10 +40,7 @@ export const InviteMembersPage = withCardStateProvider(() => {
 __unstable_manageBillingMembersLimit={__unstable_manageBillingMembersLimit}
 />
 )}
 <InviteMembersForm
 organization={organization}
 onSuccess={wizard.nextStep}
 />
 <InviteMembersForm onSuccess={wizard.nextStep} />
 </ContentPage>
 <SuccessPage
 title={title}
Expand Down
Loading

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

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 8 commits into

from

Nov 3, 2023
 Merged


feat(clerk-js,types): Fetch custom roles and localize them
#2004
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
7462464

feat(clerk-js,types): Fetch custom roles and localize them


panteliselef Oct 30, 2023
b11830a

test(clerk-js): Fetch custom roles and localize them


panteliselef Oct 31, 2023
997a175

feat(clerk-js,types): Create PermissionResource


panteliselef Nov 1, 2023
8eedd2e

chore(clerk-js): Add changeset


panteliselef Nov 1, 2023
f207d48

chore(clerk-js): Add experimental tags


panteliselef Nov 1, 2023
b015e2b

test(clerk-js): Add test case for displaying custom roles in select menu


panteliselef Nov 1, 2023
6ef966f

chore(clerk-js): Improve types & add comments


panteliselef Nov 2, 2023
bc8b4d6

chore(clerk-js): Address PR comments


panteliselef Nov 3, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/famous-forks-buy.md

View file


Open in desktop

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

Add support for custom roles in `<OrganizationProfile/>`.

The previous roles (`admin` and `basic_member`), are still kept as a fallback.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
 GetMembershipRequestParams,
 GetMemberships,
 GetPendingInvitationsParams,
 GetRolesParams,
 InviteMemberParams,
 InviteMembersParams,
 OrganizationDomainJSON,
Expand All@@ -20,6 +21,7 @@ import type {
 OrganizationMembershipRequestJSON,
 OrganizationMembershipRequestResource,
 OrganizationResource,
 RoleJSON,
 SetOrganizationLogoParams,
 UpdateMembershipParams,
 UpdateOrganizationParams,
Expand All@@ -31,6 +33,7 @@ import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';

export class Organization extends BaseResource implements OrganizationResource {
 pathRoot = '/organizations';
Expand DownExpand Up@@ -105,6 +108,21 @@ export class Organization extends BaseResource implements OrganizationResource {
 });
 };

 getRoles = async (getRolesParams?: GetRolesParams) => {
 return await BaseResource._fetch({
 path: `/organizations/${this.id}/roles`,
 method: 'GET',
 search: convertPageToOffset(getRolesParams) as any,
 }).then(res => {
 const { data: roles, total_count } = res?.response as unknown as ClerkPaginatedResponse<RoleJSON>;

 return {
 total_count,
 data: roles.map(role => new Role(role)),
 };
 });
 };

 getDomains = async (
 getDomainParams?: GetDomainsParams,
 ): Promise<ClerkPaginatedResponse<OrganizationDomainResource>> => {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import type { PermissionJSON, PermissionResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';

/**
 * @experimental
 */
export class Permission extends BaseResource implements PermissionResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 type!: 'system' | 'user';
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: PermissionJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: PermissionJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.type = data.type;
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import type { RoleJSON, RoleResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';
import { Permission } from './Permission';

/**
 * @experimental
 */
export class Role extends BaseResource implements RoleResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 permissions: Permission[] = [];
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: RoleJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: RoleJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.permissions = data.permissions.map(perm => new Permission(perm));
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ Organization {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ OrganizationMembership {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,6 @@ export const CreateOrganizationForm = (props: CreateOrganizationFormProps) => {
 >
 {organization && (
 <InviteMembersForm
 organization={organization}
 resetButtonLabel={localizationKeys('createOrganization.invitePage.formButtonReset')}
 onSuccess={wizard.nextStep}
 onReset={completeFlow}
Expand Down

26 changes: 14 additions & 12 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActiveMembersList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import type { MembershipRole, OrganizationMembershipResource } from '@clerk/types';
import type { OrganizationMembershipResource } from '@clerk/types';

import { Gate } from '../../common/Gate';
import { useCoreOrganization, useCoreUser } from '../../contexts';
import { Badge, localizationKeys, Td, Text } from '../../customizables';
import { ThreeDotsMenu, useCardState, UserPreview } from '../../elements';
import { handleError, roleLocalizationKey } from '../../utils';
import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles';
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

export const ActiveMembersList = () => {
Expand All@@ -13,11 +14,13 @@ export const ActiveMembersList = () => {
 memberships: true,
 });

 const { options, isLoading: loadingRoles } = useFetchRoles();

 if (!organization) {
 return null;
 }

 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: MembershipRole) => {
 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: string) => {
 return card
 .runAsync(async () => {
 return await membership.update({ role: newRole });
Expand All@@ -41,7 +44,7 @@ export const ActiveMembersList = () => {
 onPageChange={n => memberships?.fetchPage?.(n)}
 itemCount={memberships?.count || 0}
 pageCount={memberships?.pageCount || 0}
 isLoading={memberships?.isLoading}
 isLoading={memberships?.isLoading || loadingRoles}
 emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
 headers={[
 localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand All@@ -53,6 +56,7 @@ export const ActiveMembersList = () => {
 <MemberRow
 key={m.id}
 membership={m}
 options={options}
 onRoleChange={handleRoleChange(m)}
 onRemove={handleRemove(m)}
 />
Expand All@@ -65,9 +69,11 @@ export const ActiveMembersList = () => {
const MemberRow = (props: {
 membership: OrganizationMembershipResource;
 onRemove: () => unknown;
 onRoleChange?: (role: MembershipRole) => unknown;
 options: Parameters<typeof RoleSelect>[0]['roles'];
 onRoleChange: (role: string) => unknown;
}) => {
 const { membership, onRemove, onRoleChange } = props;
 const { membership, onRemove, onRoleChange, options } = props;
 const { localizeCustomRole } = useLocalizeCustomRoles();
 const card = useCardState();
 const user = useCoreUser();

Expand All@@ -94,17 +100,13 @@ const MemberRow = (props: {
 <Td>
 <Gate
 permission={'org:sys_memberships:manage'}
 fallback={
 <Text
 sx={t => ({ opacity: t.opacity.$inactive })}
 localizationKey={roleLocalizationKey(membership.role)}
 />
 }
 fallback={<Text sx={t => ({ opacity: t.opacity.$inactive })}>{localizeCustomRole(membership.role)}</Text>}
 >
 <RoleSelect
 isDisabled={card.isLoading || !onRoleChange}
 value={membership.role}
 onChange={onRoleChange}
 roles={options}
 />
 </Gate>
 </Td>
Expand Down

92 changes: 45 additions & 47 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,26 +1,21 @@
import { isClerkAPIResponseError } from '@clerk/shared/error';
import type { ClerkAPIError, MembershipRole, OrganizationResource } from '@clerk/types';
import React from 'react';
import type { ClerkAPIError, MembershipRole } from '@clerk/types';
import type { FormEvent } from 'react';
import { useState } from 'react';

import { useCoreOrganization } from '../../contexts';
import { Flex, Text } from '../../customizables';
import {
 Form,
 FormButtonContainer,
 Select,
 SelectButton,
 SelectOptionList,
 TagInput,
 useCardState,
} from '../../elements';
import { Form, FormButtonContainer, TagInput, useCardState } from '../../elements';
import { useFetchRoles } from '../../hooks/useFetchRoles';
import type { LocalizationKey } from '../../localization';
import { localizationKeys, useLocalizations } from '../../localization';
import { useRouter } from '../../router';
import { createListFormat, handleError, roleLocalizationKey, useFormControl } from '../../utils';
import { createListFormat, handleError, useFormControl } from '../../utils';
import { RoleSelect } from './MemberListTable';

const isEmail = (str: string) => /^\S+@\S+\.\S+$/.test(str);

type InviteMembersFormProps = {
 organization: OrganizationResource;
 onSuccess: () => void;
 onReset?: () => void;
 primaryButtonLabel?: LocalizationKey;
Expand All@@ -29,22 +24,18 @@ type InviteMembersFormProps = {

export const InviteMembersForm = (props: InviteMembersFormProps) => {
 const { navigate } = useRouter();
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel, organization } = props;
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel } = props;
 const { organization } = useCoreOrganization();
 const card = useCardState();
 const { t, locale } = useLocalizations();
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = React.useState(false);
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = useState(false);

 if (!organization) {
 return null;
 }

 const validateUnsubmittedEmail = (value: string) => setIsValidUnsubmittedEmail(isEmail(value));

 const roles: Array<{ label: string; value: MembershipRole }> = [
 { label: t(roleLocalizationKey('admin')), value: 'admin' },
 { label: t(roleLocalizationKey('basic_member')), value: 'basic_member' },
 ];

 const emailAddressField = useFormControl('emailAddress', '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__emailAddresses'),
Expand All@@ -67,18 +58,17 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 },
 } = emailAddressField;

 const roleField = useFormControl('role', 'basic_member', {
 options: roles,
 label: localizationKeys('formFieldLabel__role'),
 placeholder: '',
 });

 const canSubmit = !!emailAddressField.value.length || isValidUnsubmittedEmail;

 const onSubmit = async (e: React.FormEvent) => {
 const onSubmit = (e: FormEvent<HTMLFormElement>) => {
 e.preventDefault();

 const submittedData = new FormData(e.currentTarget);
 return organization
 .inviteMembers({ emailAddresses: emailAddressField.value.split(','), role: roleField.value as MembershipRole })
 .inviteMembers({
 emailAddresses: emailAddressField.value.split(','),
 role: submittedData.get('role') as MembershipRole,
 })
 .then(onSuccess)
 .catch(err => {
 if (isClerkAPIResponseError(err)) {
Expand DownExpand Up@@ -132,25 +122,7 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 />
 </Flex>
 </Form.ControlRow>
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 {/*@ts-expect-error Select expects options to be an array but useFormControl returns an optional field. */}
 <Select
 elementId='role'
 {...roleField.props}
 onChange={option => roleField.setValue(option.value)}
 >
 <SelectButton sx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}>
 {roleField.props.options?.find(o => o.value === roleField.value)?.label}
 </SelectButton>
 <SelectOptionList sx={t => ({ minWidth: t.sizes.$48 })} />
 </Select>
 </Flex>
 </Form.ControlRow>
 <AsyncRoleSelect />
 <FormButtonContainer>
 <Form.SubmitButton
 block={false}
Expand All@@ -166,3 +138,29 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 </Form.Root>
 );
};

const AsyncRoleSelect = () => {
 const { options, isLoading } = useFetchRoles();
 const roleField = useFormControl('role', '', {
 label: localizationKeys('formFieldLabel__role'),
 });

 return (
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 <RoleSelect
 {...roleField.props}
 roles={options}
 isDisabled={isLoading}
 onChange={value => roleField.setValue(value)}
 triggerSx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}
 optionListSx={t => ({ minWidth: t.sizes.$48 })}
 />
 </Flex>
 </Form.ControlRow>
 );
};

5 changes: 1 addition & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,10 +40,7 @@ export const InviteMembersPage = withCardStateProvider(() => {
 __unstable_manageBillingMembersLimit={__unstable_manageBillingMembersLimit}
 />
 )}
 <InviteMembersForm
 organization={organization}
 onSuccess={wizard.nextStep}
 />
 <InviteMembersForm onSuccess={wizard.nextStep} />
 </ContentPage>
 <SuccessPage
 title={title}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js,types): Fetch custom roles and localize them by panteliselef · Pull Request #2004 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,types): Fetch custom roles and localize them#2004

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 8 commits into

from

Nov 3, 2023
 Merged


feat(clerk-js,types): Fetch custom roles and localize them
#2004
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
7462464

feat(clerk-js,types): Fetch custom roles and localize them


panteliselef Oct 30, 2023
b11830a

test(clerk-js): Fetch custom roles and localize them


panteliselef Oct 31, 2023
997a175

feat(clerk-js,types): Create PermissionResource


panteliselef Nov 1, 2023
8eedd2e

chore(clerk-js): Add changeset


panteliselef Nov 1, 2023
f207d48

chore(clerk-js): Add experimental tags


panteliselef Nov 1, 2023
b015e2b

test(clerk-js): Add test case for displaying custom roles in select menu


panteliselef Nov 1, 2023
6ef966f

chore(clerk-js): Improve types & add comments


panteliselef Nov 2, 2023
bc8b4d6

chore(clerk-js): Address PR comments


panteliselef Nov 3, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/famous-forks-buy.md

View file


Open in desktop

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

Add support for custom roles in `<OrganizationProfile/>`.

The previous roles (`admin` and `basic_member`), are still kept as a fallback.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
 GetMembershipRequestParams,
 GetMemberships,
 GetPendingInvitationsParams,
 GetRolesParams,
 InviteMemberParams,
 InviteMembersParams,
 OrganizationDomainJSON,
Expand All@@ -20,6 +21,7 @@ import type {
 OrganizationMembershipRequestJSON,
 OrganizationMembershipRequestResource,
 OrganizationResource,
 RoleJSON,
 SetOrganizationLogoParams,
 UpdateMembershipParams,
 UpdateOrganizationParams,
Expand All@@ -31,6 +33,7 @@ import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';

export class Organization extends BaseResource implements OrganizationResource {
 pathRoot = '/organizations';
Expand DownExpand Up@@ -105,6 +108,21 @@ export class Organization extends BaseResource implements OrganizationResource {
 });
 };

 getRoles = async (getRolesParams?: GetRolesParams) => {
 return await BaseResource._fetch({
 path: `/organizations/${this.id}/roles`,
 method: 'GET',
 search: convertPageToOffset(getRolesParams) as any,
 }).then(res => {
 const { data: roles, total_count } = res?.response as unknown as ClerkPaginatedResponse<RoleJSON>;

 return {
 total_count,
 data: roles.map(role => new Role(role)),
 };
 });
 };

 getDomains = async (
 getDomainParams?: GetDomainsParams,
 ): Promise<ClerkPaginatedResponse<OrganizationDomainResource>> => {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import type { PermissionJSON, PermissionResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';

/**
 * @experimental
 */
export class Permission extends BaseResource implements PermissionResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 type!: 'system' | 'user';
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: PermissionJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: PermissionJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.type = data.type;
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import type { RoleJSON, RoleResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';
import { Permission } from './Permission';

/**
 * @experimental
 */
export class Role extends BaseResource implements RoleResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 permissions: Permission[] = [];
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: RoleJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: RoleJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.permissions = data.permissions.map(perm => new Permission(perm));
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ Organization {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ OrganizationMembership {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,6 @@ export const CreateOrganizationForm = (props: CreateOrganizationFormProps) => {
 >
 {organization && (
 <InviteMembersForm
 organization={organization}
 resetButtonLabel={localizationKeys('createOrganization.invitePage.formButtonReset')}
 onSuccess={wizard.nextStep}
 onReset={completeFlow}
Expand Down

26 changes: 14 additions & 12 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActiveMembersList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import type { MembershipRole, OrganizationMembershipResource } from '@clerk/types';
import type { OrganizationMembershipResource } from '@clerk/types';

import { Gate } from '../../common/Gate';
import { useCoreOrganization, useCoreUser } from '../../contexts';
import { Badge, localizationKeys, Td, Text } from '../../customizables';
import { ThreeDotsMenu, useCardState, UserPreview } from '../../elements';
import { handleError, roleLocalizationKey } from '../../utils';
import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles';
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

export const ActiveMembersList = () => {
Expand All@@ -13,11 +14,13 @@ export const ActiveMembersList = () => {
 memberships: true,
 });

 const { options, isLoading: loadingRoles } = useFetchRoles();

 if (!organization) {
 return null;
 }

 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: MembershipRole) => {
 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: string) => {
 return card
 .runAsync(async () => {
 return await membership.update({ role: newRole });
Expand All@@ -41,7 +44,7 @@ export const ActiveMembersList = () => {
 onPageChange={n => memberships?.fetchPage?.(n)}
 itemCount={memberships?.count || 0}
 pageCount={memberships?.pageCount || 0}
 isLoading={memberships?.isLoading}
 isLoading={memberships?.isLoading || loadingRoles}
 emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
 headers={[
 localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand All@@ -53,6 +56,7 @@ export const ActiveMembersList = () => {
 <MemberRow
 key={m.id}
 membership={m}
 options={options}
 onRoleChange={handleRoleChange(m)}
 onRemove={handleRemove(m)}
 />
Expand All@@ -65,9 +69,11 @@ export const ActiveMembersList = () => {
const MemberRow = (props: {
 membership: OrganizationMembershipResource;
 onRemove: () => unknown;
 onRoleChange?: (role: MembershipRole) => unknown;
 options: Parameters<typeof RoleSelect>[0]['roles'];
 onRoleChange: (role: string) => unknown;
}) => {
 const { membership, onRemove, onRoleChange } = props;
 const { membership, onRemove, onRoleChange, options } = props;
 const { localizeCustomRole } = useLocalizeCustomRoles();
 const card = useCardState();
 const user = useCoreUser();

Expand All@@ -94,17 +100,13 @@ const MemberRow = (props: {
 <Td>
 <Gate
 permission={'org:sys_memberships:manage'}
 fallback={
 <Text
 sx={t => ({ opacity: t.opacity.$inactive })}
 localizationKey={roleLocalizationKey(membership.role)}
 />
 }
 fallback={<Text sx={t => ({ opacity: t.opacity.$inactive })}>{localizeCustomRole(membership.role)}</Text>}
 >
 <RoleSelect
 isDisabled={card.isLoading || !onRoleChange}
 value={membership.role}
 onChange={onRoleChange}
 roles={options}
 />
 </Gate>
 </Td>
Expand Down

92 changes: 45 additions & 47 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,26 +1,21 @@
import { isClerkAPIResponseError } from '@clerk/shared/error';
import type { ClerkAPIError, MembershipRole, OrganizationResource } from '@clerk/types';
import React from 'react';
import type { ClerkAPIError, MembershipRole } from '@clerk/types';
import type { FormEvent } from 'react';
import { useState } from 'react';

import { useCoreOrganization } from '../../contexts';
import { Flex, Text } from '../../customizables';
import {
 Form,
 FormButtonContainer,
 Select,
 SelectButton,
 SelectOptionList,
 TagInput,
 useCardState,
} from '../../elements';
import { Form, FormButtonContainer, TagInput, useCardState } from '../../elements';
import { useFetchRoles } from '../../hooks/useFetchRoles';
import type { LocalizationKey } from '../../localization';
import { localizationKeys, useLocalizations } from '../../localization';
import { useRouter } from '../../router';
import { createListFormat, handleError, roleLocalizationKey, useFormControl } from '../../utils';
import { createListFormat, handleError, useFormControl } from '../../utils';
import { RoleSelect } from './MemberListTable';

const isEmail = (str: string) => /^\S+@\S+\.\S+$/.test(str);

type InviteMembersFormProps = {
 organization: OrganizationResource;
 onSuccess: () => void;
 onReset?: () => void;
 primaryButtonLabel?: LocalizationKey;
Expand All@@ -29,22 +24,18 @@ type InviteMembersFormProps = {

export const InviteMembersForm = (props: InviteMembersFormProps) => {
 const { navigate } = useRouter();
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel, organization } = props;
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel } = props;
 const { organization } = useCoreOrganization();
 const card = useCardState();
 const { t, locale } = useLocalizations();
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = React.useState(false);
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = useState(false);

 if (!organization) {
 return null;
 }

 const validateUnsubmittedEmail = (value: string) => setIsValidUnsubmittedEmail(isEmail(value));

 const roles: Array<{ label: string; value: MembershipRole }> = [
 { label: t(roleLocalizationKey('admin')), value: 'admin' },
 { label: t(roleLocalizationKey('basic_member')), value: 'basic_member' },
 ];

 const emailAddressField = useFormControl('emailAddress', '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__emailAddresses'),
Expand All@@ -67,18 +58,17 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 },
 } = emailAddressField;

 const roleField = useFormControl('role', 'basic_member', {
 options: roles,
 label: localizationKeys('formFieldLabel__role'),
 placeholder: '',
 });

 const canSubmit = !!emailAddressField.value.length || isValidUnsubmittedEmail;

 const onSubmit = async (e: React.FormEvent) => {
 const onSubmit = (e: FormEvent<HTMLFormElement>) => {
 e.preventDefault();

 const submittedData = new FormData(e.currentTarget);
 return organization
 .inviteMembers({ emailAddresses: emailAddressField.value.split(','), role: roleField.value as MembershipRole })
 .inviteMembers({
 emailAddresses: emailAddressField.value.split(','),
 role: submittedData.get('role') as MembershipRole,
 })
 .then(onSuccess)
 .catch(err => {
 if (isClerkAPIResponseError(err)) {
Expand DownExpand Up@@ -132,25 +122,7 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 />
 </Flex>
 </Form.ControlRow>
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 {/*@ts-expect-error Select expects options to be an array but useFormControl returns an optional field. */}
 <Select
 elementId='role'
 {...roleField.props}
 onChange={option => roleField.setValue(option.value)}
 >
 <SelectButton sx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}>
 {roleField.props.options?.find(o => o.value === roleField.value)?.label}
 </SelectButton>
 <SelectOptionList sx={t => ({ minWidth: t.sizes.$48 })} />
 </Select>
 </Flex>
 </Form.ControlRow>
 <AsyncRoleSelect />
 <FormButtonContainer>
 <Form.SubmitButton
 block={false}
Expand All@@ -166,3 +138,29 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 </Form.Root>
 );
};

const AsyncRoleSelect = () => {
 const { options, isLoading } = useFetchRoles();
 const roleField = useFormControl('role', '', {
 label: localizationKeys('formFieldLabel__role'),
 });

 return (
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 <RoleSelect
 {...roleField.props}
 roles={options}
 isDisabled={isLoading}
 onChange={value => roleField.setValue(value)}
 triggerSx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}
 optionListSx={t => ({ minWidth: t.sizes.$48 })}
 />
 </Flex>
 </Form.ControlRow>
 );
};

5 changes: 1 addition & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,10 +40,7 @@ export const InviteMembersPage = withCardStateProvider(() => {
 __unstable_manageBillingMembersLimit={__unstable_manageBillingMembersLimit}
 />
 )}
 <InviteMembersForm
 organization={organization}
 onSuccess={wizard.nextStep}
 />
 <InviteMembersForm onSuccess={wizard.nextStep} />
 </ContentPage>
 <SuccessPage
 title={title}
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(clerk-js,types): Fetch custom roles and localize them by panteliselef · Pull Request #2004 · clerk/javascript · GitHub
Skip to content
feat(clerk-js,types): Fetch custom roles and localize them#2004

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 8 commits into

from

Nov 3, 2023
 Merged


feat(clerk-js,types): Fetch custom roles and localize them
#2004
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
7462464

feat(clerk-js,types): Fetch custom roles and localize them


panteliselef Oct 30, 2023
b11830a

test(clerk-js): Fetch custom roles and localize them


panteliselef Oct 31, 2023
997a175

feat(clerk-js,types): Create PermissionResource


panteliselef Nov 1, 2023
8eedd2e

chore(clerk-js): Add changeset


panteliselef Nov 1, 2023
f207d48

chore(clerk-js): Add experimental tags


panteliselef Nov 1, 2023
b015e2b

test(clerk-js): Add test case for displaying custom roles in select menu


panteliselef Nov 1, 2023
6ef966f

chore(clerk-js): Improve types & add comments


panteliselef Nov 2, 2023
bc8b4d6

chore(clerk-js): Address PR comments


panteliselef Nov 3, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/famous-forks-buy.md

View file


Open in desktop

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

Add support for custom roles in `<OrganizationProfile/>`.

The previous roles (`admin` and `basic_member`), are still kept as a fallback.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
 GetMembershipRequestParams,
 GetMemberships,
 GetPendingInvitationsParams,
 GetRolesParams,
 InviteMemberParams,
 InviteMembersParams,
 OrganizationDomainJSON,
Expand All@@ -20,6 +21,7 @@ import type {
 OrganizationMembershipRequestJSON,
 OrganizationMembershipRequestResource,
 OrganizationResource,
 RoleJSON,
 SetOrganizationLogoParams,
 UpdateMembershipParams,
 UpdateOrganizationParams,
Expand All@@ -31,6 +33,7 @@ import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';

export class Organization extends BaseResource implements OrganizationResource {
 pathRoot = '/organizations';
Expand DownExpand Up@@ -105,6 +108,21 @@ export class Organization extends BaseResource implements OrganizationResource {
 });
 };

 getRoles = async (getRolesParams?: GetRolesParams) => {
 return await BaseResource._fetch({
 path: `/organizations/${this.id}/roles`,
 method: 'GET',
 search: convertPageToOffset(getRolesParams) as any,
 }).then(res => {
 const { data: roles, total_count } = res?.response as unknown as ClerkPaginatedResponse<RoleJSON>;

 return {
 total_count,
 data: roles.map(role => new Role(role)),
 };
 });
 };

 getDomains = async (
 getDomainParams?: GetDomainsParams,
 ): Promise<ClerkPaginatedResponse<OrganizationDomainResource>> => {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import type { PermissionJSON, PermissionResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';

/**
 * @experimental
 */
export class Permission extends BaseResource implements PermissionResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 type!: 'system' | 'user';
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: PermissionJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: PermissionJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.type = data.type;
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import type { RoleJSON, RoleResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';
import { Permission } from './Permission';

/**
 * @experimental
 */
export class Role extends BaseResource implements RoleResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 permissions: Permission[] = [];
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: RoleJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: RoleJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.permissions = data.permissions.map(perm => new Permission(perm));
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ Organization {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ OrganizationMembership {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,6 @@ export const CreateOrganizationForm = (props: CreateOrganizationFormProps) => {
 >
 {organization && (
 <InviteMembersForm
 organization={organization}
 resetButtonLabel={localizationKeys('createOrganization.invitePage.formButtonReset')}
 onSuccess={wizard.nextStep}
 onReset={completeFlow}
Expand Down

26 changes: 14 additions & 12 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActiveMembersList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import type { MembershipRole, OrganizationMembershipResource } from '@clerk/types';
import type { OrganizationMembershipResource } from '@clerk/types';

import { Gate } from '../../common/Gate';
import { useCoreOrganization, useCoreUser } from '../../contexts';
import { Badge, localizationKeys, Td, Text } from '../../customizables';
import { ThreeDotsMenu, useCardState, UserPreview } from '../../elements';
import { handleError, roleLocalizationKey } from '../../utils';
import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles';
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

export const ActiveMembersList = () => {
Expand All@@ -13,11 +14,13 @@ export const ActiveMembersList = () => {
 memberships: true,
 });

 const { options, isLoading: loadingRoles } = useFetchRoles();

 if (!organization) {
 return null;
 }

 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: MembershipRole) => {
 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: string) => {
 return card
 .runAsync(async () => {
 return await membership.update({ role: newRole });
Expand All@@ -41,7 +44,7 @@ export const ActiveMembersList = () => {
 onPageChange={n => memberships?.fetchPage?.(n)}
 itemCount={memberships?.count || 0}
 pageCount={memberships?.pageCount || 0}
 isLoading={memberships?.isLoading}
 isLoading={memberships?.isLoading || loadingRoles}
 emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
 headers={[
 localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand All@@ -53,6 +56,7 @@ export const ActiveMembersList = () => {
 <MemberRow
 key={m.id}
 membership={m}
 options={options}
 onRoleChange={handleRoleChange(m)}
 onRemove={handleRemove(m)}
 />
Expand All@@ -65,9 +69,11 @@ export const ActiveMembersList = () => {
const MemberRow = (props: {
 membership: OrganizationMembershipResource;
 onRemove: () => unknown;
 onRoleChange?: (role: MembershipRole) => unknown;
 options: Parameters<typeof RoleSelect>[0]['roles'];
 onRoleChange: (role: string) => unknown;
}) => {
 const { membership, onRemove, onRoleChange } = props;
 const { membership, onRemove, onRoleChange, options } = props;
 const { localizeCustomRole } = useLocalizeCustomRoles();
 const card = useCardState();
 const user = useCoreUser();

Expand All@@ -94,17 +100,13 @@ const MemberRow = (props: {
 <Td>
 <Gate
 permission={'org:sys_memberships:manage'}
 fallback={
 <Text
 sx={t => ({ opacity: t.opacity.$inactive })}
 localizationKey={roleLocalizationKey(membership.role)}
 />
 }
 fallback={<Text sx={t => ({ opacity: t.opacity.$inactive })}>{localizeCustomRole(membership.role)}</Text>}
 >
 <RoleSelect
 isDisabled={card.isLoading || !onRoleChange}
 value={membership.role}
 onChange={onRoleChange}
 roles={options}
 />
 </Gate>
 </Td>
Expand Down

92 changes: 45 additions & 47 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,26 +1,21 @@
import { isClerkAPIResponseError } from '@clerk/shared/error';
import type { ClerkAPIError, MembershipRole, OrganizationResource } from '@clerk/types';
import React from 'react';
import type { ClerkAPIError, MembershipRole } from '@clerk/types';
import type { FormEvent } from 'react';
import { useState } from 'react';

import { useCoreOrganization } from '../../contexts';
import { Flex, Text } from '../../customizables';
import {
 Form,
 FormButtonContainer,
 Select,
 SelectButton,
 SelectOptionList,
 TagInput,
 useCardState,
} from '../../elements';
import { Form, FormButtonContainer, TagInput, useCardState } from '../../elements';
import { useFetchRoles } from '../../hooks/useFetchRoles';
import type { LocalizationKey } from '../../localization';
import { localizationKeys, useLocalizations } from '../../localization';
import { useRouter } from '../../router';
import { createListFormat, handleError, roleLocalizationKey, useFormControl } from '../../utils';
import { createListFormat, handleError, useFormControl } from '../../utils';
import { RoleSelect } from './MemberListTable';

const isEmail = (str: string) => /^\S+@\S+\.\S+$/.test(str);

type InviteMembersFormProps = {
 organization: OrganizationResource;
 onSuccess: () => void;
 onReset?: () => void;
 primaryButtonLabel?: LocalizationKey;
Expand All@@ -29,22 +24,18 @@ type InviteMembersFormProps = {

export const InviteMembersForm = (props: InviteMembersFormProps) => {
 const { navigate } = useRouter();
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel, organization } = props;
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel } = props;
 const { organization } = useCoreOrganization();
 const card = useCardState();
 const { t, locale } = useLocalizations();
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = React.useState(false);
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = useState(false);

 if (!organization) {
 return null;
 }

 const validateUnsubmittedEmail = (value: string) => setIsValidUnsubmittedEmail(isEmail(value));

 const roles: Array<{ label: string; value: MembershipRole }> = [
 { label: t(roleLocalizationKey('admin')), value: 'admin' },
 { label: t(roleLocalizationKey('basic_member')), value: 'basic_member' },
 ];

 const emailAddressField = useFormControl('emailAddress', '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__emailAddresses'),
Expand All@@ -67,18 +58,17 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 },
 } = emailAddressField;

 const roleField = useFormControl('role', 'basic_member', {
 options: roles,
 label: localizationKeys('formFieldLabel__role'),
 placeholder: '',
 });

 const canSubmit = !!emailAddressField.value.length || isValidUnsubmittedEmail;

 const onSubmit = async (e: React.FormEvent) => {
 const onSubmit = (e: FormEvent<HTMLFormElement>) => {
 e.preventDefault();

 const submittedData = new FormData(e.currentTarget);
 return organization
 .inviteMembers({ emailAddresses: emailAddressField.value.split(','), role: roleField.value as MembershipRole })
 .inviteMembers({
 emailAddresses: emailAddressField.value.split(','),
 role: submittedData.get('role') as MembershipRole,
 })
 .then(onSuccess)
 .catch(err => {
 if (isClerkAPIResponseError(err)) {
Expand DownExpand Up@@ -132,25 +122,7 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 />
 </Flex>
 </Form.ControlRow>
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 {/*@ts-expect-error Select expects options to be an array but useFormControl returns an optional field. */}
 <Select
 elementId='role'
 {...roleField.props}
 onChange={option => roleField.setValue(option.value)}
 >
 <SelectButton sx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}>
 {roleField.props.options?.find(o => o.value === roleField.value)?.label}
 </SelectButton>
 <SelectOptionList sx={t => ({ minWidth: t.sizes.$48 })} />
 </Select>
 </Flex>
 </Form.ControlRow>
 <AsyncRoleSelect />
 <FormButtonContainer>
 <Form.SubmitButton
 block={false}
Expand All@@ -166,3 +138,29 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 </Form.Root>
 );
};

const AsyncRoleSelect = () => {
 const { options, isLoading } = useFetchRoles();
 const roleField = useFormControl('role', '', {
 label: localizationKeys('formFieldLabel__role'),
 });

 return (
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 <RoleSelect
 {...roleField.props}
 roles={options}
 isDisabled={isLoading}
 onChange={value => roleField.setValue(value)}
 triggerSx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}
 optionListSx={t => ({ minWidth: t.sizes.$48 })}
 />
 </Flex>
 </Form.ControlRow>
 );
};

5 changes: 1 addition & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,10 +40,7 @@ export const InviteMembersPage = withCardStateProvider(() => {
 __unstable_manageBillingMembersLimit={__unstable_manageBillingMembersLimit}
 />
 )}
 <InviteMembersForm
 organization={organization}
 onSuccess={wizard.nextStep}
 />
 <InviteMembersForm onSuccess={wizard.nextStep} />
 </ContentPage>
 <SuccessPage
 title={title}
Expand Down
Loading

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

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 8 commits into

from

Nov 3, 2023
 Merged


feat(clerk-js,types): Fetch custom roles and localize them
#2004
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


8 commits


Select commit
Hold shift + click to select a range
7462464

feat(clerk-js,types): Fetch custom roles and localize them


panteliselef Oct 30, 2023
b11830a

test(clerk-js): Fetch custom roles and localize them


panteliselef Oct 31, 2023
997a175

feat(clerk-js,types): Create PermissionResource


panteliselef Nov 1, 2023
8eedd2e

chore(clerk-js): Add changeset


panteliselef Nov 1, 2023
f207d48

chore(clerk-js): Add experimental tags


panteliselef Nov 1, 2023
b015e2b

test(clerk-js): Add test case for displaying custom roles in select menu


panteliselef Nov 1, 2023
6ef966f

chore(clerk-js): Improve types & add comments


panteliselef Nov 2, 2023
bc8b4d6

chore(clerk-js): Address PR comments


panteliselef Nov 3, 2023

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


8 changes: 8 additions & 0 deletions
.changeset/famous-forks-buy.md

View file


Open in desktop

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

Add support for custom roles in `<OrganizationProfile/>`.

The previous roles (`admin` and `basic_member`), are still kept as a fallback.

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -9,6 +9,7 @@ import type {
 GetMembershipRequestParams,
 GetMemberships,
 GetPendingInvitationsParams,
 GetRolesParams,
 InviteMemberParams,
 InviteMembersParams,
 OrganizationDomainJSON,
Expand All@@ -20,6 +21,7 @@ import type {
 OrganizationMembershipRequestJSON,
 OrganizationMembershipRequestResource,
 OrganizationResource,
 RoleJSON,
 SetOrganizationLogoParams,
 UpdateMembershipParams,
 UpdateOrganizationParams,
Expand All@@ -31,6 +33,7 @@ import { convertPageToOffset } from '../../utils/pagesToOffset';
import { BaseResource, OrganizationInvitation, OrganizationMembership } from './internal';
import { OrganizationDomain } from './OrganizationDomain';
import { OrganizationMembershipRequest } from './OrganizationMembershipRequest';
import { Role } from './Role';

export class Organization extends BaseResource implements OrganizationResource {
 pathRoot = '/organizations';
Expand DownExpand Up@@ -105,6 +108,21 @@ export class Organization extends BaseResource implements OrganizationResource {
 });
 };

 getRoles = async (getRolesParams?: GetRolesParams) => {
 return await BaseResource._fetch({
 path: `/organizations/${this.id}/roles`,
 method: 'GET',
 search: convertPageToOffset(getRolesParams) as any,
 }).then(res => {
 const { data: roles, total_count } = res?.response as unknown as ClerkPaginatedResponse<RoleJSON>;

 return {
 total_count,
 data: roles.map(role => new Role(role)),
 };
 });
 };

 getDomains = async (
 getDomainParams?: GetDomainsParams,
 ): Promise<ClerkPaginatedResponse<OrganizationDomainResource>> => {
Expand Down

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
import type { PermissionJSON, PermissionResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';

/**
 * @experimental
 */
export class Permission extends BaseResource implements PermissionResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 type!: 'system' | 'user';
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: PermissionJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: PermissionJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.type = data.type;
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

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

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
import type { RoleJSON, RoleResource } from '@clerk/types';

import { unixEpochToDate } from '../../utils/date';
import { BaseResource } from './internal';
import { Permission } from './Permission';

/**
 * @experimental
 */
export class Role extends BaseResource implements RoleResource {
 id!: string;
 key!: string;
 name!: string;
 description!: string;
 permissions: Permission[] = [];
 createdAt!: Date;
 updatedAt!: Date;

 constructor(data: RoleJSON) {
 super();
 this.fromJSON(data);
 }

 protected fromJSON(data: RoleJSON | null): this {
 if (!data) {
 return this;
 }

 this.id = data.id;
 this.key = data.key;
 this.name = data.name;
 this.description = data.description;
 this.permissions = data.permissions.map(perm => new Permission(perm));
 this.createdAt = unixEpochToDate(data.created_at);
 this.updatedAt = unixEpochToDate(data.updated_at);
 return this;
 }
}

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/Organization.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@ Organization {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 1 addition & 0 deletions
packages/clerk-js/src/core/resources/__snapshots__/OrganizationMembership.test.ts.snap

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ OrganizationMembership {
 "getMembershipRequests": [Function],
 "getMemberships": [Function],
 "getPendingInvitations": [Function],
 "getRoles": [Function],
 "hasImage": true,
 "id": "test_org_id",
 "imageUrl": "https://clerk.com",
Expand Down

1 change: 0 additions & 1 deletion
packages/clerk-js/src/ui/components/CreateOrganization/CreateOrganizationForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -165,7 +165,6 @@ export const CreateOrganizationForm = (props: CreateOrganizationFormProps) => {
 >
 {organization && (
 <InviteMembersForm
 organization={organization}
 resetButtonLabel={localizationKeys('createOrganization.invitePage.formButtonReset')}
 onSuccess={wizard.nextStep}
 onReset={completeFlow}
Expand Down

26 changes: 14 additions & 12 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/ActiveMembersList.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
import type { MembershipRole, OrganizationMembershipResource } from '@clerk/types';
import type { OrganizationMembershipResource } from '@clerk/types';

import { Gate } from '../../common/Gate';
import { useCoreOrganization, useCoreUser } from '../../contexts';
import { Badge, localizationKeys, Td, Text } from '../../customizables';
import { ThreeDotsMenu, useCardState, UserPreview } from '../../elements';
import { handleError, roleLocalizationKey } from '../../utils';
import { useFetchRoles, useLocalizeCustomRoles } from '../../hooks/useFetchRoles';
import { handleError } from '../../utils';
import { DataTable, RoleSelect, RowContainer } from './MemberListTable';

export const ActiveMembersList = () => {
Expand All@@ -13,11 +14,13 @@ export const ActiveMembersList = () => {
 memberships: true,
 });

 const { options, isLoading: loadingRoles } = useFetchRoles();

 if (!organization) {
 return null;
 }

 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: MembershipRole) => {
 const handleRoleChange = (membership: OrganizationMembershipResource) => (newRole: string) => {
 return card
 .runAsync(async () => {
 return await membership.update({ role: newRole });
Expand All@@ -41,7 +44,7 @@ export const ActiveMembersList = () => {
 onPageChange={n => memberships?.fetchPage?.(n)}
 itemCount={memberships?.count || 0}
 pageCount={memberships?.pageCount || 0}
 isLoading={memberships?.isLoading}
 isLoading={memberships?.isLoading || loadingRoles}
 emptyStateLocalizationKey={localizationKeys('organizationProfile.membersPage.detailsTitle__emptyRow')}
 headers={[
 localizationKeys('organizationProfile.membersPage.activeMembersTab.tableHeader__user'),
Expand All@@ -53,6 +56,7 @@ export const ActiveMembersList = () => {
 <MemberRow
 key={m.id}
 membership={m}
 options={options}
 onRoleChange={handleRoleChange(m)}
 onRemove={handleRemove(m)}
 />
Expand All@@ -65,9 +69,11 @@ export const ActiveMembersList = () => {
const MemberRow = (props: {
 membership: OrganizationMembershipResource;
 onRemove: () => unknown;
 onRoleChange?: (role: MembershipRole) => unknown;
 options: Parameters<typeof RoleSelect>[0]['roles'];
 onRoleChange: (role: string) => unknown;
}) => {
 const { membership, onRemove, onRoleChange } = props;
 const { membership, onRemove, onRoleChange, options } = props;
 const { localizeCustomRole } = useLocalizeCustomRoles();
 const card = useCardState();
 const user = useCoreUser();

Expand All@@ -94,17 +100,13 @@ const MemberRow = (props: {
 <Td>
 <Gate
 permission={'org:sys_memberships:manage'}
 fallback={
 <Text
 sx={t => ({ opacity: t.opacity.$inactive })}
 localizationKey={roleLocalizationKey(membership.role)}
 />
 }
 fallback={<Text sx={t => ({ opacity: t.opacity.$inactive })}>{localizeCustomRole(membership.role)}</Text>}
 >
 <RoleSelect
 isDisabled={card.isLoading || !onRoleChange}
 value={membership.role}
 onChange={onRoleChange}
 roles={options}
 />
 </Gate>
 </Td>
Expand Down

92 changes: 45 additions & 47 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersForm.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,26 +1,21 @@
import { isClerkAPIResponseError } from '@clerk/shared/error';
import type { ClerkAPIError, MembershipRole, OrganizationResource } from '@clerk/types';
import React from 'react';
import type { ClerkAPIError, MembershipRole } from '@clerk/types';
import type { FormEvent } from 'react';
import { useState } from 'react';

import { useCoreOrganization } from '../../contexts';
import { Flex, Text } from '../../customizables';
import {
 Form,
 FormButtonContainer,
 Select,
 SelectButton,
 SelectOptionList,
 TagInput,
 useCardState,
} from '../../elements';
import { Form, FormButtonContainer, TagInput, useCardState } from '../../elements';
import { useFetchRoles } from '../../hooks/useFetchRoles';
import type { LocalizationKey } from '../../localization';
import { localizationKeys, useLocalizations } from '../../localization';
import { useRouter } from '../../router';
import { createListFormat, handleError, roleLocalizationKey, useFormControl } from '../../utils';
import { createListFormat, handleError, useFormControl } from '../../utils';
import { RoleSelect } from './MemberListTable';

const isEmail = (str: string) => /^\S+@\S+\.\S+$/.test(str);

type InviteMembersFormProps = {
 organization: OrganizationResource;
 onSuccess: () => void;
 onReset?: () => void;
 primaryButtonLabel?: LocalizationKey;
Expand All@@ -29,22 +24,18 @@ type InviteMembersFormProps = {

export const InviteMembersForm = (props: InviteMembersFormProps) => {
 const { navigate } = useRouter();
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel, organization } = props;
 const { onSuccess, onReset = () => navigate('..'), resetButtonLabel } = props;
 const { organization } = useCoreOrganization();
 const card = useCardState();
 const { t, locale } = useLocalizations();
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = React.useState(false);
 const [isValidUnsubmittedEmail, setIsValidUnsubmittedEmail] = useState(false);

 if (!organization) {
 return null;
 }

 const validateUnsubmittedEmail = (value: string) => setIsValidUnsubmittedEmail(isEmail(value));

 const roles: Array<{ label: string; value: MembershipRole }> = [
 { label: t(roleLocalizationKey('admin')), value: 'admin' },
 { label: t(roleLocalizationKey('basic_member')), value: 'basic_member' },
 ];

 const emailAddressField = useFormControl('emailAddress', '', {
 type: 'text',
 label: localizationKeys('formFieldLabel__emailAddresses'),
Expand All@@ -67,18 +58,17 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 },
 } = emailAddressField;

 const roleField = useFormControl('role', 'basic_member', {
 options: roles,
 label: localizationKeys('formFieldLabel__role'),
 placeholder: '',
 });

 const canSubmit = !!emailAddressField.value.length || isValidUnsubmittedEmail;

 const onSubmit = async (e: React.FormEvent) => {
 const onSubmit = (e: FormEvent<HTMLFormElement>) => {
 e.preventDefault();

 const submittedData = new FormData(e.currentTarget);
 return organization
 .inviteMembers({ emailAddresses: emailAddressField.value.split(','), role: roleField.value as MembershipRole })
 .inviteMembers({
 emailAddresses: emailAddressField.value.split(','),
 role: submittedData.get('role') as MembershipRole,
 })
 .then(onSuccess)
 .catch(err => {
 if (isClerkAPIResponseError(err)) {
Expand DownExpand Up@@ -132,25 +122,7 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 />
 </Flex>
 </Form.ControlRow>
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 {/*@ts-expect-error Select expects options to be an array but useFormControl returns an optional field. */}
 <Select
 elementId='role'
 {...roleField.props}
 onChange={option => roleField.setValue(option.value)}
 >
 <SelectButton sx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}>
 {roleField.props.options?.find(o => o.value === roleField.value)?.label}
 </SelectButton>
 <SelectOptionList sx={t => ({ minWidth: t.sizes.$48 })} />
 </Select>
 </Flex>
 </Form.ControlRow>
 <AsyncRoleSelect />
 <FormButtonContainer>
 <Form.SubmitButton
 block={false}
Expand All@@ -166,3 +138,29 @@ export const InviteMembersForm = (props: InviteMembersFormProps) => {
 </Form.Root>
 );
};

const AsyncRoleSelect = () => {
 const { options, isLoading } = useFetchRoles();
 const roleField = useFormControl('role', '', {
 label: localizationKeys('formFieldLabel__role'),
 });

 return (
 <Form.ControlRow elementId={roleField.id}>
 <Flex
 direction='col'
 gap={2}
 >
 <Text localizationKey={roleField.label} />
 <RoleSelect
 {...roleField.props}
 roles={options}
 isDisabled={isLoading}
 onChange={value => roleField.setValue(value)}
 triggerSx={t => ({ width: t.sizes.$48, justifyContent: 'space-between', display: 'flex' })}
 optionListSx={t => ({ minWidth: t.sizes.$48 })}
 />
 </Flex>
 </Form.ControlRow>
 );
};

5 changes: 1 addition & 4 deletions
packages/clerk-js/src/ui/components/OrganizationProfile/InviteMembersPage.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -40,10 +40,7 @@ export const InviteMembersPage = withCardStateProvider(() => {
 __unstable_manageBillingMembersLimit={__unstable_manageBillingMembersLimit}
 />
 )}
 <InviteMembersForm
 organization={organization}
 onSuccess={wizard.nextStep}
 />
 <InviteMembersForm onSuccess={wizard.nextStep} />
 </ContentPage>
 <SuccessPage
 title={title}
Expand Down
Loading