first commit

common/resources/client/auth/use-auth.ts

@@ -0,0 +1,120 @@
+import {User} from './user';
+import {useCallback, useContext} from 'react';
+import {SiteConfigContext} from '../core/settings/site-config-context';
+import {getFromLocalStorage} from '../utils/hooks/local-storage';
+import {useBootstrapData} from '../core/bootstrap-data/bootstrap-data-context';
+import {Permission} from '@common/auth/permission';
+
+interface UseAuthReturn {
+  user: User | null;
+  hasPermission: (permission: string) => boolean;
+  getPermission: (permission: string) => Permission | undefined;
+  getRestrictionValue: (
+    permission: string,
+    restriction: string,
+  ) => string | number | boolean | undefined | null;
+  checkOverQuotaOrNoPermission: (
+    permission: string,
+    restrictionName: string,
+    currentCount: number,
+  ) => {
+    overQuota: boolean;
+    noPermission: boolean;
+    overQuotaOrNoPermission: boolean;
+  };
+  hasRole: (roleId: number) => boolean;
+  isLoggedIn: boolean;
+  isSubscribed: boolean;
+  getRedirectUri: () => string;
+}
+export function useAuth(): UseAuthReturn {
+  const {
+    data: {user, guest_role},
+  } = useBootstrapData();
+  const {
+    auth: {redirectUri = '/'},
+  } = useContext(SiteConfigContext);
+
+  const getPermission = useCallback(
+    (name: string): Permission | undefined => {
+      const permissions = user?.permissions || guest_role?.permissions;
+      if (!permissions) return;
+      return permissions.find(p => p.name === name);
+    },
+    [user?.permissions, guest_role?.permissions],
+  );
+
+  const getRestrictionValue = useCallback(
+    (
+      permissionName: string,
+      restrictionName: string,
+    ): string | number | boolean | undefined | null => {
+      const permission = getPermission(permissionName);
+      let restrictionValue = null;
+      if (permission) {
+        const restriction = permission.restrictions.find(
+          r => r.name === restrictionName,
+        );
+        restrictionValue = restriction ? restriction.value : undefined;
+      }
+      return restrictionValue;
+    },
+    [getPermission],
+  );
+
+  const hasPermission = useCallback(
+    (name: string): boolean => {
+      const permissions = user?.permissions || guest_role?.permissions;
+
+      const isAdmin = permissions?.find(p => p.name === 'admin') != null;
+      return isAdmin || getPermission(name) != null;
+    },
+    [user?.permissions, guest_role?.permissions, getPermission],
+  );
+
+  const checkOverQuotaOrNoPermission = useCallback(
+    (permission: string, restrictionName: string, currentCount: number) => {
+      const noPermission = !hasPermission(permission);
+      const maxCount = getRestrictionValue(permission, restrictionName) as
+        | number
+        | null;
+      const overQuota = maxCount != null && currentCount >= maxCount;
+      return {
+        overQuota: maxCount != null && currentCount >= maxCount,
+        noPermission,
+        overQuotaOrNoPermission: overQuota || noPermission,
+      };
+    },
+    [getRestrictionValue, hasPermission],
+  );
+
+  const isSubscribed = user?.subscriptions?.find(sub => sub.valid) != null;
+
+  const getRedirectUri = useCallback(() => {
+    const onboarding = getFromLocalStorage('be.onboarding.selected');
+    if (onboarding) {
+      return `/checkout/${onboarding.productId}/${onboarding.priceId}`;
+    }
+    return redirectUri;
+  }, [redirectUri]);
+
+  const hasRole = useCallback(
+    (roleId: number) => {
+      return user?.roles?.find(role => role.id === roleId) != null;
+    },
+    [user],
+  );
+
+  return {
+    user,
+    hasPermission,
+    getPermission,
+    getRestrictionValue,
+    checkOverQuotaOrNoPermission,
+    isLoggedIn: !!user,
+    isSubscribed,
+    hasRole,
+    // where to redirect user after successful login
+    getRedirectUri,
+  };
+}