Skip to content

fix(types): Update MembershipRole and OrganizationPermissionKey to not resolve to any #2318

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
panteliselef merged 1 commit into from
Dec 12, 2023
Merged

fix(types): Update MembershipRole and OrganizationPermissionKey to not resolve to any #2318

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .changeset/cyan-rockets-fail.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
18 changes: 8 additions & 10 deletions packages/types/src/organizationMembership.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,10 @@ export type OrganizationCustomRoleKey = ClerkAuthorization extends Placeholder
* MembershipRole includes `admin`, `basic_member`, `guest_member`. With the introduction of "Custom roles"
* these types will no longer match a developer's custom logic.
*/
export type MembershipRole = 'role' extends keyof ClerkAuthorization
? // @ts-ignore Typescript cannot infer the existence of the `role` key even if we checking it above
// Disabling eslint rule because the error causes the type to become any when accessing a property that does not exist
// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
ClerkAuthorization['role'] | 'admin' | 'basic_member' | 'guest_member'
export type MembershipRole = ClerkAuthorization extends Placeholder
? ClerkAuthorization['role'] extends string
? ClerkAuthorization['role'] | 'admin' | 'basic_member' | 'guest_member'
: Autocomplete<'admin' | 'basic_member' | 'guest_member'>
: Autocomplete<'admin' | 'basic_member' | 'guest_member'>;

export type OrganizationSystemPermissionKey =
Expand All @@ -87,11 +86,10 @@ export type OrganizationSystemPermissionKey =
* OrganizationPermissionKey is a combination of system and custom permissions.
* System permissions are only accessible from FAPI and client-side operations/utils
*/
export type OrganizationPermissionKey = 'permission' extends keyof ClerkAuthorization
? // @ts-ignore Typescript cannot infer the existence of the `permission` key even if we checking it above
// Disabling eslint rule because the error causes the type to become any when accessing a property that does not exist
// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents
ClerkAuthorization['permission'] | OrganizationSystemPermissionKey
export type OrganizationPermissionKey = ClerkAuthorization extends Placeholder
? ClerkAuthorization['permission'] extends string
? ClerkAuthorization['permission'] | OrganizationSystemPermissionKey
: Autocomplete<OrganizationSystemPermissionKey>
: Autocomplete<OrganizationSystemPermissionKey>;

export type UpdateOrganizationMembershipParams = {
Expand Down