feat(clerk-js): Session.isAuthorized now support the any parameter

clerk · Oct 18, 2023 · ef2dff3 · ef2dff3
1 parent 27448e7
commit ef2dff3
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 16 deletions.
diff --git a/packages/clerk-js/src/core/resources/Session.ts b/packages/clerk-js/src/core/resources/Session.ts
@@ -80,7 +80,7 @@ export class Session extends BaseResource implements SessionResource {
    * @experimental The method is experimental and subject to change in future releases.
    */
   isAuthorized: IsAuthorized = async params => {
-    return new Promise(resolve => {
+    return new Promise((resolve, reject) => {
       // if there is no active organization user can not be authorized
       if (!this.lastActiveOrganizationId || !this.user) {
         return resolve(false);
@@ -106,8 +106,17 @@ export class Session extends BaseResource implements SessionResource {
       }
 
       if (params.any) {
-        return resolve(params.any.filter(perm => activeOrganizationPermissions.includes(perm)).length > 0);
+        return resolve(
+          params.any.filter(permObj => {
+            if (permObj.permission) {
+              return activeOrganizationPermissions.includes(permObj.permission);
+            }
+            return activeOrganizationRole === permObj.role;
+          }).length > 0,
+        );
       }
+
+      return reject();
     });
   };
 

diff --git a/packages/clerk-js/src/ui/common/Gate.tsx b/packages/clerk-js/src/ui/common/Gate.tsx
@@ -1,12 +1,12 @@
-import type { IsAuthorized, OrganizationPermission } from '@clerk/types';
+import type { IsAuthorized } from '@clerk/types';
 import type { ComponentType, PropsWithChildren, ReactNode } from 'react';
 import React, { useEffect } from 'react';
 
 import { useCoreSession } from '../contexts';
 import { useFetch } from '../hooks';
 import { useRouter } from '../router';
 
-type GateParams = Omit<Parameters<IsAuthorized>[0], 'permission'> & { permission?: OrganizationPermission };
+type GateParams = Parameters<IsAuthorized>[0];
 type GateProps = PropsWithChildren<
   GateParams & {
     fallback?: ReactNode;

diff --git a/packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileRoutes.tsx b/packages/clerk-js/src/ui/components/OrganizationProfile/OrganizationProfileRoutes.tsx
@@ -51,7 +51,7 @@ export const OrganizationProfileRoutes = (props: PropsOfComponent<typeof Profile
               </Route>
               <Route path=':id'>
                 <Gate
-                  any={['org:sys_domains:manage', 'org:sys_domains:delete']}
+                  any={[{ permission: 'org:sys_domains:manage' }, { permission: 'org:sys_domains:delete' }]}
                   redirectTo='../../'
                 >
                   <VerifiedDomainPage />

diff --git a/packages/clerk-js/src/ui/utils/test/mockHelpers.ts b/packages/clerk-js/src/ui/utils/test/mockHelpers.ts
@@ -31,7 +31,7 @@ export const mockClerkMethods = (clerk: LoadedClerk): DeepJestMocked<LoadedClerk
   clerk.client.sessions.forEach(session => {
     mockMethodsOf(session);
     session.isAuthorized = jest.fn(args => {
-      return new Promise(resolve => {
+      return new Promise((resolve, reject) => {
         // if there is no active organization user can not be authorized
         if (!session.lastActiveOrganizationId || !session.user) {
           return resolve(false);
@@ -57,8 +57,17 @@ export const mockClerkMethods = (clerk: LoadedClerk): DeepJestMocked<LoadedClerk
         }
 
         if (args.any) {
-          return resolve(args.any.filter(perm => activeOrganizationPermissions.includes(perm)).length > 0);
+          return resolve(
+            args.any.filter(permObj => {
+              if (permObj.permission) {
+                return activeOrganizationPermissions.includes(permObj.permission);
+              }
+              return activeOrganizationRole === permObj.role;
+            }).length > 0,
+          );
         }
+
+        return reject(false);
       });
     });
     mockMethodsOf(session.user);

diff --git a/packages/types/src/session.ts b/packages/types/src/session.ts
@@ -6,15 +6,35 @@ import type { UserResource } from './user';
 
 export type IsAuthorized = (isAuthorizedParams: IsAuthorizedParams) => Promise<IsAuthorizedReturnValues>;
 
-interface IsAuthorizedParams {
-  // Adding (string & {}) allows for getting eslint autocomplete but also accepts any string
-  // eslint-disable-next-line
-  permission?: OrganizationPermission | (string & {});
-  role?: string;
-  // Adding (string & {}) allows for getting eslint autocomplete but also accepts any string
-  // eslint-disable-next-line
-  any?: (OrganizationPermission | (string & {}))[];
-}
+type IsAuthorizedParams =
+  | {
+      any: (
+        | {
+            role: string;
+            permission?: never;
+          }
+        | {
+            role?: never;
+            // Adding (string & {}) allows for getting eslint autocomplete but also accepts any string
+            // eslint-disable-next-line
+            permission: OrganizationPermission | (string & {});
+          }
+      )[];
+      role?: never;
+      permission?: never;
+    }
+  | {
+      any?: never;
+      role: string;
+      permission?: never;
+    }
+  | {
+      any?: never;
+      role?: never;
+      // Adding (string & {}) allows for getting eslint autocomplete but also accepts any string
+      // eslint-disable-next-line
+      permission: OrganizationPermission | (string & {});
+    };
 
 type IsAuthorizedReturnValues = boolean;