Skip to content

The open alternative to Salesforce, designed for AI.

[Onboarding 4/10] Add credits popover (#26871)

Thomas des Francsd9b810080f18
diff --git a/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsPill.tsx b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsPill.tsx
index 293c73a41d8..23752c12e77 100644
--- a/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsPill.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsPill.tsx
@@ -1,5 +1,6 @@
import { useNumberFormat } from '@/localization/hooks/useNumberFormat';
import { OnboardingFreeCreditsChange } from '@/onboarding/components/free-credits/OnboardingFreeCreditsChange';
+import { OnboardingFreeCreditsPopoverContent } from '@/onboarding/components/free-credits/OnboardingFreeCreditsPopoverContent';
import { OnboardingFreeCreditsProgress } from '@/onboarding/components/free-credits/OnboardingFreeCreditsProgress';
import { StyledOnboardingFreeCreditsCount } from '@/onboarding/components/free-credits/StyledOnboardingFreeCreditsCount';
import { StyledOnboardingFreeCreditsLabel } from '@/onboarding/components/free-credits/StyledOnboardingFreeCreditsLabel';
@@ -14,8 +15,8 @@ import { useLingui } from '@lingui/react/macro';
import { AnimatePresence, motion, useReducedMotion } from 'framer-motion';
import { useRef, useState } from 'react';
import { isDefined } from 'twenty-shared/utils';
-import { IconCoins } from 'twenty-ui/icon';
-import { Tooltip } from 'twenty-ui/primitives/surfaces';
+import { IconCoins, IconInfoCircle } from 'twenty-ui/icon';
+import { Popover, Tooltip } from 'twenty-ui/primitives/surfaces';
import { themeCssVariables, useTheme } from 'twenty-ui/theme';
const StyledContainer = styled.div`
@@ -24,19 +25,42 @@ const StyledContainer = styled.div`
gap: ${themeCssVariables.spacing[2]};
`;
-const StyledPill = styled.div`
+const StyledPillAnchor = styled.div`
+ display: flex;
+`;
+
+const StyledTrigger = styled.button`
+ align-items: center;
+ background: none;
+ border: none;
+ border-radius: ${themeCssVariables.border.radius.pill};
+ color: ${themeCssVariables.font.color.tertiary};
+ corner-shape: round;
+ cursor: pointer;
+ display: flex;
+ font-family: inherit;
+ padding: 0;
+
+ &:hover > span,
+ &[data-popup-open] > span {
+ background-color: ${themeCssVariables.background.transparent.medium};
+ }
+
+ &:hover > span[data-highlighted='earned'],
+ &[data-popup-open] > span[data-highlighted='earned'] {
+ background-color: ${themeCssVariables.color.green4};
+ border-color: ${themeCssVariables.color.green5};
+ }
+`;
+
+const StyledTriggerPart = styled.span`
align-items: center;
background-color: ${themeCssVariables.background.transparent.light};
border: 1px solid transparent;
- border-radius: ${themeCssVariables.border.radius.pill};
box-sizing: border-box;
- color: ${themeCssVariables.font.color.tertiary};
corner-shape: round;
display: flex;
- gap: ${themeCssVariables.spacing['1.5']};
height: ${themeCssVariables.spacing[6]};
- padding: 0 ${themeCssVariables.spacing[2]} 0
- ${themeCssVariables.spacing['1.5']};
transition:
background-color calc(${themeCssVariables.animation.duration.normal} * 1s),
border-color calc(${themeCssVariables.animation.duration.normal} * 1s),
@@ -49,12 +73,33 @@ const StyledPill = styled.div`
}
`;
+const StyledCreditsPart = styled(StyledTriggerPart)`
+ border-bottom-left-radius: ${themeCssVariables.border.radius.pill};
+ border-right: none;
+ border-top-left-radius: ${themeCssVariables.border.radius.pill};
+ gap: ${themeCssVariables.spacing['1.5']};
+ padding: 0 ${themeCssVariables.spacing[2]} 0
+ ${themeCssVariables.spacing['1.5']};
+`;
+
const StyledCreditsContent = styled(motion.span)`
align-items: center;
display: flex;
gap: ${themeCssVariables.spacing['1.5']};
`;
+const StyledInfoPart = styled(StyledTriggerPart)`
+ border-bottom-right-radius: ${themeCssVariables.border.radius.rounded};
+ border-top-right-radius: ${themeCssVariables.border.radius.rounded};
+ justify-content: center;
+ padding: 0 ${themeCssVariables.spacing['1.5']} 0
+ ${themeCssVariables.spacing[1]};
+
+ &:not([data-highlighted='earned']) {
+ border-left-color: ${themeCssVariables.border.color.transparentStrong};
+ }
+`;
+
const StyledTooltipContents = styled.div`
display: grid;
`;
@@ -74,13 +119,19 @@ export const OnboardingFreeCreditsPill = ({
const theme = useTheme();
const shouldReduceMotion = useReducedMotion();
const { numberFormat } = useNumberFormat();
+ const [isPopoverShown, setIsPopoverShown] = useState(false);
const [hasTrackGrown, setHasTrackGrown] = useState(
shouldReduceMotion ?? false,
);
const pillRef = useRef<HTMLDivElement>(null);
- const { earnedCredits, goalCredits, currentStep, currentStepCredits } =
- progress;
+ const {
+ earnedCredits,
+ earnedCreditsByStep,
+ goalCredits,
+ currentStep,
+ currentStepCredits,
+ } = progress;
const {
seenCredits,
newlyEarnedCredits,
@@ -95,6 +146,8 @@ export const OnboardingFreeCreditsPill = ({
const hasNewlyEarnedCredits = newlyEarnedCredits > 0;
const isEarningFirstCredits = goalCredits <= 0;
+ const highlight =
+ isEarningFirstCredits || hasNewlyEarnedCredits ? 'earned' : undefined;
const formattedCurrentStepCredits = formatOnboardingCredits(
currentStepCredits,
@@ -121,45 +174,66 @@ export const OnboardingFreeCreditsPill = ({
/>
)}
</AnimatePresence>
- <StyledPill
- ref={pillRef}
- data-highlighted={
- isEarningFirstCredits || hasNewlyEarnedCredits ? 'earned' : undefined
- }
- >
- <IconCoins size={theme.icon.size.md} color="currentColor" />
- <AnimatePresence mode="wait">
- <StyledCreditsContent
- key={isEarningFirstCredits ? 'earn' : 'progress'}
- initial={{ opacity: 0 }}
- animate={{ opacity: 1 }}
- exit={{ opacity: 0 }}
- transition={{ duration: theme.animation.duration.fast }}
- >
- {isEarningFirstCredits ? (
- <StyledOnboardingFreeCreditsText>
- <StyledOnboardingFreeCreditsCount>{t`Earn ${formattedCurrentStepCredits}`}</StyledOnboardingFreeCreditsCount>
- <StyledOnboardingFreeCreditsLabel>
- {plural(currentStepCredits, {
- one: 'free credit',
- other: 'free credits',
- })}
- </StyledOnboardingFreeCreditsLabel>
- </StyledOnboardingFreeCreditsText>
- ) : (
- <OnboardingFreeCreditsProgress
- earnedCredits={earnedCredits}
- goalCredits={goalCredits}
- seenCredits={seenCredits}
- hasNewlyEarnedCredits={hasNewlyEarnedCredits}
- hasTrackGrown={hasTrackGrown}
- onTrackGrown={() => setHasTrackGrown(true)}
- />
- )}
- </StyledCreditsContent>
- </AnimatePresence>
- </StyledPill>
- <Tooltip.Root open={isDefined(tooltipContent)}>
+ <StyledPillAnchor ref={pillRef}>
+ <Popover.Root
+ onOpenChange={(open) => {
+ if (open) {
+ setIsPopoverShown(true);
+ }
+ }}
+ onOpenChangeComplete={(open) => {
+ if (!open) {
+ setIsPopoverShown(false);
+ }
+ }}
+ >
+ <Popover.Trigger openOnHover render={<StyledTrigger />}>
+ <StyledCreditsPart data-highlighted={highlight}>
+ <IconCoins size={theme.icon.size.md} color="currentColor" />
+ <AnimatePresence mode="wait">
+ <StyledCreditsContent
+ key={isEarningFirstCredits ? 'earn' : 'progress'}
+ initial={{ opacity: 0 }}
+ animate={{ opacity: 1 }}
+ exit={{ opacity: 0 }}
+ transition={{ duration: theme.animation.duration.fast }}
+ >
+ {isEarningFirstCredits ? (
+ <StyledOnboardingFreeCreditsText>
+ <StyledOnboardingFreeCreditsCount>{t`Earn ${formattedCurrentStepCredits}`}</StyledOnboardingFreeCreditsCount>
+ <StyledOnboardingFreeCreditsLabel>
+ {plural(currentStepCredits, {
+ one: 'free credit',
+ other: 'free credits',
+ })}
+ </StyledOnboardingFreeCreditsLabel>
+ </StyledOnboardingFreeCreditsText>
+ ) : (
+ <OnboardingFreeCreditsProgress
+ earnedCredits={earnedCredits}
+ goalCredits={goalCredits}
+ seenCredits={seenCredits}
+ hasNewlyEarnedCredits={hasNewlyEarnedCredits}
+ hasTrackGrown={hasTrackGrown}
+ onTrackGrown={() => setHasTrackGrown(true)}
+ />
+ )}
+ </StyledCreditsContent>
+ </AnimatePresence>
+ </StyledCreditsPart>
+ <StyledInfoPart data-highlighted={highlight}>
+ <IconInfoCircle size={theme.icon.size.md} color="currentColor" />
+ </StyledInfoPart>
+ </Popover.Trigger>
+ <Popover.Popup side="bottom" align="end" aria-label={t`Free credits`}>
+ <OnboardingFreeCreditsPopoverContent
+ earnedCredits={earnedCredits}
+ earnedCreditsByStep={earnedCreditsByStep}
+ />
+ </Popover.Popup>
+ </Popover.Root>
+ </StyledPillAnchor>
+ <Tooltip.Root open={!isPopoverShown && isDefined(tooltipContent)}>
<Tooltip.Popup
anchor={pillRef}
side="bottom"
diff --git a/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsPopoverContent.tsx b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsPopoverContent.tsx
new file mode 100644
index 00000000000..914645ef72e
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsPopoverContent.tsx
@@ -0,0 +1,184 @@
+import { useNumberFormat } from '@/localization/hooks/useNumberFormat';
+import { type OnboardingCreditsProgress } from '@/onboarding/types/OnboardingCreditsProgress';
+import { type OnboardingCreditsStep } from '@/onboarding/types/OnboardingCreditsStep';
+import { formatOnboardingCredits } from '@/onboarding/utils/formatOnboardingCredits';
+import { getOnboardingCreditWorth } from '@/onboarding/utils/getOnboardingCreditWorth';
+import { UsageProgressRow } from '@/ui/feedback/progress-ring/components/UsageProgressRow';
+import { styled } from '@linaria/react';
+import { plural } from '@lingui/core/macro';
+import { useLingui } from '@lingui/react/macro';
+import { isNonEmptyArray } from 'twenty-shared/utils';
+import {
+ IconApps,
+ IconAt,
+ IconCoins,
+ type IconComponent,
+ IconCreditCard,
+ IconInfoCircle,
+ IconMail,
+ IconSettingsAutomation,
+ IconSparkles,
+ IconUserCircle,
+ IconUserPlus,
+ IconVideo,
+ IconWand,
+} from 'twenty-ui/icon';
+import { HorizontalSeparator } from 'twenty-ui/primitives/layout';
+import { themeCssVariables, useTheme } from 'twenty-ui/theme';
+
+const StyledContent = styled.div`
+ display: flex;
+ flex-direction: column;
+ gap: ${themeCssVariables.spacing[1]};
+ max-width: 100%;
+ width: 284px;
+`;
+
+const StyledSection = styled.div`
+ display: flex;
+ flex-direction: column;
+ gap: ${themeCssVariables.spacing[1]};
+`;
+
+const StyledSectionTitle = styled.span`
+ align-items: center;
+ color: ${themeCssVariables.font.color.secondary};
+ display: flex;
+ font-size: ${themeCssVariables.font.size.xs};
+ font-weight: ${themeCssVariables.font.weight.semiBold};
+ height: ${themeCssVariables.spacing[5]};
+`;
+
+const StyledFooter = styled.div`
+ align-items: center;
+ color: ${themeCssVariables.font.color.tertiary};
+ display: flex;
+ font-size: ${themeCssVariables.font.size.sm};
+ gap: ${themeCssVariables.spacing[1]};
+ min-height: ${themeCssVariables.spacing[6]};
+`;
+
+type OnboardingFreeCreditsPopoverContentProps = Pick<
+ OnboardingCreditsProgress,
+ 'earnedCredits' | 'earnedCreditsByStep'
+>;
+
+export const OnboardingFreeCreditsPopoverContent = ({
+ earnedCredits,
+ earnedCreditsByStep,
+}: OnboardingFreeCreditsPopoverContentProps) => {
+ const { t } = useLingui();
+ const theme = useTheme();
+ const { formatNumber, numberFormat } = useNumberFormat();
+
+ const creditsSteps: Record<
+ OnboardingCreditsStep,
+ { Icon: IconComponent; label: string }
+ > = {
+ importContacts: { Icon: IconAt, label: t`Import contacts` },
+ installApps: { Icon: IconApps, label: t`Install apps` },
+ createProfile: { Icon: IconUserCircle, label: t`Create profile` },
+ inviteTeam: { Icon: IconUserPlus, label: t`Invite your team` },
+ upgradeTrial: { Icon: IconCreditCard, label: t`Upgrade your trial` },
+ };
+
+ const {
+ aiActions,
+ workflowSteps,
+ enrichments,
+ callRecordingHours,
+ emailsSent,
+ } = getOnboardingCreditWorth(earnedCredits > 0 ? earnedCredits : 1);
+
+ const formattedEarnedCredits = formatOnboardingCredits(
+ earnedCredits,
+ numberFormat,
+ );
+ const formattedCallRecordingHours = formatNumber(callRecordingHours, {
+ decimals: 1,
+ });
+
+ return (
+ <StyledContent>
+ <StyledSection>
+ <StyledSectionTitle>{t`Free credits`}</StyledSectionTitle>
+ <UsageProgressRow
+ Icon={IconCoins}
+ label={t`Total earned`}
+ value={null}
+ valueLabel={plural(earnedCredits, {
+ one: `${formattedEarnedCredits} credit`,
+ other: `${formattedEarnedCredits} credits`,
+ })}
+ />
+ </StyledSection>
+ {isNonEmptyArray(earnedCreditsByStep) && (
+ <>
+ <HorizontalSeparator noMargin />
+ <StyledSection>
+ <StyledSectionTitle>{t`Breakdown`}</StyledSectionTitle>
+ {earnedCreditsByStep.map(({ step, credits, rewardCredits }) => (
+ <UsageProgressRow
+ key={step}
+ Icon={creditsSteps[step].Icon}
+ label={creditsSteps[step].label}
+ value={null}
+ valueLabel={
+ credits < rewardCredits
+ ? `${formatOnboardingCredits(credits, numberFormat)}/${formatOnboardingCredits(rewardCredits, numberFormat)}`
+ : formatOnboardingCredits(credits, numberFormat)
+ }
+ />
+ ))}
+ </StyledSection>
+ </>
+ )}
+ <HorizontalSeparator noMargin />
+ <StyledSection>
+ <StyledSectionTitle>
+ {earnedCredits > 0
+ ? t`Enough for one of these on average`
+ : t`1 credit is enough for one of these on average`}
+ </StyledSectionTitle>
+ <UsageProgressRow
+ Icon={IconSparkles}
+ label={t`AI actions`}
+ value={null}
+ valueLabel={formatNumber(aiActions)}
+ />
+ <UsageProgressRow
+ Icon={IconSettingsAutomation}
+ label={t`Workflow steps`}
+ value={null}
+ valueLabel={formatNumber(workflowSteps)}
+ />
+ <UsageProgressRow
+ Icon={IconWand}
+ label={t`Enrichments`}
+ value={null}
+ valueLabel={formatNumber(enrichments)}
+ />
+ <UsageProgressRow
+ Icon={IconVideo}
+ label={t`Call recording`}
+ value={null}
+ valueLabel={plural(callRecordingHours, {
+ one: `${formattedCallRecordingHours} hour`,
+ other: `${formattedCallRecordingHours} hours`,
+ })}
+ />
+ <UsageProgressRow
+ Icon={IconMail}
+ label={t`Shared inbox emails`}
+ value={null}
+ valueLabel={formatNumber(emailsSent)}
+ />
+ </StyledSection>
+ <HorizontalSeparator noMargin />
+ <StyledFooter>
+ <IconInfoCircle size={theme.icon.size.sm} />
+ {t`Stacks on top of your plan and never expires`}
+ </StyledFooter>
+ </StyledContent>
+ );
+};
diff --git a/packages/twenty-front/src/modules/onboarding/components/free-credits/__stories__/OnboardingHeaderFreeCredits.stories.tsx b/packages/twenty-front/src/modules/onboarding/components/free-credits/__stories__/OnboardingHeaderFreeCredits.stories.tsx
index 9a621ee24b7..4118a155b40 100644
--- a/packages/twenty-front/src/modules/onboarding/components/free-credits/__stories__/OnboardingHeaderFreeCredits.stories.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/__stories__/OnboardingHeaderFreeCredits.stories.tsx
@@ -1,10 +1,12 @@
import { type Meta, type StoryObj } from '@storybook/react-vite';
-import { expect, waitFor, within } from 'storybook/test';
+import { expect, userEvent, waitFor, within } from 'storybook/test';
import { ComponentDecorator } from 'twenty-ui/testing';
import { currentUserState } from '@/auth/states/currentUserState';
import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
+import { NumberFormat } from '@/localization/constants/NumberFormat';
+import { workspaceMemberFormatPreferencesState } from '@/localization/states/workspaceMemberFormatPreferencesState';
import { OnboardingHeaderFreeCredits } from '@/onboarding/components/free-credits/OnboardingHeaderFreeCredits';
import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
import { onboardingFreeCreditsFamilyState } from '@/onboarding/states/onboardingFreeCreditsFamilyState';
@@ -20,10 +22,16 @@ import {
const seedOnboardingFreeCredits = ({
onboardingStatus,
onboardingFreeCredits = {},
+ numberFormat = NumberFormat.COMMAS_AND_DOT,
}: {
onboardingStatus: OnboardingStatus;
onboardingFreeCredits?: Partial<OnboardingFreeCredits>;
+ numberFormat?: NumberFormat;
}) => {
+ jotaiStore.set(
+ workspaceMemberFormatPreferencesState.atom,
+ (formatPreferences) => ({ ...formatPreferences, numberFormat }),
+ );
jotaiStore.set(onboardingConfigState.atom, {
importContactsCreditsReward: 1,
inviteTeamCreditsRewardPerUser: 0.5,
@@ -55,6 +63,24 @@ const findVisibleTooltip = async (canvasElement: HTMLElement, text: string) => {
await waitFor(() => expect(tooltip).toBeVisible());
};
+const openFreeCreditsPopover = async (
+ canvasElement: HTMLElement,
+ pillName: RegExp,
+) => {
+ await userEvent.click(
+ await within(canvasElement).findByRole('button', { name: pillName }),
+ );
+
+ const dialog = await within(canvasElement.ownerDocument.body).findByRole(
+ 'dialog',
+ { name: 'Free credits' },
+ );
+
+ await waitFor(() => expect(dialog).toBeVisible());
+
+ return within(dialog);
+};
+
const meta: Meta<typeof OnboardingHeaderFreeCredits> = {
title: 'Modules/Onboarding/FreeCredits',
component: OnboardingHeaderFreeCredits,
@@ -136,3 +162,49 @@ export const NewlyEarned: Story = {
);
},
};
+
+export const CreditsWorth: Story = {
+ beforeEach: () => {
+ seedOnboardingFreeCredits({
+ onboardingStatus: OnboardingStatus.SYNC_EMAIL,
+ });
+ },
+ play: async ({ canvasElement }) => {
+ const popover = await openFreeCreditsPopover(canvasElement, /Earn 1/);
+
+ await expect(
+ popover.getByText('1 credit is enough for one of these on average'),
+ ).toBeVisible();
+ await expect(popover.getByText('Total earned')).toBeVisible();
+ await expect(popover.queryByText('Breakdown')).not.toBeInTheDocument();
+ },
+};
+
+export const Breakdown: Story = {
+ beforeEach: () => {
+ seedOnboardingFreeCredits({
+ onboardingStatus: OnboardingStatus.COMPLETED,
+ onboardingFreeCredits: {
+ importContacts: 1,
+ installApps: 0.5,
+ inviteTeam: 1,
+ seenCredits: 2.5,
+ },
+ numberFormat: NumberFormat.DOTS_AND_COMMA,
+ });
+ },
+ play: async ({ canvasElement }) => {
+ const popover = await openFreeCreditsPopover(canvasElement, /free credits/);
+
+ await expect(popover.getByText('2,5 credits')).toBeVisible();
+ await expect(
+ popover.getByText('Enough for one of these on average'),
+ ).toBeVisible();
+ await expect(popover.getByText('60')).toBeVisible();
+ await expect(popover.getByText('2,5 hours')).toBeVisible();
+ await expect(popover.getByText('Create profile')).toBeVisible();
+ await expect(popover.getByText('0/0,5')).toBeVisible();
+ await expect(popover.getByText('Invite your team')).toBeVisible();
+ await expect(popover.getByText('1/5')).toBeVisible();
+ },
+};
diff --git a/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsProgress.ts b/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsProgress.ts
index c8a631da826..db80c93ddf7 100644
--- a/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsProgress.ts
+++ b/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsProgress.ts
@@ -2,6 +2,11 @@ import { type OnboardingCreditsStep } from '@/onboarding/types/OnboardingCredits
export type OnboardingCreditsProgress = {
earnedCredits: number;
+ earnedCreditsByStep: {
+ step: OnboardingCreditsStep;
+ credits: number;
+ rewardCredits: number;
+ }[];
goalCredits: number;
currentStep: OnboardingCreditsStep | null;
currentStepCredits: number;
diff --git a/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditsProgress.test.ts b/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditsProgress.test.ts
index a94b8ba86bb..420f334fd64 100644
--- a/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditsProgress.test.ts
+++ b/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditsProgress.test.ts
@@ -32,6 +32,7 @@ describe('getOnboardingCreditsProgress', () => {
}),
).toEqual({
earnedCredits: 0,
+ earnedCreditsByStep: [],
goalCredits: 0,
currentStep: 'importContacts',
currentStepCredits: 2,
@@ -85,6 +86,7 @@ describe('getOnboardingCreditsProgress', () => {
}),
).toEqual({
earnedCredits: 0,
+ earnedCreditsByStep: [],
goalCredits: 0,
currentStep: 'importContacts',
currentStepCredits: 2,
@@ -197,6 +199,42 @@ describe('getOnboardingCreditsProgress', () => {
expect(progress.goalCredits).toBe(4);
});
+ it('should recap what each step done earned out of its reward', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({
+ importContacts: 2,
+ createProfile: 0.5,
+ inviteTeam: 0.5,
+ }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.PLAN_REQUIRED,
+ isWorkspaceCreator: true,
+ isPlanRequired: true,
+ });
+
+ expect(progress.earnedCreditsByStep).toEqual([
+ { step: 'importContacts', credits: 2, rewardCredits: 2 },
+ { step: 'installApps', credits: 0, rewardCredits: 1 },
+ { step: 'createProfile', credits: 0.5, rewardCredits: 0.5 },
+ { step: 'inviteTeam', credits: 0.5, rewardCredits: 2 },
+ { step: 'upgradeTrial', credits: 0, rewardCredits: 0.5 },
+ ]);
+ });
+
+ it('should leave the step at hand out of the recap until it earns credits', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({ importContacts: 2 }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.APPS_INSTALLATION,
+ isWorkspaceCreator: true,
+ isPlanRequired: false,
+ });
+
+ expect(progress.earnedCreditsByStep).toEqual([
+ { step: 'importContacts', credits: 2, rewardCredits: 2 },
+ ]);
+ });
+
it('should leave out the workspace creator rewards for other members', () => {
const progress = getOnboardingCreditsProgress({
onboardingFreeCredits: buildOnboardingFreeCredits(),
diff --git a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsProgress.ts b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsProgress.ts
index d579b9e7129..06fce17d3f2 100644
--- a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsProgress.ts
+++ b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsProgress.ts
@@ -70,6 +70,16 @@ export const getOnboardingCreditsProgress = ({
return {
earnedCredits: getOnboardingEarnedCredits(countedFreeCredits),
+ earnedCreditsByStep: ONBOARDING_CREDITS_STEPS.filter(
+ (step) =>
+ countedFreeCredits[step] > 0 ||
+ (isOnboardingCreditsStepDone({ step, onboardingStatus }) &&
+ rewardCreditsByStep[step] > 0),
+ ).map((step) => ({
+ step,
+ credits: countedFreeCredits[step],
+ rewardCredits: rewardCreditsByStep[step],
+ })),
goalCredits,
currentStep:
isDefined(onboardingStep) && currentStepCredits > 0