chore(nextjs): Minor improvements

Author: panteliselef

packages/backend/src/tokens/authObjects.ts

@@ -210,7 +210,9 @@ const createHasAuthorization =
   }): CheckAuthorizationWithCustomPermissions =>
   params => {
     if (!params?.permission && !params?.role) {
-      throw new Error('Missing params. `has` from `useAuth` requires a permission or role key to be passed.');
+      throw new Error(
+        'Missing parameters. `has` from `auth` or `getAuth` requires a permission or role key to be passed.',
+      );
     }
 
     if (!orgId || !userId || !orgRole || !orgPermissions) {

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

@@ -17,15 +17,27 @@ export function SignedOut(props: React.PropsWithChildren) {
 
 type ProtectServerComponentProps = React.ComponentProps<typeof ProtectClientComponent>;
 
+/**
+ * Use `<Protect/>` in order to prevent unauthenticated or unauthorized user from accessing the children passed to the component.
+ *
+ * Examples:
+ * ```
+ * <Protect permission="a_permission_key" />
+ * <Protect role="a_role_key" />
+ * <Protect condition={(has) => has({permission:"a_permission_key"})} />
+ * <Protect condition={(has) => has({role:"a_role_key"})} />
+ * <Protect fallback={<p>Unauthorized</p>}/>
+ * ```
+ */
 export function Protect(props: ProtectServerComponentProps) {
   const { children, fallback, ...restAuthorizedParams } = props;
-  const { has, userId, sessionId } = auth();
+  const { has, userId } = auth();
 
   /**
    * If neither of the authorization params are passed behave as the `<SignedIn/>`
    */
   if (!restAuthorizedParams.condition && !restAuthorizedParams.role && !restAuthorizedParams.permission) {
-    if (userId && sessionId) {
+    if (userId) {
       return <>{children}</>;
     }
     return <>{fallback ?? null}</>;

packages/react/src/components/controlComponents.tsx

@@ -73,14 +73,26 @@ type ProtectProps = React.PropsWithChildren<
   }
 >;
 
+/**
+ * Use `<Protect/>` in order to prevent unauthenticated or unauthorized user from accessing the children passed to the component.
+ *
+ * Examples:
+ * ```
+ * <Protect permission="a_permission_key" />
+ * <Protect role="a_role_key" />
+ * <Protect condition={(has) => has({permission:"a_permission_key"})} />
+ * <Protect condition={(has) => has({role:"a_role_key"})} />
+ * <Protect fallback={<p>Unauthorized</p>}/>
+ * ```
+ */
 export const Protect = ({ children, fallback, ...restAuthorizedParams }: ProtectProps) => {
-  const { has, userId, sessionId } = useAuth();
+  const { has, userId } = useAuth();
 
   /**
    * If neither of the authorization params are passed behave as the `<SignedIn/>`
    */
   if (!restAuthorizedParams.condition && !restAuthorizedParams.role && !restAuthorizedParams.permission) {
-    if (userId && sessionId) {
+    if (userId) {
       return <>{children}</>;
     }
     return <>{fallback ?? null}</>;

packages/react/src/errors.ts

@@ -45,4 +45,4 @@ export const customLinkWrongProps = (componentName: string) =>
   `Missing props. <${componentName}.Link /> component requires the following props: url, label and labelIcon.`;
 
 export const useAuthHasRequiresRoleOrPermission =
-  'Missing params. `has` from `useAuth` requires a permission or role key to be passed.';
+  'Missing parameters. `has` from `useAuth` requires a permission or role key to be passed.';

packages/types/src/organizationMembership.ts

@@ -41,7 +41,7 @@ export type OrganizationCustomRoleKey = string;
 
 /**
  * @deprecated This type is deprecated and will be removed in the next major release.
- * Use `OrganizationCustomRole` instead.
+ * Use `OrganizationCustomRoleKey` instead.
  * MembershipRole includes `admin`, `basic_member`, `guest_member`. With the introduction of "Custom roles"
  * these types will no longer match a developer's custom logic.
  */
@@ -58,7 +58,7 @@ export type OrganizationSystemPermissionKey =
   | 'org:sys_domains:read';
 
 /**
- * OrganizationPermission is a combination of system and custom permissions.
+ * OrganizationPermissionKey is a combination of system and custom permissions.
  * System permissions are only accessible from FAPI and client-side operations/utils
  */
 export type OrganizationPermissionKey = Autocomplete<OrganizationSystemPermissionKey>;