Skip to content

The open alternative to Salesforce, designed for AI.

[Onboarding 3/10] Add credits pill (#26780)

Thomas des Francsc8cd5ca95815
diff --git a/packages/twenty-docs/snippets/ui/generated/feedback/progress-bar.mdx b/packages/twenty-docs/snippets/ui/generated/feedback/progress-bar.mdx
index ea1f52a6286..b69250a2a17 100644
--- a/packages/twenty-docs/snippets/ui/generated/feedback/progress-bar.mdx
+++ b/packages/twenty-docs/snippets/ui/generated/feedback/progress-bar.mdx
@@ -39,6 +39,14 @@
Called when the countdown animation ends.
</ParamField>
+<ParamField body="onGrowInComplete" type="(() =&gt; void)">
+ Called when the grow-in animation ends.
+</ParamField>
+
+<ParamField body="size" type="&quot;md&quot; | &quot;sm&quot;" default="md">
+ Bar height: `sm` (6px) or `md` (8px).
+</ParamField>
+
<ParamField body="value" type="number" required>
Current progress from 0 to 100. Also supplies the accessible value during a countdown.
</ParamField>
@@ -46,3 +54,19 @@
<ParamField body="withBorderRadius" type="boolean" default="false">
Rounds the track and indicator corners.
</ParamField>
+
+<ParamField body="withGlint" type="boolean" default="false">
+ Sweeps a highlight across the filled bar each time the value changes.
+</ParamField>
+
+<ParamField body="withGrowIn" type="boolean" default="false">
+ Grows the bar in from zero width when it mounts.
+</ParamField>
+
+<ParamField body="withMinimumFillWidth" type="boolean" default="true">
+ Keeps a small visible fill for any value above zero.
+</ParamField>
+
+<ParamField body="withSpringFill" type="boolean" default="false">
+ Animates value changes with a spring that slightly overshoots the target.
+</ParamField>
diff --git a/packages/twenty-docs/snippets/ui/generated/surfaces/tooltip.mdx b/packages/twenty-docs/snippets/ui/generated/surfaces/tooltip.mdx
index 646c9a5b2c9..378385ba90a 100644
--- a/packages/twenty-docs/snippets/ui/generated/surfaces/tooltip.mdx
+++ b/packages/twenty-docs/snippets/ui/generated/surfaces/tooltip.mdx
@@ -180,6 +180,10 @@
There's no need to specify this prop when the tooltip is uncontrolled (that is, when the `open` prop is not set).
</ParamField>
+<ParamField body="withExitAnimation" type="boolean">
+ Fades and slides the popup out when it closes instead of hiding it at once.
+</ParamField>
+
### Tooltip.Root
<ParamField body="Root.actionsRef" type="RefObject&lt;TooltipRootActions | null&gt;">
@@ -399,6 +403,10 @@
Inline styles for the popup.
</ParamField>
+<ParamField body="Popup.withExitAnimation" type="boolean" default="false">
+ Fades and slides the popup out when it closes instead of hiding it at once.
+</ParamField>
+
### Tooltip.Content
<ParamField body="Content.children" type="ReactNode">
diff --git a/packages/twenty-front/src/modules/command-menu-item/display/components/CommandMenuItemSelectionRecordStack.tsx b/packages/twenty-front/src/modules/command-menu-item/display/components/CommandMenuItemSelectionRecordStack.tsx
index 876c84d554a..31f092b07b0 100644
--- a/packages/twenty-front/src/modules/command-menu-item/display/components/CommandMenuItemSelectionRecordStack.tsx
+++ b/packages/twenty-front/src/modules/command-menu-item/display/components/CommandMenuItemSelectionRecordStack.tsx
@@ -7,6 +7,7 @@ import { themeCssVariables, useTheme } from 'twenty-ui/theme';
import { type EnrichedObjectMetadataItem } from '@/object-metadata/types/EnrichedObjectMetadataItem';
import { type ObjectRecord } from '@/object-record/types/ObjectRecord';
import { SidePanelContextRecordChipAvatars } from '@/side-panel/components/SidePanelContextRecordChipAvatars';
+import { EASE_OUT } from '@/ui/theme/constants/EaseOut';
// Card offsets in the 24px icon column for 1, 2 and 3 cards, front card first.
const CARD_POSITIONS_BY_RECORD_COUNT = [
@@ -28,7 +29,6 @@ const DROP_DISTANCE_IN_PX = 6;
const DROP_SCALE = 1.25;
const HIDDEN_SCALE = 0.8;
const OPENING_STAGGER_IN_SECONDS = 0.04;
-const EASE_OUT = [0.2, 0, 0, 1] as const;
const StyledStack = styled.div`
height: ${themeCssVariables.spacing[6]};
diff --git a/packages/twenty-front/src/modules/onboarding/components/OnboardingHeader.tsx b/packages/twenty-front/src/modules/onboarding/components/OnboardingHeader.tsx
index 0ff08b3c0ad..51ab68b710f 100644
--- a/packages/twenty-front/src/modules/onboarding/components/OnboardingHeader.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/OnboardingHeader.tsx
@@ -1,10 +1,11 @@
import { ONBOARDING_CONTENT_BLOCK_WIDTH } from '@/onboarding/constants/OnboardingContentBlockWidth';
import { styled } from '@linaria/react';
import { useLingui } from '@lingui/react/macro';
+import { type ReactNode } from 'react';
import { isDefined } from 'twenty-shared/utils';
import { LightIconButton } from 'twenty-ui/components';
-import { IconChevronLeft, IconCoins, IconInfoCircle } from 'twenty-ui/icon';
-import { MOBILE_VIEWPORT, themeCssVariables, useTheme } from 'twenty-ui/theme';
+import { IconChevronLeft } from 'twenty-ui/icon';
+import { MOBILE_VIEWPORT, themeCssVariables } from 'twenty-ui/theme';
const StyledHeader = styled.div`
align-items: flex-start;
@@ -61,66 +62,18 @@ const StyledLogo = styled.div`
width: ${themeCssVariables.spacing[6]};
`;
-const StyledFreeCredits = styled.div`
- align-items: center;
- color: ${themeCssVariables.font.color.tertiary};
- display: flex;
-`;
-
-const StyledCreditsTag = styled.div`
- align-items: center;
- background-color: ${themeCssVariables.background.tertiary};
- border-bottom: 1px solid ${themeCssVariables.border.color.light};
- border-bottom-left-radius: ${themeCssVariables.border.radius.pill};
- border-left: 1px solid ${themeCssVariables.border.color.light};
- border-top: 1px solid ${themeCssVariables.border.color.light};
- border-top-left-radius: ${themeCssVariables.border.radius.pill};
- box-sizing: border-box;
- corner-shape: round;
- display: flex;
- gap: ${themeCssVariables.spacing[1]};
- height: ${themeCssVariables.spacing[6]};
- padding: 0 ${themeCssVariables.spacing[2]} 0
- ${themeCssVariables.spacing['1.5']};
-`;
-
-const StyledCreditsCount = styled.span`
- font-size: ${themeCssVariables.font.size.md};
- font-weight: ${themeCssVariables.font.weight.medium};
-`;
-
-const StyledCreditsLabel = styled.span`
- font-size: ${themeCssVariables.font.size.sm};
-`;
-
-const StyledInfoTag = styled.div`
- align-items: center;
- background-color: ${themeCssVariables.background.tertiary};
- border: 1px solid ${themeCssVariables.border.color.light};
- border-bottom-right-radius: ${themeCssVariables.border.radius.rounded};
- border-top-right-radius: ${themeCssVariables.border.radius.rounded};
- box-sizing: border-box;
- corner-shape: round;
- display: flex;
- height: ${themeCssVariables.spacing[6]};
- justify-content: center;
- padding: 0 ${themeCssVariables.spacing['1.5']} 0
- ${themeCssVariables.spacing[1]};
-`;
-
type OnboardingHeaderProps = {
onBack?: () => void;
isBackDisabled?: boolean;
- freeCredits?: number;
+ rightComponent?: ReactNode;
};
export const OnboardingHeader = ({
onBack,
isBackDisabled,
- freeCredits,
+ rightComponent,
}: OnboardingHeaderProps) => {
const { t } = useLingui();
- const theme = useTheme();
return (
<StyledHeader>
@@ -140,26 +93,7 @@ export const OnboardingHeader = ({
<StyledCenter>
<StyledLogo />
</StyledCenter>
- <StyledRightSide>
- {isDefined(freeCredits) && (
- <StyledFreeCredits>
- <StyledCreditsTag>
- <IconCoins
- size={theme.icon.size.md}
- color={themeCssVariables.font.color.tertiary}
- />
- <StyledCreditsCount>{freeCredits}</StyledCreditsCount>
- <StyledCreditsLabel>{t`free credits`}</StyledCreditsLabel>
- </StyledCreditsTag>
- <StyledInfoTag>
- <IconInfoCircle
- size={theme.icon.size.md}
- color={themeCssVariables.font.color.tertiary}
- />
- </StyledInfoTag>
- </StyledFreeCredits>
- )}
- </StyledRightSide>
+ <StyledRightSide>{rightComponent}</StyledRightSide>
</StyledHeader>
);
};
diff --git a/packages/twenty-front/src/modules/onboarding/components/OnboardingLayout.tsx b/packages/twenty-front/src/modules/onboarding/components/OnboardingLayout.tsx
index ebe0018cf42..d4d3e2ac453 100644
--- a/packages/twenty-front/src/modules/onboarding/components/OnboardingLayout.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/OnboardingLayout.tsx
@@ -15,20 +15,20 @@ type OnboardingLayoutProps = {
children: ReactNode;
onBack?: () => void;
isBackDisabled?: boolean;
- freeCredits?: number;
+ headerRightComponent?: ReactNode;
};
export const OnboardingLayout = ({
children,
onBack,
isBackDisabled,
- freeCredits,
+ headerRightComponent,
}: OnboardingLayoutProps) => (
<StyledBackground>
<OnboardingHeader
onBack={onBack}
isBackDisabled={isBackDisabled}
- freeCredits={freeCredits}
+ rightComponent={headerRightComponent}
/>
{children}
</StyledBackground>
diff --git a/packages/twenty-front/src/modules/onboarding/components/OnboardingStepLayout.tsx b/packages/twenty-front/src/modules/onboarding/components/OnboardingStepLayout.tsx
index 8c8c772eeb9..3ca41386b5c 100644
--- a/packages/twenty-front/src/modules/onboarding/components/OnboardingStepLayout.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/OnboardingStepLayout.tsx
@@ -1,17 +1,14 @@
import { currentUserState } from '@/auth/states/currentUserState';
-import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
import { OnboardingLayout } from '@/onboarding/components/OnboardingLayout';
import { OnboardingTransitionOutlet } from '@/onboarding/components/OnboardingTransitionOutlet';
+import { OnboardingHeaderFreeCredits } from '@/onboarding/components/free-credits/OnboardingHeaderFreeCredits';
import { PrefetchBookCallStepEffect } from '@/onboarding/effect-components/PrefetchBookCallStepEffect';
import { PrefetchPlanRequiredStepEffect } from '@/onboarding/effect-components/PrefetchPlanRequiredStepEffect';
import { useGoBackToPreviousOnboardingStep } from '@/onboarding/hooks/useGoBackToPreviousOnboardingStep';
-import { useOnboardingFreeCreditsTotal } from '@/onboarding/hooks/useOnboardingFreeCreditsTotal';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { isDefined } from 'twenty-shared/utils';
export const OnboardingStepLayout = () => {
- const onboardingConfig = useAtomStateValue(onboardingConfigState);
- const freeCreditsTotal = useOnboardingFreeCreditsTotal();
const currentUser = useAtomStateValue(currentUserState);
const {
goBackToPreviousOnboardingStep,
@@ -32,7 +29,7 @@ export const OnboardingStepLayout = () => {
: undefined
}
isBackDisabled={isGoingBackToPreviousOnboardingStep}
- freeCredits={isDefined(onboardingConfig) ? freeCreditsTotal : undefined}
+ headerRightComponent={<OnboardingHeaderFreeCredits />}
>
<PrefetchBookCallStepEffect />
<PrefetchPlanRequiredStepEffect />
diff --git a/packages/twenty-front/src/modules/onboarding/components/__tests__/OnboardingStepLayout.test.tsx b/packages/twenty-front/src/modules/onboarding/components/__tests__/OnboardingStepLayout.test.tsx
index 18e15deda5a..31f941891a2 100644
--- a/packages/twenty-front/src/modules/onboarding/components/__tests__/OnboardingStepLayout.test.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/__tests__/OnboardingStepLayout.test.tsx
@@ -6,16 +6,24 @@ import { Provider as JotaiProvider } from 'jotai';
import { type ReactNode } from 'react';
import { SOURCE_LOCALE } from 'twenty-shared/translations';
+import { currentUserState } from '@/auth/states/currentUserState';
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
import { type OnboardingConfig } from '@/client-config/types/OnboardingConfig';
import { OnboardingStepLayout } from '@/onboarding/components/OnboardingStepLayout';
-import { onboardingFreeCreditsState } from '@/onboarding/states/onboardingFreeCreditsState';
+import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
+import { onboardingFreeCreditsFamilyState } from '@/onboarding/states/onboardingFreeCreditsFamilyState';
import {
jotaiStore,
resetJotaiStore,
} from '@/ui/utilities/state/jotai/jotaiStore';
import { ToastProvider } from 'twenty-ui/components';
+import { OnboardingStatus } from '~/generated-metadata/graphql';
import { messages } from '~/locales/generated/en';
+import {
+ mockCurrentWorkspace,
+ mockedUserData,
+} from '~/testing/mock-data/users';
jest.mock(
'@/onboarding/effect-components/PrefetchPlanRequiredStepEffect',
@@ -50,31 +58,55 @@ const Wrapper = ({ children }: { children: ReactNode }) => (
</MockedProvider>
);
+const setOnboardingStatus = (onboardingStatus: OnboardingStatus) =>
+ jotaiStore.set(currentUserState.atom, {
+ ...mockedUserData,
+ isWorkspaceCreator: true,
+ onboardingStatus,
+ });
+
describe('OnboardingStepLayout', () => {
beforeEach(() => {
localStorage.clear();
resetJotaiStore();
- jotaiStore.set(onboardingFreeCreditsState.atom, {
- importContacts: 2,
- inviteTeam: 3,
- installApps: 1,
- });
+ jotaiStore.set(currentWorkspaceState.atom, mockCurrentWorkspace);
});
- it('should display the free credits pill when credits rewards are configured', () => {
+ it('should invite to earn the email reward on the first step', async () => {
jotaiStore.set(onboardingConfigState.atom, onboardingConfig);
+ setOnboardingStatus(OnboardingStatus.SYNC_EMAIL);
render(<OnboardingStepLayout />, { wrapper: Wrapper });
- expect(screen.getByText('free credits')).toBeInTheDocument();
- expect(screen.getByText('6')).toBeInTheDocument();
+ expect(await screen.findByText('Earn 2')).toBeInTheDocument();
+ });
+
+ it('should display the free credits won out of the steps done so far', async () => {
+ jotaiStore.set(onboardingConfigState.atom, onboardingConfig);
+ setOnboardingStatus(OnboardingStatus.PROFILE_CREATION);
+ jotaiStore.set(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ {
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 1.5,
+ seenCredits: 1.5,
+ },
+ );
+
+ render(<OnboardingStepLayout />, { wrapper: Wrapper });
+
+ const freeCreditsLabel = await screen.findByText('free credits');
+
+ expect(freeCreditsLabel.parentElement).toHaveTextContent('1.5/3');
});
it('should hide the free credits pill when credits rewards are not configured', () => {
jotaiStore.set(onboardingConfigState.atom, null);
+ setOnboardingStatus(OnboardingStatus.SYNC_EMAIL);
+
render(<OnboardingStepLayout />, { wrapper: Wrapper });
- expect(screen.queryByText('free credits')).not.toBeInTheDocument();
+ expect(screen.queryByText('Earn 2')).not.toBeInTheDocument();
});
});
diff --git a/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsAnimatedCount.tsx b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsAnimatedCount.tsx
new file mode 100644
index 00000000000..070b54adb54
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsAnimatedCount.tsx
@@ -0,0 +1,66 @@
+import { useNumberFormat } from '@/localization/hooks/useNumberFormat';
+import { formatOnboardingCredits } from '@/onboarding/utils/formatOnboardingCredits';
+import { EASE_OUT } from '@/ui/theme/constants/EaseOut';
+import { styled } from '@linaria/react';
+import { AnimatePresence, motion, useReducedMotion } from 'framer-motion';
+import { useState } from 'react';
+import { useTheme } from 'twenty-ui/theme';
+
+const ROLL_OFFSET_PERCENT = 60;
+
+const StyledContainer = styled.span`
+ display: inline-flex;
+ position: relative;
+`;
+
+type OnboardingFreeCreditsAnimatedCountProps = {
+ credits: number;
+};
+
+export const OnboardingFreeCreditsAnimatedCount = ({
+ credits,
+}: OnboardingFreeCreditsAnimatedCountProps) => {
+ const theme = useTheme();
+ const { numberFormat } = useNumberFormat();
+ const shouldReduceMotion = useReducedMotion();
+ const [previousCredits, setPreviousCredits] = useState(credits);
+ const [rollDirection, setRollDirection] = useState(1);
+
+ if (credits !== previousCredits) {
+ setRollDirection(credits > previousCredits ? 1 : -1);
+ setPreviousCredits(credits);
+ }
+
+ const rollOffsetPercent = shouldReduceMotion ? 0 : ROLL_OFFSET_PERCENT;
+
+ return (
+ <StyledContainer>
+ <AnimatePresence initial={false} mode="popLayout" custom={rollDirection}>
+ <motion.span
+ key={credits}
+ custom={rollDirection}
+ variants={{
+ enter: (direction: number) => ({
+ opacity: 0,
+ y: `${direction * rollOffsetPercent}%`,
+ }),
+ center: { opacity: 1, y: '0%' },
+ exit: (direction: number) => ({
+ opacity: 0,
+ y: `${-direction * rollOffsetPercent}%`,
+ }),
+ }}
+ initial="enter"
+ animate="center"
+ exit="exit"
+ transition={{
+ duration: theme.animation.duration.normal,
+ ease: EASE_OUT,
+ }}
+ >
+ {formatOnboardingCredits(credits, numberFormat)}
+ </motion.span>
+ </AnimatePresence>
+ </StyledContainer>
+ );
+};
diff --git a/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsChange.tsx b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsChange.tsx
new file mode 100644
index 00000000000..e6e265b7985
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsChange.tsx
@@ -0,0 +1,77 @@
+import { ONBOARDING_NEWLY_EARNED_CREDITS_DISPLAY_DURATION_S } from '@/onboarding/constants/OnboardingNewlyEarnedCreditsDisplayDurationS';
+import { styled } from '@linaria/react';
+import { motion, useReducedMotion } from 'framer-motion';
+import { themeCssVariables, useTheme } from 'twenty-ui/theme';
+
+const StyledChange = styled(motion.span)`
+ color: ${themeCssVariables.color.green9};
+ font-size: ${themeCssVariables.font.size.md};
+ font-weight: ${themeCssVariables.font.weight.medium};
+`;
+
+type OnboardingFreeCreditsChangeProps = {
+ label: string;
+ delay: number;
+ onDisplayed: () => void;
+};
+
+export const OnboardingFreeCreditsChange = ({
+ label,
+ delay,
+ onDisplayed,
+}: OnboardingFreeCreditsChangeProps) => {
+ const theme = useTheme();
+ const shouldReduceMotion = useReducedMotion();
+
+ const fadeInDuration = theme.animation.duration.normal;
+ const fadeOutDuration = theme.animation.duration.fast;
+ const displayDuration =
+ ONBOARDING_NEWLY_EARNED_CREDITS_DISPLAY_DURATION_S + fadeOutDuration;
+ const fadeTimes = [
+ 0,
+ fadeInDuration / displayDuration,
+ ONBOARDING_NEWLY_EARNED_CREDITS_DISPLAY_DURATION_S / displayDuration,
+ 1,
+ ];
+ const slideOffset = shouldReduceMotion ? 0 : theme.spacingMultiplicator * 2;
+
+ return (
+ <StyledChange
+ variants={{
+ hidden: {
+ opacity: 0,
+ scale: shouldReduceMotion ? 1 : 0.6,
+ x: slideOffset,
+ y: 0,
+ },
+ displayed: {
+ opacity: [0, 1, 1, 0],
+ scale: 1,
+ x: 0,
+ y: [0, 0, 0, -slideOffset],
+ transition: {
+ opacity: { duration: displayDuration, times: fadeTimes, delay },
+ y: { duration: displayDuration, times: fadeTimes, delay },
+ scale: { type: 'spring', stiffness: 500, damping: 14, delay },
+ x: { duration: fadeInDuration, delay },
+ },
+ },
+ exit: {
+ opacity: 0,
+ y: -slideOffset,
+ transition: { duration: fadeOutDuration },
+ },
+ }}
+ initial="hidden"
+ animate="displayed"
+ exit="exit"
+ onAnimationComplete={(definition) => {
+ if (definition === 'displayed') {
+ onDisplayed();
+ }
+ }}
+ >
+ {label}
+ </StyledChange>
+ );
+};
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
new file mode 100644
index 00000000000..293c73a41d8
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsPill.tsx
@@ -0,0 +1,191 @@
+import { useNumberFormat } from '@/localization/hooks/useNumberFormat';
+import { OnboardingFreeCreditsChange } from '@/onboarding/components/free-credits/OnboardingFreeCreditsChange';
+import { OnboardingFreeCreditsProgress } from '@/onboarding/components/free-credits/OnboardingFreeCreditsProgress';
+import { StyledOnboardingFreeCreditsCount } from '@/onboarding/components/free-credits/StyledOnboardingFreeCreditsCount';
+import { StyledOnboardingFreeCreditsLabel } from '@/onboarding/components/free-credits/StyledOnboardingFreeCreditsLabel';
+import { StyledOnboardingFreeCreditsText } from '@/onboarding/components/free-credits/StyledOnboardingFreeCreditsText';
+import { useOnboardingFreeCreditsTooltipContent } from '@/onboarding/hooks/useOnboardingFreeCreditsTooltipContent';
+import { useOnboardingNewlyEarnedCredits } from '@/onboarding/hooks/useOnboardingNewlyEarnedCredits';
+import { type OnboardingCreditsProgress } from '@/onboarding/types/OnboardingCreditsProgress';
+import { formatOnboardingCredits } from '@/onboarding/utils/formatOnboardingCredits';
+import { styled } from '@linaria/react';
+import { plural } from '@lingui/core/macro';
+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 { themeCssVariables, useTheme } from 'twenty-ui/theme';
+
+const StyledContainer = styled.div`
+ align-items: center;
+ display: flex;
+ gap: ${themeCssVariables.spacing[2]};
+`;
+
+const StyledPill = styled.div`
+ 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),
+ color calc(${themeCssVariables.animation.duration.normal} * 1s);
+
+ &[data-highlighted='earned'] {
+ background-color: ${themeCssVariables.color.green3};
+ border-color: ${themeCssVariables.color.green4};
+ color: ${themeCssVariables.color.green9};
+ }
+`;
+
+const StyledCreditsContent = styled(motion.span)`
+ align-items: center;
+ display: flex;
+ gap: ${themeCssVariables.spacing['1.5']};
+`;
+
+const StyledTooltipContents = styled.div`
+ display: grid;
+`;
+
+const StyledTooltipContent = styled(motion.div)`
+ grid-area: 1 / 1;
+`;
+
+type OnboardingFreeCreditsPillProps = {
+ progress: OnboardingCreditsProgress;
+};
+
+export const OnboardingFreeCreditsPill = ({
+ progress,
+}: OnboardingFreeCreditsPillProps) => {
+ const { t } = useLingui();
+ const theme = useTheme();
+ const shouldReduceMotion = useReducedMotion();
+ const { numberFormat } = useNumberFormat();
+ const [hasTrackGrown, setHasTrackGrown] = useState(
+ shouldReduceMotion ?? false,
+ );
+ const pillRef = useRef<HTMLDivElement>(null);
+
+ const { earnedCredits, goalCredits, currentStep, currentStepCredits } =
+ progress;
+ const {
+ seenCredits,
+ newlyEarnedCredits,
+ isFirstCreditsGain,
+ markCreditsAsSeen,
+ } = useOnboardingNewlyEarnedCredits();
+ const tooltipContent = useOnboardingFreeCreditsTooltipContent({
+ currentStep,
+ newlyEarnedCredits,
+ isFirstCreditsGain,
+ });
+
+ const hasNewlyEarnedCredits = newlyEarnedCredits > 0;
+ const isEarningFirstCredits = goalCredits <= 0;
+
+ const formattedCurrentStepCredits = formatOnboardingCredits(
+ currentStepCredits,
+ numberFormat,
+ );
+
+ const tooltipSlideOffset = shouldReduceMotion
+ ? 0
+ : theme.spacingMultiplicator;
+
+ return (
+ <StyledContainer>
+ <AnimatePresence>
+ {hasNewlyEarnedCredits && (
+ <OnboardingFreeCreditsChange
+ key={newlyEarnedCredits}
+ label={`+${formatOnboardingCredits(newlyEarnedCredits, numberFormat)}`}
+ delay={
+ hasTrackGrown
+ ? theme.animation.duration.normal
+ : theme.animation.duration.normal * 2
+ }
+ onDisplayed={markCreditsAsSeen}
+ />
+ )}
+ </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)}>
+ <Tooltip.Popup
+ anchor={pillRef}
+ side="bottom"
+ align="end"
+ arrow
+ withExitAnimation
+ >
+ <StyledTooltipContents>
+ <AnimatePresence initial={false}>
+ {isDefined(tooltipContent) && (
+ <StyledTooltipContent
+ key={tooltipContent.title}
+ initial={{ opacity: 0, y: tooltipSlideOffset }}
+ animate={{ opacity: 1, y: 0 }}
+ exit={{ opacity: 0, y: -tooltipSlideOffset }}
+ transition={{ duration: theme.animation.duration.normal }}
+ >
+ <Tooltip.Content description={tooltipContent.description}>
+ {tooltipContent.title}
+ </Tooltip.Content>
+ </StyledTooltipContent>
+ )}
+ </AnimatePresence>
+ </StyledTooltipContents>
+ </Tooltip.Popup>
+ </Tooltip.Root>
+ </StyledContainer>
+ );
+};
diff --git a/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsProgress.tsx b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsProgress.tsx
new file mode 100644
index 00000000000..f7d41c6f06d
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsProgress.tsx
@@ -0,0 +1,69 @@
+import { OnboardingFreeCreditsAnimatedCount } from '@/onboarding/components/free-credits/OnboardingFreeCreditsAnimatedCount';
+import { StyledOnboardingFreeCreditsCount } from '@/onboarding/components/free-credits/StyledOnboardingFreeCreditsCount';
+import { StyledOnboardingFreeCreditsLabel } from '@/onboarding/components/free-credits/StyledOnboardingFreeCreditsLabel';
+import { StyledOnboardingFreeCreditsText } from '@/onboarding/components/free-credits/StyledOnboardingFreeCreditsText';
+import { styled } from '@linaria/react';
+import { plural } from '@lingui/core/macro';
+import { useLingui } from '@lingui/react/macro';
+import { ProgressBar } from 'twenty-ui/primitives/feedback';
+import { themeCssVariables } from 'twenty-ui/theme';
+
+const StyledProgressBarContainer = styled.div`
+ flex-shrink: 0;
+ width: ${themeCssVariables.spacing[16]};
+`;
+
+type OnboardingFreeCreditsProgressProps = {
+ earnedCredits: number;
+ goalCredits: number;
+ seenCredits: number;
+ hasNewlyEarnedCredits: boolean;
+ hasTrackGrown: boolean;
+ onTrackGrown: () => void;
+};
+
+export const OnboardingFreeCreditsProgress = ({
+ earnedCredits,
+ goalCredits,
+ seenCredits,
+ hasNewlyEarnedCredits,
+ hasTrackGrown,
+ onTrackGrown,
+}: OnboardingFreeCreditsProgressProps) => {
+ const { t } = useLingui();
+
+ const displayedCredits = hasTrackGrown ? earnedCredits : seenCredits;
+
+ return (
+ <>
+ <StyledProgressBarContainer>
+ <ProgressBar
+ value={Math.min(100, (displayedCredits / goalCredits) * 100)}
+ size="sm"
+ ariaLabel={t`Free credits earned`}
+ backgroundColor={themeCssVariables.background.transparent.medium}
+ barColor={themeCssVariables.color.green9}
+ withBorderRadius
+ withGrowIn={!hasTrackGrown}
+ withGlint={hasTrackGrown && hasNewlyEarnedCredits}
+ withSpringFill
+ withMinimumFillWidth={false}
+ onGrowInComplete={onTrackGrown}
+ />
+ </StyledProgressBarContainer>
+ <StyledOnboardingFreeCreditsText>
+ <StyledOnboardingFreeCreditsCount>
+ <OnboardingFreeCreditsAnimatedCount credits={displayedCredits} />
+ /
+ <OnboardingFreeCreditsAnimatedCount credits={goalCredits} />
+ </StyledOnboardingFreeCreditsCount>
+ <StyledOnboardingFreeCreditsLabel>
+ {plural(goalCredits, {
+ one: 'free credit',
+ other: 'free credits',
+ })}
+ </StyledOnboardingFreeCreditsLabel>
+ </StyledOnboardingFreeCreditsText>
+ </>
+ );
+};
diff --git a/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingHeaderFreeCredits.tsx b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingHeaderFreeCredits.tsx
new file mode 100644
index 00000000000..7d00e944686
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingHeaderFreeCredits.tsx
@@ -0,0 +1,16 @@
+import { OnboardingFreeCreditsPill } from '@/onboarding/components/free-credits/OnboardingFreeCreditsPill';
+import { useOnboardingCreditsProgress } from '@/onboarding/hooks/useOnboardingCreditsProgress';
+import { isDefined } from 'twenty-shared/utils';
+
+export const OnboardingHeaderFreeCredits = () => {
+ const progress = useOnboardingCreditsProgress();
+
+ if (
+ !isDefined(progress) ||
+ (progress.goalCredits <= 0 && progress.currentStepCredits <= 0)
+ ) {
+ return null;
+ }
+
+ return <OnboardingFreeCreditsPill progress={progress} />;
+};
diff --git a/packages/twenty-front/src/modules/onboarding/components/free-credits/StyledOnboardingFreeCreditsCount.ts b/packages/twenty-front/src/modules/onboarding/components/free-credits/StyledOnboardingFreeCreditsCount.ts
new file mode 100644
index 00000000000..04b285aea6b
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/StyledOnboardingFreeCreditsCount.ts
@@ -0,0 +1,10 @@
+import { styled } from '@linaria/react';
+import { themeCssVariables } from 'twenty-ui/theme';
+
+export const StyledOnboardingFreeCreditsCount = styled.span`
+ align-items: baseline;
+ display: flex;
+ font-size: ${themeCssVariables.font.size.md};
+ font-variant-numeric: tabular-nums;
+ font-weight: ${themeCssVariables.font.weight.medium};
+`;
diff --git a/packages/twenty-front/src/modules/onboarding/components/free-credits/StyledOnboardingFreeCreditsLabel.ts b/packages/twenty-front/src/modules/onboarding/components/free-credits/StyledOnboardingFreeCreditsLabel.ts
new file mode 100644
index 00000000000..bb943024111
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/StyledOnboardingFreeCreditsLabel.ts
@@ -0,0 +1,6 @@
+import { styled } from '@linaria/react';
+import { themeCssVariables } from 'twenty-ui/theme';
+
+export const StyledOnboardingFreeCreditsLabel = styled.span`
+ font-size: ${themeCssVariables.font.size.sm};
+`;
diff --git a/packages/twenty-front/src/modules/onboarding/components/free-credits/StyledOnboardingFreeCreditsText.ts b/packages/twenty-front/src/modules/onboarding/components/free-credits/StyledOnboardingFreeCreditsText.ts
new file mode 100644
index 00000000000..ef414115b84
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/StyledOnboardingFreeCreditsText.ts
@@ -0,0 +1,9 @@
+import { styled } from '@linaria/react';
+import { themeCssVariables } from 'twenty-ui/theme';
+
+export const StyledOnboardingFreeCreditsText = styled.span`
+ align-items: baseline;
+ display: flex;
+ gap: ${themeCssVariables.spacing[1]};
+ white-space: nowrap;
+`;
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
new file mode 100644
index 00000000000..9a621ee24b7
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/__stories__/OnboardingHeaderFreeCredits.stories.tsx
@@ -0,0 +1,138 @@
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import { expect, 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 { OnboardingHeaderFreeCredits } from '@/onboarding/components/free-credits/OnboardingHeaderFreeCredits';
+import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
+import { onboardingFreeCreditsFamilyState } from '@/onboarding/states/onboardingFreeCreditsFamilyState';
+import { type OnboardingFreeCredits } from '@/onboarding/types/OnboardingFreeCredits';
+import { jotaiStore } from '@/ui/utilities/state/jotai/jotaiStore';
+import { OnboardingStatus } from '~/generated-metadata/graphql';
+import { WorkspaceDecorator } from '~/testing/decorators/WorkspaceDecorator';
+import {
+ mockCurrentWorkspace,
+ mockedUserData,
+} from '~/testing/mock-data/users';
+
+const seedOnboardingFreeCredits = ({
+ onboardingStatus,
+ onboardingFreeCredits = {},
+}: {
+ onboardingStatus: OnboardingStatus;
+ onboardingFreeCredits?: Partial<OnboardingFreeCredits>;
+}) => {
+ jotaiStore.set(onboardingConfigState.atom, {
+ importContactsCreditsReward: 1,
+ inviteTeamCreditsRewardPerUser: 0.5,
+ installAppsCreditsReward: 0.5,
+ createProfileCreditsReward: 0.5,
+ upgradeCreditsReward: 2,
+ inviteTeamMaxInvites: 10,
+ });
+ jotaiStore.set(currentUserState.atom, {
+ ...mockedUserData,
+ isWorkspaceCreator: true,
+ onboardingStatus,
+ });
+ jotaiStore.set(currentWorkspaceState.atom, mockCurrentWorkspace);
+ jotaiStore.set(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ {
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ ...onboardingFreeCredits,
+ },
+ );
+};
+
+const findVisibleTooltip = async (canvasElement: HTMLElement, text: string) => {
+ const tooltip = await within(canvasElement.ownerDocument.body).findByText(
+ text,
+ );
+
+ await waitFor(() => expect(tooltip).toBeVisible());
+};
+
+const meta: Meta<typeof OnboardingHeaderFreeCredits> = {
+ title: 'Modules/Onboarding/FreeCredits',
+ component: OnboardingHeaderFreeCredits,
+ decorators: [ComponentDecorator, WorkspaceDecorator],
+ parameters: {
+ container: { width: 360, height: 560 },
+ },
+};
+
+export default meta;
+type Story = StoryObj<typeof OnboardingHeaderFreeCredits>;
+
+export const FirstStep: Story = {
+ beforeEach: () => {
+ seedOnboardingFreeCredits({
+ onboardingStatus: OnboardingStatus.SYNC_EMAIL,
+ });
+ },
+ play: async ({ canvasElement }) => {
+ await expect(
+ await within(canvasElement).findByText('Earn 1'),
+ ).toBeVisible();
+ await findVisibleTooltip(
+ canvasElement,
+ 'Connect your mailbox to earn 1 free credit',
+ );
+ },
+};
+
+export const EarnedSoFar: Story = {
+ beforeEach: () => {
+ seedOnboardingFreeCredits({
+ onboardingStatus: OnboardingStatus.APPS_INSTALLATION,
+ onboardingFreeCredits: { importContacts: 1, seenCredits: 1 },
+ });
+ },
+ play: async ({ canvasElement }) => {
+ const freeCreditsLabel =
+ await within(canvasElement).findByText('free credit');
+
+ await waitFor(() =>
+ expect(freeCreditsLabel.parentElement).toHaveTextContent('1/1'),
+ );
+ await findVisibleTooltip(
+ canvasElement,
+ 'Start with apps and earn 0.5 free credits',
+ );
+ },
+};
+
+export const NewlyEarned: Story = {
+ beforeEach: () => {
+ seedOnboardingFreeCredits({
+ onboardingStatus: OnboardingStatus.PROFILE_CREATION,
+ });
+ },
+ play: async ({ canvasElement }) => {
+ const freeCreditsLabel =
+ await within(canvasElement).findByText('free credits');
+
+ await waitFor(() =>
+ expect(freeCreditsLabel.parentElement).toHaveTextContent('0/1.5'),
+ );
+
+ jotaiStore.set(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ (onboardingFreeCredits) => ({
+ ...onboardingFreeCredits,
+ importContacts: 1,
+ }),
+ );
+
+ await within(canvasElement).findByText('+1');
+ await waitFor(() =>
+ expect(freeCreditsLabel.parentElement).toHaveTextContent('1/1.5'),
+ );
+ await waitFor(() =>
+ expect(within(canvasElement).queryByText('+1')).not.toBeInTheDocument(),
+ );
+ },
+};
diff --git a/packages/twenty-front/src/modules/onboarding/constants/OnboardingCreditWorthPerCredit.ts b/packages/twenty-front/src/modules/onboarding/constants/OnboardingCreditWorthPerCredit.ts
new file mode 100644
index 00000000000..8496460a6d0
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/constants/OnboardingCreditWorthPerCredit.ts
@@ -0,0 +1,7 @@
+export const ONBOARDING_CREDIT_WORTH_PER_CREDIT = {
+ aiActions: 24,
+ workflowSteps: 10_000,
+ enrichments: 10,
+ callRecordingHours: 1,
+ emailsSent: 3_000,
+};
diff --git a/packages/twenty-front/src/modules/onboarding/constants/OnboardingCreditsSteps.ts b/packages/twenty-front/src/modules/onboarding/constants/OnboardingCreditsSteps.ts
new file mode 100644
index 00000000000..b57fe463122
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/constants/OnboardingCreditsSteps.ts
@@ -0,0 +1,7 @@
+export const ONBOARDING_CREDITS_STEPS = [
+ 'importContacts',
+ 'installApps',
+ 'createProfile',
+ 'inviteTeam',
+ 'upgradeTrial',
+] as const;
diff --git a/packages/twenty-front/src/modules/onboarding/constants/OnboardingFreeCreditsDefaultValue.ts b/packages/twenty-front/src/modules/onboarding/constants/OnboardingFreeCreditsDefaultValue.ts
new file mode 100644
index 00000000000..fdcaf547a4d
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/constants/OnboardingFreeCreditsDefaultValue.ts
@@ -0,0 +1,10 @@
+import { type OnboardingFreeCredits } from '@/onboarding/types/OnboardingFreeCredits';
+
+export const ONBOARDING_FREE_CREDITS_DEFAULT_VALUE: OnboardingFreeCredits = {
+ importContacts: 0,
+ installApps: 0,
+ createProfile: 0,
+ inviteTeam: 0,
+ upgradeTrial: 0,
+ seenCredits: 0,
+};
diff --git a/packages/twenty-front/src/modules/onboarding/constants/OnboardingNewlyEarnedCreditsDisplayDurationS.ts b/packages/twenty-front/src/modules/onboarding/constants/OnboardingNewlyEarnedCreditsDisplayDurationS.ts
new file mode 100644
index 00000000000..d59aa4f49c1
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/constants/OnboardingNewlyEarnedCreditsDisplayDurationS.ts
@@ -0,0 +1 @@
+export const ONBOARDING_NEWLY_EARNED_CREDITS_DISPLAY_DURATION_S = 2.4;
diff --git a/packages/twenty-front/src/modules/onboarding/constants/OnboardingStatusByCreditsStep.ts b/packages/twenty-front/src/modules/onboarding/constants/OnboardingStatusByCreditsStep.ts
new file mode 100644
index 00000000000..36914baadb3
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/constants/OnboardingStatusByCreditsStep.ts
@@ -0,0 +1,13 @@
+import { type OnboardingCreditsStep } from '@/onboarding/types/OnboardingCreditsStep';
+import { OnboardingStatus } from '~/generated-metadata/graphql';
+
+export const ONBOARDING_STATUS_BY_CREDITS_STEP: Record<
+ OnboardingCreditsStep,
+ OnboardingStatus
+> = {
+ importContacts: OnboardingStatus.SYNC_EMAIL,
+ installApps: OnboardingStatus.APPS_INSTALLATION,
+ createProfile: OnboardingStatus.PROFILE_CREATION,
+ inviteTeam: OnboardingStatus.INVITE_TEAM,
+ upgradeTrial: OnboardingStatus.PLAN_REQUIRED,
+};
diff --git a/packages/twenty-front/src/modules/onboarding/constants/OnboardingStatusOrder.ts b/packages/twenty-front/src/modules/onboarding/constants/OnboardingStatusOrder.ts
new file mode 100644
index 00000000000..657b26aaeab
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/constants/OnboardingStatusOrder.ts
@@ -0,0 +1,12 @@
+import { OnboardingStatus } from '~/generated-metadata/graphql';
+
+export const ONBOARDING_STATUS_ORDER = [
+ OnboardingStatus.WORKSPACE_ACTIVATION,
+ OnboardingStatus.SYNC_EMAIL,
+ OnboardingStatus.APPS_INSTALLATION,
+ OnboardingStatus.PROFILE_CREATION,
+ OnboardingStatus.INVITE_TEAM,
+ OnboardingStatus.BOOK_CALL,
+ OnboardingStatus.PLAN_REQUIRED,
+ OnboardingStatus.COMPLETED,
+];
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useInstallOnboardingApps.test.ts b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useInstallOnboardingApps.test.ts
index 7e8f1f0cd40..50af65d51c3 100644
--- a/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useInstallOnboardingApps.test.ts
+++ b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useInstallOnboardingApps.test.ts
@@ -2,16 +2,18 @@ import { act, renderHook } from '@testing-library/react';
import { Provider as JotaiProvider } from 'jotai';
import { createElement } from 'react';
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
import { type OnboardingConfig } from '@/client-config/types/OnboardingConfig';
import { useInstallOnboardingApps } from '@/onboarding/hooks/useInstallOnboardingApps';
-import { onboardingFreeCreditsState } from '@/onboarding/states/onboardingFreeCreditsState';
-import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
+import { onboardingFreeCreditsFamilyState } from '@/onboarding/states/onboardingFreeCreditsFamilyState';
+import { useAtomFamilyStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomFamilyStateValue';
import { useSetAtomState } from '@/ui/utilities/state/jotai/hooks/useSetAtomState';
import {
jotaiStore,
resetJotaiStore,
} from '@/ui/utilities/state/jotai/jotaiStore';
+import { mockCurrentWorkspace } from '~/testing/mock-data/users';
const mockTriggerInstallAppsOnboardingStep = jest.fn();
@@ -36,8 +38,9 @@ const renderInstallHook = () => {
const { result } = renderHook(
() => {
const setOnboardingConfig = useSetAtomState(onboardingConfigState);
- const onboardingFreeCredits = useAtomStateValue(
- onboardingFreeCreditsState,
+ const onboardingFreeCredits = useAtomFamilyStateValue(
+ onboardingFreeCreditsFamilyState,
+ mockCurrentWorkspace.id,
);
const installOnboardingApps = useInstallOnboardingApps();
@@ -61,6 +64,7 @@ describe('useInstallOnboardingApps', () => {
beforeEach(() => {
localStorage.clear();
resetJotaiStore();
+ jotaiStore.set(currentWorkspaceState.atom, mockCurrentWorkspace);
mockTriggerInstallAppsOnboardingStep.mockReset();
});
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useOnboardingNewlyEarnedCredits.test.ts b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useOnboardingNewlyEarnedCredits.test.ts
new file mode 100644
index 00000000000..27938399e8e
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useOnboardingNewlyEarnedCredits.test.ts
@@ -0,0 +1,62 @@
+import { act, renderHook } from '@testing-library/react';
+import { Provider as JotaiProvider } from 'jotai';
+import { createElement } from 'react';
+
+import { currentUserState } from '@/auth/states/currentUserState';
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
+import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
+import { useOnboardingNewlyEarnedCredits } from '@/onboarding/hooks/useOnboardingNewlyEarnedCredits';
+import { onboardingFreeCreditsFamilyState } from '@/onboarding/states/onboardingFreeCreditsFamilyState';
+import {
+ jotaiStore,
+ resetJotaiStore,
+} from '@/ui/utilities/state/jotai/jotaiStore';
+import { OnboardingStatus } from '~/generated-metadata/graphql';
+import {
+ mockCurrentWorkspace,
+ mockedUserData,
+} from '~/testing/mock-data/users';
+
+const Wrapper = ({ children }: { children: React.ReactNode }) =>
+ createElement(JotaiProvider, { store: jotaiStore }, children);
+
+const setOnboardingStatus = (onboardingStatus: OnboardingStatus) =>
+ jotaiStore.set(currentUserState.atom, {
+ ...mockedUserData,
+ isWorkspaceCreator: true,
+ onboardingStatus,
+ });
+
+describe('useOnboardingNewlyEarnedCredits', () => {
+ beforeEach(() => {
+ localStorage.clear();
+ resetJotaiStore();
+ jotaiStore.set(currentWorkspaceState.atom, mockCurrentWorkspace);
+ });
+
+ it('should hold the email reward back until the mailbox step is past', () => {
+ setOnboardingStatus(OnboardingStatus.SYNC_EMAIL);
+ jotaiStore.set(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ { ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE, importContacts: 2 },
+ );
+
+ const { result } = renderHook(() => useOnboardingNewlyEarnedCredits(), {
+ wrapper: Wrapper,
+ });
+
+ expect(result.current.newlyEarnedCredits).toBe(0);
+
+ act(() => {
+ result.current.markCreditsAsSeen();
+ });
+
+ expect(result.current.seenCredits).toBe(0);
+
+ act(() => {
+ setOnboardingStatus(OnboardingStatus.APPS_INSTALLATION);
+ });
+
+ expect(result.current.newlyEarnedCredits).toBe(2);
+ });
+});
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useSetOnboardingStepFreeCredits.test.ts b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useSetOnboardingStepFreeCredits.test.ts
new file mode 100644
index 00000000000..acf2a7b392d
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useSetOnboardingStepFreeCredits.test.ts
@@ -0,0 +1,202 @@
+import { act, renderHook } from '@testing-library/react';
+import { Provider as JotaiProvider } from 'jotai';
+import { createElement } from 'react';
+
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
+import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
+import { useSetOnboardingStepFreeCredits } from '@/onboarding/hooks/useSetOnboardingStepFreeCredits';
+import { onboardingFreeCreditsFamilyState } from '@/onboarding/states/onboardingFreeCreditsFamilyState';
+import { useAtomFamilyStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomFamilyStateValue';
+import {
+ jotaiStore,
+ resetJotaiStore,
+} from '@/ui/utilities/state/jotai/jotaiStore';
+import { mockCurrentWorkspace } from '~/testing/mock-data/users';
+
+const Wrapper = ({ children }: { children: React.ReactNode }) =>
+ createElement(JotaiProvider, { store: jotaiStore }, children);
+
+const renderSetStepFreeCreditsHook = () =>
+ renderHook(
+ () => ({
+ onboardingFreeCredits: useAtomFamilyStateValue(
+ onboardingFreeCreditsFamilyState,
+ mockCurrentWorkspace.id,
+ ),
+ setOnboardingStepFreeCredits: useSetOnboardingStepFreeCredits(),
+ }),
+ { wrapper: Wrapper },
+ ).result;
+
+describe('useSetOnboardingStepFreeCredits', () => {
+ beforeEach(() => {
+ localStorage.clear();
+ resetJotaiStore();
+ jotaiStore.set(currentWorkspaceState.atom, mockCurrentWorkspace);
+ });
+
+ it('should keep the seen credits when a step earns more', () => {
+ jotaiStore.set(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ {
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 2,
+ seenCredits: 2,
+ },
+ );
+
+ const result = renderSetStepFreeCreditsHook();
+
+ act(() => {
+ result.current.setOnboardingStepFreeCredits('installApps', 1);
+ });
+
+ expect(result.current.onboardingFreeCredits).toEqual({
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 2,
+ installApps: 1,
+ seenCredits: 2,
+ });
+ });
+
+ it('should count quiet credits as already seen', () => {
+ jotaiStore.set(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ {
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 2,
+ installApps: 1,
+ seenCredits: 2,
+ },
+ );
+
+ const result = renderSetStepFreeCreditsHook();
+
+ act(() => {
+ result.current.setOnboardingStepFreeCredits('upgradeTrial', 4, {
+ isQuiet: true,
+ });
+ });
+
+ expect(result.current.onboardingFreeCredits).toEqual({
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 2,
+ installApps: 1,
+ upgradeTrial: 4,
+ seenCredits: 6,
+ });
+ });
+
+ it('should keep unseen credits when a quiet reward is removed', () => {
+ jotaiStore.set(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ {
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 2,
+ seenCredits: 0,
+ },
+ );
+
+ const result = renderSetStepFreeCreditsHook();
+
+ act(() => {
+ result.current.setOnboardingStepFreeCredits('upgradeTrial', 0.5, {
+ isQuiet: true,
+ });
+ });
+
+ expect(result.current.onboardingFreeCredits).toEqual({
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 2,
+ upgradeTrial: 0.5,
+ seenCredits: 0.5,
+ });
+
+ act(() => {
+ result.current.setOnboardingStepFreeCredits('upgradeTrial', 0, {
+ isQuiet: true,
+ });
+ });
+
+ expect(result.current.onboardingFreeCredits).toEqual({
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 2,
+ seenCredits: 0,
+ });
+ });
+
+ it('should leave the credits of other workspaces untouched', () => {
+ const otherWorkspaceFreeCredits = {
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 2,
+ seenCredits: 2,
+ };
+
+ jotaiStore.set(
+ onboardingFreeCreditsFamilyState.atomFamily('other-workspace-id'),
+ otherWorkspaceFreeCredits,
+ );
+
+ const result = renderSetStepFreeCreditsHook();
+
+ act(() => {
+ result.current.setOnboardingStepFreeCredits('installApps', 1);
+ });
+
+ expect(result.current.onboardingFreeCredits).toEqual({
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ installApps: 1,
+ });
+ expect(
+ jotaiStore.get(
+ onboardingFreeCreditsFamilyState.atomFamily('other-workspace-id'),
+ ),
+ ).toEqual(otherWorkspaceFreeCredits);
+ });
+
+ it('should not write any credits while the current workspace is not loaded', () => {
+ jotaiStore.set(currentWorkspaceState.atom, null);
+
+ const result = renderSetStepFreeCreditsHook();
+
+ act(() => {
+ result.current.setOnboardingStepFreeCredits('installApps', 1);
+ });
+
+ expect(
+ jotaiStore.get(onboardingFreeCreditsFamilyState.atomFamily('')),
+ ).toEqual(ONBOARDING_FREE_CREDITS_DEFAULT_VALUE);
+
+ act(() => {
+ jotaiStore.set(currentWorkspaceState.atom, mockCurrentWorkspace);
+ });
+
+ expect(result.current.onboardingFreeCredits).toEqual(
+ ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ );
+ });
+
+ it('should lower the seen credits when a step loses its reward', () => {
+ jotaiStore.set(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ {
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 2,
+ installApps: 1,
+ seenCredits: 3,
+ },
+ );
+
+ const result = renderSetStepFreeCreditsHook();
+
+ act(() => {
+ result.current.setOnboardingStepFreeCredits('installApps', 0);
+ });
+
+ expect(result.current.onboardingFreeCredits).toEqual({
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 2,
+ seenCredits: 2,
+ });
+ });
+});
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useInstallOnboardingApps.ts b/packages/twenty-front/src/modules/onboarding/hooks/useInstallOnboardingApps.ts
index 507bfd4e36d..363900f7dca 100644
--- a/packages/twenty-front/src/modules/onboarding/hooks/useInstallOnboardingApps.ts
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useInstallOnboardingApps.ts
@@ -1,14 +1,13 @@
import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
+import { useSetOnboardingStepFreeCredits } from '@/onboarding/hooks/useSetOnboardingStepFreeCredits';
import { useTriggerInstallAppsOnboardingStep } from '@/onboarding/hooks/useTriggerInstallAppsOnboardingStep';
-import { onboardingFreeCreditsState } from '@/onboarding/states/onboardingFreeCreditsState';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
-import { useSetAtomState } from '@/ui/utilities/state/jotai/hooks/useSetAtomState';
import { useState } from 'react';
import { isNonEmptyArray } from 'twenty-shared/utils';
export const useInstallOnboardingApps = () => {
const onboardingConfig = useAtomStateValue(onboardingConfigState);
- const setOnboardingFreeCredits = useSetAtomState(onboardingFreeCreditsState);
+ const setOnboardingStepFreeCredits = useSetOnboardingStepFreeCredits();
const triggerInstallAppsOnboardingStep =
useTriggerInstallAppsOnboardingStep();
@@ -38,10 +37,10 @@ export const useInstallOnboardingApps = () => {
const creditsReward = onboardingConfig?.installAppsCreditsReward ?? 0;
- setOnboardingFreeCredits((current) => ({
- ...current,
- installApps: isNonEmptyArray(universalIdentifiers) ? creditsReward : 0,
- }));
+ setOnboardingStepFreeCredits(
+ 'installApps',
+ isNonEmptyArray(universalIdentifiers) ? creditsReward : 0,
+ );
} catch {
setIsCompleting(false);
}
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useInviteTeam.ts b/packages/twenty-front/src/modules/onboarding/hooks/useInviteTeam.ts
index 11984918c09..5b4dafd9fc3 100644
--- a/packages/twenty-front/src/modules/onboarding/hooks/useInviteTeam.ts
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useInviteTeam.ts
@@ -2,12 +2,11 @@ import { isBookCallOnboardingStepEnabledState } from '@/client-config/states/isB
import { isCompanyEnrichmentEnabledState } from '@/client-config/states/isCompanyEnrichmentEnabledState';
import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
import { useSetNextOnboardingStatus } from '@/onboarding/hooks/useSetNextOnboardingStatus';
-import { onboardingFreeCreditsState } from '@/onboarding/states/onboardingFreeCreditsState';
+import { useSetOnboardingStepFreeCredits } from '@/onboarding/hooks/useSetOnboardingStepFreeCredits';
import { waitForCompanyEnrichmentSettlement } from '@/onboarding/utils/waitForCompanyEnrichmentSettlement';
import { PageFocusId } from '@/types/PageFocusId';
import { useHotkeysOnFocusedElement } from '@/ui/utilities/hotkey/hooks/useHotkeysOnFocusedElement';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
-import { useSetAtomState } from '@/ui/utilities/state/jotai/hooks/useSetAtomState';
import { useCreateWorkspaceInvitation } from '@/workspace-invitation/hooks/useCreateWorkspaceInvitation';
import { useQuery } from '@apollo/client/react';
import { zodResolver } from '@hookform/resolvers/zod';
@@ -32,7 +31,7 @@ export const useInviteTeam = () => {
const { enqueueToast } = useToast();
const { sendInvitation } = useCreateWorkspaceInvitation();
const setNextOnboardingStatus = useSetNextOnboardingStatus();
- const setOnboardingFreeCredits = useSetAtomState(onboardingFreeCreditsState);
+ const setOnboardingStepFreeCredits = useSetOnboardingStepFreeCredits();
const onboardingConfig = useAtomStateValue(onboardingConfigState);
const isBookCallOnboardingStepEnabled = useAtomStateValue(
isBookCallOnboardingStepEnabledState,
@@ -165,12 +164,11 @@ export const useInviteTeam = () => {
const maxRewardedInvitationsCount =
onboardingConfig?.inviteTeamMaxInvites ?? 0;
- setOnboardingFreeCredits((current) => ({
- ...current,
- inviteTeam:
- Math.min(sentInvitationsCount, maxRewardedInvitationsCount) *
+ setOnboardingStepFreeCredits(
+ 'inviteTeam',
+ Math.min(sentInvitationsCount, maxRewardedInvitationsCount) *
creditsRewardPerUser,
- }));
+ );
if (emails.length > 0) {
enqueueToast({
@@ -202,7 +200,7 @@ export const useInviteTeam = () => {
onboardingConfig?.inviteTeamMaxInvites,
sendInvitation,
setNextOnboardingStatus,
- setOnboardingFreeCredits,
+ setOnboardingStepFreeCredits,
store,
t,
],
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingCreditsProgress.ts b/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingCreditsProgress.ts
new file mode 100644
index 00000000000..d51c34259b3
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingCreditsProgress.ts
@@ -0,0 +1,28 @@
+import { currentUserState } from '@/auth/states/currentUserState';
+import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
+import { useIsPlanRequired } from '@/onboarding/hooks/useIsPlanRequired';
+import { currentWorkspaceOnboardingFreeCreditsSelector } from '@/onboarding/states/selectors/currentWorkspaceOnboardingFreeCreditsSelector';
+import { getOnboardingCreditsProgress } from '@/onboarding/utils/getOnboardingCreditsProgress';
+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
+import { isDefined } from 'twenty-shared/utils';
+
+export const useOnboardingCreditsProgress = () => {
+ const onboardingConfig = useAtomStateValue(onboardingConfigState);
+ const currentWorkspaceOnboardingFreeCredits = useAtomStateValue(
+ currentWorkspaceOnboardingFreeCreditsSelector,
+ );
+ const currentUser = useAtomStateValue(currentUserState);
+ const isPlanRequired = useIsPlanRequired();
+
+ if (!isDefined(onboardingConfig)) {
+ return null;
+ }
+
+ return getOnboardingCreditsProgress({
+ onboardingFreeCredits: currentWorkspaceOnboardingFreeCredits,
+ onboardingConfig,
+ onboardingStatus: currentUser?.onboardingStatus,
+ isWorkspaceCreator: currentUser?.isWorkspaceCreator ?? false,
+ isPlanRequired,
+ });
+};
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingFreeCreditsTooltipContent.ts b/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingFreeCreditsTooltipContent.ts
new file mode 100644
index 00000000000..a64194d9848
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingFreeCreditsTooltipContent.ts
@@ -0,0 +1,125 @@
+import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
+import { useNumberFormat } from '@/localization/hooks/useNumberFormat';
+import { type OnboardingCreditsStep } from '@/onboarding/types/OnboardingCreditsStep';
+import { type OnboardingFreeCreditsTooltipContent } from '@/onboarding/types/OnboardingFreeCreditsTooltipContent';
+import { formatOnboardingCredits } from '@/onboarding/utils/formatOnboardingCredits';
+import { getOnboardingCreditWorth } from '@/onboarding/utils/getOnboardingCreditWorth';
+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
+import { plural } from '@lingui/core/macro';
+import { useLingui } from '@lingui/react/macro';
+import { isDefined } from 'twenty-shared/utils';
+
+type UseOnboardingFreeCreditsTooltipContentArgs = {
+ currentStep: OnboardingCreditsStep | null;
+ newlyEarnedCredits: number;
+ isFirstCreditsGain: boolean;
+};
+
+export const useOnboardingFreeCreditsTooltipContent = ({
+ currentStep,
+ newlyEarnedCredits,
+ isFirstCreditsGain,
+}: UseOnboardingFreeCreditsTooltipContentArgs): OnboardingFreeCreditsTooltipContent | null => {
+ const { t } = useLingui();
+ const { formatNumber, numberFormat } = useNumberFormat();
+ const onboardingConfig = useAtomStateValue(onboardingConfigState);
+
+ if (!isDefined(onboardingConfig)) {
+ return null;
+ }
+
+ const {
+ aiActions: importContactsAiActions,
+ enrichments: importContactsEnrichments,
+ callRecordingHours: importContactsCallRecordingHours,
+ } = getOnboardingCreditWorth(onboardingConfig.importContactsCreditsReward);
+ const formattedImportContactsAiActions = formatNumber(
+ importContactsAiActions,
+ );
+ const formattedImportContactsEnrichments = formatNumber(
+ importContactsEnrichments,
+ );
+ const formattedImportContactsCallRecordingHours = formatNumber(
+ importContactsCallRecordingHours,
+ { decimals: 1 },
+ );
+ const formattedNewlyEarnedAiActions = formatNumber(
+ getOnboardingCreditWorth(newlyEarnedCredits).aiActions,
+ );
+ const formattedImportContactsCreditsReward = formatOnboardingCredits(
+ onboardingConfig.importContactsCreditsReward,
+ numberFormat,
+ );
+ const formattedInstallAppsCreditsReward = formatOnboardingCredits(
+ onboardingConfig.installAppsCreditsReward,
+ numberFormat,
+ );
+ const formattedInviteTeamCreditsRewardPerUser = formatOnboardingCredits(
+ onboardingConfig.inviteTeamCreditsRewardPerUser,
+ numberFormat,
+ );
+ const formattedUpgradeCreditsReward = formatOnboardingCredits(
+ onboardingConfig.upgradeCreditsReward,
+ numberFormat,
+ );
+ const formattedNewlyEarnedCredits = formatOnboardingCredits(
+ newlyEarnedCredits,
+ numberFormat,
+ );
+
+ const helperByStep: Record<
+ OnboardingCreditsStep,
+ OnboardingFreeCreditsTooltipContent | null
+ > = {
+ importContacts: {
+ title: plural(onboardingConfig.importContactsCreditsReward, {
+ one: `Connect your mailbox to earn ${formattedImportContactsCreditsReward} free credit`,
+ other: `Connect your mailbox to earn ${formattedImportContactsCreditsReward} free credits`,
+ }),
+ description: plural(importContactsCallRecordingHours, {
+ one: `${formattedImportContactsAiActions} AI actions, ${formattedImportContactsEnrichments} enrichments or ${formattedImportContactsCallRecordingHours} hour of call recording.`,
+ other: `${formattedImportContactsAiActions} AI actions, ${formattedImportContactsEnrichments} enrichments or ${formattedImportContactsCallRecordingHours} hours of call recording.`,
+ }),
+ },
+ installApps: {
+ title: plural(onboardingConfig.installAppsCreditsReward, {
+ one: `Start with apps and earn ${formattedInstallAppsCreditsReward} free credit`,
+ other: `Start with apps and earn ${formattedInstallAppsCreditsReward} free credits`,
+ }),
+ description: t`Apps like enrichment and call recording run on credits.`,
+ },
+ createProfile: null,
+ inviteTeam: {
+ title: plural(onboardingConfig.inviteTeamCreditsRewardPerUser, {
+ one: `Earn ${formattedInviteTeamCreditsRewardPerUser} free credit per teammate who joins`,
+ other: `Earn ${formattedInviteTeamCreditsRewardPerUser} free credits per teammate who joins`,
+ }),
+ description: t`Credits are added when they accept your invite.`,
+ },
+ upgradeTrial: {
+ title: plural(onboardingConfig.upgradeCreditsReward, {
+ one: `Upgrade your trial to earn ${formattedUpgradeCreditsReward} free credit`,
+ other: `Upgrade your trial to earn ${formattedUpgradeCreditsReward} free credits`,
+ }),
+ description: t`Credits are added when your trial starts.`,
+ },
+ };
+
+ const currentStepHelper = isDefined(currentStep)
+ ? helperByStep[currentStep]
+ : null;
+
+ if (isDefined(currentStepHelper)) {
+ return currentStepHelper;
+ }
+
+ return newlyEarnedCredits > 0 && isFirstCreditsGain
+ ? {
+ title: plural(newlyEarnedCredits, {
+ one: `You earned ${formattedNewlyEarnedCredits} free credit`,
+ other: `You earned ${formattedNewlyEarnedCredits} free credits`,
+ }),
+ description: t`That's about ${formattedNewlyEarnedAiActions} AI actions. Credits never expire.`,
+ }
+ : null;
+};
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingFreeCreditsTotal.ts b/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingFreeCreditsTotal.ts
deleted file mode 100644
index 5bb7f257e14..00000000000
--- a/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingFreeCreditsTotal.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-import { onboardingFreeCreditsState } from '@/onboarding/states/onboardingFreeCreditsState';
-import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
-
-export const useOnboardingFreeCreditsTotal = () => {
- const onboardingFreeCredits = useAtomStateValue(onboardingFreeCreditsState);
-
- return (
- onboardingFreeCredits.importContacts +
- onboardingFreeCredits.inviteTeam +
- onboardingFreeCredits.installApps
- );
-};
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingNewlyEarnedCredits.ts b/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingNewlyEarnedCredits.ts
new file mode 100644
index 00000000000..cea30387e96
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingNewlyEarnedCredits.ts
@@ -0,0 +1,42 @@
+import { currentUserState } from '@/auth/states/currentUserState';
+import { useSetCurrentWorkspaceOnboardingFreeCredits } from '@/onboarding/hooks/useSetCurrentWorkspaceOnboardingFreeCredits';
+import { currentWorkspaceOnboardingFreeCreditsSelector } from '@/onboarding/states/selectors/currentWorkspaceOnboardingFreeCreditsSelector';
+import { getOnboardingCountedFreeCredits } from '@/onboarding/utils/getOnboardingCountedFreeCredits';
+import { getOnboardingEarnedCredits } from '@/onboarding/utils/getOnboardingEarnedCredits';
+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
+
+export const useOnboardingNewlyEarnedCredits = () => {
+ const currentWorkspaceOnboardingFreeCredits = useAtomStateValue(
+ currentWorkspaceOnboardingFreeCreditsSelector,
+ );
+ const currentUser = useAtomStateValue(currentUserState);
+ const setOnboardingFreeCredits =
+ useSetCurrentWorkspaceOnboardingFreeCredits();
+
+ const onboardingStatus = currentUser?.onboardingStatus;
+ const { seenCredits } = currentWorkspaceOnboardingFreeCredits;
+
+ const markCreditsAsSeen = () =>
+ setOnboardingFreeCredits((current) => ({
+ ...current,
+ seenCredits: getOnboardingEarnedCredits(
+ getOnboardingCountedFreeCredits({
+ onboardingFreeCredits: current,
+ onboardingStatus,
+ }),
+ ),
+ }));
+
+ return {
+ seenCredits,
+ newlyEarnedCredits:
+ getOnboardingEarnedCredits(
+ getOnboardingCountedFreeCredits({
+ onboardingFreeCredits: currentWorkspaceOnboardingFreeCredits,
+ onboardingStatus,
+ }),
+ ) - seenCredits,
+ isFirstCreditsGain: seenCredits === 0,
+ markCreditsAsSeen,
+ };
+};
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useSetCurrentWorkspaceOnboardingFreeCredits.ts b/packages/twenty-front/src/modules/onboarding/hooks/useSetCurrentWorkspaceOnboardingFreeCredits.ts
new file mode 100644
index 00000000000..90286f51912
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useSetCurrentWorkspaceOnboardingFreeCredits.ts
@@ -0,0 +1,38 @@
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
+import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
+import { onboardingFreeCreditsFamilyState } from '@/onboarding/states/onboardingFreeCreditsFamilyState';
+import { type OnboardingFreeCredits } from '@/onboarding/types/OnboardingFreeCredits';
+import { isFunction } from '@sniptt/guards';
+import { useStore } from 'jotai';
+import { useCallback } from 'react';
+import { isDefined } from 'twenty-shared/utils';
+
+export const useSetCurrentWorkspaceOnboardingFreeCredits = () => {
+ const store = useStore();
+
+ return useCallback(
+ (
+ onboardingFreeCredits:
+ | OnboardingFreeCredits
+ | ((current: OnboardingFreeCredits) => OnboardingFreeCredits),
+ ) => {
+ const currentWorkspace = store.get(currentWorkspaceState.atom);
+
+ if (!isDefined(currentWorkspace)) {
+ return;
+ }
+
+ store.set(
+ onboardingFreeCreditsFamilyState.atomFamily(currentWorkspace.id),
+ (current) =>
+ isFunction(onboardingFreeCredits)
+ ? onboardingFreeCredits({
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ ...current,
+ })
+ : onboardingFreeCredits,
+ );
+ },
+ [store],
+ );
+};
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useSetOnboardingStepFreeCredits.ts b/packages/twenty-front/src/modules/onboarding/hooks/useSetOnboardingStepFreeCredits.ts
new file mode 100644
index 00000000000..2fe2e2efc24
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useSetOnboardingStepFreeCredits.ts
@@ -0,0 +1,34 @@
+import { useSetCurrentWorkspaceOnboardingFreeCredits } from '@/onboarding/hooks/useSetCurrentWorkspaceOnboardingFreeCredits';
+import { type OnboardingCreditsStep } from '@/onboarding/types/OnboardingCreditsStep';
+import { getOnboardingEarnedCredits } from '@/onboarding/utils/getOnboardingEarnedCredits';
+import { useCallback } from 'react';
+
+type SetOnboardingStepFreeCreditsOptions = {
+ isQuiet?: boolean;
+};
+
+export const useSetOnboardingStepFreeCredits = () => {
+ const setOnboardingFreeCredits =
+ useSetCurrentWorkspaceOnboardingFreeCredits();
+
+ return useCallback(
+ (
+ step: OnboardingCreditsStep,
+ credits: number,
+ { isQuiet = false }: SetOnboardingStepFreeCreditsOptions = {},
+ ) =>
+ setOnboardingFreeCredits((current) => {
+ const onboardingFreeCredits = { ...current, [step]: credits };
+ const quietCreditsChange = isQuiet ? credits - current[step] : 0;
+
+ return {
+ ...onboardingFreeCredits,
+ seenCredits: Math.min(
+ Math.max(0, current.seenCredits + quietCreditsChange),
+ getOnboardingEarnedCredits(onboardingFreeCredits),
+ ),
+ };
+ }),
+ [setOnboardingFreeCredits],
+ );
+};
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useSetOnboardingUpgradeTrialFreeCredits.ts b/packages/twenty-front/src/modules/onboarding/hooks/useSetOnboardingUpgradeTrialFreeCredits.ts
new file mode 100644
index 00000000000..1ca07054180
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useSetOnboardingUpgradeTrialFreeCredits.ts
@@ -0,0 +1,15 @@
+import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
+import { useSetOnboardingStepFreeCredits } from '@/onboarding/hooks/useSetOnboardingStepFreeCredits';
+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
+
+export const useSetOnboardingUpgradeTrialFreeCredits = () => {
+ const onboardingConfig = useAtomStateValue(onboardingConfigState);
+ const setOnboardingStepFreeCredits = useSetOnboardingStepFreeCredits();
+
+ return (isTrialUpgraded: boolean) =>
+ setOnboardingStepFreeCredits(
+ 'upgradeTrial',
+ isTrialUpgraded ? (onboardingConfig?.upgradeCreditsReward ?? 0) : 0,
+ { isQuiet: true },
+ );
+};
diff --git a/packages/twenty-front/src/modules/onboarding/states/onboardingFreeCreditsFamilyState.ts b/packages/twenty-front/src/modules/onboarding/states/onboardingFreeCreditsFamilyState.ts
new file mode 100644
index 00000000000..d10af735885
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/states/onboardingFreeCreditsFamilyState.ts
@@ -0,0 +1,13 @@
+import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
+import { type OnboardingFreeCredits } from '@/onboarding/types/OnboardingFreeCredits';
+import { createAtomFamilyState } from '@/ui/utilities/state/jotai/utils/createAtomFamilyState';
+
+export const onboardingFreeCreditsFamilyState = createAtomFamilyState<
+ OnboardingFreeCredits,
+ string
+>({
+ key: 'onboardingFreeCreditsFamilyState',
+ defaultValue: ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ useLocalStorage: true,
+ localStorageOptions: { getOnInit: true },
+});
diff --git a/packages/twenty-front/src/modules/onboarding/states/onboardingFreeCreditsState.ts b/packages/twenty-front/src/modules/onboarding/states/onboardingFreeCreditsState.ts
deleted file mode 100644
index 9b5eb8a4e7c..00000000000
--- a/packages/twenty-front/src/modules/onboarding/states/onboardingFreeCreditsState.ts
+++ /dev/null
@@ -1,14 +0,0 @@
-import { type OnboardingFreeCredits } from '@/onboarding/types/OnboardingFreeCredits';
-import { createAtomState } from '@/ui/utilities/state/jotai/utils/createAtomState';
-
-export const onboardingFreeCreditsState =
- createAtomState<OnboardingFreeCredits>({
- key: 'onboardingFreeCreditsState',
- defaultValue: { importContacts: 0, inviteTeam: 0, installApps: 0 },
- useLocalStorage: true,
- localStorageOptions: { getOnInit: true },
- validateInitFn: (payload) =>
- Number.isFinite(payload.importContacts) &&
- Number.isFinite(payload.inviteTeam) &&
- Number.isFinite(payload.installApps),
- });
diff --git a/packages/twenty-front/src/modules/onboarding/states/selectors/__tests__/currentWorkspaceOnboardingFreeCreditsSelector.test.ts b/packages/twenty-front/src/modules/onboarding/states/selectors/__tests__/currentWorkspaceOnboardingFreeCreditsSelector.test.ts
new file mode 100644
index 00000000000..3b43ce921dc
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/states/selectors/__tests__/currentWorkspaceOnboardingFreeCreditsSelector.test.ts
@@ -0,0 +1,67 @@
+import { createStore } from 'jotai';
+
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
+import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
+import { onboardingFreeCreditsFamilyState } from '@/onboarding/states/onboardingFreeCreditsFamilyState';
+import { currentWorkspaceOnboardingFreeCreditsSelector } from '@/onboarding/states/selectors/currentWorkspaceOnboardingFreeCreditsSelector';
+import { mockCurrentWorkspace } from '~/testing/mock-data/users';
+
+const EARNED_ONBOARDING_FREE_CREDITS = {
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 2,
+ seenCredits: 2,
+};
+
+describe('currentWorkspaceOnboardingFreeCreditsSelector', () => {
+ afterEach(() => {
+ localStorage.clear();
+ });
+
+ it('should read the credits of the current workspace', () => {
+ const store = createStore();
+
+ store.set(currentWorkspaceState.atom, mockCurrentWorkspace);
+ store.set(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ EARNED_ONBOARDING_FREE_CREDITS,
+ );
+
+ expect(
+ store.get(currentWorkspaceOnboardingFreeCreditsSelector.atom),
+ ).toEqual(EARNED_ONBOARDING_FREE_CREDITS);
+ });
+
+ it('should fill fields missing from a stored counter with their defaults', () => {
+ const workspace = {
+ ...mockCurrentWorkspace,
+ id: 'workspace-with-partial-credits',
+ };
+
+ localStorage.setItem(
+ `onboardingFreeCreditsFamilyState__${workspace.id}`,
+ JSON.stringify({ importContacts: 2 }),
+ );
+
+ const store = createStore();
+
+ store.set(currentWorkspaceState.atom, workspace);
+
+ expect(
+ store.get(currentWorkspaceOnboardingFreeCreditsSelector.atom),
+ ).toEqual({ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE, importContacts: 2 });
+ });
+
+ it('should read the default credits while the current workspace is not loaded', () => {
+ const store = createStore();
+
+ store.set(currentWorkspaceState.atom, null);
+ store.set(
+ onboardingFreeCreditsFamilyState.atomFamily(''),
+ EARNED_ONBOARDING_FREE_CREDITS,
+ );
+
+ expect(
+ store.get(currentWorkspaceOnboardingFreeCreditsSelector.atom),
+ ).toEqual(ONBOARDING_FREE_CREDITS_DEFAULT_VALUE);
+ });
+});
diff --git a/packages/twenty-front/src/modules/onboarding/states/selectors/currentWorkspaceOnboardingFreeCreditsSelector.ts b/packages/twenty-front/src/modules/onboarding/states/selectors/currentWorkspaceOnboardingFreeCreditsSelector.ts
new file mode 100644
index 00000000000..34de672c5e5
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/states/selectors/currentWorkspaceOnboardingFreeCreditsSelector.ts
@@ -0,0 +1,23 @@
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
+import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
+import { onboardingFreeCreditsFamilyState } from '@/onboarding/states/onboardingFreeCreditsFamilyState';
+import { type OnboardingFreeCredits } from '@/onboarding/types/OnboardingFreeCredits';
+import { createAtomSelector } from '@/ui/utilities/state/jotai/utils/createAtomSelector';
+import { isDefined } from 'twenty-shared/utils';
+
+export const currentWorkspaceOnboardingFreeCreditsSelector =
+ createAtomSelector<OnboardingFreeCredits>({
+ key: 'currentWorkspaceOnboardingFreeCreditsSelector',
+ get: ({ get }) => {
+ const currentWorkspace = get(currentWorkspaceState);
+
+ if (!isDefined(currentWorkspace)) {
+ return ONBOARDING_FREE_CREDITS_DEFAULT_VALUE;
+ }
+
+ return {
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ ...get(onboardingFreeCreditsFamilyState, currentWorkspace.id),
+ };
+ },
+ });
diff --git a/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsProgress.ts b/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsProgress.ts
new file mode 100644
index 00000000000..c8a631da826
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsProgress.ts
@@ -0,0 +1,8 @@
+import { type OnboardingCreditsStep } from '@/onboarding/types/OnboardingCreditsStep';
+
+export type OnboardingCreditsProgress = {
+ earnedCredits: number;
+ goalCredits: number;
+ currentStep: OnboardingCreditsStep | null;
+ currentStepCredits: number;
+};
diff --git a/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsStep.ts b/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsStep.ts
new file mode 100644
index 00000000000..e311fa6b557
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsStep.ts
@@ -0,0 +1,3 @@
+import { type ONBOARDING_CREDITS_STEPS } from '@/onboarding/constants/OnboardingCreditsSteps';
+
+export type OnboardingCreditsStep = (typeof ONBOARDING_CREDITS_STEPS)[number];
diff --git a/packages/twenty-front/src/modules/onboarding/types/OnboardingFreeCredits.ts b/packages/twenty-front/src/modules/onboarding/types/OnboardingFreeCredits.ts
index ebee5c331e9..d250e77748f 100644
--- a/packages/twenty-front/src/modules/onboarding/types/OnboardingFreeCredits.ts
+++ b/packages/twenty-front/src/modules/onboarding/types/OnboardingFreeCredits.ts
@@ -1,5 +1,5 @@
-export type OnboardingFreeCredits = {
- importContacts: number;
- inviteTeam: number;
- installApps: number;
+import { type OnboardingCreditsStep } from '@/onboarding/types/OnboardingCreditsStep';
+
+export type OnboardingFreeCredits = Record<OnboardingCreditsStep, number> & {
+ seenCredits: number;
};
diff --git a/packages/twenty-front/src/modules/onboarding/types/OnboardingFreeCreditsTooltipContent.ts b/packages/twenty-front/src/modules/onboarding/types/OnboardingFreeCreditsTooltipContent.ts
new file mode 100644
index 00000000000..8717b194e3d
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/types/OnboardingFreeCreditsTooltipContent.ts
@@ -0,0 +1,4 @@
+export type OnboardingFreeCreditsTooltipContent = {
+ title: string;
+ description: string;
+};
diff --git a/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditWorth.test.ts b/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditWorth.test.ts
new file mode 100644
index 00000000000..aaa44036bb1
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditWorth.test.ts
@@ -0,0 +1,33 @@
+import { getOnboardingCreditWorth } from '@/onboarding/utils/getOnboardingCreditWorth';
+
+describe('getOnboardingCreditWorth', () => {
+ it('should convert one credit into what it pays for on average', () => {
+ expect(getOnboardingCreditWorth(1)).toEqual({
+ aiActions: 24,
+ workflowSteps: 10_000,
+ enrichments: 10,
+ callRecordingHours: 1,
+ emailsSent: 3_000,
+ });
+ });
+
+ it('should round down partial actions and keep one decimal of call recording', () => {
+ expect(getOnboardingCreditWorth(0.33)).toEqual({
+ aiActions: 7,
+ workflowSteps: 3_300,
+ enrichments: 3,
+ callRecordingHours: 0.3,
+ emailsSent: 990,
+ });
+ });
+
+ it('should be worth nothing without credits', () => {
+ expect(getOnboardingCreditWorth(0)).toEqual({
+ aiActions: 0,
+ workflowSteps: 0,
+ enrichments: 0,
+ callRecordingHours: 0,
+ emailsSent: 0,
+ });
+ });
+});
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
new file mode 100644
index 00000000000..a94b8ba86bb
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditsProgress.test.ts
@@ -0,0 +1,213 @@
+import { type OnboardingConfig } from '@/client-config/types/OnboardingConfig';
+import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
+import { type OnboardingFreeCredits } from '@/onboarding/types/OnboardingFreeCredits';
+import { getOnboardingCreditsProgress } from '@/onboarding/utils/getOnboardingCreditsProgress';
+import { OnboardingStatus } from '~/generated-metadata/graphql';
+
+const onboardingConfig: OnboardingConfig = {
+ importContactsCreditsReward: 2,
+ inviteTeamCreditsRewardPerUser: 0.5,
+ installAppsCreditsReward: 1,
+ createProfileCreditsReward: 0.5,
+ upgradeCreditsReward: 0.5,
+ inviteTeamMaxInvites: 4,
+};
+
+const buildOnboardingFreeCredits = (
+ onboardingFreeCredits: Partial<OnboardingFreeCredits> = {},
+): OnboardingFreeCredits => ({
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ ...onboardingFreeCredits,
+});
+
+describe('getOnboardingCreditsProgress', () => {
+ it('should offer the email reward on the first step', () => {
+ expect(
+ getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits(),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.SYNC_EMAIL,
+ isWorkspaceCreator: true,
+ isPlanRequired: true,
+ }),
+ ).toEqual({
+ earnedCredits: 0,
+ goalCredits: 0,
+ currentStep: 'importContacts',
+ currentStepCredits: 2,
+ });
+ });
+
+ it('should sum the counter fields as earned credits', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({
+ importContacts: 2,
+ installApps: 1,
+ createProfile: 0.5,
+ inviteTeam: 1,
+ upgradeTrial: 0.5,
+ seenCredits: 3,
+ }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.COMPLETED,
+ isWorkspaceCreator: true,
+ isPlanRequired: true,
+ });
+
+ expect(progress.earnedCredits).toBe(5);
+ });
+
+ it('should leave the step at hand out of the goal until it is done', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({ importContacts: 2 }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.APPS_INSTALLATION,
+ isWorkspaceCreator: true,
+ isPlanRequired: false,
+ });
+
+ expect(progress.earnedCredits).toBe(2);
+ expect(progress.goalCredits).toBe(2);
+ expect(progress.currentStep).toBe('installApps');
+ expect(progress.currentStepCredits).toBe(1);
+ });
+
+ it('should not count the email reward while the mailbox step is at hand', () => {
+ expect(
+ getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({
+ importContacts: 2,
+ }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.SYNC_EMAIL,
+ isWorkspaceCreator: true,
+ isPlanRequired: true,
+ }),
+ ).toEqual({
+ earnedCredits: 0,
+ goalCredits: 0,
+ currentStep: 'importContacts',
+ currentStepCredits: 2,
+ });
+ });
+
+ it('should keep skipped steps in the goal on the profile step', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits(),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.PROFILE_CREATION,
+ isWorkspaceCreator: true,
+ isPlanRequired: false,
+ });
+
+ expect(progress.earnedCredits).toBe(0);
+ expect(progress.goalCredits).toBe(3);
+ expect(progress.currentStep).toBe('createProfile');
+ });
+
+ it('should count the profile reward once the profile is created', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({ createProfile: 0.5 }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.INVITE_TEAM,
+ isWorkspaceCreator: true,
+ isPlanRequired: false,
+ });
+
+ expect(progress.earnedCredits).toBe(0.5);
+ expect(progress.goalCredits).toBe(3.5);
+ expect(progress.currentStep).toBe('inviteTeam');
+ expect(progress.currentStepCredits).toBe(2);
+ });
+
+ it('should only count the sent invites in the goal', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({
+ importContacts: 2,
+ createProfile: 0.5,
+ inviteTeam: 1,
+ }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.BOOK_CALL,
+ isWorkspaceCreator: true,
+ isPlanRequired: true,
+ });
+
+ expect(progress.earnedCredits).toBe(3.5);
+ expect(progress.goalCredits).toBe(4.5);
+ });
+
+ it('should point at the upgrade reward on the plan step', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({ importContacts: 2 }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.PLAN_REQUIRED,
+ isWorkspaceCreator: true,
+ isPlanRequired: true,
+ });
+
+ expect(progress.goalCredits).toBe(4);
+ expect(progress.currentStep).toBe('upgradeTrial');
+ expect(progress.currentStepCredits).toBe(0.5);
+ });
+
+ it('should stop pointing at the upgrade once the trial is upgraded', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({
+ importContacts: 2,
+ upgradeTrial: 0.5,
+ }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.PLAN_REQUIRED,
+ isWorkspaceCreator: true,
+ isPlanRequired: true,
+ });
+
+ expect(progress.earnedCredits).toBe(2.5);
+ expect(progress.currentStep).toBeNull();
+ });
+
+ it('should leave out the upgrade reward once the workspace has a plan', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits(),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.COMPLETED,
+ isWorkspaceCreator: true,
+ isPlanRequired: false,
+ });
+
+ expect(progress.goalCredits).toBe(3.5);
+ });
+
+ it('should keep the earned upgrade reward in the goal once the workspace has a plan', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({
+ importContacts: 2,
+ installApps: 1,
+ createProfile: 0.5,
+ upgradeTrial: 0.5,
+ }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.COMPLETED,
+ isWorkspaceCreator: true,
+ isPlanRequired: false,
+ });
+
+ expect(progress.earnedCredits).toBe(4);
+ expect(progress.goalCredits).toBe(4);
+ });
+
+ it('should leave out the workspace creator rewards for other members', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits(),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.SYNC_EMAIL,
+ isWorkspaceCreator: false,
+ isPlanRequired: false,
+ });
+
+ expect(progress.goalCredits).toBe(0);
+ expect(progress.currentStep).toBeNull();
+ expect(progress.currentStepCredits).toBe(0);
+ });
+});
diff --git a/packages/twenty-front/src/modules/onboarding/utils/formatOnboardingCredits.ts b/packages/twenty-front/src/modules/onboarding/utils/formatOnboardingCredits.ts
new file mode 100644
index 00000000000..7d7131d6648
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/utils/formatOnboardingCredits.ts
@@ -0,0 +1,7 @@
+import { type NumberFormat } from '@/localization/constants/NumberFormat';
+import { formatNumber } from '~/utils/format/formatNumber';
+
+export const formatOnboardingCredits = (
+ credits: number,
+ numberFormat: NumberFormat,
+) => formatNumber(credits, { decimals: 2, format: numberFormat });
diff --git a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCountedFreeCredits.ts b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCountedFreeCredits.ts
new file mode 100644
index 00000000000..a7b8e0d9d05
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCountedFreeCredits.ts
@@ -0,0 +1,21 @@
+import { ONBOARDING_CREDITS_STEPS } from '@/onboarding/constants/OnboardingCreditsSteps';
+import { type OnboardingFreeCredits } from '@/onboarding/types/OnboardingFreeCredits';
+import { isOnboardingCreditsStepDone } from '@/onboarding/utils/isOnboardingCreditsStepDone';
+import { type OnboardingStatus } from '~/generated-metadata/graphql';
+
+type GetOnboardingCountedFreeCreditsArgs = {
+ onboardingFreeCredits: OnboardingFreeCredits;
+ onboardingStatus: OnboardingStatus | null | undefined;
+};
+
+export const getOnboardingCountedFreeCredits = ({
+ onboardingFreeCredits,
+ onboardingStatus,
+}: GetOnboardingCountedFreeCreditsArgs) =>
+ ONBOARDING_CREDITS_STEPS.reduce<OnboardingFreeCredits>(
+ (countedFreeCredits, step) =>
+ isOnboardingCreditsStepDone({ step, onboardingStatus })
+ ? countedFreeCredits
+ : { ...countedFreeCredits, [step]: 0 },
+ onboardingFreeCredits,
+ );
diff --git a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditWorth.ts b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditWorth.ts
new file mode 100644
index 00000000000..1692105214e
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditWorth.ts
@@ -0,0 +1,18 @@
+import { ONBOARDING_CREDIT_WORTH_PER_CREDIT } from '@/onboarding/constants/OnboardingCreditWorthPerCredit';
+
+export const getOnboardingCreditWorth = (credits: number) => ({
+ aiActions: Math.floor(credits * ONBOARDING_CREDIT_WORTH_PER_CREDIT.aiActions),
+ workflowSteps: Math.floor(
+ credits * ONBOARDING_CREDIT_WORTH_PER_CREDIT.workflowSteps,
+ ),
+ enrichments: Math.floor(
+ credits * ONBOARDING_CREDIT_WORTH_PER_CREDIT.enrichments,
+ ),
+ callRecordingHours:
+ Math.round(
+ credits * ONBOARDING_CREDIT_WORTH_PER_CREDIT.callRecordingHours * 10,
+ ) / 10,
+ emailsSent: Math.floor(
+ credits * ONBOARDING_CREDIT_WORTH_PER_CREDIT.emailsSent,
+ ),
+});
diff --git a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsProgress.ts b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsProgress.ts
new file mode 100644
index 00000000000..d579b9e7129
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsProgress.ts
@@ -0,0 +1,80 @@
+import { type OnboardingConfig } from '@/client-config/types/OnboardingConfig';
+import { ONBOARDING_CREDITS_STEPS } from '@/onboarding/constants/OnboardingCreditsSteps';
+import { ONBOARDING_STATUS_BY_CREDITS_STEP } from '@/onboarding/constants/OnboardingStatusByCreditsStep';
+import { type OnboardingCreditsProgress } from '@/onboarding/types/OnboardingCreditsProgress';
+import { type OnboardingCreditsStep } from '@/onboarding/types/OnboardingCreditsStep';
+import { type OnboardingFreeCredits } from '@/onboarding/types/OnboardingFreeCredits';
+import { getOnboardingCountedFreeCredits } from '@/onboarding/utils/getOnboardingCountedFreeCredits';
+import { getOnboardingEarnedCredits } from '@/onboarding/utils/getOnboardingEarnedCredits';
+import { isOnboardingCreditsStepDone } from '@/onboarding/utils/isOnboardingCreditsStepDone';
+import { isDefined } from 'twenty-shared/utils';
+import { type OnboardingStatus } from '~/generated-metadata/graphql';
+
+type GetOnboardingCreditsProgressArgs = {
+ onboardingFreeCredits: OnboardingFreeCredits;
+ onboardingConfig: OnboardingConfig;
+ onboardingStatus: OnboardingStatus | null | undefined;
+ isWorkspaceCreator: boolean;
+ isPlanRequired: boolean;
+};
+
+export const getOnboardingCreditsProgress = ({
+ onboardingFreeCredits,
+ onboardingConfig,
+ onboardingStatus,
+ isWorkspaceCreator,
+ isPlanRequired,
+}: GetOnboardingCreditsProgressArgs): OnboardingCreditsProgress => {
+ const countedFreeCredits = getOnboardingCountedFreeCredits({
+ onboardingFreeCredits,
+ onboardingStatus,
+ });
+
+ const rewardCreditsByStep: Record<OnboardingCreditsStep, number> = {
+ importContacts: isWorkspaceCreator
+ ? onboardingConfig.importContactsCreditsReward
+ : 0,
+ installApps: isWorkspaceCreator
+ ? onboardingConfig.installAppsCreditsReward
+ : 0,
+ createProfile: isWorkspaceCreator
+ ? onboardingConfig.createProfileCreditsReward
+ : 0,
+ inviteTeam:
+ onboardingConfig.inviteTeamCreditsRewardPerUser *
+ onboardingConfig.inviteTeamMaxInvites,
+ upgradeTrial: isPlanRequired ? onboardingConfig.upgradeCreditsReward : 0,
+ };
+
+ const onboardingStep = ONBOARDING_CREDITS_STEPS.find(
+ (step) => ONBOARDING_STATUS_BY_CREDITS_STEP[step] === onboardingStatus,
+ );
+
+ const currentStepCredits = isDefined(onboardingStep)
+ ? Math.max(
+ 0,
+ rewardCreditsByStep[onboardingStep] -
+ countedFreeCredits[onboardingStep],
+ )
+ : 0;
+
+ const goalCredits = ONBOARDING_CREDITS_STEPS.reduce(
+ (goal, step) =>
+ goal +
+ (isOnboardingCreditsStepDone({ step, onboardingStatus }) &&
+ step !== 'inviteTeam'
+ ? Math.max(rewardCreditsByStep[step], countedFreeCredits[step])
+ : countedFreeCredits[step]),
+ 0,
+ );
+
+ return {
+ earnedCredits: getOnboardingEarnedCredits(countedFreeCredits),
+ goalCredits,
+ currentStep:
+ isDefined(onboardingStep) && currentStepCredits > 0
+ ? onboardingStep
+ : null,
+ currentStepCredits,
+ };
+};
diff --git a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingEarnedCredits.ts b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingEarnedCredits.ts
new file mode 100644
index 00000000000..dd5eb63bab0
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingEarnedCredits.ts
@@ -0,0 +1,10 @@
+import { ONBOARDING_CREDITS_STEPS } from '@/onboarding/constants/OnboardingCreditsSteps';
+import { type OnboardingFreeCredits } from '@/onboarding/types/OnboardingFreeCredits';
+
+export const getOnboardingEarnedCredits = (
+ onboardingFreeCredits: OnboardingFreeCredits,
+) =>
+ ONBOARDING_CREDITS_STEPS.reduce(
+ (earnedCredits, step) => earnedCredits + onboardingFreeCredits[step],
+ 0,
+ );
diff --git a/packages/twenty-front/src/modules/onboarding/utils/isOnboardingCreditsStepDone.ts b/packages/twenty-front/src/modules/onboarding/utils/isOnboardingCreditsStepDone.ts
new file mode 100644
index 00000000000..8342c11edac
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/utils/isOnboardingCreditsStepDone.ts
@@ -0,0 +1,26 @@
+import { ONBOARDING_STATUS_BY_CREDITS_STEP } from '@/onboarding/constants/OnboardingStatusByCreditsStep';
+import { ONBOARDING_STATUS_ORDER } from '@/onboarding/constants/OnboardingStatusOrder';
+import { type OnboardingCreditsStep } from '@/onboarding/types/OnboardingCreditsStep';
+import { isDefined } from 'twenty-shared/utils';
+import { type OnboardingStatus } from '~/generated-metadata/graphql';
+
+type IsOnboardingCreditsStepDoneArgs = {
+ step: OnboardingCreditsStep;
+ onboardingStatus: OnboardingStatus | null | undefined;
+};
+
+export const isOnboardingCreditsStepDone = ({
+ step,
+ onboardingStatus,
+}: IsOnboardingCreditsStepDoneArgs) => {
+ const statusIndex = isDefined(onboardingStatus)
+ ? ONBOARDING_STATUS_ORDER.indexOf(onboardingStatus)
+ : -1;
+ const stepStatusIndex = ONBOARDING_STATUS_ORDER.indexOf(
+ ONBOARDING_STATUS_BY_CREDITS_STEP[step],
+ );
+
+ return step === 'upgradeTrial'
+ ? statusIndex >= stepStatusIndex
+ : statusIndex > stepStatusIndex;
+};
diff --git a/packages/twenty-front/src/modules/ui/theme/constants/EaseOut.ts b/packages/twenty-front/src/modules/ui/theme/constants/EaseOut.ts
new file mode 100644
index 00000000000..a866de51414
--- /dev/null
+++ b/packages/twenty-front/src/modules/ui/theme/constants/EaseOut.ts
@@ -0,0 +1 @@
+export const EASE_OUT = [0.2, 0, 0, 1] as const;
diff --git a/packages/twenty-front/src/pages/onboarding/CreateProfile.tsx b/packages/twenty-front/src/pages/onboarding/CreateProfile.tsx
index 29dbf0ebe70..6d233e357fd 100644
--- a/packages/twenty-front/src/pages/onboarding/CreateProfile.tsx
+++ b/packages/twenty-front/src/pages/onboarding/CreateProfile.tsx
@@ -1,6 +1,7 @@
import { currentUserState } from '@/auth/states/currentUserState';
import { currentWorkspaceMemberState } from '@/auth/states/currentWorkspaceMemberState';
import { currentWorkspaceMembersState } from '@/auth/states/currentWorkspaceMembersState';
+import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
import { getToastOptionsFromError } from '@/error-handler/utils/getToastOptionsFromError';
import { OnboardingProfilePictureUploader } from '@/onboarding/components/OnboardingProfilePictureUploader';
import { OnboardingStepAnimatedItem } from '@/onboarding/components/OnboardingStepAnimatedItem';
@@ -11,6 +12,7 @@ import { StyledOnboardingStepTitle } from '@/onboarding/components/StyledOnboard
import { ONBOARDING_CONTENT_BLOCK_WIDTH } from '@/onboarding/constants/OnboardingContentBlockWidth';
import { usePrefetchInviteSuggestions } from '@/onboarding/hooks/usePrefetchInviteSuggestions';
import { useSetNextOnboardingStatus } from '@/onboarding/hooks/useSetNextOnboardingStatus';
+import { useSetOnboardingStepFreeCredits } from '@/onboarding/hooks/useSetOnboardingStepFreeCredits';
import { useUpdateWorkspaceMemberSettings } from '@/settings/profile/hooks/useUpdateWorkspaceMemberSettings';
import { PageFocusId } from '@/types/PageFocusId';
import { TextInput } from '@/ui/input/components/TextInput';
@@ -80,12 +82,15 @@ type Form = z.infer<typeof validationSchema>;
export const CreateProfile = () => {
const { t } = useLingui();
const setNextOnboardingStatus = useSetNextOnboardingStatus();
+ const setOnboardingStepFreeCredits = useSetOnboardingStepFreeCredits();
usePrefetchInviteSuggestions();
const { enqueueToast } = useToast();
const currentWorkspaceMember = useAtomStateValue(currentWorkspaceMemberState);
+ const currentUser = useAtomStateValue(currentUserState);
const setCurrentUser = useSetAtomState(currentUserState);
+ const onboardingConfig = useAtomStateValue(onboardingConfigState);
const setCurrentWorkspaceMembers = useSetAtomState(
currentWorkspaceMembersState,
);
@@ -156,6 +161,12 @@ export const CreateProfile = () => {
return current;
});
+ setOnboardingStepFreeCredits(
+ 'createProfile',
+ currentUser?.isWorkspaceCreator
+ ? (onboardingConfig?.createProfileCreditsReward ?? 0)
+ : 0,
+ );
setNextOnboardingStatus({ stepHistoryEffect: 'recordAsReversible' });
setIsNavigating(true);
} catch (error: any) {
@@ -165,7 +176,10 @@ export const CreateProfile = () => {
},
[
currentWorkspaceMember?.id,
+ currentUser?.isWorkspaceCreator,
+ onboardingConfig?.createProfileCreditsReward,
setNextOnboardingStatus,
+ setOnboardingStepFreeCredits,
enqueueToast,
setCurrentWorkspaceMembers,
setCurrentUser,
diff --git a/packages/twenty-front/src/pages/onboarding/SyncEmails.tsx b/packages/twenty-front/src/pages/onboarding/SyncEmails.tsx
index 24fd0139ac0..fdeb4d2a468 100644
--- a/packages/twenty-front/src/pages/onboarding/SyncEmails.tsx
+++ b/packages/twenty-front/src/pages/onboarding/SyncEmails.tsx
@@ -7,12 +7,11 @@ import { isMicrosoftCalendarEnabledState } from '@/client-config/states/isMicros
import { isMicrosoftMessagingEnabledState } from '@/client-config/states/isMicrosoftMessagingEnabledState';
import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
import { SyncEmailsAutoSkipEffect } from '@/onboarding/effect-components/SyncEmailsAutoSkipEffect';
+import { useSetOnboardingStepFreeCredits } from '@/onboarding/hooks/useSetOnboardingStepFreeCredits';
import { useSkipSyncEmailOnboardingStep } from '@/onboarding/hooks/useSkipSyncEmailOnboardingStep';
-import { onboardingFreeCreditsState } from '@/onboarding/states/onboardingFreeCreditsState';
import { useTriggerApisOAuth } from '@/settings/accounts/hooks/useTriggerApiOAuth';
import { useHasPermissionFlag } from '@/settings/roles/hooks/useHasPermissionFlag';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
-import { useSetAtomState } from '@/ui/utilities/state/jotai/hooks/useSetAtomState';
import { useCallback, useState } from 'react';
import { AppPath, ConnectedAccountProvider } from 'twenty-shared/types';
import { PermissionFlagType } from '~/generated-metadata/graphql';
@@ -25,7 +24,7 @@ import {
export const SyncEmails = () => {
const { triggerApisOAuth } = useTriggerApisOAuth();
const skipSyncEmailOnboardingStep = useSkipSyncEmailOnboardingStep();
- const setOnboardingFreeCredits = useSetAtomState(onboardingFreeCreditsState);
+ const setOnboardingStepFreeCredits = useSetOnboardingStepFreeCredits();
const [hasAutoSkipFailed, setHasAutoSkipFailed] = useState(false);
const isCurrentUserLoaded = useAtomStateValue(isCurrentUserLoadedState);
const hasConnectedAccountsPermission = useHasPermissionFlag(
@@ -64,10 +63,7 @@ export const SyncEmails = () => {
: undefined;
const connectWithProvider = async (provider: ConnectedAccountProvider) => {
- setOnboardingFreeCredits((current) => ({
- ...current,
- importContacts: creditsReward ?? 0,
- }));
+ setOnboardingStepFreeCredits('importContacts', creditsReward ?? 0);
try {
await triggerApisOAuth(provider, {
@@ -77,10 +73,7 @@ export const SyncEmails = () => {
skipMessageChannelConfiguration: true,
});
} catch (error) {
- setOnboardingFreeCredits((current) => ({
- ...current,
- importContacts: 0,
- }));
+ setOnboardingStepFreeCredits('importContacts', 0);
throw error;
}
@@ -89,10 +82,7 @@ export const SyncEmails = () => {
const handleSkip = async () => {
await skipSyncEmailOnboardingStep({ isAutoSkipped: false });
- setOnboardingFreeCredits((current) => ({
- ...current,
- importContacts: 0,
- }));
+ setOnboardingStepFreeCredits('importContacts', 0);
};
const handleAutoSkipError = useCallback(() => {
diff --git a/packages/twenty-front/src/pages/onboarding/UpgradeFreeTrial.tsx b/packages/twenty-front/src/pages/onboarding/UpgradeFreeTrial.tsx
index 5e4c365e051..1ffcc2a2f4a 100644
--- a/packages/twenty-front/src/pages/onboarding/UpgradeFreeTrial.tsx
+++ b/packages/twenty-front/src/pages/onboarding/UpgradeFreeTrial.tsx
@@ -14,6 +14,7 @@ import { OnboardingCreditsRewardTag } from '@/onboarding/components/import-conta
import { OnboardingPlanCard } from '@/onboarding/components/upgrade-free-trial/OnboardingPlanCard';
import { OnboardingTrialExtensionTag } from '@/onboarding/components/upgrade-free-trial/OnboardingTrialExtensionTag';
import { CAL_LINK } from '@/onboarding/constants/CalLink';
+import { useSetOnboardingUpgradeTrialFreeCredits } from '@/onboarding/hooks/useSetOnboardingUpgradeTrialFreeCredits';
import { isOnboardingCheckoutPendingState } from '@/onboarding/states/isOnboardingCheckoutPendingState';
import { useBaseLicensedPriceByPlanKeyAndInterval } from '@/settings/billing/hooks/useBaseLicensedPriceByPlanKeyAndInterval';
import { useHandleCheckoutSession } from '@/settings/billing/hooks/useHandleCheckoutSession';
@@ -96,8 +97,11 @@ const UpgradeFreeTrialSubmitButton = ({
const setIsOnboardingCheckoutPending = useSetAtomState(
isOnboardingCheckoutPendingState,
);
+ const setOnboardingUpgradeTrialFreeCredits =
+ useSetOnboardingUpgradeTrialFreeCredits();
const handleSubmit = () => {
+ setOnboardingUpgradeTrialFreeCredits(true);
setIsOnboardingCheckoutPending(true);
void submit();
};
@@ -157,8 +161,13 @@ const UpgradeFreeTrialContent = ({
const setIsOnboardingCheckoutPending = useSetAtomState(
isOnboardingCheckoutPendingState,
);
+ const setOnboardingUpgradeTrialFreeCredits =
+ useSetOnboardingUpgradeTrialFreeCredits();
const handleCheckoutSessionClick = () => {
+ setOnboardingUpgradeTrialFreeCredits(
+ billingCheckoutSession.requirePaymentMethod,
+ );
setIsOnboardingCheckoutPending(true);
void handleCheckoutSession();
};
@@ -173,6 +182,7 @@ const UpgradeFreeTrialContent = ({
interval: baseProductPrice.recurringInterval,
requirePaymentMethod: withCreditCard,
});
+ setOnboardingUpgradeTrialFreeCredits(withCreditCard);
}
};
diff --git a/packages/twenty-front/src/pages/onboarding/WorkspaceActivation.tsx b/packages/twenty-front/src/pages/onboarding/WorkspaceActivation.tsx
index c01d8cabaaa..35ef3e07db3 100644
--- a/packages/twenty-front/src/pages/onboarding/WorkspaceActivation.tsx
+++ b/packages/twenty-front/src/pages/onboarding/WorkspaceActivation.tsx
@@ -5,9 +5,10 @@ import { Title } from '@/auth/components/Title';
import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { isCreatingWorkspaceState } from '@/auth/states/isCreatingWorkspaceState';
import { OnboardingStepAnimatedItem } from '@/onboarding/components/OnboardingStepAnimatedItem';
+import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
+import { useSetCurrentWorkspaceOnboardingFreeCredits } from '@/onboarding/hooks/useSetCurrentWorkspaceOnboardingFreeCredits';
import { useSetNextOnboardingStatus } from '@/onboarding/hooks/useSetNextOnboardingStatus';
import { onboardingActivationFailedState } from '@/onboarding/states/onboardingActivationFailedState';
-import { onboardingFreeCreditsState } from '@/onboarding/states/onboardingFreeCreditsState';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { useSetAtomState } from '@/ui/utilities/state/jotai/hooks/useSetAtomState';
import { useLoadCurrentUser } from '@/users/hooks/useLoadCurrentUser';
@@ -54,7 +55,8 @@ export const WorkspaceActivation = () => {
);
const currentWorkspace = useAtomStateValue(currentWorkspaceState);
const setIsCreatingWorkspace = useSetAtomState(isCreatingWorkspaceState);
- const setOnboardingFreeCredits = useSetAtomState(onboardingFreeCreditsState);
+ const setOnboardingFreeCredits =
+ useSetCurrentWorkspaceOnboardingFreeCredits();
const setIsAppEffectRedirectEnabled = useSetAtomState(
isAppEffectRedirectEnabledState,
);
@@ -107,11 +109,7 @@ export const WorkspaceActivation = () => {
}
hasTriggeredRef.current = true;
- setOnboardingFreeCredits({
- importContacts: 0,
- inviteTeam: 0,
- installApps: 0,
- });
+ setOnboardingFreeCredits(ONBOARDING_FREE_CREDITS_DEFAULT_VALUE);
void activate();
}, [activate, currentWorkspace, setOnboardingFreeCredits]);
diff --git a/packages/twenty-ui/docs/progressBarPropDescriptions.ts b/packages/twenty-ui/docs/progressBarPropDescriptions.ts
index 5d8615bcd36..2b24a31c121 100644
--- a/packages/twenty-ui/docs/progressBarPropDescriptions.ts
+++ b/packages/twenty-ui/docs/progressBarPropDescriptions.ts
@@ -5,14 +5,22 @@ import { type ProgressBar } from '../src/primitives/feedback/ProgressBar/Progres
export const PROGRESS_BAR_PROP_DESCRIPTIONS = {
value:
'Current progress from 0 to 100. Also supplies the accessible value during a countdown.',
+ size: 'Bar height: `sm` (6px) or `md` (8px).',
className: 'CSS class applied to the progress root.',
barColor: 'CSS color of the filled bar. Defaults to the primary text color.',
backgroundColor: 'CSS background color of the track.',
withBorderRadius: 'Rounds the track and indicator corners.',
+ withGrowIn: 'Grows the bar in from zero width when it mounts.',
+ withGlint:
+ 'Sweeps a highlight across the filled bar each time the value changes.',
+ withSpringFill:
+ 'Animates value changes with a spring that slightly overshoots the target.',
+ withMinimumFillWidth: 'Keeps a small visible fill for any value above zero.',
ariaLabel: 'Accessible name describing the operation being measured.',
countdownDurationInMs:
'Starts a visual animation from full to empty over this duration in milliseconds. Does not update `value`.',
isCountdownPaused:
'Pauses the countdown animation without resetting its position.',
onCountdownComplete: 'Called when the countdown animation ends.',
+ onGrowInComplete: 'Called when the grow-in animation ends.',
} satisfies Partial<Record<keyof ComponentProps<typeof ProgressBar>, string>>;
diff --git a/packages/twenty-ui/docs/tooltipPropDescriptions.ts b/packages/twenty-ui/docs/tooltipPropDescriptions.ts
index bf720e9a3b3..1725ac1c02b 100644
--- a/packages/twenty-ui/docs/tooltipPropDescriptions.ts
+++ b/packages/twenty-ui/docs/tooltipPropDescriptions.ts
@@ -10,6 +10,8 @@ export const TOOLTIP_PROP_DESCRIPTIONS = {
sideOffset: 'Distance from the trigger in pixels. Defaults to 10.',
alignOffset: 'Offset along the alignment axis in pixels.',
arrow: 'Displays an arrow pointing to the trigger. Defaults to false.',
+ withExitAnimation:
+ 'Fades and slides the popup out when it closes instead of hiding it at once.',
maxWidth: 'Maximum popup width. Defaults to 300 pixels.',
positionMethod: 'CSS positioning method for the popup.',
open: 'Controlled visibility of the tooltip.',
diff --git a/packages/twenty-ui/generated/components.docs.json b/packages/twenty-ui/generated/components.docs.json
index 0fbf26a495d..f2401c10f60 100644
--- a/packages/twenty-ui/generated/components.docs.json
+++ b/packages/twenty-ui/generated/components.docs.json
@@ -179,6 +179,20 @@
"defaultValue": null,
"description": "Called when the countdown animation ends."
},
+ {
+ "name": "onGrowInComplete",
+ "type": "(() => void)",
+ "required": false,
+ "defaultValue": null,
+ "description": "Called when the grow-in animation ends."
+ },
+ {
+ "name": "size",
+ "type": "\"md\" | \"sm\"",
+ "required": false,
+ "defaultValue": "md",
+ "description": "Bar height: `sm` (6px) or `md` (8px)."
+ },
{
"name": "value",
"type": "number",
@@ -192,6 +206,34 @@
"required": false,
"defaultValue": "false",
"description": "Rounds the track and indicator corners."
+ },
+ {
+ "name": "withGlint",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Sweeps a highlight across the filled bar each time the value changes."
+ },
+ {
+ "name": "withGrowIn",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Grows the bar in from zero width when it mounts."
+ },
+ {
+ "name": "withMinimumFillWidth",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "true",
+ "description": "Keeps a small visible fill for any value above zero."
+ },
+ {
+ "name": "withSpringFill",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Animates value changes with a spring that slightly overshoots the target."
}
]
},
@@ -5727,6 +5769,13 @@
"required": false,
"defaultValue": null,
"description": "ID of the trigger that the tooltip is associated with.\nThis is useful in conjunction with the `open` prop to create a controlled tooltip.\nThere's no need to specify this prop when the tooltip is uncontrolled (that is, when the `open` prop is not set)."
+ },
+ {
+ "name": "withExitAnimation",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": null,
+ "description": "Fades and slides the popup out when it closes instead of hiding it at once."
}
],
"parts": [
@@ -6036,6 +6085,13 @@
"required": false,
"defaultValue": null,
"description": "Inline styles for the popup."
+ },
+ {
+ "name": "withExitAnimation",
+ "type": "boolean",
+ "required": false,
+ "defaultValue": "false",
+ "description": "Fades and slides the popup out when it closes instead of hiding it at once."
}
]
},
diff --git a/packages/twenty-ui/src/primitives/feedback/ProgressBar/ProgressBar.module.scss b/packages/twenty-ui/src/primitives/feedback/ProgressBar/ProgressBar.module.scss
index 8eb2e60e52c..e7df6e900a6 100644
--- a/packages/twenty-ui/src/primitives/feedback/ProgressBar/ProgressBar.module.scss
+++ b/packages/twenty-ui/src/primitives/feedback/ProgressBar/ProgressBar.module.scss
@@ -6,10 +6,18 @@
border-radius: 0;
overflow: hidden;
+ &[data-size='sm'] {
+ height: var(--t-spacing-1_5);
+ }
+
&[data-with-border-radius] {
border-radius: var(--t-border-radius-pill);
corner-shape: round;
}
+
+ &[data-grow-in] {
+ animation: progressBarGrowIn duration(normal) cubic-bezier(0.2, 0, 0, 1);
+ }
}
.track {
@@ -22,6 +30,8 @@
height: 100%;
background-color: var(--progress-bar-color, var(--t-font-color-primary));
border-radius: 0;
+ overflow: hidden;
+ position: relative;
transition: width duration(normal) linear;
&[data-with-border-radius] {
@@ -29,11 +39,48 @@
corner-shape: round;
}
+ &[data-spring-fill] {
+ transition: width calc(#{duration(normal)} * 2)
+ linear(
+ 0,
+ 0.092,
+ 0.285,
+ 0.496,
+ 0.681,
+ 0.823,
+ 0.922,
+ 0.982,
+ 1.015,
+ 1.028,
+ 1.03,
+ 1.026,
+ 1.02,
+ 1.014,
+ 1.008,
+ 1.004,
+ 1.002,
+ 1,
+ 0.999,
+ 0.999,
+ 1
+ );
+ }
+
&[data-nonzero] {
min-width: 12px;
}
}
+.glint {
+ animation: progressBarGlint calc(#{duration(normal)} * 3)
+ cubic-bezier(0.2, 0, 0, 1) forwards;
+ backdrop-filter: brightness(1.6);
+ inset: 0;
+ mask-image: linear-gradient(90deg, transparent, black, transparent);
+ position: absolute;
+ transform: translateX(-100%);
+}
+
.countdown {
animation: progressBarCountdown
var(--progress-bar-countdown-duration, #{duration(normal)}) linear forwards;
@@ -52,3 +99,33 @@
width: 0;
}
}
+
+@keyframes progressBarGrowIn {
+ from {
+ width: 0;
+ }
+}
+
+@keyframes progressBarGlint {
+ from {
+ transform: translateX(-100%);
+ }
+
+ to {
+ transform: translateX(100%);
+ }
+}
+
+@media (prefers-reduced-motion: reduce) {
+ .bar[data-grow-in] {
+ animation-duration: 0s;
+ }
+
+ .indicator[data-spring-fill] {
+ transition: none;
+ }
+
+ .glint {
+ display: none;
+ }
+}
diff --git a/packages/twenty-ui/src/primitives/feedback/ProgressBar/ProgressBar.module.scss.d.ts b/packages/twenty-ui/src/primitives/feedback/ProgressBar/ProgressBar.module.scss.d.ts
index 17931fe96ad..270be59ea00 100644
--- a/packages/twenty-ui/src/primitives/feedback/ProgressBar/ProgressBar.module.scss.d.ts
+++ b/packages/twenty-ui/src/primitives/feedback/ProgressBar/ProgressBar.module.scss.d.ts
@@ -2,6 +2,7 @@ declare const classNames: {
readonly bar: 'bar';
readonly track: 'track';
readonly indicator: 'indicator';
+ readonly glint: 'glint';
readonly countdown: 'countdown';
};
export default classNames;
diff --git a/packages/twenty-ui/src/primitives/feedback/ProgressBar/ProgressBar.tsx b/packages/twenty-ui/src/primitives/feedback/ProgressBar/ProgressBar.tsx
index 3d54a09c937..c88d1e2c21c 100644
--- a/packages/twenty-ui/src/primitives/feedback/ProgressBar/ProgressBar.tsx
+++ b/packages/twenty-ui/src/primitives/feedback/ProgressBar/ProgressBar.tsx
@@ -5,35 +5,54 @@ import styles from './ProgressBar.module.scss';
export type ProgressBarProps = {
value: number;
+ size?: 'sm' | 'md';
className?: string;
barColor?: string;
backgroundColor?: string;
withBorderRadius?: boolean;
+ withGrowIn?: boolean;
+ withGlint?: boolean;
+ withSpringFill?: boolean;
+ withMinimumFillWidth?: boolean;
ariaLabel?: string;
countdownDurationInMs?: number;
isCountdownPaused?: boolean;
onCountdownComplete?: () => void;
+ onGrowInComplete?: () => void;
};
export const ProgressBar = ({
value,
+ size = 'md',
className,
barColor,
backgroundColor = 'none',
withBorderRadius = false,
+ withGrowIn = false,
+ withGlint = false,
+ withSpringFill = false,
+ withMinimumFillWidth = true,
ariaLabel,
countdownDurationInMs,
isCountdownPaused = false,
onCountdownComplete,
+ onGrowInComplete,
}: ProgressBarProps) => {
const isCountdown = countdownDurationInMs !== undefined;
return (
<Progress.Root
className={clsx(styles.bar, className)}
+ data-size={size}
data-with-border-radius={withBorderRadius || undefined}
+ data-grow-in={withGrowIn || undefined}
aria-label={ariaLabel}
value={value}
+ onAnimationEnd={(event) => {
+ if (withGrowIn && event.target === event.currentTarget) {
+ onGrowInComplete?.();
+ }
+ }}
style={
{
'--progress-bar-background-color': backgroundColor,
@@ -50,10 +69,15 @@ export const ProgressBar = ({
<Progress.Indicator
className={clsx(styles.indicator, isCountdown && styles.countdown)}
data-with-border-radius={withBorderRadius || undefined}
- data-nonzero={(value > 0 && !isCountdown) || undefined}
+ data-spring-fill={withSpringFill || undefined}
+ data-nonzero={
+ (withMinimumFillWidth && value > 0 && !isCountdown) || undefined
+ }
data-paused={(isCountdown && isCountdownPaused) || undefined}
onAnimationEnd={isCountdown ? onCountdownComplete : undefined}
- />
+ >
+ {withGlint && <span key={value} className={styles.glint} />}
+ </Progress.Indicator>
</Progress.Track>
</Progress.Root>
);
diff --git a/packages/twenty-ui/src/primitives/feedback/ProgressBar/__stories__/ProgressBar.stories.tsx b/packages/twenty-ui/src/primitives/feedback/ProgressBar/__stories__/ProgressBar.stories.tsx
index 5aeba6462ec..9a582000ddf 100644
--- a/packages/twenty-ui/src/primitives/feedback/ProgressBar/__stories__/ProgressBar.stories.tsx
+++ b/packages/twenty-ui/src/primitives/feedback/ProgressBar/__stories__/ProgressBar.stories.tsx
@@ -1,4 +1,5 @@
import { type Meta, type StoryObj } from '@storybook/react-vite';
+import { expect, within } from 'storybook/test';
import { ComponentDecorator } from '@ui/testing/decorators/ComponentDecorator';
import { ProgressBar } from '@ui/primitives/feedback/ProgressBar/ProgressBar';
@@ -23,6 +24,56 @@ export const Default: Story = {
},
};
+export const Small: Story = {
+ args: {
+ value: 50,
+ ariaLabel: 'Progress',
+ size: 'sm',
+ withBorderRadius: true,
+ },
+ play: async ({ canvasElement }) => {
+ const progressBar = await within(canvasElement).findByRole('progressbar', {
+ name: 'Progress',
+ });
+
+ expect(progressBar).toHaveAttribute('aria-valuenow', '50');
+ await expect(progressBar).toHaveStyle({ height: '6px' });
+ },
+};
+
+export const GrowInWithGlint: Story = {
+ args: {
+ value: 60,
+ ariaLabel: 'Progress',
+ withBorderRadius: true,
+ withGrowIn: true,
+ withGlint: true,
+ },
+ play: async ({ canvasElement }) => {
+ const progressBar = await within(canvasElement).findByRole('progressbar', {
+ name: 'Progress',
+ });
+
+ expect(progressBar).toHaveAttribute('aria-valuenow', '60');
+ },
+};
+
+export const SpringFill: Story = {
+ args: {
+ value: 40,
+ ariaLabel: 'Progress',
+ withBorderRadius: true,
+ withSpringFill: true,
+ },
+ play: async ({ canvasElement }) => {
+ const progressBar = await within(canvasElement).findByRole('progressbar', {
+ name: 'Progress',
+ });
+
+ expect(progressBar).toHaveAttribute('aria-valuenow', '40');
+ },
+};
+
export const Countdown: Story = {
tags: ['!test'],
argTypes: {
diff --git a/packages/twenty-ui/src/primitives/surfaces/Tooltip/Tooltip.module.scss b/packages/twenty-ui/src/primitives/surfaces/Tooltip/Tooltip.module.scss
index 02b2093092a..6311c2038db 100644
--- a/packages/twenty-ui/src/primitives/surfaces/Tooltip/Tooltip.module.scss
+++ b/packages/twenty-ui/src/primitives/surfaces/Tooltip/Tooltip.module.scss
@@ -30,6 +30,35 @@
&[data-ending-style] {
transition-duration: 0s;
}
+
+ &[data-with-exit-animation] {
+ transition:
+ opacity duration(fast) ease-out,
+ transform duration(fast) cubic-bezier(0.2, 0, 0, 1);
+
+ &[data-ending-style] {
+ transition-duration: duration(fast);
+ }
+
+ &[data-starting-style],
+ &[data-ending-style] {
+ &[data-side='top'] {
+ transform: translateY(var(--t-spacing-1));
+ }
+
+ &[data-side='bottom'] {
+ transform: translateY(calc(-1 * var(--t-spacing-1)));
+ }
+
+ &[data-side='left'] {
+ transform: translateX(var(--t-spacing-1));
+ }
+
+ &[data-side='right'] {
+ transform: translateX(calc(-1 * var(--t-spacing-1)));
+ }
+ }
+ }
}
.content {
@@ -108,7 +137,8 @@
}
@media (prefers-reduced-motion: reduce) {
- .popup {
+ .popup,
+ .popup[data-with-exit-animation] {
transition: none;
}
}
diff --git a/packages/twenty-ui/src/primitives/surfaces/Tooltip/__stories__/Tooltip.stories.tsx b/packages/twenty-ui/src/primitives/surfaces/Tooltip/__stories__/Tooltip.stories.tsx
index b95fac5063b..c7a8d7719f2 100644
--- a/packages/twenty-ui/src/primitives/surfaces/Tooltip/__stories__/Tooltip.stories.tsx
+++ b/packages/twenty-ui/src/primitives/surfaces/Tooltip/__stories__/Tooltip.stories.tsx
@@ -54,6 +54,11 @@ export const WithArrow: Story = {
args: { arrow: true },
};
+export const WithExitAnimation: Story = {
+ ...Default,
+ args: { withExitAnimation: true },
+};
+
export const WithDescription: Story = {
...Default,
args: {
diff --git a/packages/twenty-ui/src/primitives/surfaces/Tooltip/internal/TooltipPopup.tsx b/packages/twenty-ui/src/primitives/surfaces/Tooltip/internal/TooltipPopup.tsx
index 19828ba619c..d7cb55a8daa 100644
--- a/packages/twenty-ui/src/primitives/surfaces/Tooltip/internal/TooltipPopup.tsx
+++ b/packages/twenty-ui/src/primitives/surfaces/Tooltip/internal/TooltipPopup.tsx
@@ -25,6 +25,7 @@ export const TooltipPopup = ({
sticky,
disableAnchorTracking,
arrow = false,
+ withExitAnimation = false,
maxWidth = DEFAULT_MAX_WIDTH,
container,
keepMounted,
@@ -60,6 +61,7 @@ export const TooltipPopup = ({
<TooltipPrimitive.Popup
role="tooltip"
{...props}
+ data-with-exit-animation={withExitAnimation || undefined}
className={mergeClassNames(styles.popup, className)}
>
{hasPlainTextContent ? (
diff --git a/packages/twenty-ui/src/primitives/surfaces/Tooltip/types/TooltipPopupProps.ts b/packages/twenty-ui/src/primitives/surfaces/Tooltip/types/TooltipPopupProps.ts
index 6c895d8d2f6..2970d3549f3 100644
--- a/packages/twenty-ui/src/primitives/surfaces/Tooltip/types/TooltipPopupProps.ts
+++ b/packages/twenty-ui/src/primitives/surfaces/Tooltip/types/TooltipPopupProps.ts
@@ -20,6 +20,7 @@ export type TooltipPopupProps = TooltipPrimitive.Popup.Props &
side?: TooltipSide;
align?: TooltipAlign;
arrow?: boolean;
+ withExitAnimation?: boolean;
maxWidth?: CSSProperties['maxWidth'];
container?: TooltipPrimitive.Portal.Props['container'];
keepMounted?: boolean;