packages/components/hooks/drive/useDrivePlan.ts

   1 import { useOrganization } from '@proton/account/organization/hooks';
   2 import { useUser } from '@proton/account/user/hooks';
   3 import { PLANS } from '@proton/payments';
   4
   5 /**
   6  * This hook centralized logic for Drive subscriptions.
   7  */
   8 export const useDrivePlan = () => {
   9     const [{ hasPaidDrive, isAdmin }] = useUser();
  10     const [organization] = useOrganization();
  11     const plan = organization?.PlanName || PLANS.FREE;
  12
  13     // B2B plans
  14     // Note: Enterprise plan is currently *NOT* implemented anywhere,
  15     //       so it should not be handled.
  16     const isDriveProfessional = plan === PLANS.DRIVE_BUSINESS;
  17     const isProtonBusinessSuite = plan === PLANS.BUNDLE_PRO || plan === PLANS.BUNDLE_PRO_2024;
  18
  19     const isB2B = isDriveProfessional || isProtonBusinessSuite;
  20
  21     // B2C plans
  22     const isDriveLite = plan === PLANS.DRIVE_LITE;
  23
  24     const isB2C = hasPaidDrive && !isB2B;
  25
  26     // Upsells
  27     const canUpsellFree = !hasPaidDrive;
  28     const canUpsellB2B = isB2B && !isProtonBusinessSuite;
  29
  30     return {
  31         /** `true` if the user has a paid Drive plan. */
  32         hasPaidDrive,
  33
  34         /** `true` if the user is admin of their organization. */
  35         isAdmin,
  36
  37         /**
  38          * The organization attached to the current user.
  39          */
  40         organization,
  41
  42         /** The {@link PLANS} the user is subscribed to. */
  43         plan,
  44
  45         /**
  46          * `true` if the user is on a Drive B2B plan.
  47          *
  48          * For Drive, only Drive-specific and ecosystem B2B plans are considered. \
  49          * i.e. Mail Professional is not be considered B2B in a Drive context.
  50          */
  51         isB2B,
  52
  53         /**
  54          * `true` if the user is on a Drive B2C plan.
  55          *
  56          * For Drive, only Drive-specific and ecosystem B2C plans are considered. \
  57          * i.e. Mail Plus is not be considered B2C in a Drive context.
  58          */
  59         isB2C,
  60
  61         /** `true` is plan is *Drive Professional*. */
  62         isDriveProfessional,
  63
  64         /** `true` if plan is *Proton Business Suite*. */
  65         isProtonBusinessSuite,
  66
  67         /** `true` if plan is *Drive Lite*. */
  68         isDriveLite,
  69
  70         /** `true` if a B2C upsell is available. */
  71         canUpsellFree,
  72
  73         /** `true` if a B2B upsell is available. */
  74         canUpsellB2B,
  75     };
  76 };