chore(types): Add Key prefix to OrganizationCustomPermission

Author: panteliselef

packages/backend/src/tokens/authObjects.ts

@@ -2,8 +2,8 @@ import type {
   ActClaim,
   CheckAuthorizationWithCustomPermissions,
   JwtPayload,
-  OrganizationCustomPermission,
-  OrganizationCustomRole,
+  OrganizationCustomPermissionKey,
+  OrganizationCustomRoleKey,
   ServerGetToken,
   ServerGetTokenOptions,
 } from '@clerk/types';
@@ -30,9 +30,9 @@ export type SignedInAuthObject = {
   userId: string;
   user: User | undefined;
   orgId: string | undefined;
-  orgRole: OrganizationCustomRole | undefined;
+  orgRole: OrganizationCustomRoleKey | undefined;
   orgSlug: string | undefined;
-  orgPermissions: OrganizationCustomPermission[] | undefined;
+  orgPermissions: OrganizationCustomPermissionKey[] | undefined;
   organization: Organization | undefined;
   getToken: ServerGetToken;
   has: CheckAuthorizationWithCustomPermissions;

packages/clerk-js/src/core/resources/OrganizationMembership.ts

@@ -5,7 +5,7 @@ import type {
   MembershipRole,
   OrganizationMembershipJSON,
   OrganizationMembershipResource,
-  OrganizationPermission,
+  OrganizationPermissionKey,
 } from '@clerk/types';
 
 import { unixEpochToDate } from '../../utils/date';
@@ -17,10 +17,7 @@ export class OrganizationMembership extends BaseResource implements Organization
   publicMetadata: OrganizationMembershipPublicMetadata = {};
   publicUserData!: PublicUserData;
   organization!: Organization;
-  /**
-   * @experimental The property is experimental and subject to change in future releases.
-   */
-  permissions: OrganizationPermission[] = [];
+  permissions: OrganizationPermissionKey[] = [];
   role!: MembershipRole;
   createdAt!: Date;
   updatedAt!: Date;
@@ -36,7 +33,7 @@ export class OrganizationMembership extends BaseResource implements Organization
       method: 'GET',
       // `paginated` is used in some legacy endpoints to support clerk paginated responses
       // The parameter will be dropped in FAPI v2
-      search: convertPageToOffset({ ...retrieveMembershipsParams, paginated: true }) as any,
+      search: convertPageToOffset({ ...retrieveMembershipsParams, paginated: true }),
     })
       .then(res => {
         if (!res?.response) {

packages/nextjs/src/app-router/server/auth.ts

@@ -1,8 +1,8 @@
 import type { SignedInAuthObject, SignedOutAuthObject } from '@clerk/backend';
 import type {
   CheckAuthorizationWithCustomPermissions,
-  OrganizationCustomPermission,
-  OrganizationCustomRole,
+  OrganizationCustomPermissionKey,
+  OrganizationCustomRoleKey,
 } from '@clerk/types';
 import { notFound } from 'next/navigation';
 
@@ -21,12 +21,12 @@ export const auth = () => {
           protect: (
             params?:
               | {
-                  role: OrganizationCustomRole;
+                  role: OrganizationCustomRoleKey;
                   permission?: never;
                 }
               | {
                   role?: never;
-                  permission: OrganizationCustomPermission;
+                  permission: OrganizationCustomPermissionKey;
                 }
               | ((has: CheckAuthorizationWithCustomPermissions) => boolean),
           ) => AuthObjectWithoutResources<SignedInAuthObject>;

packages/nextjs/src/app-router/server/controlComponents.tsx

@@ -1,7 +1,7 @@
 import type {
   CheckAuthorizationWithCustomPermissions,
-  OrganizationCustomPermission,
-  OrganizationCustomRole,
+  OrganizationCustomPermissionKey,
+  OrganizationCustomRoleKey,
 } from '@clerk/types';
 import React from 'react';
 
@@ -19,17 +19,17 @@ export function SignedOut(props: React.PropsWithChildren) {
   return userId ? null : <>{children}</>;
 }
 
-type GateServerComponentProps = React.PropsWithChildren<
+type ProtectServerComponentProps = React.PropsWithChildren<
   (
     | {
         condition?: never;
-        role: OrganizationCustomRole;
+        role: OrganizationCustomRoleKey;
         permission?: never;
       }
     | {
         condition?: never;
         role?: never;
-        permission: OrganizationCustomPermission;
+        permission: OrganizationCustomPermissionKey;
       }
     | {
         condition: (has: CheckAuthorizationWithCustomPermissions) => boolean;
@@ -46,11 +46,8 @@ type GateServerComponentProps = React.PropsWithChildren<
   }
 >;
 
-/**
- * @experimental The component is experimental and subject to change in future releases.
- */
-export function Protect(gateProps: GateServerComponentProps) {
-  const { children, fallback, ...restAuthorizedParams } = gateProps;
+export function Protect(props: ProtectServerComponentProps) {
+  const { children, fallback, ...restAuthorizedParams } = props;
   const { has, userId, sessionId } = auth();
 
   /**

packages/nextjs/src/index.ts

@@ -89,9 +89,6 @@ export const ClerkProvider = ComponentsModule.ClerkProvider as ServerComponentsS
 export const SignedIn = ComponentsModule.SignedIn as ServerComponentsServerModuleTypes['SignedIn'];
 export const SignedOut = ComponentsModule.SignedOut as ServerComponentsServerModuleTypes['SignedOut'];
 
-/**
- * @experimental
- */
 export const Protect = ComponentsModule.Protect as ServerComponentsServerModuleTypes['Protect'];
 
 export const auth = ServerHelperModule.auth as ServerHelpersServerModuleTypes['auth'];

packages/react/src/components/controlComponents.tsx

@@ -1,8 +1,8 @@
 import type {
   CheckAuthorizationWithCustomPermissions,
   HandleOAuthCallbackParams,
-  OrganizationCustomPermission,
-  OrganizationCustomRole,
+  OrganizationCustomPermissionKey,
+  OrganizationCustomRoleKey,
 } from '@clerk/types';
 import React from 'react';
 
@@ -50,13 +50,13 @@ type ProtectProps = React.PropsWithChildren<
   (
     | {
         condition?: never;
-        role: OrganizationCustomRole;
+        role: OrganizationCustomRoleKey;
         permission?: never;
       }
     | {
         condition?: never;
         role?: never;
-        permission: OrganizationCustomPermission;
+        permission: OrganizationCustomPermissionKey;
       }
     | {
         condition: (has: CheckAuthorizationWithCustomPermissions) => boolean;

packages/types/src/json.ts

@@ -7,7 +7,7 @@ import type { ActJWTClaim } from './jwt';
 import type { OAuthProvider } from './oauth';
 import type { OrganizationDomainVerificationStatus, OrganizationEnrollmentMode } from './organizationDomain';
 import type { OrganizationInvitationStatus } from './organizationInvitation';
-import type { MembershipRole, OrganizationPermission } from './organizationMembership';
+import type { MembershipRole, OrganizationPermissionKey } from './organizationMembership';
 import type { OrganizationSettingsJSON } from './organizationSettings';
 import type { OrganizationSuggestionStatus } from './organizationSuggestion';
 import type { SamlIdpSlug } from './saml';
@@ -300,10 +300,7 @@ export interface OrganizationMembershipJSON extends ClerkResourceJSON {
   object: 'organization_membership';
   id: string;
   organization: OrganizationJSON;
-  /**
-   * @experimental The property is experimental and subject to change in future releases.
-   */
-  permissions: OrganizationPermission[];
+  permissions: OrganizationPermissionKey[];
   public_metadata: OrganizationMembershipPublicMetadata;
   public_user_data: PublicUserDataJSON;
   role: MembershipRole;

packages/types/src/jwtv2.ts

@@ -1,4 +1,4 @@
-import type { MembershipRole, OrganizationCustomPermission } from './organizationMembership';
+import type { MembershipRole, OrganizationCustomPermissionKey } from './organizationMembership';
 
 export interface Jwt {
   header: JwtHeader;
@@ -99,7 +99,7 @@ export interface JwtPayload extends CustomJwtSessionClaims {
   /**
    * Active organization role
    */
-  org_permissions?: OrganizationCustomPermission[];
+  org_permissions?: OrganizationCustomPermissionKey[];
 
   /**
    * Any other JWT Claim Set member.

packages/types/src/organizationMembership.ts

@@ -26,10 +26,7 @@ declare global {
 export interface OrganizationMembershipResource extends ClerkResource {
   id: string;
   organization: OrganizationResource;
-  /**
-   * @experimental The property is experimental and subject to change in future releases.
-   */
-  permissions: OrganizationPermission[];
+  permissions: OrganizationPermissionKey[];
   publicMetadata: OrganizationMembershipPublicMetadata;
   publicUserData: PublicUserData;
   role: MembershipRole;
@@ -39,8 +36,8 @@ export interface OrganizationMembershipResource extends ClerkResource {
   update: (updateParams: UpdateOrganizationMembershipParams) => Promise<OrganizationMembershipResource>;
 }
 
-export type OrganizationCustomPermission = string;
-export type OrganizationCustomRole = string;
+export type OrganizationCustomPermissionKey = string;
+export type OrganizationCustomRoleKey = string;
 
 /**
  * @deprecated This type is deprecated and will be removed in the next major release.
@@ -50,7 +47,7 @@ export type OrganizationCustomRole = string;
  */
 export type MembershipRole = Autocomplete<'admin' | 'basic_member' | 'guest_member'>;
 
-export type OrganizationSystemPermission =
+export type OrganizationSystemPermissionKey =
   | 'org:sys_domains:manage'
   | 'org:sys_domains:delete'
   | 'org:sys_profile:manage'
@@ -64,7 +61,7 @@ export type OrganizationSystemPermission =
  * OrganizationPermission is a combination of system and custom permissions.
  * System permissions are only accessible from FAPI and client-side operations/utils
  */
-export type OrganizationPermission = Autocomplete<OrganizationSystemPermission>;
+export type OrganizationPermissionKey = Autocomplete<OrganizationSystemPermissionKey>;
 
 export type UpdateOrganizationMembershipParams = {
   role: MembershipRole;

packages/types/src/session.ts

@@ -1,26 +1,27 @@
 import type { ActJWTClaim } from './jwt';
 import type {
   MembershipRole,
-  OrganizationCustomPermission,
-  OrganizationCustomRole,
-  OrganizationPermission,
+  OrganizationCustomPermissionKey,
+  OrganizationCustomRoleKey,
+  OrganizationPermissionKey,
 } from './organizationMembership';
 import type { ClerkResource } from './resource';
 import type { TokenResource } from './token';
 import type { UserResource } from './user';
+
 export type CheckAuthorizationFn<Params> = (isAuthorizedParams: Params) => boolean;
 
 export type CheckAuthorizationWithCustomPermissions =
   CheckAuthorizationFn<CheckAuthorizationParamsWithCustomPermissions>;
 
 type CheckAuthorizationParamsWithCustomPermissions =
   | {
-      role: OrganizationCustomRole;
+      role: OrganizationCustomRoleKey;
       permission?: never;
     }
   | {
       role?: never;
-      permission: OrganizationCustomPermission;
+      permission: OrganizationCustomPermissionKey;
     };
 
 export type CheckAuthorization = CheckAuthorizationFn<CheckAuthorizationParams>;
@@ -34,7 +35,7 @@ type CheckAuthorizationParams =
           }
         | {
             role?: never;
-            permission: OrganizationPermission;
+            permission: OrganizationPermissionKey;
           }
       )[];
       role?: never;
@@ -48,7 +49,7 @@ type CheckAuthorizationParams =
   | {
       some?: never;
       role?: never;
-      permission: OrganizationPermission;
+      permission: OrganizationPermissionKey;
     };
 
 export interface SessionResource extends ClerkResource {

packages/types/src/ssr.ts

@@ -1,6 +1,6 @@
 import type { ActClaim, JwtPayload } from './jwtv2';
 import type { OrganizationResource } from './organization';
-import type { MembershipRole, OrganizationCustomPermission } from './organizationMembership';
+import type { MembershipRole, OrganizationCustomPermissionKey } from './organizationMembership';
 import type { SessionResource } from './session';
 import type { UserResource } from './user';
 import type { Serializable } from './utils';
@@ -18,6 +18,6 @@ export type InitialState = Serializable<{
   orgId: string | undefined;
   orgRole: MembershipRole | undefined;
   orgSlug: string | undefined;
-  orgPermissions: OrganizationCustomPermission[] | undefined;
+  orgPermissions: OrganizationCustomPermissionKey[] | undefined;
   organization: OrganizationResource | undefined;
 }>;