Skip to content

fix(types): Typescript v5 cannot infer custom role types correctly #2314

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
brkalow merged 1 commit into from
Dec 12, 2023
Merged

fix(types): Typescript v5 cannot infer custom role types correctly #2314

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/tame-olives-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
19 changes: 13 additions & 6 deletions packages/types/src/organizationMembership.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ interface Base {
role: string;
}

interface Placeholder {
permission: unknown;
role: unknown;
}

declare global {
interface ClerkAuthorization {}
}
Expand Down Expand Up @@ -45,14 +50,16 @@ export interface OrganizationMembershipResource extends ClerkResource {
update: (updateParams: UpdateOrganizationMembershipParams) => Promise<OrganizationMembershipResource>;
}

export type OrganizationCustomPermissionKey = 'permission' extends keyof ClerkAuthorization
? // @ts-ignore Typescript cannot infer the existence of the `permission` key even if we checking it above
ClerkAuthorization['permission']
export type OrganizationCustomPermissionKey = ClerkAuthorization extends Placeholder
? ClerkAuthorization['permission'] extends string
? ClerkAuthorization['permission']
: Base['permission']
: Base['permission'];

export type OrganizationCustomRoleKey = 'role' extends keyof ClerkAuthorization
? // @ts-ignore Typescript cannot infer the existence of the `role` key even if we checking it above
ClerkAuthorization['role']
export type OrganizationCustomRoleKey = ClerkAuthorization extends Placeholder
? ClerkAuthorization['role'] extends string
? ClerkAuthorization['role']
: Base['role']
: Base['role'];

/**
Expand Down