refactor(console): refactor tag component

logto-io · Aug 16, 2024 · 626482f · 626482f
1 parent 04c533e
commit 626482f
Show file tree

Hide file tree

Showing 12 changed files with 52 additions and 67 deletions.
diff --git a/packages/console/src/components/ApplicationCreation/CreateForm/index.tsx b/packages/console/src/components/ApplicationCreation/CreateForm/index.tsx
@@ -128,6 +128,7 @@ function CreateForm({
             planId === ReservedPlanId.Pro &&
             ReservedPlanId.Pro
         )}
+        hasAddOnTag={isDevFeaturesEnabled && watch('type') === ApplicationType.MachineToMachine}
         size={defaultCreateType ? 'medium' : 'large'}
         footer={
           <Footer

diff --git a/packages/console/src/components/FeatureTag/AddOnTag.tsx b/packages/console/src/components/FeatureTag/AddOnTag.tsx
diff --git a/packages/console/src/components/FeatureTag/index.tsx b/packages/console/src/components/FeatureTag/index.tsx
@@ -2,11 +2,10 @@ import { ReservedPlanId } from '@logto/schemas';
 import classNames from 'classnames';
 import { useContext } from 'react';
 
-import { isDevFeaturesEnabled } from '@/consts/env';
+import { isCloud, isDevFeaturesEnabled } from '@/consts/env';
 import { SubscriptionDataContext } from '@/contexts/SubscriptionDataProvider';
 import { TenantsContext } from '@/contexts/TenantsProvider';
 
-import AddOnTag from './AddOnTag';
 import styles from './index.module.scss';
 
 export { default as BetaTag } from './BetaTag';
@@ -53,9 +52,6 @@ export type Props = {
 function FeatureTag(props: Props) {
   const { className } = props;
   const { isDevTenant } = useContext(TenantsContext);
-  const {
-    currentSubscription: { planId },
-  } = useContext(SubscriptionDataContext);
 
   const { isVisible, plan } = props;
 
@@ -65,12 +61,36 @@ function FeatureTag(props: Props) {
     return null;
   }
 
-  // Show the add-on tag for Pro plan when dev features are enabled.
-  if (isDevFeaturesEnabled && planId === ReservedPlanId.Pro) {
-    return <AddOnTag className={className} />;
-  }
-
   return <div className={classNames(styles.tag, className)}>{plan}</div>;
 }
 
 export default FeatureTag;
+
+type CombinedAddOnAndFeatureTagProps = {
+  readonly hasAddOnTag?: boolean;
+  readonly className?: string;
+  /** The minimum plan required to use the feature. */
+  readonly paywall?: Props['plan'];
+};
+
+/**
+ * When `hasAddOnTag` is `true`, the tag will be `AddOnTag` if the plan is `ReservedPlanId.Pro`
+ * and dev features are enabled. Otherwise, it will be `FeatureTag` with the `paywall` prop.
+ */
+export function CombinedAddOnAndFeatureTag(props: CombinedAddOnAndFeatureTagProps) {
+  const { hasAddOnTag, className, paywall } = props;
+  const {
+    currentSubscription: { planId },
+  } = useContext(SubscriptionDataContext);
+
+  // Show the "Add-on" tag for Pro plan when dev features enabled.
+  if (hasAddOnTag && isDevFeaturesEnabled && planId === ReservedPlanId.Pro) {
+    return <div className={classNames(styles.tag, styles.beta, className)}>Add-on</div>;
+  }
+
+  if (paywall && isCloud) {
+    return <FeatureTag isVisible plan={paywall} />;
+  }
+
+  return null;
+}
diff --git a/packages/console/src/ds-components/CardTitle/index.tsx b/packages/console/src/ds-components/CardTitle/index.tsx
@@ -4,8 +4,7 @@ import classNames from 'classnames';
 import type { ReactElement } from 'react';
 import { useTranslation } from 'react-i18next';
 
-import FeatureTag from '@/components/FeatureTag';
-import { isCloud } from '@/consts/env';
+import { CombinedAddOnAndFeatureTag } from '@/components/FeatureTag';
 import type { Props as TextLinkProps } from '@/ds-components/TextLink';
 
 import type DangerousRaw from '../DangerousRaw';
@@ -27,6 +26,7 @@ export type Props = {
    * If not provided, no paywall tag will be shown.
    */
   readonly paywall?: Exclude<ReservedPlanId, ReservedPlanId.Free | ReservedPlanId.Development>;
+  readonly hasAddOnTag?: boolean;
 };
 
 /**
@@ -40,14 +40,15 @@ function CardTitle({
   learnMoreLink,
   className,
   paywall,
+  hasAddOnTag,
 }: Props) {
   const { t } = useTranslation(undefined, { keyPrefix: 'admin_console' });
 
   return (
     <div className={classNames(styles.container, styles[size], className)}>
       <div className={classNames(styles.title, !isWordWrapEnabled && styles.titleEllipsis)}>
         {typeof title === 'string' ? <DynamicT forKey={title} /> : title}
-        {paywall && isCloud && <FeatureTag isVisible plan={paywall} />}
+        <CombinedAddOnAndFeatureTag hasAddOnTag={hasAddOnTag} paywall={paywall} />
       </div>
       {Boolean(subtitle ?? learnMoreLink) && (
         <div className={styles.subtitle}>

diff --git a/packages/console/src/ds-components/ModalLayout/index.tsx b/packages/console/src/ds-components/ModalLayout/index.tsx
@@ -17,7 +17,10 @@ export type Props = {
   readonly className?: string;
   readonly size?: 'medium' | 'large' | 'xlarge';
   readonly headerIcon?: ReactElement;
-} & Pick<CardTitleProps, 'learnMoreLink' | 'title' | 'subtitle' | 'isWordWrapEnabled' | 'paywall'>;
+} & Pick<
+  CardTitleProps,
+  'learnMoreLink' | 'title' | 'subtitle' | 'isWordWrapEnabled' | 'paywall' | 'hasAddOnTag'
+>;
 
 function ModalLayout({
   children,

diff --git a/packages/console/src/pages/ApiResources/components/CreateForm/index.tsx b/packages/console/src/pages/ApiResources/components/CreateForm/index.tsx
@@ -70,6 +70,7 @@ function CreateForm({ onClose }: Props) {
         paywall={conditional(
           isDevFeaturesEnabled && planId === ReservedPlanId.Pro && ReservedPlanId.Pro
         )}
+        hasAddOnTag={isDevFeaturesEnabled}
         footer={<Footer isCreationLoading={isSubmitting} onClickCreate={onSubmit} />}
         onClose={onClose}
       >

diff --git a/packages/console/src/pages/EnterpriseSso/index.tsx b/packages/console/src/pages/EnterpriseSso/index.tsx
@@ -36,11 +36,7 @@ function EnterpriseSso() {
   const { navigate } = useTenantPathname();
   const { t } = useTranslation(undefined, { keyPrefix: 'admin_console' });
   const { isDevTenant } = useContext(TenantsContext);
-  const {
-    currentPlan,
-    currentSubscription: { planId },
-    currentSubscriptionQuota,
-  } = useContext(SubscriptionDataContext);
+  const { currentPlan, currentSubscriptionQuota } = useContext(SubscriptionDataContext);
 
   const [{ page }, updateSearchParameters] = useSearchParametersWatcher({
     page: 1,
@@ -67,11 +63,10 @@ function EnterpriseSso() {
   return (
     <ListPage
       title={{
-        paywall: isDevFeaturesEnabled
-          ? conditional(planId === ReservedPlanId.Pro && ReservedPlanId.Pro)
-          : conditional((!isSsoEnabled || isDevTenant) && ReservedPlanId.Pro),
+        paywall: conditional((!isSsoEnabled || isDevTenant) && ReservedPlanId.Pro),
         title: 'enterprise_sso.title',
         subtitle: 'enterprise_sso.subtitle',
+        hasAddOnTag: isDevFeaturesEnabled,
       }}
       pageMeta={{ titleKey: 'enterprise_sso.page_title' }}
       createButton={conditional(

diff --git a/packages/console/src/pages/Mfa/PageWrapper/index.tsx b/packages/console/src/pages/Mfa/PageWrapper/index.tsx
@@ -18,7 +18,6 @@ function PageWrapper({ children }: Props) {
   const { isDevTenant } = useContext(TenantsContext);
   const {
     currentPlan,
-    currentSubscription: { planId },
     currentSubscriptionQuota: { mfaEnabled },
   } = useContext(SubscriptionDataContext);
   const isMfaEnabled =
@@ -28,11 +27,8 @@ function PageWrapper({ children }: Props) {
     <div className={styles.container}>
       <PageMeta titleKey="mfa.title" />
       <CardTitle
-        paywall={
-          isDevFeaturesEnabled
-            ? cond(planId === ReservedPlanId.Pro && ReservedPlanId.Pro)
-            : cond((!isMfaEnabled || isDevTenant) && ReservedPlanId.Pro)
-        }
+        paywall={cond((!isMfaEnabled || isDevTenant) && ReservedPlanId.Pro)}
+        hasAddOnTag={isDevFeaturesEnabled}
         title="mfa.title"
         subtitle="mfa.description"
         className={styles.cardTitle}

diff --git a/packages/console/src/pages/OrganizationTemplate/index.tsx b/packages/console/src/pages/OrganizationTemplate/index.tsx
@@ -32,11 +32,7 @@ const basePathname = '/organization-template';
 function OrganizationTemplate() {
   const { getDocumentationUrl } = useDocumentationUrl();
   const [isGuideDrawerOpen, setIsGuideDrawerOpen] = useState(false);
-  const {
-    currentPlan,
-    currentSubscription: { planId },
-    currentSubscriptionQuota,
-  } = useContext(SubscriptionDataContext);
+  const { currentPlan, currentSubscriptionQuota } = useContext(SubscriptionDataContext);
   const { isDevTenant } = useContext(TenantsContext);
   const isOrganizationsDisabled =
     isCloud &&
@@ -60,11 +56,7 @@ function OrganizationTemplate() {
             href: getDocumentationUrl(organizationTemplateLink),
             targetBlank: 'noopener',
           }}
-          paywall={
-            isDevFeaturesEnabled
-              ? cond(planId === ReservedPlanId.Pro && ReservedPlanId.Pro)
-              : cond((isOrganizationsDisabled || isDevTenant) && ReservedPlanId.Pro)
-          }
+          paywall={cond((isOrganizationsDisabled || isDevTenant) && ReservedPlanId.Pro)}
         />
         <Button
           title="application_details.check_guide"

diff --git a/packages/console/src/pages/Organizations/CreateOrganizationModal/index.tsx b/packages/console/src/pages/Organizations/CreateOrganizationModal/index.tsx
@@ -84,6 +84,7 @@ function CreateOrganizationModal({ isOpen, onClose }: Props) {
         paywall={conditional(
           isDevFeaturesEnabled && planId === ReservedPlanId.Pro && ReservedPlanId.Pro
         )}
+        hasAddOnTag={isDevFeaturesEnabled}
         footer={
           cond(
             isDevFeaturesEnabled &&

diff --git a/packages/console/src/pages/Organizations/index.tsx b/packages/console/src/pages/Organizations/index.tsx
@@ -25,11 +25,7 @@ const organizationsPathname = '/organizations';
 
 function Organizations() {
   const { getDocumentationUrl } = useDocumentationUrl();
-  const {
-    currentPlan,
-    currentSubscription: { planId },
-    currentSubscriptionQuota,
-  } = useContext(SubscriptionDataContext);
+  const { currentPlan, currentSubscriptionQuota } = useContext(SubscriptionDataContext);
   const { isDevTenant } = useContext(TenantsContext);
 
   const { navigate } = useTenantPathname();
@@ -64,11 +60,8 @@ function Organizations() {
       <PageMeta titleKey="organizations.page_title" />
       <div className={pageLayout.headline}>
         <CardTitle
-          paywall={
-            isDevFeaturesEnabled
-              ? cond(planId === ReservedPlanId.Pro && ReservedPlanId.Pro)
-              : cond((isOrganizationsDisabled || isDevTenant) && ReservedPlanId.Pro)
-          }
+          paywall={cond((isOrganizationsDisabled || isDevTenant) && ReservedPlanId.Pro)}
+          hasAddOnTag={isDevFeaturesEnabled}
           title="organizations.title"
           subtitle="organizations.subtitle"
           learnMoreLink={{

diff --git a/packages/console/src/pages/TenantSettings/TenantMembers/InviteMemberModal/index.tsx b/packages/console/src/pages/TenantSettings/TenantMembers/InviteMemberModal/index.tsx
@@ -132,6 +132,7 @@ function InviteMemberModal({ isOpen, onClose }: Props) {
         paywall={conditional(
           isDevFeaturesEnabled && planId === ReservedPlanId.Pro && ReservedPlanId.Pro
         )}
+        hasAddOnTag={isDevFeaturesEnabled}
         subtitle="tenant_members.invite_modal.subtitle"
         footer={
           conditional(