Skip to content

Elef/com 439 support strict types for has feature plan #5613

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Elef/com 439 support strict types for has feature plan #5613

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ba1a997
wip improve types
panteliselef Apr 11, 2025
8b46c87
wip improve types 2
panteliselef Apr 12, 2025
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
7 changes: 4 additions & 3 deletions packages/react/src/components/controlComponents.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import { deprecated } from '@clerk/shared/deprecated';
import type {
Autocomplete,
CheckAuthorizationWithCustomPermissions,
ClerkCustomFeatureKey,
ClerkCustomPlanKey,
HandleOAuthCallbackParams,
OrganizationCustomPermissionKey,
OrganizationCustomRoleKey,
Expand Down Expand Up @@ -83,15 +84,15 @@ export type ProtectProps = React.PropsWithChildren<
condition?: never;
role?: never;
permission?: never;
feature: Autocomplete<`user:${string}` | `org:${string}`>;
feature: ClerkCustomFeatureKey;
plan?: never;
}
| {
condition?: never;
role?: never;
permission?: never;
feature?: never;
plan: Autocomplete<`user:${string}` | `org:${string}`>;
plan: ClerkCustomPlanKey;
}
| {
condition?: never;
Expand Down
61 changes: 61 additions & 0 deletions packages/types/src/organizationMembership.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,24 @@ import type { Autocomplete } from './utils';
interface Base {
permission: string;
role: string;
feature: string;
plan: string;
}

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

// interface StructuredClerkAuthorization {
// permission?: `org:${string}`;
// role?: `org:${string}`;
// feature: `org:${string}` | `user:${string}`;
// plan: `org:${string}` | `user:${string}`;
// }

declare global {
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
interface ClerkAuthorization {}
Expand Down Expand Up @@ -72,6 +83,56 @@ export type OrganizationCustomRoleKey = ClerkAuthorization extends Placeholder
: Base['role']
: Base['role'];

// type ExtractAfterPrefix<T extends string, P extends string> = T extends `${P}${infer Rest}` ? Rest : never;

// type Util<T extends string> = T | ExtractAfterPrefix<T, 'user:'> | ExtractAfterPrefix<T, 'org:'>;

// type ExtractAfterPrefix<T extends string, P extends string> = T extends `${P}${infer Rest}` ? Rest : never;

// type DistributeUnion<T extends string> = T extends any ? T : never;

// type Util<T extends string> = DistributeUnion<T | ExtractAfterPrefix<T, "user:"> | ExtractAfterPrefix<T, "org:">>;
//
// type Util<T extends string> = T | ExtractAfterPrefix<T, 'user:'> | ExtractAfterPrefix<T, 'org:'>;
//
// type InternalClerkCustomFeatureKey = ClerkAuthorization['feature']

// type ExtractAfterPrefix<T extends string, P extends string> = T extends `${P}${infer Rest}` ? Rest : never;

// type Util<T extends string> = T | ExtractAfterPrefix<T, 'user:'> | ExtractAfterPrefix<T, 'org:'>;

// type InternalClerkCustomFeatureKey = Util<ClerkAuthorization['feature']>;

type ValidPrefix = 'user:' | 'org:';
type ValidFeaturePattern = `${ValidPrefix}${string}`;

type ExtractAfterPrefix<T extends string, P extends string> = T extends `${P}${infer Rest}` ? Rest : never;

type Util<T extends string> = T extends ValidFeaturePattern
? T | ExtractAfterPrefix<T, 'user:'> | ExtractAfterPrefix<T, 'org:'>
: `Expected format: "user:<string>" | "org:<string>", but got "${T}"`;

type ExtractMiddlePart<T extends string> = T extends `${'org:'}${infer Rest}:${string}` ? `org:${Rest}` : never;

interface FakeClerkAuthorization {
// @ts-ignore
feature: Util<ClerkAuthorization['feature']> | Util<ExtractMiddlePart<ClerkAuthorization['permission']>>;
// @ts-ignore
plan: Util<ClerkAuthorization['plan']>;
}

export type ClerkCustomFeatureKey = ClerkAuthorization extends Placeholder
? ClerkAuthorization['feature'] extends string
? FakeClerkAuthorization['feature']
: Util<Base['feature']>
: Util<Base['feature']>;

export type ClerkCustomPlanKey = ClerkAuthorization extends Placeholder
? ClerkAuthorization['plan'] extends string
? FakeClerkAuthorization['plan']
: Util<Base['plan']>
: Util<Base['plan']>;

export type OrganizationSystemPermissionPrefix = 'org:sys_';
export type OrganizationSystemPermissionKey =
| `${OrganizationSystemPermissionPrefix}domains:manage`
Expand Down
15 changes: 8 additions & 7 deletions packages/types/src/session.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import type {
} from './factors';
import type { ActClaim } from './jwtv2';
import type {
ClerkCustomFeatureKey,
ClerkCustomPlanKey,
OrganizationCustomPermissionKey,
OrganizationCustomRoleKey,
OrganizationPermissionKey,
Expand All @@ -26,7 +28,6 @@ import type {
import type { SessionJSONSnapshot } from './snapshots';
import type { TokenResource } from './token';
import type { UserResource } from './user';
import type { Autocomplete } from './utils';

/**
* @inline
Expand Down Expand Up @@ -70,14 +71,14 @@ export type CheckAuthorizationParamsWithCustomPermissions = WithReverification<
| {
role?: never;
permission?: never;
feature: Autocomplete<`user:${string}` | `org:${string}`>;
feature: ClerkCustomFeatureKey;
plan?: never;
}
| {
role?: never;
permission?: never;
feature?: never;
plan: Autocomplete<`user:${string}` | `org:${string}`>;
plan: ClerkCustomPlanKey;
}
| { role?: never; permission?: never; feature?: never; plan?: never }
>;
Expand All @@ -100,14 +101,14 @@ type CheckAuthorizationParams = WithReverification<
| {
role?: never;
permission?: never;
feature: Autocomplete<`user:${string}` | `org:${string}`>;
feature: ClerkCustomFeatureKey;
plan?: never;
}
| {
role?: never;
permission?: never;
feature?: never;
plan: Autocomplete<`user:${string}` | `org:${string}`>;
plan: ClerkCustomPlanKey;
}
| { role?: never; permission?: never; feature?: never; plan?: never }
>;
Expand Down Expand Up @@ -137,14 +138,14 @@ export type CheckAuthorizationParamsFromSessionClaims<P extends OrganizationCust
| {
role?: never;
permission?: never;
feature: Autocomplete<`user:${string}` | `org:${string}`>;
feature: ClerkCustomFeatureKey;
plan?: never;
}
| {
role?: never;
permission?: never;
feature?: never;
plan: Autocomplete<`user:${string}` | `org:${string}`>;
plan: ClerkCustomPlanKey;
}
| { role?: never; permission?: never; feature?: never; plan?: never }
>;
Expand Down
Loading