Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/wild-pugs-kick.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

feat(types,clerk-js): Update types; RoleSelect allows fallbackLabel
- this updates OrganizationInvitation and OrganizationMembership resource+types to include `roleName` which is already present on frontend-api responses, as `role_name`.
- this updates RoleSelect to allow rendering a `fallbackLabel` in the event that `value` does not map to any of the supplied roles
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
publicMetadata: OrganizationInvitationPublicMetadata = {};
status!: OrganizationInvitationStatus;
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -67,6 +68,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
this.organizationId = data.organization_id;
this.publicMetadata = data.public_metadata;
this.role = data.role;
this.roleName = data.role_name;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class OrganizationMembership extends BaseResource implements Organization
organization!: Organization;
permissions: OrganizationPermissionKey[] = [];
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -77,6 +78,7 @@ export class OrganizationMembership extends BaseResource implements Organization
}
this.permissions = Array.isArray(data.permissions) ? [...data.permissions] : [];
this.role = data.role;
this.roleName = data.role_name;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
Expand All@@ -91,6 +93,7 @@ export class OrganizationMembership extends BaseResource implements Organization
public_user_data: this.publicUserData?.__internal_toSnapshot(),
permissions: this.permissions,
role: this.role,
role_name: this.roleName,
created_at: this.createdAt.getTime(),
updated_at: this.updatedAt.getTime(),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ OrganizationInvitation {
},
"revoke": [Function],
"role": "basic_member",
"roleName": undefined,
"status": "pending",
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ OrganizationMembership {
"userId": undefined,
},
"role": "admin",
"roleName": undefined,
"update": [Function],
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ const MemberRow = (props: {
<RoleSelect
isDisabled={card.isLoading || !onRoleChange}
value={membership.role}
fallbackLabel={membership.roleName}
onChange={onRoleChange}
roles={options}
/>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -134,19 +134,20 @@ export const RowContainer = (props: PropsOfComponent<typeof Tr>) => {
export const RoleSelect = (props: {
roles: { label: string; value: string }[] | undefined;
value: string;
fallbackLabel?: string;
onChange: (params: string) => unknown;
isDisabled?: boolean;
triggerSx?: ThemableCssProp;
optionListSx?: ThemableCssProp;
prefixLocalizationKey?: LocalizationKey | string;
}) => {
const { value, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;
const { value, fallbackLabel, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;

const { localizeCustomRole } = useLocalizeCustomRoles();

const fetchedRoles = useMemo(() => [...(roles || [])], [roles]);

const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles]);
const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles, value]);
const { t } = useLocalizations();

const localizedOptions = useMemo(
Expand DownExpand Up@@ -195,9 +196,9 @@ export const RoleSelect = (props: {
textWrap: 'nowrap',
}))
}
isDisabled={isDisabled}
isDisabled={isDisabled || (!!value && fetchedRoles.length > 0 && !selectedRole)}
>
{(selectedRole?.label || selectedRole?.value) && (
{selectedRole?.label || selectedRole?.value ? (
<Flex
as='span'
gap={1}
Expand All@@ -211,12 +212,19 @@ export const RoleSelect = (props: {
)}
<Text
as='span'
sx={t => ({ color: t.colors.$colorText })}
colorScheme='body'
>
{localizeCustomRole(selectedRole?.value) || selectedRole?.label}
</Text>
</Flex>
)}
) : fallbackLabel ? (
<Text
as='span'
colorScheme='body'
>
{fallbackLabel}
</Text>
) : null}
</SelectButton>
<SelectOptionList sx={optionListSx} />
</Select>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -474,6 +474,69 @@ describe('OrganizationMembers', () => {
expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
});
it('disables the role select when the membership role does not map to fetched roles', async () => {
const membersList: OrganizationMembershipResource[] = [
createFakeMember({ id: '1', orgId: '1', role: 'admin', identifier: 'test_user1' }),
createFakeMember({
id: '2',
orgId: '1',
role: 'org:managed_admin',
roleName: 'Managed Admin',
identifier: 'test_user2',
}),
];
const { wrapper, fixtures } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
id: '1',
email_addresses: ['test@clerk.com'],
organization_memberships: [{ name: 'Org1', id: '1' }],
});
});

fixtures.clerk.organization?.getMemberships.mockReturnValue(
Promise.resolve({
data: membersList,
total_count: 2,
}),
);
fixtures.clerk.organization?.getRoles.mockResolvedValue({
total_count: 2,
data: [
{
pathRoot: '',
reload: jest.fn(),
id: 'member',
key: 'member',
name: 'Member',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
{
pathRoot: '',
reload: jest.fn(),
id: 'admin',
key: 'admin',
name: 'Admin',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
],
});

const { container, getByText, getByRole } = render(<OrganizationMembers />, { wrapper });

await waitForLoadingCompleted(container);

expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
expect(getByText('Managed Admin')).toBeInTheDocument();
await waitFor(() => expect(getByRole('button', { name: 'Managed Admin' })).toBeDisabled());
});

describe('InviteMembersScreen', () => {
it('shows the invite screen when user clicks on Invite button', async () => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ type FakeMemberParams = {
id: string;
orgId: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
identifier?: string;
firstName?: string;
lastName?: string;
Expand All@@ -30,6 +31,7 @@ export const createFakeMember = (params: FakeMemberParams): OrganizationMembersh
organization: { id: params.orgId } as any as OrganizationResource,
id: params.id,
role: params?.role || 'admin',
roleName: params?.roleName || 'Admin',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
publicMetadata: {},
Expand DownExpand Up@@ -79,6 +81,7 @@ export const createFakeDomain = (params: FakeDomainParams): OrganizationDomainRe
type FakeInvitationParams = {
id: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
status?: OrganizationInvitationStatus;
emailAddress: string;
organizationId: string;
Expand All@@ -93,6 +96,7 @@ export const createFakeOrganizationInvitation = (params: FakeInvitationParams):
organizationId: params.organizationId,
publicMetadata: {} as any,
role: params.role || 'basic_member',
roleName: params.roleName || 'Basic Member',
status: params.status || 'pending',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -392,6 +392,7 @@ export interface OrganizationMembershipJSON extends ClerkResourceJSON {
public_metadata: OrganizationMembershipPublicMetadata;
public_user_data?: PublicUserDataJSON;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand All@@ -404,6 +405,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
public_metadata: OrganizationInvitationPublicMetadata;
status: OrganizationInvitationStatus;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationInvitation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export interface OrganizationInvitationResource extends ClerkResource {
organizationId: string;
publicMetadata: OrganizationInvitationPublicMetadata;
role: OrganizationCustomRoleKey;
roleName: string;
status: OrganizationInvitationStatus;
createdAt: Date;
updatedAt: Date;
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationMembership.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ export interface OrganizationMembershipResource extends ClerkResource {
publicMetadata: OrganizationMembershipPublicMetadata;
publicUserData?: PublicUserData;
role: OrganizationCustomRoleKey;
roleName: string;
createdAt: Date;
updatedAt: Date;
destroy: () => Promise<OrganizationMembershipResource>;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/wild-pugs-kick.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

feat(types,clerk-js): Update types; RoleSelect allows fallbackLabel
- this updates OrganizationInvitation and OrganizationMembership resource+types to include `roleName` which is already present on frontend-api responses, as `role_name`.
- this updates RoleSelect to allow rendering a `fallbackLabel` in the event that `value` does not map to any of the supplied roles
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
publicMetadata: OrganizationInvitationPublicMetadata = {};
status!: OrganizationInvitationStatus;
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -67,6 +68,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
this.organizationId = data.organization_id;
this.publicMetadata = data.public_metadata;
this.role = data.role;
this.roleName = data.role_name;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class OrganizationMembership extends BaseResource implements Organization
organization!: Organization;
permissions: OrganizationPermissionKey[] = [];
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -77,6 +78,7 @@ export class OrganizationMembership extends BaseResource implements Organization
}
this.permissions = Array.isArray(data.permissions) ? [...data.permissions] : [];
this.role = data.role;
this.roleName = data.role_name;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
Expand All@@ -91,6 +93,7 @@ export class OrganizationMembership extends BaseResource implements Organization
public_user_data: this.publicUserData?.__internal_toSnapshot(),
permissions: this.permissions,
role: this.role,
role_name: this.roleName,
created_at: this.createdAt.getTime(),
updated_at: this.updatedAt.getTime(),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ OrganizationInvitation {
},
"revoke": [Function],
"role": "basic_member",
"roleName": undefined,
"status": "pending",
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ OrganizationMembership {
"userId": undefined,
},
"role": "admin",
"roleName": undefined,
"update": [Function],
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ const MemberRow = (props: {
<RoleSelect
isDisabled={card.isLoading || !onRoleChange}
value={membership.role}
fallbackLabel={membership.roleName}
onChange={onRoleChange}
roles={options}
/>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -134,19 +134,20 @@ export const RowContainer = (props: PropsOfComponent<typeof Tr>) => {
export const RoleSelect = (props: {
roles: { label: string; value: string }[] | undefined;
value: string;
fallbackLabel?: string;
onChange: (params: string) => unknown;
isDisabled?: boolean;
triggerSx?: ThemableCssProp;
optionListSx?: ThemableCssProp;
prefixLocalizationKey?: LocalizationKey | string;
}) => {
const { value, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;
const { value, fallbackLabel, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;

const { localizeCustomRole } = useLocalizeCustomRoles();

const fetchedRoles = useMemo(() => [...(roles || [])], [roles]);

const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles]);
const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles, value]);
const { t } = useLocalizations();

const localizedOptions = useMemo(
Expand DownExpand Up@@ -195,9 +196,9 @@ export const RoleSelect = (props: {
textWrap: 'nowrap',
}))
}
isDisabled={isDisabled}
isDisabled={isDisabled || (!!value && fetchedRoles.length > 0 && !selectedRole)}
>
{(selectedRole?.label || selectedRole?.value) && (
{selectedRole?.label || selectedRole?.value ? (
<Flex
as='span'
gap={1}
Expand All@@ -211,12 +212,19 @@ export const RoleSelect = (props: {
)}
<Text
as='span'
sx={t => ({ color: t.colors.$colorText })}
colorScheme='body'
>
{localizeCustomRole(selectedRole?.value) || selectedRole?.label}
</Text>
</Flex>
)}
) : fallbackLabel ? (
<Text
as='span'
colorScheme='body'
>
{fallbackLabel}
</Text>
) : null}
</SelectButton>
<SelectOptionList sx={optionListSx} />
</Select>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -474,6 +474,69 @@ describe('OrganizationMembers', () => {
expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
});
it('disables the role select when the membership role does not map to fetched roles', async () => {
const membersList: OrganizationMembershipResource[] = [
createFakeMember({ id: '1', orgId: '1', role: 'admin', identifier: 'test_user1' }),
createFakeMember({
id: '2',
orgId: '1',
role: 'org:managed_admin',
roleName: 'Managed Admin',
identifier: 'test_user2',
}),
];
const { wrapper, fixtures } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
id: '1',
email_addresses: ['test@clerk.com'],
organization_memberships: [{ name: 'Org1', id: '1' }],
});
});

fixtures.clerk.organization?.getMemberships.mockReturnValue(
Promise.resolve({
data: membersList,
total_count: 2,
}),
);
fixtures.clerk.organization?.getRoles.mockResolvedValue({
total_count: 2,
data: [
{
pathRoot: '',
reload: jest.fn(),
id: 'member',
key: 'member',
name: 'Member',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
{
pathRoot: '',
reload: jest.fn(),
id: 'admin',
key: 'admin',
name: 'Admin',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
],
});

const { container, getByText, getByRole } = render(<OrganizationMembers />, { wrapper });

await waitForLoadingCompleted(container);

expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
expect(getByText('Managed Admin')).toBeInTheDocument();
await waitFor(() => expect(getByRole('button', { name: 'Managed Admin' })).toBeDisabled());
});

describe('InviteMembersScreen', () => {
it('shows the invite screen when user clicks on Invite button', async () => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ type FakeMemberParams = {
id: string;
orgId: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
identifier?: string;
firstName?: string;
lastName?: string;
Expand All@@ -30,6 +31,7 @@ export const createFakeMember = (params: FakeMemberParams): OrganizationMembersh
organization: { id: params.orgId } as any as OrganizationResource,
id: params.id,
role: params?.role || 'admin',
roleName: params?.roleName || 'Admin',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
publicMetadata: {},
Expand DownExpand Up@@ -79,6 +81,7 @@ export const createFakeDomain = (params: FakeDomainParams): OrganizationDomainRe
type FakeInvitationParams = {
id: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
status?: OrganizationInvitationStatus;
emailAddress: string;
organizationId: string;
Expand All@@ -93,6 +96,7 @@ export const createFakeOrganizationInvitation = (params: FakeInvitationParams):
organizationId: params.organizationId,
publicMetadata: {} as any,
role: params.role || 'basic_member',
roleName: params.roleName || 'Basic Member',
status: params.status || 'pending',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -392,6 +392,7 @@ export interface OrganizationMembershipJSON extends ClerkResourceJSON {
public_metadata: OrganizationMembershipPublicMetadata;
public_user_data?: PublicUserDataJSON;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand All@@ -404,6 +405,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
public_metadata: OrganizationInvitationPublicMetadata;
status: OrganizationInvitationStatus;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationInvitation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export interface OrganizationInvitationResource extends ClerkResource {
organizationId: string;
publicMetadata: OrganizationInvitationPublicMetadata;
role: OrganizationCustomRoleKey;
roleName: string;
status: OrganizationInvitationStatus;
createdAt: Date;
updatedAt: Date;
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationMembership.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ export interface OrganizationMembershipResource extends ClerkResource {
publicMetadata: OrganizationMembershipPublicMetadata;
publicUserData?: PublicUserData;
role: OrganizationCustomRoleKey;
roleName: string;
createdAt: Date;
updatedAt: Date;
destroy: () => Promise<OrganizationMembershipResource>;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/wild-pugs-kick.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

feat(types,clerk-js): Update types; RoleSelect allows fallbackLabel
- this updates OrganizationInvitation and OrganizationMembership resource+types to include `roleName` which is already present on frontend-api responses, as `role_name`.
- this updates RoleSelect to allow rendering a `fallbackLabel` in the event that `value` does not map to any of the supplied roles
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
publicMetadata: OrganizationInvitationPublicMetadata = {};
status!: OrganizationInvitationStatus;
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -67,6 +68,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
this.organizationId = data.organization_id;
this.publicMetadata = data.public_metadata;
this.role = data.role;
this.roleName = data.role_name;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class OrganizationMembership extends BaseResource implements Organization
organization!: Organization;
permissions: OrganizationPermissionKey[] = [];
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -77,6 +78,7 @@ export class OrganizationMembership extends BaseResource implements Organization
}
this.permissions = Array.isArray(data.permissions) ? [...data.permissions] : [];
this.role = data.role;
this.roleName = data.role_name;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
Expand All@@ -91,6 +93,7 @@ export class OrganizationMembership extends BaseResource implements Organization
public_user_data: this.publicUserData?.__internal_toSnapshot(),
permissions: this.permissions,
role: this.role,
role_name: this.roleName,
created_at: this.createdAt.getTime(),
updated_at: this.updatedAt.getTime(),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ OrganizationInvitation {
},
"revoke": [Function],
"role": "basic_member",
"roleName": undefined,
"status": "pending",
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ OrganizationMembership {
"userId": undefined,
},
"role": "admin",
"roleName": undefined,
"update": [Function],
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ const MemberRow = (props: {
<RoleSelect
isDisabled={card.isLoading || !onRoleChange}
value={membership.role}
fallbackLabel={membership.roleName}
onChange={onRoleChange}
roles={options}
/>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -134,19 +134,20 @@ export const RowContainer = (props: PropsOfComponent<typeof Tr>) => {
export const RoleSelect = (props: {
roles: { label: string; value: string }[] | undefined;
value: string;
fallbackLabel?: string;
onChange: (params: string) => unknown;
isDisabled?: boolean;
triggerSx?: ThemableCssProp;
optionListSx?: ThemableCssProp;
prefixLocalizationKey?: LocalizationKey | string;
}) => {
const { value, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;
const { value, fallbackLabel, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;

const { localizeCustomRole } = useLocalizeCustomRoles();

const fetchedRoles = useMemo(() => [...(roles || [])], [roles]);

const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles]);
const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles, value]);
const { t } = useLocalizations();

const localizedOptions = useMemo(
Expand DownExpand Up@@ -195,9 +196,9 @@ export const RoleSelect = (props: {
textWrap: 'nowrap',
}))
}
isDisabled={isDisabled}
isDisabled={isDisabled || (!!value && fetchedRoles.length > 0 && !selectedRole)}
>
{(selectedRole?.label || selectedRole?.value) && (
{selectedRole?.label || selectedRole?.value ? (
<Flex
as='span'
gap={1}
Expand All@@ -211,12 +212,19 @@ export const RoleSelect = (props: {
)}
<Text
as='span'
sx={t => ({ color: t.colors.$colorText })}
colorScheme='body'
>
{localizeCustomRole(selectedRole?.value) || selectedRole?.label}
</Text>
</Flex>
)}
) : fallbackLabel ? (
<Text
as='span'
colorScheme='body'
>
{fallbackLabel}
</Text>
) : null}
</SelectButton>
<SelectOptionList sx={optionListSx} />
</Select>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -474,6 +474,69 @@ describe('OrganizationMembers', () => {
expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
});
it('disables the role select when the membership role does not map to fetched roles', async () => {
const membersList: OrganizationMembershipResource[] = [
createFakeMember({ id: '1', orgId: '1', role: 'admin', identifier: 'test_user1' }),
createFakeMember({
id: '2',
orgId: '1',
role: 'org:managed_admin',
roleName: 'Managed Admin',
identifier: 'test_user2',
}),
];
const { wrapper, fixtures } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
id: '1',
email_addresses: ['test@clerk.com'],
organization_memberships: [{ name: 'Org1', id: '1' }],
});
});

fixtures.clerk.organization?.getMemberships.mockReturnValue(
Promise.resolve({
data: membersList,
total_count: 2,
}),
);
fixtures.clerk.organization?.getRoles.mockResolvedValue({
total_count: 2,
data: [
{
pathRoot: '',
reload: jest.fn(),
id: 'member',
key: 'member',
name: 'Member',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
{
pathRoot: '',
reload: jest.fn(),
id: 'admin',
key: 'admin',
name: 'Admin',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
],
});

const { container, getByText, getByRole } = render(<OrganizationMembers />, { wrapper });

await waitForLoadingCompleted(container);

expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
expect(getByText('Managed Admin')).toBeInTheDocument();
await waitFor(() => expect(getByRole('button', { name: 'Managed Admin' })).toBeDisabled());
});

describe('InviteMembersScreen', () => {
it('shows the invite screen when user clicks on Invite button', async () => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ type FakeMemberParams = {
id: string;
orgId: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
identifier?: string;
firstName?: string;
lastName?: string;
Expand All@@ -30,6 +31,7 @@ export const createFakeMember = (params: FakeMemberParams): OrganizationMembersh
organization: { id: params.orgId } as any as OrganizationResource,
id: params.id,
role: params?.role || 'admin',
roleName: params?.roleName || 'Admin',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
publicMetadata: {},
Expand DownExpand Up@@ -79,6 +81,7 @@ export const createFakeDomain = (params: FakeDomainParams): OrganizationDomainRe
type FakeInvitationParams = {
id: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
status?: OrganizationInvitationStatus;
emailAddress: string;
organizationId: string;
Expand All@@ -93,6 +96,7 @@ export const createFakeOrganizationInvitation = (params: FakeInvitationParams):
organizationId: params.organizationId,
publicMetadata: {} as any,
role: params.role || 'basic_member',
roleName: params.roleName || 'Basic Member',
status: params.status || 'pending',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -392,6 +392,7 @@ export interface OrganizationMembershipJSON extends ClerkResourceJSON {
public_metadata: OrganizationMembershipPublicMetadata;
public_user_data?: PublicUserDataJSON;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand All@@ -404,6 +405,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
public_metadata: OrganizationInvitationPublicMetadata;
status: OrganizationInvitationStatus;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationInvitation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export interface OrganizationInvitationResource extends ClerkResource {
organizationId: string;
publicMetadata: OrganizationInvitationPublicMetadata;
role: OrganizationCustomRoleKey;
roleName: string;
status: OrganizationInvitationStatus;
createdAt: Date;
updatedAt: Date;
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationMembership.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ export interface OrganizationMembershipResource extends ClerkResource {
publicMetadata: OrganizationMembershipPublicMetadata;
publicUserData?: PublicUserData;
role: OrganizationCustomRoleKey;
roleName: string;
createdAt: Date;
updatedAt: Date;
destroy: () => Promise<OrganizationMembershipResource>;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/wild-pugs-kick.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

feat(types,clerk-js): Update types; RoleSelect allows fallbackLabel
- this updates OrganizationInvitation and OrganizationMembership resource+types to include `roleName` which is already present on frontend-api responses, as `role_name`.
- this updates RoleSelect to allow rendering a `fallbackLabel` in the event that `value` does not map to any of the supplied roles
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
publicMetadata: OrganizationInvitationPublicMetadata = {};
status!: OrganizationInvitationStatus;
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -67,6 +68,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
this.organizationId = data.organization_id;
this.publicMetadata = data.public_metadata;
this.role = data.role;
this.roleName = data.role_name;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class OrganizationMembership extends BaseResource implements Organization
organization!: Organization;
permissions: OrganizationPermissionKey[] = [];
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -77,6 +78,7 @@ export class OrganizationMembership extends BaseResource implements Organization
}
this.permissions = Array.isArray(data.permissions) ? [...data.permissions] : [];
this.role = data.role;
this.roleName = data.role_name;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
Expand All@@ -91,6 +93,7 @@ export class OrganizationMembership extends BaseResource implements Organization
public_user_data: this.publicUserData?.__internal_toSnapshot(),
permissions: this.permissions,
role: this.role,
role_name: this.roleName,
created_at: this.createdAt.getTime(),
updated_at: this.updatedAt.getTime(),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ OrganizationInvitation {
},
"revoke": [Function],
"role": "basic_member",
"roleName": undefined,
"status": "pending",
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ OrganizationMembership {
"userId": undefined,
},
"role": "admin",
"roleName": undefined,
"update": [Function],
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ const MemberRow = (props: {
<RoleSelect
isDisabled={card.isLoading || !onRoleChange}
value={membership.role}
fallbackLabel={membership.roleName}
onChange={onRoleChange}
roles={options}
/>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -134,19 +134,20 @@ export const RowContainer = (props: PropsOfComponent<typeof Tr>) => {
export const RoleSelect = (props: {
roles: { label: string; value: string }[] | undefined;
value: string;
fallbackLabel?: string;
onChange: (params: string) => unknown;
isDisabled?: boolean;
triggerSx?: ThemableCssProp;
optionListSx?: ThemableCssProp;
prefixLocalizationKey?: LocalizationKey | string;
}) => {
const { value, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;
const { value, fallbackLabel, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;

const { localizeCustomRole } = useLocalizeCustomRoles();

const fetchedRoles = useMemo(() => [...(roles || [])], [roles]);

const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles]);
const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles, value]);
const { t } = useLocalizations();

const localizedOptions = useMemo(
Expand DownExpand Up@@ -195,9 +196,9 @@ export const RoleSelect = (props: {
textWrap: 'nowrap',
}))
}
isDisabled={isDisabled}
isDisabled={isDisabled || (!!value && fetchedRoles.length > 0 && !selectedRole)}
>
{(selectedRole?.label || selectedRole?.value) && (
{selectedRole?.label || selectedRole?.value ? (
<Flex
as='span'
gap={1}
Expand All@@ -211,12 +212,19 @@ export const RoleSelect = (props: {
)}
<Text
as='span'
sx={t => ({ color: t.colors.$colorText })}
colorScheme='body'
>
{localizeCustomRole(selectedRole?.value) || selectedRole?.label}
</Text>
</Flex>
)}
) : fallbackLabel ? (
<Text
as='span'
colorScheme='body'
>
{fallbackLabel}
</Text>
) : null}
</SelectButton>
<SelectOptionList sx={optionListSx} />
</Select>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -474,6 +474,69 @@ describe('OrganizationMembers', () => {
expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
});
it('disables the role select when the membership role does not map to fetched roles', async () => {
const membersList: OrganizationMembershipResource[] = [
createFakeMember({ id: '1', orgId: '1', role: 'admin', identifier: 'test_user1' }),
createFakeMember({
id: '2',
orgId: '1',
role: 'org:managed_admin',
roleName: 'Managed Admin',
identifier: 'test_user2',
}),
];
const { wrapper, fixtures } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
id: '1',
email_addresses: ['test@clerk.com'],
organization_memberships: [{ name: 'Org1', id: '1' }],
});
});

fixtures.clerk.organization?.getMemberships.mockReturnValue(
Promise.resolve({
data: membersList,
total_count: 2,
}),
);
fixtures.clerk.organization?.getRoles.mockResolvedValue({
total_count: 2,
data: [
{
pathRoot: '',
reload: jest.fn(),
id: 'member',
key: 'member',
name: 'Member',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
{
pathRoot: '',
reload: jest.fn(),
id: 'admin',
key: 'admin',
name: 'Admin',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
],
});

const { container, getByText, getByRole } = render(<OrganizationMembers />, { wrapper });

await waitForLoadingCompleted(container);

expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
expect(getByText('Managed Admin')).toBeInTheDocument();
await waitFor(() => expect(getByRole('button', { name: 'Managed Admin' })).toBeDisabled());
});

describe('InviteMembersScreen', () => {
it('shows the invite screen when user clicks on Invite button', async () => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ type FakeMemberParams = {
id: string;
orgId: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
identifier?: string;
firstName?: string;
lastName?: string;
Expand All@@ -30,6 +31,7 @@ export const createFakeMember = (params: FakeMemberParams): OrganizationMembersh
organization: { id: params.orgId } as any as OrganizationResource,
id: params.id,
role: params?.role || 'admin',
roleName: params?.roleName || 'Admin',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
publicMetadata: {},
Expand DownExpand Up@@ -79,6 +81,7 @@ export const createFakeDomain = (params: FakeDomainParams): OrganizationDomainRe
type FakeInvitationParams = {
id: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
status?: OrganizationInvitationStatus;
emailAddress: string;
organizationId: string;
Expand All@@ -93,6 +96,7 @@ export const createFakeOrganizationInvitation = (params: FakeInvitationParams):
organizationId: params.organizationId,
publicMetadata: {} as any,
role: params.role || 'basic_member',
roleName: params.roleName || 'Basic Member',
status: params.status || 'pending',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -392,6 +392,7 @@ export interface OrganizationMembershipJSON extends ClerkResourceJSON {
public_metadata: OrganizationMembershipPublicMetadata;
public_user_data?: PublicUserDataJSON;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand All@@ -404,6 +405,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
public_metadata: OrganizationInvitationPublicMetadata;
status: OrganizationInvitationStatus;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationInvitation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export interface OrganizationInvitationResource extends ClerkResource {
organizationId: string;
publicMetadata: OrganizationInvitationPublicMetadata;
role: OrganizationCustomRoleKey;
roleName: string;
status: OrganizationInvitationStatus;
createdAt: Date;
updatedAt: Date;
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationMembership.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ export interface OrganizationMembershipResource extends ClerkResource {
publicMetadata: OrganizationMembershipPublicMetadata;
publicUserData?: PublicUserData;
role: OrganizationCustomRoleKey;
roleName: string;
createdAt: Date;
updatedAt: Date;
destroy: () => Promise<OrganizationMembershipResource>;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/wild-pugs-kick.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

feat(types,clerk-js): Update types; RoleSelect allows fallbackLabel
- this updates OrganizationInvitation and OrganizationMembership resource+types to include `roleName` which is already present on frontend-api responses, as `role_name`.
- this updates RoleSelect to allow rendering a `fallbackLabel` in the event that `value` does not map to any of the supplied roles
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
publicMetadata: OrganizationInvitationPublicMetadata = {};
status!: OrganizationInvitationStatus;
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -67,6 +68,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
this.organizationId = data.organization_id;
this.publicMetadata = data.public_metadata;
this.role = data.role;
this.roleName = data.role_name;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class OrganizationMembership extends BaseResource implements Organization
organization!: Organization;
permissions: OrganizationPermissionKey[] = [];
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -77,6 +78,7 @@ export class OrganizationMembership extends BaseResource implements Organization
}
this.permissions = Array.isArray(data.permissions) ? [...data.permissions] : [];
this.role = data.role;
this.roleName = data.role_name;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
Expand All@@ -91,6 +93,7 @@ export class OrganizationMembership extends BaseResource implements Organization
public_user_data: this.publicUserData?.__internal_toSnapshot(),
permissions: this.permissions,
role: this.role,
role_name: this.roleName,
created_at: this.createdAt.getTime(),
updated_at: this.updatedAt.getTime(),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ OrganizationInvitation {
},
"revoke": [Function],
"role": "basic_member",
"roleName": undefined,
"status": "pending",
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ OrganizationMembership {
"userId": undefined,
},
"role": "admin",
"roleName": undefined,
"update": [Function],
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ const MemberRow = (props: {
<RoleSelect
isDisabled={card.isLoading || !onRoleChange}
value={membership.role}
fallbackLabel={membership.roleName}
onChange={onRoleChange}
roles={options}
/>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -134,19 +134,20 @@ export const RowContainer = (props: PropsOfComponent<typeof Tr>) => {
export const RoleSelect = (props: {
roles: { label: string; value: string }[] | undefined;
value: string;
fallbackLabel?: string;
onChange: (params: string) => unknown;
isDisabled?: boolean;
triggerSx?: ThemableCssProp;
optionListSx?: ThemableCssProp;
prefixLocalizationKey?: LocalizationKey | string;
}) => {
const { value, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;
const { value, fallbackLabel, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;

const { localizeCustomRole } = useLocalizeCustomRoles();

const fetchedRoles = useMemo(() => [...(roles || [])], [roles]);

const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles]);
const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles, value]);
const { t } = useLocalizations();

const localizedOptions = useMemo(
Expand DownExpand Up@@ -195,9 +196,9 @@ export const RoleSelect = (props: {
textWrap: 'nowrap',
}))
}
isDisabled={isDisabled}
isDisabled={isDisabled || (!!value && fetchedRoles.length > 0 && !selectedRole)}
>
{(selectedRole?.label || selectedRole?.value) && (
{selectedRole?.label || selectedRole?.value ? (
<Flex
as='span'
gap={1}
Expand All@@ -211,12 +212,19 @@ export const RoleSelect = (props: {
)}
<Text
as='span'
sx={t => ({ color: t.colors.$colorText })}
colorScheme='body'
>
{localizeCustomRole(selectedRole?.value) || selectedRole?.label}
</Text>
</Flex>
)}
) : fallbackLabel ? (
<Text
as='span'
colorScheme='body'
>
{fallbackLabel}
</Text>
) : null}
</SelectButton>
<SelectOptionList sx={optionListSx} />
</Select>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -474,6 +474,69 @@ describe('OrganizationMembers', () => {
expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
});
it('disables the role select when the membership role does not map to fetched roles', async () => {
const membersList: OrganizationMembershipResource[] = [
createFakeMember({ id: '1', orgId: '1', role: 'admin', identifier: 'test_user1' }),
createFakeMember({
id: '2',
orgId: '1',
role: 'org:managed_admin',
roleName: 'Managed Admin',
identifier: 'test_user2',
}),
];
const { wrapper, fixtures } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
id: '1',
email_addresses: ['test@clerk.com'],
organization_memberships: [{ name: 'Org1', id: '1' }],
});
});

fixtures.clerk.organization?.getMemberships.mockReturnValue(
Promise.resolve({
data: membersList,
total_count: 2,
}),
);
fixtures.clerk.organization?.getRoles.mockResolvedValue({
total_count: 2,
data: [
{
pathRoot: '',
reload: jest.fn(),
id: 'member',
key: 'member',
name: 'Member',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
{
pathRoot: '',
reload: jest.fn(),
id: 'admin',
key: 'admin',
name: 'Admin',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
],
});

const { container, getByText, getByRole } = render(<OrganizationMembers />, { wrapper });

await waitForLoadingCompleted(container);

expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
expect(getByText('Managed Admin')).toBeInTheDocument();
await waitFor(() => expect(getByRole('button', { name: 'Managed Admin' })).toBeDisabled());
});

describe('InviteMembersScreen', () => {
it('shows the invite screen when user clicks on Invite button', async () => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ type FakeMemberParams = {
id: string;
orgId: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
identifier?: string;
firstName?: string;
lastName?: string;
Expand All@@ -30,6 +31,7 @@ export const createFakeMember = (params: FakeMemberParams): OrganizationMembersh
organization: { id: params.orgId } as any as OrganizationResource,
id: params.id,
role: params?.role || 'admin',
roleName: params?.roleName || 'Admin',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
publicMetadata: {},
Expand DownExpand Up@@ -79,6 +81,7 @@ export const createFakeDomain = (params: FakeDomainParams): OrganizationDomainRe
type FakeInvitationParams = {
id: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
status?: OrganizationInvitationStatus;
emailAddress: string;
organizationId: string;
Expand All@@ -93,6 +96,7 @@ export const createFakeOrganizationInvitation = (params: FakeInvitationParams):
organizationId: params.organizationId,
publicMetadata: {} as any,
role: params.role || 'basic_member',
roleName: params.roleName || 'Basic Member',
status: params.status || 'pending',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -392,6 +392,7 @@ export interface OrganizationMembershipJSON extends ClerkResourceJSON {
public_metadata: OrganizationMembershipPublicMetadata;
public_user_data?: PublicUserDataJSON;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand All@@ -404,6 +405,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
public_metadata: OrganizationInvitationPublicMetadata;
status: OrganizationInvitationStatus;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationInvitation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export interface OrganizationInvitationResource extends ClerkResource {
organizationId: string;
publicMetadata: OrganizationInvitationPublicMetadata;
role: OrganizationCustomRoleKey;
roleName: string;
status: OrganizationInvitationStatus;
createdAt: Date;
updatedAt: Date;
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationMembership.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ export interface OrganizationMembershipResource extends ClerkResource {
publicMetadata: OrganizationMembershipPublicMetadata;
publicUserData?: PublicUserData;
role: OrganizationCustomRoleKey;
roleName: string;
createdAt: Date;
updatedAt: Date;
destroy: () => Promise<OrganizationMembershipResource>;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/wild-pugs-kick.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

feat(types,clerk-js): Update types; RoleSelect allows fallbackLabel
- this updates OrganizationInvitation and OrganizationMembership resource+types to include `roleName` which is already present on frontend-api responses, as `role_name`.
- this updates RoleSelect to allow rendering a `fallbackLabel` in the event that `value` does not map to any of the supplied roles
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
publicMetadata: OrganizationInvitationPublicMetadata = {};
status!: OrganizationInvitationStatus;
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -67,6 +68,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
this.organizationId = data.organization_id;
this.publicMetadata = data.public_metadata;
this.role = data.role;
this.roleName = data.role_name;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class OrganizationMembership extends BaseResource implements Organization
organization!: Organization;
permissions: OrganizationPermissionKey[] = [];
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -77,6 +78,7 @@ export class OrganizationMembership extends BaseResource implements Organization
}
this.permissions = Array.isArray(data.permissions) ? [...data.permissions] : [];
this.role = data.role;
this.roleName = data.role_name;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
Expand All@@ -91,6 +93,7 @@ export class OrganizationMembership extends BaseResource implements Organization
public_user_data: this.publicUserData?.__internal_toSnapshot(),
permissions: this.permissions,
role: this.role,
role_name: this.roleName,
created_at: this.createdAt.getTime(),
updated_at: this.updatedAt.getTime(),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ OrganizationInvitation {
},
"revoke": [Function],
"role": "basic_member",
"roleName": undefined,
"status": "pending",
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ OrganizationMembership {
"userId": undefined,
},
"role": "admin",
"roleName": undefined,
"update": [Function],
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ const MemberRow = (props: {
<RoleSelect
isDisabled={card.isLoading || !onRoleChange}
value={membership.role}
fallbackLabel={membership.roleName}
onChange={onRoleChange}
roles={options}
/>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -134,19 +134,20 @@ export const RowContainer = (props: PropsOfComponent<typeof Tr>) => {
export const RoleSelect = (props: {
roles: { label: string; value: string }[] | undefined;
value: string;
fallbackLabel?: string;
onChange: (params: string) => unknown;
isDisabled?: boolean;
triggerSx?: ThemableCssProp;
optionListSx?: ThemableCssProp;
prefixLocalizationKey?: LocalizationKey | string;
}) => {
const { value, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;
const { value, fallbackLabel, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;

const { localizeCustomRole } = useLocalizeCustomRoles();

const fetchedRoles = useMemo(() => [...(roles || [])], [roles]);

const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles]);
const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles, value]);
const { t } = useLocalizations();

const localizedOptions = useMemo(
Expand DownExpand Up@@ -195,9 +196,9 @@ export const RoleSelect = (props: {
textWrap: 'nowrap',
}))
}
isDisabled={isDisabled}
isDisabled={isDisabled || (!!value && fetchedRoles.length > 0 && !selectedRole)}
>
{(selectedRole?.label || selectedRole?.value) && (
{selectedRole?.label || selectedRole?.value ? (
<Flex
as='span'
gap={1}
Expand All@@ -211,12 +212,19 @@ export const RoleSelect = (props: {
)}
<Text
as='span'
sx={t => ({ color: t.colors.$colorText })}
colorScheme='body'
>
{localizeCustomRole(selectedRole?.value) || selectedRole?.label}
</Text>
</Flex>
)}
) : fallbackLabel ? (
<Text
as='span'
colorScheme='body'
>
{fallbackLabel}
</Text>
) : null}
</SelectButton>
<SelectOptionList sx={optionListSx} />
</Select>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -474,6 +474,69 @@ describe('OrganizationMembers', () => {
expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
});
it('disables the role select when the membership role does not map to fetched roles', async () => {
const membersList: OrganizationMembershipResource[] = [
createFakeMember({ id: '1', orgId: '1', role: 'admin', identifier: 'test_user1' }),
createFakeMember({
id: '2',
orgId: '1',
role: 'org:managed_admin',
roleName: 'Managed Admin',
identifier: 'test_user2',
}),
];
const { wrapper, fixtures } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
id: '1',
email_addresses: ['test@clerk.com'],
organization_memberships: [{ name: 'Org1', id: '1' }],
});
});

fixtures.clerk.organization?.getMemberships.mockReturnValue(
Promise.resolve({
data: membersList,
total_count: 2,
}),
);
fixtures.clerk.organization?.getRoles.mockResolvedValue({
total_count: 2,
data: [
{
pathRoot: '',
reload: jest.fn(),
id: 'member',
key: 'member',
name: 'Member',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
{
pathRoot: '',
reload: jest.fn(),
id: 'admin',
key: 'admin',
name: 'Admin',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
],
});

const { container, getByText, getByRole } = render(<OrganizationMembers />, { wrapper });

await waitForLoadingCompleted(container);

expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
expect(getByText('Managed Admin')).toBeInTheDocument();
await waitFor(() => expect(getByRole('button', { name: 'Managed Admin' })).toBeDisabled());
});

describe('InviteMembersScreen', () => {
it('shows the invite screen when user clicks on Invite button', async () => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ type FakeMemberParams = {
id: string;
orgId: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
identifier?: string;
firstName?: string;
lastName?: string;
Expand All@@ -30,6 +31,7 @@ export const createFakeMember = (params: FakeMemberParams): OrganizationMembersh
organization: { id: params.orgId } as any as OrganizationResource,
id: params.id,
role: params?.role || 'admin',
roleName: params?.roleName || 'Admin',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
publicMetadata: {},
Expand DownExpand Up@@ -79,6 +81,7 @@ export const createFakeDomain = (params: FakeDomainParams): OrganizationDomainRe
type FakeInvitationParams = {
id: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
status?: OrganizationInvitationStatus;
emailAddress: string;
organizationId: string;
Expand All@@ -93,6 +96,7 @@ export const createFakeOrganizationInvitation = (params: FakeInvitationParams):
organizationId: params.organizationId,
publicMetadata: {} as any,
role: params.role || 'basic_member',
roleName: params.roleName || 'Basic Member',
status: params.status || 'pending',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -392,6 +392,7 @@ export interface OrganizationMembershipJSON extends ClerkResourceJSON {
public_metadata: OrganizationMembershipPublicMetadata;
public_user_data?: PublicUserDataJSON;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand All@@ -404,6 +405,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
public_metadata: OrganizationInvitationPublicMetadata;
status: OrganizationInvitationStatus;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationInvitation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export interface OrganizationInvitationResource extends ClerkResource {
organizationId: string;
publicMetadata: OrganizationInvitationPublicMetadata;
role: OrganizationCustomRoleKey;
roleName: string;
status: OrganizationInvitationStatus;
createdAt: Date;
updatedAt: Date;
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationMembership.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ export interface OrganizationMembershipResource extends ClerkResource {
publicMetadata: OrganizationMembershipPublicMetadata;
publicUserData?: PublicUserData;
role: OrganizationCustomRoleKey;
roleName: string;
createdAt: Date;
updatedAt: Date;
destroy: () => Promise<OrganizationMembershipResource>;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/wild-pugs-kick.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

feat(types,clerk-js): Update types; RoleSelect allows fallbackLabel
- this updates OrganizationInvitation and OrganizationMembership resource+types to include `roleName` which is already present on frontend-api responses, as `role_name`.
- this updates RoleSelect to allow rendering a `fallbackLabel` in the event that `value` does not map to any of the supplied roles
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
publicMetadata: OrganizationInvitationPublicMetadata = {};
status!: OrganizationInvitationStatus;
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -67,6 +68,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
this.organizationId = data.organization_id;
this.publicMetadata = data.public_metadata;
this.role = data.role;
this.roleName = data.role_name;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class OrganizationMembership extends BaseResource implements Organization
organization!: Organization;
permissions: OrganizationPermissionKey[] = [];
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -77,6 +78,7 @@ export class OrganizationMembership extends BaseResource implements Organization
}
this.permissions = Array.isArray(data.permissions) ? [...data.permissions] : [];
this.role = data.role;
this.roleName = data.role_name;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
Expand All@@ -91,6 +93,7 @@ export class OrganizationMembership extends BaseResource implements Organization
public_user_data: this.publicUserData?.__internal_toSnapshot(),
permissions: this.permissions,
role: this.role,
role_name: this.roleName,
created_at: this.createdAt.getTime(),
updated_at: this.updatedAt.getTime(),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ OrganizationInvitation {
},
"revoke": [Function],
"role": "basic_member",
"roleName": undefined,
"status": "pending",
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ OrganizationMembership {
"userId": undefined,
},
"role": "admin",
"roleName": undefined,
"update": [Function],
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ const MemberRow = (props: {
<RoleSelect
isDisabled={card.isLoading || !onRoleChange}
value={membership.role}
fallbackLabel={membership.roleName}
onChange={onRoleChange}
roles={options}
/>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -134,19 +134,20 @@ export const RowContainer = (props: PropsOfComponent<typeof Tr>) => {
export const RoleSelect = (props: {
roles: { label: string; value: string }[] | undefined;
value: string;
fallbackLabel?: string;
onChange: (params: string) => unknown;
isDisabled?: boolean;
triggerSx?: ThemableCssProp;
optionListSx?: ThemableCssProp;
prefixLocalizationKey?: LocalizationKey | string;
}) => {
const { value, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;
const { value, fallbackLabel, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;

const { localizeCustomRole } = useLocalizeCustomRoles();

const fetchedRoles = useMemo(() => [...(roles || [])], [roles]);

const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles]);
const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles, value]);
const { t } = useLocalizations();

const localizedOptions = useMemo(
Expand DownExpand Up@@ -195,9 +196,9 @@ export const RoleSelect = (props: {
textWrap: 'nowrap',
}))
}
isDisabled={isDisabled}
isDisabled={isDisabled || (!!value && fetchedRoles.length > 0 && !selectedRole)}
>
{(selectedRole?.label || selectedRole?.value) && (
{selectedRole?.label || selectedRole?.value ? (
<Flex
as='span'
gap={1}
Expand All@@ -211,12 +212,19 @@ export const RoleSelect = (props: {
)}
<Text
as='span'
sx={t => ({ color: t.colors.$colorText })}
colorScheme='body'
>
{localizeCustomRole(selectedRole?.value) || selectedRole?.label}
</Text>
</Flex>
)}
) : fallbackLabel ? (
<Text
as='span'
colorScheme='body'
>
{fallbackLabel}
</Text>
) : null}
</SelectButton>
<SelectOptionList sx={optionListSx} />
</Select>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -474,6 +474,69 @@ describe('OrganizationMembers', () => {
expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
});
it('disables the role select when the membership role does not map to fetched roles', async () => {
const membersList: OrganizationMembershipResource[] = [
createFakeMember({ id: '1', orgId: '1', role: 'admin', identifier: 'test_user1' }),
createFakeMember({
id: '2',
orgId: '1',
role: 'org:managed_admin',
roleName: 'Managed Admin',
identifier: 'test_user2',
}),
];
const { wrapper, fixtures } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
id: '1',
email_addresses: ['test@clerk.com'],
organization_memberships: [{ name: 'Org1', id: '1' }],
});
});

fixtures.clerk.organization?.getMemberships.mockReturnValue(
Promise.resolve({
data: membersList,
total_count: 2,
}),
);
fixtures.clerk.organization?.getRoles.mockResolvedValue({
total_count: 2,
data: [
{
pathRoot: '',
reload: jest.fn(),
id: 'member',
key: 'member',
name: 'Member',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
{
pathRoot: '',
reload: jest.fn(),
id: 'admin',
key: 'admin',
name: 'Admin',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
],
});

const { container, getByText, getByRole } = render(<OrganizationMembers />, { wrapper });

await waitForLoadingCompleted(container);

expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
expect(getByText('Managed Admin')).toBeInTheDocument();
await waitFor(() => expect(getByRole('button', { name: 'Managed Admin' })).toBeDisabled());
});

describe('InviteMembersScreen', () => {
it('shows the invite screen when user clicks on Invite button', async () => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ type FakeMemberParams = {
id: string;
orgId: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
identifier?: string;
firstName?: string;
lastName?: string;
Expand All@@ -30,6 +31,7 @@ export const createFakeMember = (params: FakeMemberParams): OrganizationMembersh
organization: { id: params.orgId } as any as OrganizationResource,
id: params.id,
role: params?.role || 'admin',
roleName: params?.roleName || 'Admin',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
publicMetadata: {},
Expand DownExpand Up@@ -79,6 +81,7 @@ export const createFakeDomain = (params: FakeDomainParams): OrganizationDomainRe
type FakeInvitationParams = {
id: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
status?: OrganizationInvitationStatus;
emailAddress: string;
organizationId: string;
Expand All@@ -93,6 +96,7 @@ export const createFakeOrganizationInvitation = (params: FakeInvitationParams):
organizationId: params.organizationId,
publicMetadata: {} as any,
role: params.role || 'basic_member',
roleName: params.roleName || 'Basic Member',
status: params.status || 'pending',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -392,6 +392,7 @@ export interface OrganizationMembershipJSON extends ClerkResourceJSON {
public_metadata: OrganizationMembershipPublicMetadata;
public_user_data?: PublicUserDataJSON;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand All@@ -404,6 +405,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
public_metadata: OrganizationInvitationPublicMetadata;
status: OrganizationInvitationStatus;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationInvitation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export interface OrganizationInvitationResource extends ClerkResource {
organizationId: string;
publicMetadata: OrganizationInvitationPublicMetadata;
role: OrganizationCustomRoleKey;
roleName: string;
status: OrganizationInvitationStatus;
createdAt: Date;
updatedAt: Date;
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationMembership.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ export interface OrganizationMembershipResource extends ClerkResource {
publicMetadata: OrganizationMembershipPublicMetadata;
publicUserData?: PublicUserData;
role: OrganizationCustomRoleKey;
roleName: string;
createdAt: Date;
updatedAt: Date;
destroy: () => Promise<OrganizationMembershipResource>;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/wild-pugs-kick.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
---
'@clerk/clerk-js': patch
'@clerk/types': patch
---

feat(types,clerk-js): Update types; RoleSelect allows fallbackLabel
- this updates OrganizationInvitation and OrganizationMembership resource+types to include `roleName` which is already present on frontend-api responses, as `role_name`.
- this updates RoleSelect to allow rendering a `fallbackLabel` in the event that `value` does not map to any of the supplied roles
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
publicMetadata: OrganizationInvitationPublicMetadata = {};
status!: OrganizationInvitationStatus;
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -67,6 +68,7 @@ export class OrganizationInvitation extends BaseResource implements Organization
this.organizationId = data.organization_id;
this.publicMetadata = data.public_metadata;
this.role = data.role;
this.roleName = data.role_name;
this.status = data.status;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,6 +21,7 @@ export class OrganizationMembership extends BaseResource implements Organization
organization!: Organization;
permissions: OrganizationPermissionKey[] = [];
role!: OrganizationCustomRoleKey;
roleName!: string;
createdAt!: Date;
updatedAt!: Date;

Expand DownExpand Up@@ -77,6 +78,7 @@ export class OrganizationMembership extends BaseResource implements Organization
}
this.permissions = Array.isArray(data.permissions) ? [...data.permissions] : [];
this.role = data.role;
this.roleName = data.role_name;
this.createdAt = unixEpochToDate(data.created_at);
this.updatedAt = unixEpochToDate(data.updated_at);
return this;
Expand All@@ -91,6 +93,7 @@ export class OrganizationMembership extends BaseResource implements Organization
public_user_data: this.publicUserData?.__internal_toSnapshot(),
permissions: this.permissions,
role: this.role,
role_name: this.roleName,
created_at: this.createdAt.getTime(),
updated_at: this.updatedAt.getTime(),
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@ OrganizationInvitation {
},
"revoke": [Function],
"role": "basic_member",
"roleName": undefined,
"status": "pending",
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,7 @@ OrganizationMembership {
"userId": undefined,
},
"role": "admin",
"roleName": undefined,
"update": [Function],
"updatedAt": 1970-01-01T00:00:05.678Z,
}
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,6 +110,7 @@ const MemberRow = (props: {
<RoleSelect
isDisabled={card.isLoading || !onRoleChange}
value={membership.role}
fallbackLabel={membership.roleName}
onChange={onRoleChange}
roles={options}
/>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -134,19 +134,20 @@ export const RowContainer = (props: PropsOfComponent<typeof Tr>) => {
export const RoleSelect = (props: {
roles: { label: string; value: string }[] | undefined;
value: string;
fallbackLabel?: string;
onChange: (params: string) => unknown;
isDisabled?: boolean;
triggerSx?: ThemableCssProp;
optionListSx?: ThemableCssProp;
prefixLocalizationKey?: LocalizationKey | string;
}) => {
const { value, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;
const { value, fallbackLabel, roles, onChange, isDisabled, triggerSx, optionListSx, prefixLocalizationKey } = props;

const { localizeCustomRole } = useLocalizeCustomRoles();

const fetchedRoles = useMemo(() => [...(roles || [])], [roles]);

const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles]);
const selectedRole = useMemo(() => fetchedRoles.find(r => r.value === value), [fetchedRoles, value]);
const { t } = useLocalizations();

const localizedOptions = useMemo(
Expand DownExpand Up@@ -195,9 +196,9 @@ export const RoleSelect = (props: {
textWrap: 'nowrap',
}))
}
isDisabled={isDisabled}
isDisabled={isDisabled || (!!value && fetchedRoles.length > 0 && !selectedRole)}
>
{(selectedRole?.label || selectedRole?.value) && (
{selectedRole?.label || selectedRole?.value ? (
<Flex
as='span'
gap={1}
Expand All@@ -211,12 +212,19 @@ export const RoleSelect = (props: {
)}
<Text
as='span'
sx={t => ({ color: t.colors.$colorText })}
colorScheme='body'
>
{localizeCustomRole(selectedRole?.value) || selectedRole?.label}
</Text>
</Flex>
)}
) : fallbackLabel ? (
<Text
as='span'
colorScheme='body'
>
{fallbackLabel}
</Text>
) : null}
</SelectButton>
<SelectOptionList sx={optionListSx} />
</Select>
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -474,6 +474,69 @@ describe('OrganizationMembers', () => {
expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
});
it('disables the role select when the membership role does not map to fetched roles', async () => {
const membersList: OrganizationMembershipResource[] = [
createFakeMember({ id: '1', orgId: '1', role: 'admin', identifier: 'test_user1' }),
createFakeMember({
id: '2',
orgId: '1',
role: 'org:managed_admin',
roleName: 'Managed Admin',
identifier: 'test_user2',
}),
];
const { wrapper, fixtures } = await createFixtures(f => {
f.withOrganizations();
f.withUser({
id: '1',
email_addresses: ['test@clerk.com'],
organization_memberships: [{ name: 'Org1', id: '1' }],
});
});

fixtures.clerk.organization?.getMemberships.mockReturnValue(
Promise.resolve({
data: membersList,
total_count: 2,
}),
);
fixtures.clerk.organization?.getRoles.mockResolvedValue({
total_count: 2,
data: [
{
pathRoot: '',
reload: jest.fn(),
id: 'member',
key: 'member',
name: 'Member',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
{
pathRoot: '',
reload: jest.fn(),
id: 'admin',
key: 'admin',
name: 'Admin',
description: '',
permissions: [],
createdAt: new Date(),
updatedAt: new Date(),
},
],
});

const { container, getByText, getByRole } = render(<OrganizationMembers />, { wrapper });

await waitForLoadingCompleted(container);

expect(fixtures.clerk.organization?.getMemberships).toHaveBeenCalled();
expect(getByText('You')).toBeInTheDocument();
expect(getByText('Managed Admin')).toBeInTheDocument();
await waitFor(() => expect(getByRole('button', { name: 'Managed Admin' })).toBeDisabled());
});

describe('InviteMembersScreen', () => {
it('shows the invite screen when user clicks on Invite button', async () => {
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@ type FakeMemberParams = {
id: string;
orgId: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
identifier?: string;
firstName?: string;
lastName?: string;
Expand All@@ -30,6 +31,7 @@ export const createFakeMember = (params: FakeMemberParams): OrganizationMembersh
organization: { id: params.orgId } as any as OrganizationResource,
id: params.id,
role: params?.role || 'admin',
roleName: params?.roleName || 'Admin',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
publicMetadata: {},
Expand DownExpand Up@@ -79,6 +81,7 @@ export const createFakeDomain = (params: FakeDomainParams): OrganizationDomainRe
type FakeInvitationParams = {
id: string;
role?: OrganizationCustomRoleKey;
roleName?: string;
status?: OrganizationInvitationStatus;
emailAddress: string;
organizationId: string;
Expand All@@ -93,6 +96,7 @@ export const createFakeOrganizationInvitation = (params: FakeInvitationParams):
organizationId: params.organizationId,
publicMetadata: {} as any,
role: params.role || 'basic_member',
roleName: params.roleName || 'Basic Member',
status: params.status || 'pending',
createdAt: params?.createdAt || new Date(),
updatedAt: new Date(),
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/json.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -392,6 +392,7 @@ export interface OrganizationMembershipJSON extends ClerkResourceJSON {
public_metadata: OrganizationMembershipPublicMetadata;
public_user_data?: PublicUserDataJSON;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand All@@ -404,6 +405,7 @@ export interface OrganizationInvitationJSON extends ClerkResourceJSON {
public_metadata: OrganizationInvitationPublicMetadata;
status: OrganizationInvitationStatus;
role: OrganizationCustomRoleKey;
role_name: string;
created_at: number;
updated_at: number;
}
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationInvitation.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,6 +26,7 @@ export interface OrganizationInvitationResource extends ClerkResource {
organizationId: string;
publicMetadata: OrganizationInvitationPublicMetadata;
role: OrganizationCustomRoleKey;
roleName: string;
status: OrganizationInvitationStatus;
createdAt: Date;
updatedAt: Date;
Expand Down
1 change: 1 addition & 0 deletions packages/types/src/organizationMembership.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -50,6 +50,7 @@ export interface OrganizationMembershipResource extends ClerkResource {
publicMetadata: OrganizationMembershipPublicMetadata;
publicUserData?: PublicUserData;
role: OrganizationCustomRoleKey;
roleName: string;
createdAt: Date;
updatedAt: Date;
destroy: () => Promise<OrganizationMembershipResource>;
Expand Down