Skip to content

The open alternative to Salesforce, designed for AI.

[Onboarding 7/10] Count credits live (#26782)

Thomas des Francsda0fe52b5e08
diff --git a/packages/twenty-e2e-testing/lib/pom/loginPage.ts b/packages/twenty-e2e-testing/lib/pom/loginPage.ts
index 04b919fb5c6..336baa09dc5 100644
--- a/packages/twenty-e2e-testing/lib/pom/loginPage.ts
+++ b/packages/twenty-e2e-testing/lib/pom/loginPage.ts
@@ -19,6 +19,7 @@ export class LoginPage {
private readonly subdomainField: Locator;
private readonly createWorkspaceButton: Locator;
private readonly skipOnboardingStepButton: Locator;
+ private readonly skipOnboardingStepAnywayButton: Locator;
private readonly firstNameField: Locator;
private readonly lastNameField: Locator;
private readonly syncEverythingWithGoogleRadio: Locator;
@@ -46,8 +47,7 @@ export class LoginPage {
this.privacyPolicyLink = page.getByRole('link', { name: 'Privacy Policy' });
this.emailField = page.getByPlaceholder('Email');
this.continueButton = page.getByRole('button', {
- name: 'Continue',
- exact: true,
+ name: /^Continue(,|$)/,
});
this.forgotPasswordButton = page.getByText('Forgot your password?');
this.passwordField = page.getByPlaceholder('Password');
@@ -66,6 +66,9 @@ export class LoginPage {
name: 'Skip',
exact: true,
});
+ this.skipOnboardingStepAnywayButton = page.getByTestId(
+ 'onboarding-skip-dialog-skip-anyway',
+ );
this.firstNameField = page.getByLabel('First Name', { exact: true });
this.lastNameField = page.getByLabel('Last name', { exact: true });
this.syncEverythingWithGoogleRadio = page.locator(
@@ -166,6 +169,12 @@ export class LoginPage {
async clickSkipOnboardingStep() {
await this.skipOnboardingStepButton.click();
+
+ try {
+ await this.skipOnboardingStepAnywayButton.click({ timeout: 3000 });
+ } catch {
+ // No skip dialog on this step - clicking Skip already moved on
+ }
}
async typeFirstName(firstName: string) {
diff --git a/packages/twenty-e2e-testing/tests/authentication/onboarding.spec.ts b/packages/twenty-e2e-testing/tests/authentication/onboarding.spec.ts
index d90496a0b5f..a162a51b86c 100644
--- a/packages/twenty-e2e-testing/tests/authentication/onboarding.spec.ts
+++ b/packages/twenty-e2e-testing/tests/authentication/onboarding.spec.ts
@@ -39,55 +39,56 @@ test('New workspace signup goes through every onboarding stage', async ({
await page.waitForURL('**/workspace-activation', { timeout: 90000 });
});
- const syncEmailsHeading = page.getByText('Import your contacts');
- const installAppsHeading = page.getByText('Install your first apps');
- const createProfileHeading = page.getByText('Create profile');
+ const syncEmailsStep = page.getByTestId('onboarding-sync-emails-step');
+ const installAppsStep = page.getByTestId('onboarding-install-apps-step');
+ const createProfileStep = page.getByTestId('onboarding-create-profile-step');
+ const inviteTeamStep = page.getByTestId('onboarding-invite-team-step');
// Both stages auto-skip when the instance has no connected-account provider
// and no vetted marketplace app, which is how the e2e server is configured.
await test.step('Sync-email stage (when shown)', async () => {
await expect(
- syncEmailsHeading.or(installAppsHeading).or(createProfileHeading),
+ syncEmailsStep.or(installAppsStep).or(createProfileStep),
).toBeVisible({
timeout: 90000,
});
- if (!(await syncEmailsHeading.isVisible())) {
+ if (!(await syncEmailsStep.isVisible())) {
return;
}
await loginPage.clickSkipOnboardingStep();
- await expect(installAppsHeading).toBeVisible();
+ await expect(installAppsStep.or(createProfileStep)).toBeVisible();
await test.step('Goes back to the skipped sync-email stage', async () => {
await page.getByRole('button', { name: 'Go back' }).click();
- await expect(syncEmailsHeading).toBeVisible();
+ await expect(syncEmailsStep).toBeVisible();
await page.reload();
- await expect(syncEmailsHeading).toBeVisible({
+ await expect(syncEmailsStep).toBeVisible({
timeout: 30000,
});
await loginPage.clickSkipOnboardingStep();
- await expect(installAppsHeading).toBeVisible();
+ await expect(installAppsStep.or(createProfileStep)).toBeVisible();
});
});
await test.step('Install-apps stage (when shown)', async () => {
- if (await installAppsHeading.isVisible()) {
+ if (await installAppsStep.isVisible()) {
await loginPage.clickSkipOnboardingStep();
}
});
await test.step('Create-profile stage', async () => {
- await expect(page.getByText('Create profile')).toBeVisible();
+ await expect(createProfileStep).toBeVisible();
await loginPage.typeFirstName('Ada');
await loginPage.typeLastName('Lovelace');
await loginPage.clickContinueButton();
});
await test.step('Invite-team stage', async () => {
- await expect(page.getByText('Invite your team')).toBeVisible();
+ await expect(inviteTeamStep).toBeVisible();
await loginPage.clickSkipOnboardingStep();
});
diff --git a/packages/twenty-front/src/modules/app/effect-components/PageChangeEffect.tsx b/packages/twenty-front/src/modules/app/effect-components/PageChangeEffect.tsx
index 3a1535c29fd..23272dbc450 100644
--- a/packages/twenty-front/src/modules/app/effect-components/PageChangeEffect.tsx
+++ b/packages/twenty-front/src/modules/app/effect-components/PageChangeEffect.tsx
@@ -345,6 +345,22 @@ export const PageChangeEffect = () => {
});
break;
}
+ case isMatchingLocation(location, AppPath.InstallApps): {
+ resetFocusStackToFocusItem({
+ focusStackItem: {
+ focusId: PageFocusId.InstallApps,
+ componentInstance: {
+ componentType: FocusComponentType.PAGE,
+ componentInstanceId: PageFocusId.InstallApps,
+ },
+ globalHotkeysConfig: {
+ enableGlobalHotkeysWithModifiers: false,
+ enableGlobalHotkeysConflictingWithKeyboard: false,
+ },
+ },
+ });
+ break;
+ }
case isMatchingLocation(location, AppPath.InviteTeam): {
resetFocusStackToFocusItem({
focusStackItem: {
diff --git a/packages/twenty-front/src/modules/onboarding/components/OnboardingCreditsRewardChip.tsx b/packages/twenty-front/src/modules/onboarding/components/OnboardingCreditsRewardChip.tsx
index 4738de6dc38..3eceba65da3 100644
--- a/packages/twenty-front/src/modules/onboarding/components/OnboardingCreditsRewardChip.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/OnboardingCreditsRewardChip.tsx
@@ -1,17 +1,28 @@
+import { useLingui } from '@lingui/react/macro';
import { IconCoins } from 'twenty-ui/icon';
import { Pill } from 'twenty-ui/primitives/data-display';
type OnboardingCreditsRewardChipProps = {
formattedCreditsReward: string;
+ isRewardPerItem?: boolean;
};
export const OnboardingCreditsRewardChip = ({
formattedCreditsReward,
-}: OnboardingCreditsRewardChipProps) => (
- <Pill
- Icon={IconCoins}
- label={`+${formattedCreditsReward}`}
- size="md"
- color="inherit"
- />
-);
+ isRewardPerItem = false,
+}: OnboardingCreditsRewardChipProps) => {
+ const { t } = useLingui();
+
+ return (
+ <Pill
+ Icon={IconCoins}
+ label={
+ isRewardPerItem
+ ? t`+${formattedCreditsReward} each`
+ : `+${formattedCreditsReward}`
+ }
+ size="md"
+ color="inherit"
+ />
+ );
+};
diff --git a/packages/twenty-front/src/modules/onboarding/components/OnboardingInviteTeamSkipDialog.tsx b/packages/twenty-front/src/modules/onboarding/components/OnboardingInviteTeamSkipDialog.tsx
new file mode 100644
index 00000000000..2df7ae3028f
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/components/OnboardingInviteTeamSkipDialog.tsx
@@ -0,0 +1,104 @@
+import { currentWorkspaceMemberState } from '@/auth/states/currentWorkspaceMemberState';
+import { OnboardingSkipDialog } from '@/onboarding/components/OnboardingSkipDialog';
+import { OnboardingSkipDialogAvatars } from '@/onboarding/components/OnboardingSkipDialogAvatars';
+import { ONBOARDING_INVITE_TEAM_EMPTY_SEATS_COUNT } from '@/onboarding/constants/OnboardingInviteTeamEmptySeatsCount';
+import { ONBOARDING_SKIP_DIALOG_IDS } from '@/onboarding/constants/OnboardingSkipDialogIds';
+import { onboardingCreditsProgressSelector } from '@/onboarding/states/selectors/onboardingCreditsProgressSelector';
+import { onboardingInviteTeamValidEmailsSelector } from '@/onboarding/states/selectors/onboardingInviteTeamValidEmailsSelector';
+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
+import { plural } from '@lingui/core/macro';
+import { useLingui } from '@lingui/react/macro';
+import { type ComponentProps } from 'react';
+import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';
+import { type DialogPopupProps } from 'twenty-ui/primitives/surfaces';
+import { getAbsoluteImageUrl } from '~/utils/image/getAbsoluteImageUrl';
+
+type OnboardingInviteTeamSkipDialogAvatar = ComponentProps<
+ typeof OnboardingSkipDialogAvatars
+>['avatars'][number];
+
+type OnboardingInviteTeamSkipDialogProps = {
+ isValid: boolean;
+ finalFocus: DialogPopupProps['finalFocus'];
+ onInvite: () => void;
+ onSkip: () => void;
+};
+
+export const OnboardingInviteTeamSkipDialog = ({
+ isValid,
+ finalFocus,
+ onInvite,
+ onSkip,
+}: OnboardingInviteTeamSkipDialogProps) => {
+ const { t } = useLingui();
+ const currentWorkspaceMember = useAtomStateValue(currentWorkspaceMemberState);
+ const onboardingInviteTeamValidEmails = useAtomStateValue(
+ onboardingInviteTeamValidEmailsSelector,
+ );
+ const { inviteTeamButtonReward } = useAtomStateValue(
+ onboardingCreditsProgressSelector,
+ );
+
+ const hasInviteEmails = isNonEmptyArray(onboardingInviteTeamValidEmails);
+
+ const currentWorkspaceMemberAvatars: OnboardingInviteTeamSkipDialogAvatar[] =
+ isDefined(currentWorkspaceMember)
+ ? [
+ {
+ id: currentWorkspaceMember.id,
+ name: `${currentWorkspaceMember.name.firstName} ${currentWorkspaceMember.name.lastName}`,
+ src: getAbsoluteImageUrl(currentWorkspaceMember.avatarUrl),
+ shape: 'circle',
+ },
+ ]
+ : [];
+ const teammateAvatars: OnboardingInviteTeamSkipDialogAvatar[] =
+ onboardingInviteTeamValidEmails.map((email) => ({
+ id: email,
+ name: email,
+ shape: 'circle',
+ }));
+
+ return (
+ <OnboardingSkipDialog
+ dialogId={ONBOARDING_SKIP_DIALOG_IDS.inviteTeam}
+ visual={
+ <OnboardingSkipDialogAvatars
+ avatars={[...currentWorkspaceMemberAvatars, ...teammateAvatars]}
+ emptySeatsCount={
+ hasInviteEmails ? 0 : ONBOARDING_INVITE_TEAM_EMPTY_SEATS_COUNT
+ }
+ />
+ }
+ title={
+ hasInviteEmails
+ ? plural(onboardingInviteTeamValidEmails.length, {
+ one: "Your invite isn't sent yet",
+ other: "Your # invites aren't sent yet",
+ })
+ : t`Twenty works better with your team`
+ }
+ description={
+ hasInviteEmails ? undefined : t`All it takes is their email.`
+ }
+ actions={[
+ hasInviteEmails && isValid
+ ? {
+ label: plural(onboardingInviteTeamValidEmails.length, {
+ one: 'Send invite',
+ other: 'Send # invites',
+ }),
+ ...inviteTeamButtonReward,
+ onClick: onInvite,
+ }
+ : {
+ label: t`Add teammates`,
+ ...inviteTeamButtonReward,
+ onClick: () => {},
+ },
+ ]}
+ finalFocus={finalFocus}
+ onSkip={onSkip}
+ />
+ );
+};
diff --git a/packages/twenty-front/src/modules/onboarding/components/OnboardingRewardMainButton.tsx b/packages/twenty-front/src/modules/onboarding/components/OnboardingRewardMainButton.tsx
index 20d7fe0f020..3cc814dfbe3 100644
--- a/packages/twenty-front/src/modules/onboarding/components/OnboardingRewardMainButton.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/OnboardingRewardMainButton.tsx
@@ -6,10 +6,12 @@ import { getOnboardingCreditsRewardAriaLabel } from '@/onboarding/utils/getOnboa
import { type Ref } from 'react';
import { isDefined } from 'twenty-shared/utils';
import { MainButton } from 'twenty-ui/components';
+import { Loader } from 'twenty-ui/primitives/feedback';
import { useTheme } from 'twenty-ui/theme';
type OnboardingRewardMainButtonProps = OnboardingRewardAction & {
- creditsReward: number;
+ disabled?: boolean;
+ isLoading?: boolean;
ref?: Ref<HTMLButtonElement>;
};
@@ -17,6 +19,9 @@ export const OnboardingRewardMainButton = ({
label,
Icon,
creditsReward,
+ isRewardPerItem = false,
+ disabled = false,
+ isLoading = false,
onClick,
ref,
}: OnboardingRewardMainButtonProps) => {
@@ -27,18 +32,26 @@ export const OnboardingRewardMainButton = ({
numberFormat,
);
+ const getStartIcon = () => {
+ if (isLoading) {
+ return <Loader />;
+ }
+
+ return isDefined(Icon) ? <Icon size={theme.icon.size.md} /> : undefined;
+ };
+
return (
<MainButton
ref={ref}
fullWidth
+ disabled={disabled || isLoading}
onClick={onClick}
- startIcon={
- isDefined(Icon) ? <Icon size={theme.icon.size.md} /> : undefined
- }
+ startIcon={getStartIcon()}
endIcon={
creditsReward > 0 ? (
<OnboardingCreditsRewardChip
formattedCreditsReward={formattedCreditsReward}
+ isRewardPerItem={isRewardPerItem}
/>
) : undefined
}
@@ -46,6 +59,7 @@ export const OnboardingRewardMainButton = ({
label,
creditsReward,
formattedCreditsReward,
+ isRewardPerItem,
})}
>
{label}
diff --git a/packages/twenty-front/src/modules/onboarding/components/OnboardingSkipDialog.tsx b/packages/twenty-front/src/modules/onboarding/components/OnboardingSkipDialog.tsx
index 46a21b53e1c..fa0e915905a 100644
--- a/packages/twenty-front/src/modules/onboarding/components/OnboardingSkipDialog.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/OnboardingSkipDialog.tsx
@@ -9,7 +9,7 @@ import { isDefined } from 'twenty-shared/utils';
import { IconButton } from 'twenty-ui/components';
import { IconX } from 'twenty-ui/icon';
import { Button } from 'twenty-ui/primitives/input';
-import { Dialog } from 'twenty-ui/primitives/surfaces';
+import { Dialog, type DialogPopupProps } from 'twenty-ui/primitives/surfaces';
import { themeCssVariables } from 'twenty-ui/theme';
const StyledHeader = styled(Dialog.Header)`
@@ -34,7 +34,7 @@ type OnboardingSkipDialogProps = {
title: string;
description?: string;
actions: OnboardingRewardAction[];
- creditsReward: number;
+ finalFocus?: DialogPopupProps['finalFocus'];
onSkip: () => void;
};
@@ -44,7 +44,7 @@ export const OnboardingSkipDialog = ({
title,
description,
actions,
- creditsReward,
+ finalFocus,
onSkip,
}: OnboardingSkipDialogProps) => {
const { t } = useLingui();
@@ -63,6 +63,7 @@ export const OnboardingSkipDialog = ({
{...{ container, backdrop, viewportProps, onKeyDown }}
size="compact"
initialFocus={firstActionRef}
+ finalFocus={finalFocus}
data-globally-prevent-click-outside
>
<StyledHeader>
@@ -89,13 +90,15 @@ export const OnboardingSkipDialog = ({
ref={index === 0 ? firstActionRef : undefined}
label={action.label}
Icon={action.Icon}
- creditsReward={creditsReward}
+ creditsReward={action.creditsReward}
+ isRewardPerItem={action.isRewardPerItem}
onClick={() => runAction(action)}
/>
))}
<Button
variant="ghost"
fullWidth
+ data-testid="onboarding-skip-dialog-skip-anyway"
onClick={() => {
closeDialog(dialogId);
onSkip();
diff --git a/packages/twenty-front/src/modules/onboarding/components/OnboardingSkipDialogAvatarItem.tsx b/packages/twenty-front/src/modules/onboarding/components/OnboardingSkipDialogAvatarItem.tsx
new file mode 100644
index 00000000000..71139c53197
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/components/OnboardingSkipDialogAvatarItem.tsx
@@ -0,0 +1,34 @@
+import { styled } from '@linaria/react';
+import { motion, useReducedMotion } from 'framer-motion';
+import { type ReactNode } from 'react';
+
+const StyledItem = styled(motion.div)`
+ display: flex;
+`;
+
+type OnboardingSkipDialogAvatarItemProps = {
+ index: number;
+ children: ReactNode;
+};
+
+export const OnboardingSkipDialogAvatarItem = ({
+ index,
+ children,
+}: OnboardingSkipDialogAvatarItemProps) => {
+ const shouldReduceMotion = useReducedMotion();
+
+ return (
+ <StyledItem
+ initial={{ opacity: 0, scale: shouldReduceMotion ? 1 : 0.6 }}
+ animate={{ opacity: 1, scale: 1 }}
+ transition={{
+ type: 'spring',
+ stiffness: 420,
+ damping: 22,
+ delay: index * 0.05,
+ }}
+ >
+ {children}
+ </StyledItem>
+ );
+};
diff --git a/packages/twenty-front/src/modules/onboarding/components/OnboardingSkipDialogAvatars.tsx b/packages/twenty-front/src/modules/onboarding/components/OnboardingSkipDialogAvatars.tsx
index 64cdd50b583..4562f4e7d9b 100644
--- a/packages/twenty-front/src/modules/onboarding/components/OnboardingSkipDialogAvatars.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/OnboardingSkipDialogAvatars.tsx
@@ -1,12 +1,31 @@
+import { OnboardingSkipDialogAvatarItem } from '@/onboarding/components/OnboardingSkipDialogAvatarItem';
import { styled } from '@linaria/react';
-import { motion, useReducedMotion } from 'framer-motion';
import { AvatarGroup } from 'twenty-ui/components';
-import { Avatar, type AvatarShape } from 'twenty-ui/primitives/data-display';
+import { IconPlus } from 'twenty-ui/icon';
+import {
+ AVATAR_PROPERTIES_BY_SIZE,
+ Avatar,
+ type AvatarShape,
+} from 'twenty-ui/primitives/data-display';
+import { themeCssVariables, useTheme } from 'twenty-ui/theme';
const MAX_VISIBLE_AVATARS = 5;
-const StyledItem = styled(motion.div)`
+const EMPTY_SEAT_SIZE = AVATAR_PROPERTIES_BY_SIZE.lg.width;
+
+const StyledEmptySeat = styled.div`
+ align-items: center;
+ background-color: ${themeCssVariables.background.primary};
+ border: 1px dashed ${themeCssVariables.border.color.strong};
+ border-radius: 50%;
+ box-shadow: 0 0 0 2px ${themeCssVariables.background.primary};
+ box-sizing: border-box;
+ color: ${themeCssVariables.font.color.light};
+ corner-shape: round;
display: flex;
+ height: ${EMPTY_SEAT_SIZE};
+ justify-content: center;
+ width: ${EMPTY_SEAT_SIZE};
`;
type OnboardingSkipDialogAvatar = {
@@ -18,41 +37,45 @@ type OnboardingSkipDialogAvatar = {
type OnboardingSkipDialogAvatarsProps = {
avatars: OnboardingSkipDialogAvatar[];
+ emptySeatsCount?: number;
};
export const OnboardingSkipDialogAvatars = ({
avatars,
+ emptySeatsCount = 0,
}: OnboardingSkipDialogAvatarsProps) => {
- const shouldReduceMotion = useReducedMotion();
+ const theme = useTheme();
const visibleAvatars = avatars.slice(0, MAX_VISIBLE_AVATARS);
return (
<AvatarGroup
- maxVisible={visibleAvatars.length}
+ maxVisible={visibleAvatars.length + emptySeatsCount}
overlapOffset="4px"
- avatars={visibleAvatars.map((avatar, index) => (
- <StyledItem
- key={avatar.id}
- initial={{ opacity: 0, scale: shouldReduceMotion ? 1 : 0.6 }}
- animate={{ opacity: 1, scale: 1 }}
- transition={{
- type: 'spring',
- stiffness: 420,
- damping: 22,
- delay: index * 0.05,
- }}
- >
- <Avatar
- src={avatar.src}
- name={avatar.name}
- colorSeed={avatar.id}
- size="lg"
- shape={avatar.shape}
- ring
- />
- </StyledItem>
- ))}
+ avatars={[
+ ...visibleAvatars.map((avatar, index) => (
+ <OnboardingSkipDialogAvatarItem key={avatar.id} index={index}>
+ <Avatar
+ src={avatar.src}
+ name={avatar.name}
+ colorSeed={avatar.id}
+ size="lg"
+ shape={avatar.shape}
+ ring
+ />
+ </OnboardingSkipDialogAvatarItem>
+ )),
+ ...Array.from({ length: emptySeatsCount }, (_, emptySeatIndex) => (
+ <OnboardingSkipDialogAvatarItem
+ key={`empty-seat-${emptySeatIndex}`}
+ index={visibleAvatars.length + emptySeatIndex}
+ >
+ <StyledEmptySeat>
+ <IconPlus size={theme.icon.size.sm} />
+ </StyledEmptySeat>
+ </OnboardingSkipDialogAvatarItem>
+ )),
+ ]}
/>
);
};
diff --git a/packages/twenty-front/src/modules/onboarding/components/__stories__/OnboardingCreditsRewardChip.stories.tsx b/packages/twenty-front/src/modules/onboarding/components/__stories__/OnboardingCreditsRewardChip.stories.tsx
index 8977f191b92..01897d7fb8c 100644
--- a/packages/twenty-front/src/modules/onboarding/components/__stories__/OnboardingCreditsRewardChip.stories.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/__stories__/OnboardingCreditsRewardChip.stories.tsx
@@ -19,3 +19,12 @@ export const Default: Story = {
await expect(await within(canvasElement).findByText('+2')).toBeVisible();
},
};
+
+export const PerItem: Story = {
+ args: { formattedCreditsReward: '0.5', isRewardPerItem: true },
+ play: async ({ canvasElement }) => {
+ await expect(
+ await within(canvasElement).findByText('+0.5 each'),
+ ).toBeVisible();
+ },
+};
diff --git a/packages/twenty-front/src/modules/onboarding/components/__stories__/OnboardingSkipDialog.stories.tsx b/packages/twenty-front/src/modules/onboarding/components/__stories__/OnboardingSkipDialog.stories.tsx
index 3281b495768..1cea65b00b0 100644
--- a/packages/twenty-front/src/modules/onboarding/components/__stories__/OnboardingSkipDialog.stories.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/__stories__/OnboardingSkipDialog.stories.tsx
@@ -63,15 +63,16 @@ const meta: Meta<typeof OnboardingSkipDialogExample> = {
{
label: 'Continue with Microsoft',
Icon: IconMicrosoft,
+ creditsReward: 2,
onClick: fn(),
},
{
label: 'Continue with Google',
Icon: IconGoogle,
+ creditsReward: 2,
onClick: fn(),
},
],
- creditsReward: 2,
onSkip: fn(),
},
};
@@ -92,7 +93,16 @@ export const Default: Story = {
};
export const WithoutCreditsReward: Story = {
- args: { creditsReward: 0 },
+ args: {
+ actions: [
+ {
+ label: 'Continue with Google',
+ Icon: IconGoogle,
+ creditsReward: 0,
+ onClick: fn(),
+ },
+ ],
+ },
play: async ({ canvasElement }) => {
const dialog = await openSkipDialog(canvasElement);
@@ -114,3 +124,25 @@ export const SkipAnyway: Story = {
await expect(args.onSkip).toHaveBeenCalledTimes(1);
},
};
+
+export const PerItemCreditsReward: Story = {
+ args: {
+ actions: [
+ {
+ label: 'Add teammates',
+ creditsReward: 0.5,
+ isRewardPerItem: true,
+ onClick: fn(),
+ },
+ ],
+ },
+ play: async ({ canvasElement }) => {
+ const dialog = await openSkipDialog(canvasElement);
+
+ await expect(
+ within(dialog).getByRole('button', {
+ name: 'Add teammates, earn 0.5 free credits each',
+ }),
+ ).toHaveTextContent('+0.5 each');
+ },
+};
diff --git a/packages/twenty-front/src/modules/onboarding/components/__stories__/OnboardingSkipDialogAvatars.stories.tsx b/packages/twenty-front/src/modules/onboarding/components/__stories__/OnboardingSkipDialogAvatars.stories.tsx
index 1d21f01cabb..8b7f950820a 100644
--- a/packages/twenty-front/src/modules/onboarding/components/__stories__/OnboardingSkipDialogAvatars.stories.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/__stories__/OnboardingSkipDialogAvatars.stories.tsx
@@ -32,6 +32,21 @@ export const Default: Story = {
},
};
+export const WithEmptySeats: Story = {
+ args: {
+ avatars: [{ id: 'Alice', name: 'Alice', shape: 'circle' }],
+ emptySeatsCount: 2,
+ },
+ play: async ({ canvasElement }) => {
+ const aliceAvatar = await within(canvasElement).findByText('A');
+
+ await waitFor(() => expect(aliceAvatar).toBeVisible());
+ await expect(
+ canvasElement.querySelectorAll('.tabler-icon-plus'),
+ ).toHaveLength(2);
+ },
+};
+
export const CapsVisibleAvatars: Story = {
args: {
avatars: ['Alice', 'Bruno', 'Chloe', 'David', 'Emma', 'Farid'].map(
diff --git a/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsPill.tsx b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsPill.tsx
index 29933c1fc57..84552e3902d 100644
--- a/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsPill.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingFreeCreditsPill.tsx
@@ -6,7 +6,7 @@ import { StyledOnboardingFreeCreditsCount } from '@/onboarding/components/free-c
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 { useMarkOnboardingFreeCreditsAsSeen } from '@/onboarding/hooks/useMarkOnboardingFreeCreditsAsSeen';
import { type OnboardingCreditsProgress } from '@/onboarding/types/OnboardingCreditsProgress';
import { formatOnboardingCredits } from '@/onboarding/utils/formatOnboardingCredits';
import { currentFocusedItemSelector } from '@/ui/utilities/focus/states/currentFocusedItemSelector';
@@ -138,13 +138,11 @@ export const OnboardingFreeCreditsPill = ({
goalCredits,
currentStep,
currentStepCredits,
- } = progress;
- const {
seenCredits,
newlyEarnedCredits,
isFirstCreditsGain,
- markCreditsAsSeen,
- } = useOnboardingNewlyEarnedCredits();
+ } = progress;
+ const markCreditsAsSeen = useMarkOnboardingFreeCreditsAsSeen();
const tooltipContent = useOnboardingFreeCreditsTooltipContent({
currentStep,
newlyEarnedCredits,
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
index 7d00e944686..549fec46a12 100644
--- a/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingHeaderFreeCredits.tsx
+++ b/packages/twenty-front/src/modules/onboarding/components/free-credits/OnboardingHeaderFreeCredits.tsx
@@ -1,16 +1,18 @@
import { OnboardingFreeCreditsPill } from '@/onboarding/components/free-credits/OnboardingFreeCreditsPill';
-import { useOnboardingCreditsProgress } from '@/onboarding/hooks/useOnboardingCreditsProgress';
-import { isDefined } from 'twenty-shared/utils';
+import { onboardingCreditsProgressSelector } from '@/onboarding/states/selectors/onboardingCreditsProgressSelector';
+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
export const OnboardingHeaderFreeCredits = () => {
- const progress = useOnboardingCreditsProgress();
+ const onboardingCreditsProgress = useAtomStateValue(
+ onboardingCreditsProgressSelector,
+ );
if (
- !isDefined(progress) ||
- (progress.goalCredits <= 0 && progress.currentStepCredits <= 0)
+ onboardingCreditsProgress.goalCredits <= 0 &&
+ onboardingCreditsProgress.currentStepCredits <= 0
) {
return null;
}
- return <OnboardingFreeCreditsPill progress={progress} />;
+ return <OnboardingFreeCreditsPill progress={onboardingCreditsProgress} />;
};
diff --git a/packages/twenty-front/src/modules/onboarding/constants/OnboardingCreditsProgressEmptyValue.ts b/packages/twenty-front/src/modules/onboarding/constants/OnboardingCreditsProgressEmptyValue.ts
new file mode 100644
index 00000000000..fb7a74786f0
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/constants/OnboardingCreditsProgressEmptyValue.ts
@@ -0,0 +1,21 @@
+import { type OnboardingCreditsProgress } from '@/onboarding/types/OnboardingCreditsProgress';
+
+export const ONBOARDING_CREDITS_PROGRESS_EMPTY_VALUE: OnboardingCreditsProgress =
+ {
+ rewardCreditsByStep: {
+ importContacts: 0,
+ installApps: 0,
+ createProfile: 0,
+ inviteTeam: 0,
+ upgradeTrial: 0,
+ },
+ earnedCredits: 0,
+ earnedCreditsByStep: [],
+ goalCredits: 0,
+ currentStep: null,
+ currentStepCredits: 0,
+ seenCredits: 0,
+ newlyEarnedCredits: 0,
+ isFirstCreditsGain: true,
+ inviteTeamButtonReward: { creditsReward: 0, isRewardPerItem: false },
+ };
diff --git a/packages/twenty-front/src/modules/onboarding/constants/OnboardingInstallableApps.ts b/packages/twenty-front/src/modules/onboarding/constants/OnboardingInstallableApps.ts
index e84adfea344..0a6222d3528 100644
--- a/packages/twenty-front/src/modules/onboarding/constants/OnboardingInstallableApps.ts
+++ b/packages/twenty-front/src/modules/onboarding/constants/OnboardingInstallableApps.ts
@@ -5,16 +5,16 @@ export const ONBOARDING_INSTALLABLE_APPS: OnboardingInstallableApp[] = [
{
universalIdentifier: '8da4b8b5-5edf-4880-b51f-ab6e679ec617',
label: msg`Call recorder`,
- description: msg`Record your calls and get transcripts`,
+ description: msg`Records and transcribes your meetings`,
},
{
universalIdentifier: '4a1178c1-3535-4a47-b592-231d3216b36f',
- label: msg`Enrichment`,
- description: msg`Enrich your leads with People Data Labs`,
+ label: msg`People Data Labs`,
+ description: msg`Enriches your people and companies`,
},
{
universalIdentifier: '66a504cc-0a75-410e-a43f-cdeae1db1522',
label: msg`Last contact`,
- description: msg`Get last contact date with relations`,
+ description: msg`Shows when you last talked to each contact`,
},
];
diff --git a/packages/twenty-front/src/modules/onboarding/constants/OnboardingInviteTeamEmptySeatsCount.ts b/packages/twenty-front/src/modules/onboarding/constants/OnboardingInviteTeamEmptySeatsCount.ts
new file mode 100644
index 00000000000..bbdde85a895
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/constants/OnboardingInviteTeamEmptySeatsCount.ts
@@ -0,0 +1 @@
+export const ONBOARDING_INVITE_TEAM_EMPTY_SEATS_COUNT = 2;
diff --git a/packages/twenty-front/src/modules/onboarding/constants/OnboardingSkipDialogIds.ts b/packages/twenty-front/src/modules/onboarding/constants/OnboardingSkipDialogIds.ts
index 4cbb41d725d..b25371c1070 100644
--- a/packages/twenty-front/src/modules/onboarding/constants/OnboardingSkipDialogIds.ts
+++ b/packages/twenty-front/src/modules/onboarding/constants/OnboardingSkipDialogIds.ts
@@ -1,3 +1,4 @@
export const ONBOARDING_SKIP_DIALOG_IDS = {
syncEmails: 'onboarding-sync-emails-skip-dialog',
+ inviteTeam: 'onboarding-invite-team-skip-dialog',
} as const;
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 50af65d51c3..650ccdb231b 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,18 +2,21 @@ 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 { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
import { type OnboardingConfig } from '@/client-config/types/OnboardingConfig';
import { useInstallOnboardingApps } from '@/onboarding/hooks/useInstallOnboardingApps';
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';
+import {
+ mockCurrentWorkspace,
+ mockedUserData,
+} from '~/testing/mock-data/users';
const mockTriggerInstallAppsOnboardingStep = jest.fn();
@@ -22,6 +25,8 @@ jest.mock('@/onboarding/hooks/useTriggerInstallAppsOnboardingStep', () => ({
mockTriggerInstallAppsOnboardingStep,
}));
+const AVAILABLE_APPS = ['app-1', 'app-2'];
+
const onboardingConfig: OnboardingConfig = {
importContactsCreditsReward: 2,
inviteTeamCreditsRewardPerUser: 3,
@@ -36,27 +41,16 @@ const Wrapper = ({ children }: { children: React.ReactNode }) =>
const renderInstallHook = () => {
const { result } = renderHook(
- () => {
- const setOnboardingConfig = useSetAtomState(onboardingConfigState);
- const onboardingFreeCredits = useAtomFamilyStateValue(
+ () => ({
+ onboardingFreeCredits: useAtomFamilyStateValue(
onboardingFreeCreditsFamilyState,
mockCurrentWorkspace.id,
- );
- const installOnboardingApps = useInstallOnboardingApps();
-
- return {
- setOnboardingConfig,
- onboardingFreeCredits,
- installOnboardingApps,
- };
- },
+ ),
+ installOnboardingApps: useInstallOnboardingApps(AVAILABLE_APPS),
+ }),
{ wrapper: Wrapper },
);
- act(() => {
- result.current.setOnboardingConfig(onboardingConfig);
- });
-
return result;
};
@@ -65,19 +59,37 @@ describe('useInstallOnboardingApps', () => {
localStorage.clear();
resetJotaiStore();
jotaiStore.set(currentWorkspaceState.atom, mockCurrentWorkspace);
+ jotaiStore.set(onboardingConfigState.atom, onboardingConfig);
+ jotaiStore.set(currentUserState.atom, {
+ ...mockedUserData,
+ isWorkspaceCreator: true,
+ });
mockTriggerInstallAppsOnboardingStep.mockReset();
});
- it('should credit the selected apps once the step succeeds', async () => {
+ it('should install and credit every available app by default', async () => {
mockTriggerInstallAppsOnboardingStep.mockResolvedValue(undefined);
const result = renderInstallHook();
- act(() => {
- result.current.installOnboardingApps.toggleApp('app-1');
+ await act(async () => {
+ await result.current.installOnboardingApps.installSelectedAppsAndContinue();
+ });
+
+ expect(mockTriggerInstallAppsOnboardingStep).toHaveBeenCalledWith({
+ universalIdentifiers: ['app-1', 'app-2'],
+ isAutoSkipped: false,
});
+ expect(result.current.onboardingFreeCredits.installApps).toBe(1);
+ });
+
+ it('should leave out the apps turned off', async () => {
+ mockTriggerInstallAppsOnboardingStep.mockResolvedValue(undefined);
+
+ const result = renderInstallHook();
+
act(() => {
- result.current.installOnboardingApps.toggleApp('app-2');
+ result.current.installOnboardingApps.toggleApp('app-1');
});
await act(async () => {
@@ -85,23 +97,42 @@ describe('useInstallOnboardingApps', () => {
});
expect(mockTriggerInstallAppsOnboardingStep).toHaveBeenCalledWith({
- universalIdentifiers: ['app-1', 'app-2'],
+ universalIdentifiers: ['app-2'],
isAutoSkipped: false,
});
+ });
+
+ it('should credit the apps as soon as their install starts', () => {
+ mockTriggerInstallAppsOnboardingStep.mockReturnValue(new Promise(() => {}));
+
+ const result = renderInstallHook();
+
+ act(() => {
+ void result.current.installOnboardingApps.installSelectedAppsAndContinue();
+ });
+
expect(result.current.onboardingFreeCredits.installApps).toBe(1);
});
- it('should reset the completing state and not credit when the step fails', async () => {
+ it('should not credit a skip', async () => {
+ mockTriggerInstallAppsOnboardingStep.mockResolvedValue(undefined);
+
+ const result = renderInstallHook();
+
+ await act(async () => {
+ await result.current.installOnboardingApps.skip();
+ });
+
+ expect(result.current.onboardingFreeCredits.installApps).toBe(0);
+ });
+
+ it('should reset the completing state and the credits when the step fails', async () => {
mockTriggerInstallAppsOnboardingStep.mockRejectedValue(
new Error('network error'),
);
const result = renderInstallHook();
- act(() => {
- result.current.installOnboardingApps.toggleApp('app-1');
- });
-
await act(async () => {
await result.current.installOnboardingApps.installSelectedAppsAndContinue();
});
@@ -117,10 +148,6 @@ describe('useInstallOnboardingApps', () => {
const result = renderInstallHook();
- act(() => {
- result.current.installOnboardingApps.toggleApp('app-1');
- });
-
await act(async () => {
await result.current.installOnboardingApps.installSelectedAppsAndContinue();
});
@@ -144,10 +171,6 @@ describe('useInstallOnboardingApps', () => {
const result = renderInstallHook();
- act(() => {
- result.current.installOnboardingApps.toggleApp('app-1');
- });
-
act(() => {
void result.current.installOnboardingApps.installSelectedAppsAndContinue();
});
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useInviteTeam.test.ts b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useInviteTeam.test.ts
index d134a29458d..5c2f39400b8 100644
--- a/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useInviteTeam.test.ts
+++ b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useInviteTeam.test.ts
@@ -1,17 +1,22 @@
import { i18n } from '@lingui/core';
import { I18nProvider } from '@lingui/react';
-import { act, renderHook } from '@testing-library/react';
+import { act, renderHook, waitFor } from '@testing-library/react';
import { Provider as JotaiProvider } from 'jotai';
import { SOURCE_LOCALE } from 'twenty-shared/translations';
import { dynamicActivate } from '~/utils/i18n/dynamicActivate';
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
import { isBookCallOnboardingStepEnabledState } from '@/client-config/states/isBookCallOnboardingStepEnabledState';
import { isCompanyEnrichmentEnabledState } from '@/client-config/states/isCompanyEnrichmentEnabledState';
+import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
import { useInviteTeam } from '@/onboarding/hooks/useInviteTeam';
+import { onboardingFreeCreditsFamilyState } from '@/onboarding/states/onboardingFreeCreditsFamilyState';
+import { onboardingInviteTeamEmailsDraftState } from '@/onboarding/states/onboardingInviteTeamEmailsDraftState';
import {
jotaiStore,
resetJotaiStore,
} from '@/ui/utilities/state/jotai/jotaiStore';
+import { mockCurrentWorkspace } from '~/testing/mock-data/users';
const mockSendInvitation = jest.fn();
const mockSetNextOnboardingStatus = jest.fn();
@@ -63,6 +68,7 @@ describe('useInviteTeam', () => {
localStorage.clear();
sessionStorage.clear();
resetJotaiStore();
+ jotaiStore.set(currentWorkspaceState.atom, mockCurrentWorkspace);
jest.clearAllMocks();
mockSendInvitation.mockResolvedValue({});
mockWaitForCompanyEnrichmentSettlement.mockResolvedValue(undefined);
@@ -196,4 +202,195 @@ describe('useInviteTeam', () => {
expect(result.current.isNavigating).toBe(false);
expect(mockSetNextOnboardingStatus).not.toHaveBeenCalled();
});
+
+ it('should credit the sent invites up to the maximum rewarded invites', async () => {
+ jotaiStore.set(onboardingConfigState.atom, {
+ importContactsCreditsReward: 1,
+ inviteTeamCreditsRewardPerUser: 0.5,
+ installAppsCreditsReward: 0.5,
+ createProfileCreditsReward: 0.5,
+ upgradeCreditsReward: 2,
+ inviteTeamMaxInvites: 2,
+ });
+ jotaiStore.set(onboardingInviteTeamEmailsDraftState.atom, [
+ '',
+ ]);
+ mockSendInvitation.mockResolvedValue({
+ data: {
+ sendInvitations: {
+ result: [
+ { email: '[email protected]' },
+ { email: '[email protected]' },
+ { email: '[email protected]' },
+ ],
+ },
+ },
+ });
+
+ const { result } = renderInviteTeam();
+
+ act(() => {
+ result.current.handleInvite();
+ });
+
+ await waitFor(() => expect(mockSetNextOnboardingStatus).toHaveBeenCalled());
+ expect(
+ jotaiStore.get(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ ).inviteTeam,
+ ).toBe(1);
+ });
+
+ it('should bring the typed emails back when going back after the server rejected them all', async () => {
+ jotaiStore.set(onboardingInviteTeamEmailsDraftState.atom, [
+ '',
+ ]);
+ mockSendInvitation.mockResolvedValue({
+ data: {
+ sendInvitations: {
+ success: false,
+ errors: [
+ '[email protected] already invited',
+ '[email protected] is already in the workspace',
+ ],
+ result: [],
+ },
+ },
+ });
+
+ const { result, unmount } = renderInviteTeam();
+
+ act(() => {
+ result.current.handleInvite();
+ });
+
+ await waitFor(() =>
+ expect(mockSetNextOnboardingStatus).toHaveBeenCalledWith({
+ stepHistoryEffect: 'recordAsReversible',
+ }),
+ );
+ unmount();
+
+ const { result: resultAfterGoingBack } = renderInviteTeam();
+
+ expect(
+ resultAfterGoingBack.current.fields.map(({ email }) => email),
+ ).toEqual(['[email protected]', '[email protected]', '']);
+ });
+
+ it('should show the server errors instead of the success toast when every invitation is rejected', async () => {
+ jotaiStore.set(onboardingInviteTeamEmailsDraftState.atom, [
+ '',
+ ]);
+ mockSendInvitation.mockResolvedValue({
+ data: {
+ sendInvitations: {
+ success: false,
+ errors: ['[email protected] already invited'],
+ result: [],
+ },
+ },
+ });
+
+ const { result } = renderInviteTeam();
+
+ act(() => {
+ result.current.handleInvite();
+ });
+
+ await waitFor(() => expect(mockSetNextOnboardingStatus).toHaveBeenCalled());
+ expect(mockEnqueueToast).toHaveBeenCalledTimes(1);
+ expect(mockEnqueueToast).toHaveBeenCalledWith(
+ expect.objectContaining({
+ variant: 'error',
+ children: '[email protected] already invited',
+ }),
+ );
+ });
+
+ it('should drop the invite credits on skip and keep the typed emails', async () => {
+ jotaiStore.set(onboardingInviteTeamEmailsDraftState.atom, [
+ '',
+ ]);
+ jotaiStore.set(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ {
+ ...jotaiStore.get(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ ),
+ inviteTeam: 0.5,
+ },
+ );
+
+ const { result } = renderInviteTeam();
+
+ await act(async () => {
+ await result.current.handleSkip();
+ });
+
+ expect(
+ jotaiStore.get(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ ).inviteTeam,
+ ).toBe(0);
+ expect(jotaiStore.get(onboardingInviteTeamEmailsDraftState.atom)).toEqual([
+ '',
+ ]);
+ });
+
+ it('should send the invitations once when inviting again while they are being sent', async () => {
+ let resolveInvitation: (value: unknown) => void = () => {};
+
+ jotaiStore.set(onboardingInviteTeamEmailsDraftState.atom, [
+ '',
+ ]);
+ mockSendInvitation.mockReturnValue(
+ new Promise((resolve) => {
+ resolveInvitation = resolve;
+ }),
+ );
+
+ const { result } = renderInviteTeam();
+
+ await act(async () => {
+ result.current.handleInvite();
+ });
+
+ await waitFor(() => expect(mockSendInvitation).toHaveBeenCalledTimes(1));
+
+ await act(async () => {
+ result.current.handleInvite();
+ });
+
+ await act(async () => {
+ resolveInvitation({});
+ });
+
+ expect(mockSendInvitation).toHaveBeenCalledTimes(1);
+ });
+
+ it('should aim the focus at the first invalid email restored from the draft when the skip dialog opens', async () => {
+ jotaiStore.set(onboardingInviteTeamEmailsDraftState.atom, [
+ 'alan@',
+ '',
+ ]);
+
+ const { result } = renderInviteTeam();
+
+ await act(async () => {
+ await result.current.openSkipDialog();
+ });
+
+ expect(result.current.emailIndexToFocus).toBe(1);
+ });
});
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useMarkOnboardingFreeCreditsAsSeen.test.ts b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useMarkOnboardingFreeCreditsAsSeen.test.ts
new file mode 100644
index 00000000000..bff1847bf2a
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useMarkOnboardingFreeCreditsAsSeen.test.ts
@@ -0,0 +1,116 @@
+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 { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
+import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
+import { useMarkOnboardingFreeCreditsAsSeen } from '@/onboarding/hooks/useMarkOnboardingFreeCreditsAsSeen';
+import { onboardingCreateProfileDraftState } from '@/onboarding/states/onboardingCreateProfileDraftState';
+import { onboardingFreeCreditsFamilyState } from '@/onboarding/states/onboardingFreeCreditsFamilyState';
+import { onboardingCreditsProgressSelector } from '@/onboarding/states/selectors/onboardingCreditsProgressSelector';
+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
+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,
+ });
+
+const renderMarkCreditsAsSeenHook = () =>
+ renderHook(
+ () => ({
+ progress: useAtomStateValue(onboardingCreditsProgressSelector),
+ markCreditsAsSeen: useMarkOnboardingFreeCreditsAsSeen(),
+ }),
+ { wrapper: Wrapper },
+ ).result;
+
+describe('useMarkOnboardingFreeCreditsAsSeen', () => {
+ beforeEach(() => {
+ localStorage.clear();
+ resetJotaiStore();
+ jotaiStore.set(currentWorkspaceState.atom, mockCurrentWorkspace);
+ jotaiStore.set(onboardingConfigState.atom, {
+ importContactsCreditsReward: 2,
+ inviteTeamCreditsRewardPerUser: 0.5,
+ installAppsCreditsReward: 1,
+ createProfileCreditsReward: 0.5,
+ upgradeCreditsReward: 0.5,
+ inviteTeamMaxInvites: 4,
+ });
+ });
+
+ 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 = renderMarkCreditsAsSeenHook();
+
+ expect(result.current.progress.newlyEarnedCredits).toBe(0);
+
+ act(() => {
+ result.current.markCreditsAsSeen();
+ });
+
+ expect(result.current.progress.seenCredits).toBe(0);
+
+ act(() => {
+ setOnboardingStatus(OnboardingStatus.APPS_INSTALLATION);
+ });
+
+ expect(result.current.progress.newlyEarnedCredits).toBe(2);
+ });
+
+ it('should mark the counted credits as seen', () => {
+ setOnboardingStatus(OnboardingStatus.APPS_INSTALLATION);
+ jotaiStore.set(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ { ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE, importContacts: 2 },
+ );
+
+ const result = renderMarkCreditsAsSeenHook();
+
+ act(() => {
+ result.current.markCreditsAsSeen();
+ });
+
+ expect(result.current.progress.seenCredits).toBe(2);
+ expect(result.current.progress.newlyEarnedCredits).toBe(0);
+ });
+
+ it('should stop announcing the typed profile credits once they are seen', () => {
+ setOnboardingStatus(OnboardingStatus.PROFILE_CREATION);
+ jotaiStore.set(onboardingCreateProfileDraftState.atom, {
+ firstName: 'Tim',
+ lastName: 'Apple',
+ });
+
+ const result = renderMarkCreditsAsSeenHook();
+
+ expect(result.current.progress.newlyEarnedCredits).toBe(0.5);
+
+ act(() => {
+ result.current.markCreditsAsSeen();
+ });
+
+ expect(result.current.progress.newlyEarnedCredits).toBe(0);
+ });
+});
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
deleted file mode 100644
index 27938399e8e..00000000000
--- a/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useOnboardingNewlyEarnedCredits.test.ts
+++ /dev/null
@@ -1,62 +0,0 @@
-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
index acf2a7b392d..0e3f42b2127 100644
--- a/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useSetOnboardingStepFreeCredits.test.ts
+++ b/packages/twenty-front/src/modules/onboarding/hooks/__tests__/useSetOnboardingStepFreeCredits.test.ts
@@ -2,16 +2,23 @@ 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 { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
import { ONBOARDING_FREE_CREDITS_DEFAULT_VALUE } from '@/onboarding/constants/OnboardingFreeCreditsDefaultValue';
import { useSetOnboardingStepFreeCredits } from '@/onboarding/hooks/useSetOnboardingStepFreeCredits';
import { onboardingFreeCreditsFamilyState } from '@/onboarding/states/onboardingFreeCreditsFamilyState';
+import { onboardingCreditsProgressSelector } from '@/onboarding/states/selectors/onboardingCreditsProgressSelector';
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';
+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);
@@ -33,6 +40,19 @@ describe('useSetOnboardingStepFreeCredits', () => {
localStorage.clear();
resetJotaiStore();
jotaiStore.set(currentWorkspaceState.atom, mockCurrentWorkspace);
+ jotaiStore.set(onboardingConfigState.atom, {
+ importContactsCreditsReward: 2,
+ inviteTeamCreditsRewardPerUser: 0.5,
+ installAppsCreditsReward: 1,
+ createProfileCreditsReward: 0.5,
+ upgradeCreditsReward: 4,
+ inviteTeamMaxInvites: 4,
+ });
+ jotaiStore.set(currentUserState.atom, {
+ ...mockedUserData,
+ isWorkspaceCreator: true,
+ onboardingStatus: OnboardingStatus.COMPLETED,
+ });
});
it('should keep the seen credits when a step earns more', () => {
@@ -199,4 +219,30 @@ describe('useSetOnboardingStepFreeCredits', () => {
seenCredits: 2,
});
});
+
+ it('should announce a new gain after credits counted but never stored were seen', () => {
+ jotaiStore.set(currentUserState.atom, {
+ ...mockedUserData,
+ isWorkspaceCreator: true,
+ onboardingStatus: OnboardingStatus.APPS_INSTALLATION,
+ });
+ jotaiStore.set(
+ onboardingFreeCreditsFamilyState.atomFamily(mockCurrentWorkspace.id),
+ {
+ ...ONBOARDING_FREE_CREDITS_DEFAULT_VALUE,
+ importContacts: 2,
+ seenCredits: 2.5,
+ },
+ );
+
+ const result = renderSetStepFreeCreditsHook();
+
+ act(() => {
+ result.current.setOnboardingStepFreeCredits('installApps', 1);
+ });
+
+ expect(
+ jotaiStore.get(onboardingCreditsProgressSelector.atom).newlyEarnedCredits,
+ ).toBe(1);
+ });
});
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useInstallOnboardingApps.ts b/packages/twenty-front/src/modules/onboarding/hooks/useInstallOnboardingApps.ts
index 363900f7dca..3483f250989 100644
--- a/packages/twenty-front/src/modules/onboarding/hooks/useInstallOnboardingApps.ts
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useInstallOnboardingApps.ts
@@ -1,25 +1,34 @@
-import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
import { useSetOnboardingStepFreeCredits } from '@/onboarding/hooks/useSetOnboardingStepFreeCredits';
import { useTriggerInstallAppsOnboardingStep } from '@/onboarding/hooks/useTriggerInstallAppsOnboardingStep';
-import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
+import { onboardingCreditsProgressSelector } from '@/onboarding/states/selectors/onboardingCreditsProgressSelector';
+import { useStore } from 'jotai';
import { useState } from 'react';
import { isNonEmptyArray } from 'twenty-shared/utils';
-export const useInstallOnboardingApps = () => {
- const onboardingConfig = useAtomStateValue(onboardingConfigState);
+export const useInstallOnboardingApps = (
+ availableUniversalIdentifiers: string[],
+) => {
+ const store = useStore();
const setOnboardingStepFreeCredits = useSetOnboardingStepFreeCredits();
const triggerInstallAppsOnboardingStep =
useTriggerInstallAppsOnboardingStep();
- const [selectedUniversalIdentifiers, setSelectedUniversalIdentifiers] =
+ const [deselectedUniversalIdentifiers, setDeselectedUniversalIdentifiers] =
useState<string[]>([]);
const [isCompleting, setIsCompleting] = useState(false);
+ const selectedUniversalIdentifiers = availableUniversalIdentifiers.filter(
+ (universalIdentifier) =>
+ !deselectedUniversalIdentifiers.includes(universalIdentifier),
+ );
+
const toggleApp = (universalIdentifier: string) => {
- setSelectedUniversalIdentifiers((current) =>
- current.includes(universalIdentifier)
- ? current.filter((identifier) => identifier !== universalIdentifier)
- : [...current, universalIdentifier],
+ setDeselectedUniversalIdentifiers((currentDeselected) =>
+ currentDeselected.includes(universalIdentifier)
+ ? currentDeselected.filter(
+ (identifier) => identifier !== universalIdentifier,
+ )
+ : [...currentDeselected, universalIdentifier],
);
};
@@ -29,19 +38,22 @@ export const useInstallOnboardingApps = () => {
}
setIsCompleting(true);
+ const installAppsCreditsReward = store.get(
+ onboardingCreditsProgressSelector.atom,
+ ).rewardCreditsByStep.installApps;
+
+ setOnboardingStepFreeCredits(
+ 'installApps',
+ isNonEmptyArray(universalIdentifiers) ? installAppsCreditsReward : 0,
+ );
+
try {
await triggerInstallAppsOnboardingStep({
universalIdentifiers,
isAutoSkipped: false,
});
-
- const creditsReward = onboardingConfig?.installAppsCreditsReward ?? 0;
-
- setOnboardingStepFreeCredits(
- 'installApps',
- isNonEmptyArray(universalIdentifiers) ? creditsReward : 0,
- );
} catch {
+ setOnboardingStepFreeCredits('installApps', 0);
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 5b4dafd9fc3..5ab742a5e24 100644
--- a/packages/twenty-front/src/modules/onboarding/hooks/useInviteTeam.ts
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useInviteTeam.ts
@@ -1,11 +1,17 @@
import { isBookCallOnboardingStepEnabledState } from '@/client-config/states/isBookCallOnboardingStepEnabledState';
import { isCompanyEnrichmentEnabledState } from '@/client-config/states/isCompanyEnrichmentEnabledState';
import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
+import { ONBOARDING_SKIP_DIALOG_IDS } from '@/onboarding/constants/OnboardingSkipDialogIds';
+import { useOnboardingStepEnterHotkey } from '@/onboarding/hooks/useOnboardingStepEnterHotkey';
import { useSetNextOnboardingStatus } from '@/onboarding/hooks/useSetNextOnboardingStatus';
import { useSetOnboardingStepFreeCredits } from '@/onboarding/hooks/useSetOnboardingStepFreeCredits';
+import { onboardingInviteTeamEmailsDraftState } from '@/onboarding/states/onboardingInviteTeamEmailsDraftState';
+import { onboardingInviteTeamValidEmailsSelector } from '@/onboarding/states/selectors/onboardingInviteTeamValidEmailsSelector';
+import { getInviteTeamCreditsReward } from '@/onboarding/utils/getInviteTeamCreditsReward';
+import { getValidInviteEmails } from '@/onboarding/utils/getValidInviteEmails';
import { waitForCompanyEnrichmentSettlement } from '@/onboarding/utils/waitForCompanyEnrichmentSettlement';
import { PageFocusId } from '@/types/PageFocusId';
-import { useHotkeysOnFocusedElement } from '@/ui/utilities/hotkey/hooks/useHotkeysOnFocusedElement';
+import { useDialog } from '@/ui/layout/dialog/hooks/useDialog';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { useCreateWorkspaceInvitation } from '@/workspace-invitation/hooks/useCreateWorkspaceInvitation';
import { useQuery } from '@apollo/client/react';
@@ -14,8 +20,7 @@ import { useLingui } from '@lingui/react/macro';
import { useStore } from 'jotai';
import { useCallback, useEffect, useMemo, useState } from 'react';
import { type SubmitHandler, useFieldArray, useForm } from 'react-hook-form';
-import { Key } from 'ts-key-enum';
-import { isDefined } from 'twenty-shared/utils';
+import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';
import { useToast } from 'twenty-ui/components';
import { z } from 'zod';
import { GetInviteSuggestionsDocument } from '~/generated-metadata/graphql';
@@ -32,7 +37,6 @@ export const useInviteTeam = () => {
const { sendInvitation } = useCreateWorkspaceInvitation();
const setNextOnboardingStatus = useSetNextOnboardingStatus();
const setOnboardingStepFreeCredits = useSetOnboardingStepFreeCredits();
- const onboardingConfig = useAtomStateValue(onboardingConfigState);
const isBookCallOnboardingStepEnabled = useAtomStateValue(
isBookCallOnboardingStepEnabledState,
);
@@ -40,19 +44,29 @@ export const useInviteTeam = () => {
isCompanyEnrichmentEnabledState,
);
const store = useStore();
+ const { openDialog } = useDialog();
const [isNavigating, setIsNavigating] = useState(false);
+ const [emailIndexToFocus, setEmailIndexToFocus] = useState(0);
+ const [initialEmailsDraft] = useState(() =>
+ store.get(onboardingInviteTeamEmailsDraftState.atom),
+ );
const {
control,
handleSubmit,
watch,
reset,
+ getValues,
+ trigger,
+ getFieldState,
formState: { isValid, isSubmitting, isDirty },
} = useForm<InviteTeamFormInput>({
mode: 'onChange',
defaultValues: {
- emails: [{ email: '' }, { email: '' }, { email: '' }],
+ emails: isDefined(initialEmailsDraft)
+ ? initialEmailsDraft.map((email) => ({ email }))
+ : [{ email: '' }, { email: '' }, { email: '' }],
},
resolver: zodResolver(validationSchema),
});
@@ -62,7 +76,9 @@ export const useInviteTeam = () => {
name: 'emails',
});
- const [hasPrefilledSuggestions, setHasPrefilledSuggestions] = useState(false);
+ const [hasPrefilledSuggestions, setHasPrefilledSuggestions] = useState(
+ isDefined(initialEmailsDraft),
+ );
const { data: inviteSuggestionsData } = useQuery(
GetInviteSuggestionsDocument,
@@ -103,6 +119,10 @@ export const useInviteTeam = () => {
return;
}
const emailValues = emails.map((email) => email?.email);
+ store.set(
+ onboardingInviteTeamEmailsDraftState.atom,
+ emailValues.map((email) => email ?? ''),
+ );
if (emailValues[emailValues.length - 1] !== '') {
append({ email: '' });
}
@@ -115,7 +135,7 @@ export const useInviteTeam = () => {
});
return () => subscription.unsubscribe();
- }, [watch, append, remove]);
+ }, [watch, append, remove, store]);
const getPlaceholder = (emailIndex: number) => {
if (emailIndex === 0) {
@@ -132,12 +152,8 @@ export const useInviteTeam = () => {
const onSubmit: SubmitHandler<InviteTeamFormInput> = useCallback(
async (data) => {
- const emails = Array.from(
- new Set(
- data.emails
- .map((emailData) => emailData.email.trim())
- .filter((email) => email.length > 0),
- ),
+ const emails = getValidInviteEmails(
+ data.emails.map((emailData) => emailData.email),
);
setIsNavigating(true);
@@ -158,19 +174,29 @@ export const useInviteTeam = () => {
const sentInvitationsCount =
result.data?.sendInvitations.result.length ?? 0;
-
- const creditsRewardPerUser =
- onboardingConfig?.inviteTeamCreditsRewardPerUser ?? 0;
- const maxRewardedInvitationsCount =
- onboardingConfig?.inviteTeamMaxInvites ?? 0;
+ const invitationErrors = result.data?.sendInvitations.errors ?? [];
setOnboardingStepFreeCredits(
'inviteTeam',
- Math.min(sentInvitationsCount, maxRewardedInvitationsCount) *
- creditsRewardPerUser,
+ getInviteTeamCreditsReward({
+ invitedTeammatesCount: sentInvitationsCount,
+ onboardingConfig: store.get(onboardingConfigState.atom),
+ }),
);
- if (emails.length > 0) {
+ if (
+ sentInvitationsCount === 0 &&
+ isNonEmptyArray(emails) &&
+ isNonEmptyArray(invitationErrors)
+ ) {
+ enqueueToast({
+ variant: 'error',
+ children: invitationErrors.join(', '),
+ duration: 5000,
+ });
+ }
+
+ if (sentInvitationsCount > 0) {
enqueueToast({
variant: 'success',
children: t`Invite link sent to email addresses`,
@@ -196,8 +222,6 @@ export const useInviteTeam = () => {
enqueueToast,
isBookCallOnboardingStepEnabled,
isCompanyEnrichmentEnabled,
- onboardingConfig?.inviteTeamCreditsRewardPerUser,
- onboardingConfig?.inviteTeamMaxInvites,
sendInvitation,
setNextOnboardingStatus,
setOnboardingStepFreeCredits,
@@ -210,22 +234,45 @@ export const useInviteTeam = () => {
await onSubmit({ emails: [] });
};
- useHotkeysOnFocusedElement({
- keys: Key.Enter,
- callback: () => {
- handleSubmit(onSubmit)();
- },
+ const openSkipDialog = async () => {
+ await trigger();
+
+ const firstInvalidEmailIndex = getValues('emails').findIndex(
+ (_, index) => getFieldState(`emails.${index}.email`).invalid,
+ );
+
+ setEmailIndexToFocus(Math.max(firstInvalidEmailIndex, 0));
+ openDialog(ONBOARDING_SKIP_DIALOG_IDS.inviteTeam);
+ };
+
+ const handleInvite = () => {
+ if (isSubmitting || isNavigating) {
+ return;
+ }
+
+ if (
+ !isNonEmptyArray(store.get(onboardingInviteTeamValidEmailsSelector.atom))
+ ) {
+ void openSkipDialog();
+ return;
+ }
+
+ void handleSubmit(onSubmit)();
+ };
+
+ useOnboardingStepEnterHotkey({
focusId: PageFocusId.InviteTeam,
- dependencies: [handleSubmit, onSubmit],
+ onEnter: handleInvite,
});
return {
control,
fields,
remove,
- handleSubmit,
- onSubmit,
handleSkip,
+ handleInvite,
+ openSkipDialog,
+ emailIndexToFocus,
getPlaceholder,
isValid,
isSubmitting,
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useMarkOnboardingFreeCreditsAsSeen.ts b/packages/twenty-front/src/modules/onboarding/hooks/useMarkOnboardingFreeCreditsAsSeen.ts
new file mode 100644
index 00000000000..2d9df2f8a22
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useMarkOnboardingFreeCreditsAsSeen.ts
@@ -0,0 +1,18 @@
+import { useSetCurrentWorkspaceOnboardingFreeCredits } from '@/onboarding/hooks/useSetCurrentWorkspaceOnboardingFreeCredits';
+import { onboardingCreditsProgressSelector } from '@/onboarding/states/selectors/onboardingCreditsProgressSelector';
+import { useStore } from 'jotai';
+
+export const useMarkOnboardingFreeCreditsAsSeen = () => {
+ const store = useStore();
+ const setOnboardingFreeCredits =
+ useSetCurrentWorkspaceOnboardingFreeCredits();
+
+ return () => {
+ const { earnedCredits } = store.get(onboardingCreditsProgressSelector.atom);
+
+ setOnboardingFreeCredits((current) => ({
+ ...current,
+ seenCredits: earnedCredits,
+ }));
+ };
+};
diff --git a/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingCreditsProgress.ts b/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingCreditsProgress.ts
deleted file mode 100644
index d51c34259b3..00000000000
--- a/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingCreditsProgress.ts
+++ /dev/null
@@ -1,28 +0,0 @@
-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/useOnboardingNewlyEarnedCredits.ts b/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingNewlyEarnedCredits.ts
deleted file mode 100644
index cea30387e96..00000000000
--- a/packages/twenty-front/src/modules/onboarding/hooks/useOnboardingNewlyEarnedCredits.ts
+++ /dev/null
@@ -1,42 +0,0 @@
-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/useSetOnboardingStepFreeCredits.ts b/packages/twenty-front/src/modules/onboarding/hooks/useSetOnboardingStepFreeCredits.ts
index 2fe2e2efc24..c64e08a29a1 100644
--- a/packages/twenty-front/src/modules/onboarding/hooks/useSetOnboardingStepFreeCredits.ts
+++ b/packages/twenty-front/src/modules/onboarding/hooks/useSetOnboardingStepFreeCredits.ts
@@ -1,6 +1,8 @@
+import { ONBOARDING_CREDITS_STEPS } from '@/onboarding/constants/OnboardingCreditsSteps';
import { useSetCurrentWorkspaceOnboardingFreeCredits } from '@/onboarding/hooks/useSetCurrentWorkspaceOnboardingFreeCredits';
+import { onboardingCreditsProgressSelector } from '@/onboarding/states/selectors/onboardingCreditsProgressSelector';
import { type OnboardingCreditsStep } from '@/onboarding/types/OnboardingCreditsStep';
-import { getOnboardingEarnedCredits } from '@/onboarding/utils/getOnboardingEarnedCredits';
+import { useStore } from 'jotai';
import { useCallback } from 'react';
type SetOnboardingStepFreeCreditsOptions = {
@@ -8,6 +10,7 @@ type SetOnboardingStepFreeCreditsOptions = {
};
export const useSetOnboardingStepFreeCredits = () => {
+ const store = useStore();
const setOnboardingFreeCredits =
useSetCurrentWorkspaceOnboardingFreeCredits();
@@ -16,19 +19,31 @@ export const useSetOnboardingStepFreeCredits = () => {
step: OnboardingCreditsStep,
credits: number,
{ isQuiet = false }: SetOnboardingStepFreeCreditsOptions = {},
- ) =>
+ ) => {
+ const { earnedCredits } = store.get(
+ onboardingCreditsProgressSelector.atom,
+ );
+
setOnboardingFreeCredits((current) => {
const onboardingFreeCredits = { ...current, [step]: credits };
const quietCreditsChange = isQuiet ? credits - current[step] : 0;
-
+ const storedCredits = ONBOARDING_CREDITS_STEPS.reduce(
+ (total, creditsStep) => total + onboardingFreeCredits[creditsStep],
+ 0,
+ );
return {
...onboardingFreeCredits,
- seenCredits: Math.min(
- Math.max(0, current.seenCredits + quietCreditsChange),
- getOnboardingEarnedCredits(onboardingFreeCredits),
+ seenCredits: Math.max(
+ 0,
+ Math.min(
+ current.seenCredits + quietCreditsChange,
+ storedCredits,
+ earnedCredits + quietCreditsChange,
+ ),
),
};
- }),
- [setOnboardingFreeCredits],
+ });
+ },
+ [setOnboardingFreeCredits, store],
);
};
diff --git a/packages/twenty-front/src/modules/onboarding/states/onboardingCreateProfileDraftState.ts b/packages/twenty-front/src/modules/onboarding/states/onboardingCreateProfileDraftState.ts
new file mode 100644
index 00000000000..3c687173605
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/states/onboardingCreateProfileDraftState.ts
@@ -0,0 +1,8 @@
+import { createAtomState } from '@/ui/utilities/state/jotai/utils/createAtomState';
+import { type FullNameMetadata } from 'twenty-shared/types';
+
+export const onboardingCreateProfileDraftState =
+ createAtomState<FullNameMetadata | null>({
+ key: 'onboardingCreateProfileDraftState',
+ defaultValue: null,
+ });
diff --git a/packages/twenty-front/src/modules/onboarding/states/onboardingInviteTeamEmailsDraftState.ts b/packages/twenty-front/src/modules/onboarding/states/onboardingInviteTeamEmailsDraftState.ts
new file mode 100644
index 00000000000..f528a48ac8b
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/states/onboardingInviteTeamEmailsDraftState.ts
@@ -0,0 +1,8 @@
+import { createAtomState } from '@/ui/utilities/state/jotai/utils/createAtomState';
+
+export const onboardingInviteTeamEmailsDraftState = createAtomState<
+ string[] | null
+>({
+ key: 'onboardingInviteTeamEmailsDraftState',
+ defaultValue: null,
+});
diff --git a/packages/twenty-front/src/modules/onboarding/states/selectors/__tests__/onboardingCreditsProgressSelector.test.ts b/packages/twenty-front/src/modules/onboarding/states/selectors/__tests__/onboardingCreditsProgressSelector.test.ts
new file mode 100644
index 00000000000..d840583db24
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/states/selectors/__tests__/onboardingCreditsProgressSelector.test.ts
@@ -0,0 +1,115 @@
+import { createStore } from 'jotai';
+import { type FullNameMetadata } from 'twenty-shared/types';
+
+import { currentUserState } from '@/auth/states/currentUserState';
+import { currentWorkspaceMemberState } from '@/auth/states/currentWorkspaceMemberState';
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
+import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
+import { ONBOARDING_CREDITS_PROGRESS_EMPTY_VALUE } from '@/onboarding/constants/OnboardingCreditsProgressEmptyValue';
+import { onboardingCreateProfileDraftState } from '@/onboarding/states/onboardingCreateProfileDraftState';
+import { onboardingInviteTeamEmailsDraftState } from '@/onboarding/states/onboardingInviteTeamEmailsDraftState';
+import { onboardingCreditsProgressSelector } from '@/onboarding/states/selectors/onboardingCreditsProgressSelector';
+import { OnboardingStatus } from '~/generated-metadata/graphql';
+import {
+ mockCurrentWorkspace,
+ mockedUserData,
+ mockedWorkspaceMemberData,
+} from '~/testing/mock-data/users';
+
+const PROFILE_NAME_CASES: {
+ title: string;
+ onboardingCreateProfileDraft: FullNameMetadata | null;
+ workspaceMemberName: FullNameMetadata;
+ earnedCredits: number;
+}[] = [
+ {
+ title: 'count the typed names',
+ onboardingCreateProfileDraft: { firstName: 'Tim', lastName: 'Apple' },
+ workspaceMemberName: { firstName: '', lastName: '' },
+ earnedCredits: 0.5,
+ },
+ {
+ title: 'count the saved names when nothing is typed',
+ onboardingCreateProfileDraft: null,
+ workspaceMemberName: { firstName: 'Tim', lastName: 'Apple' },
+ earnedCredits: 0.5,
+ },
+ {
+ title: 'prefer a typed empty name over the saved names',
+ onboardingCreateProfileDraft: { firstName: 'Tim', lastName: '' },
+ workspaceMemberName: { firstName: 'Tim', lastName: 'Apple' },
+ earnedCredits: 0,
+ },
+];
+
+const buildStore = () => {
+ const store = createStore();
+
+ store.set(currentWorkspaceState.atom, mockCurrentWorkspace);
+ store.set(currentUserState.atom, {
+ ...mockedUserData,
+ isWorkspaceCreator: true,
+ onboardingStatus: OnboardingStatus.PROFILE_CREATION,
+ });
+ store.set(onboardingConfigState.atom, {
+ importContactsCreditsReward: 1,
+ inviteTeamCreditsRewardPerUser: 0.5,
+ installAppsCreditsReward: 0.5,
+ createProfileCreditsReward: 0.5,
+ upgradeCreditsReward: 2,
+ inviteTeamMaxInvites: 5,
+ });
+
+ return store;
+};
+
+describe('onboardingCreditsProgressSelector', () => {
+ afterEach(() => {
+ localStorage.clear();
+ });
+
+ it('should earn nothing until the onboarding config loads', () => {
+ const store = buildStore();
+
+ store.set(onboardingConfigState.atom, null);
+
+ expect(store.get(onboardingCreditsProgressSelector.atom)).toEqual(
+ ONBOARDING_CREDITS_PROGRESS_EMPTY_VALUE,
+ );
+ });
+
+ it.each(PROFILE_NAME_CASES)(
+ 'should $title on the profile step',
+ ({ onboardingCreateProfileDraft, workspaceMemberName, earnedCredits }) => {
+ const store = buildStore();
+
+ store.set(currentWorkspaceMemberState.atom, {
+ ...mockedWorkspaceMemberData,
+ name: workspaceMemberName,
+ });
+ store.set(
+ onboardingCreateProfileDraftState.atom,
+ onboardingCreateProfileDraft,
+ );
+
+ expect(
+ store.get(onboardingCreditsProgressSelector.atom).earnedCredits,
+ ).toBe(earnedCredits);
+ },
+ );
+
+ it('should reward the valid invite emails typed so far', () => {
+ const store = buildStore();
+
+ store.set(onboardingInviteTeamEmailsDraftState.atom, [
+ 'alan@',
+ ]);
+
+ expect(
+ store.get(onboardingCreditsProgressSelector.atom).inviteTeamButtonReward,
+ ).toEqual({ creditsReward: 1, isRewardPerItem: false });
+ });
+});
diff --git a/packages/twenty-front/src/modules/onboarding/states/selectors/onboardingCreditsProgressSelector.ts b/packages/twenty-front/src/modules/onboarding/states/selectors/onboardingCreditsProgressSelector.ts
new file mode 100644
index 00000000000..2f910f31c10
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/states/selectors/onboardingCreditsProgressSelector.ts
@@ -0,0 +1,48 @@
+import { currentUserState } from '@/auth/states/currentUserState';
+import { currentWorkspaceMemberState } from '@/auth/states/currentWorkspaceMemberState';
+import { currentWorkspaceState } from '@/auth/states/currentWorkspaceState';
+import { billingState } from '@/client-config/states/billingState';
+import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
+import { ONBOARDING_CREDITS_PROGRESS_EMPTY_VALUE } from '@/onboarding/constants/OnboardingCreditsProgressEmptyValue';
+import { onboardingCreateProfileDraftState } from '@/onboarding/states/onboardingCreateProfileDraftState';
+import { currentWorkspaceOnboardingFreeCreditsSelector } from '@/onboarding/states/selectors/currentWorkspaceOnboardingFreeCreditsSelector';
+import { onboardingInviteTeamValidEmailsSelector } from '@/onboarding/states/selectors/onboardingInviteTeamValidEmailsSelector';
+import { type OnboardingCreditsProgress } from '@/onboarding/types/OnboardingCreditsProgress';
+import { getIsPlanRequired } from '@/onboarding/utils/getIsPlanRequired';
+import { getOnboardingCreditsProgress } from '@/onboarding/utils/getOnboardingCreditsProgress';
+import { createAtomSelector } from '@/ui/utilities/state/jotai/utils/createAtomSelector';
+import { isDefined } from 'twenty-shared/utils';
+import { isDeeplyEqual } from '~/utils/isDeeplyEqual';
+
+export const onboardingCreditsProgressSelector =
+ createAtomSelector<OnboardingCreditsProgress>({
+ key: 'onboardingCreditsProgressSelector',
+ get: ({ get }) => {
+ const onboardingConfig = get(onboardingConfigState);
+
+ if (!isDefined(onboardingConfig)) {
+ return ONBOARDING_CREDITS_PROGRESS_EMPTY_VALUE;
+ }
+
+ const currentUser = get(currentUserState);
+
+ return getOnboardingCreditsProgress({
+ onboardingFreeCredits: get(
+ currentWorkspaceOnboardingFreeCreditsSelector,
+ ),
+ onboardingConfig,
+ onboardingStatus: currentUser?.onboardingStatus,
+ isWorkspaceCreator: currentUser?.isWorkspaceCreator ?? false,
+ isPlanRequired: getIsPlanRequired({
+ isBillingEnabled: get(billingState)?.isBillingEnabled ?? false,
+ currentWorkspace: get(currentWorkspaceState),
+ }),
+ profileName:
+ get(onboardingCreateProfileDraftState) ??
+ get(currentWorkspaceMemberState)?.name,
+ inviteTeamValidEmailsCount: get(onboardingInviteTeamValidEmailsSelector)
+ .length,
+ });
+ },
+ areEqual: isDeeplyEqual,
+ });
diff --git a/packages/twenty-front/src/modules/onboarding/states/selectors/onboardingInviteTeamValidEmailsSelector.ts b/packages/twenty-front/src/modules/onboarding/states/selectors/onboardingInviteTeamValidEmailsSelector.ts
new file mode 100644
index 00000000000..cc8b3a90df6
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/states/selectors/onboardingInviteTeamValidEmailsSelector.ts
@@ -0,0 +1,11 @@
+import { onboardingInviteTeamEmailsDraftState } from '@/onboarding/states/onboardingInviteTeamEmailsDraftState';
+import { getValidInviteEmails } from '@/onboarding/utils/getValidInviteEmails';
+import { createAtomSelector } from '@/ui/utilities/state/jotai/utils/createAtomSelector';
+
+export const onboardingInviteTeamValidEmailsSelector = createAtomSelector<
+ string[]
+>({
+ key: 'onboardingInviteTeamValidEmailsSelector',
+ get: ({ get }) =>
+ getValidInviteEmails(get(onboardingInviteTeamEmailsDraftState) ?? []),
+});
diff --git a/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsProgress.ts b/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsProgress.ts
index db80c93ddf7..227b23bc83f 100644
--- a/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsProgress.ts
+++ b/packages/twenty-front/src/modules/onboarding/types/OnboardingCreditsProgress.ts
@@ -1,6 +1,7 @@
import { type OnboardingCreditsStep } from '@/onboarding/types/OnboardingCreditsStep';
export type OnboardingCreditsProgress = {
+ rewardCreditsByStep: Record<OnboardingCreditsStep, number>;
earnedCredits: number;
earnedCreditsByStep: {
step: OnboardingCreditsStep;
@@ -10,4 +11,11 @@ export type OnboardingCreditsProgress = {
goalCredits: number;
currentStep: OnboardingCreditsStep | null;
currentStepCredits: number;
+ seenCredits: number;
+ newlyEarnedCredits: number;
+ isFirstCreditsGain: boolean;
+ inviteTeamButtonReward: {
+ creditsReward: number;
+ isRewardPerItem: boolean;
+ };
};
diff --git a/packages/twenty-front/src/modules/onboarding/types/OnboardingRewardAction.ts b/packages/twenty-front/src/modules/onboarding/types/OnboardingRewardAction.ts
index eec2149d850..52797b31302 100644
--- a/packages/twenty-front/src/modules/onboarding/types/OnboardingRewardAction.ts
+++ b/packages/twenty-front/src/modules/onboarding/types/OnboardingRewardAction.ts
@@ -3,5 +3,7 @@ import { type IconComponent } from 'twenty-ui/icon';
export type OnboardingRewardAction = {
label: string;
Icon?: IconComponent;
+ creditsReward: number;
+ isRewardPerItem?: boolean;
onClick: () => void;
};
diff --git a/packages/twenty-front/src/modules/onboarding/utils/__tests__/getInviteTeamCreditsReward.test.ts b/packages/twenty-front/src/modules/onboarding/utils/__tests__/getInviteTeamCreditsReward.test.ts
new file mode 100644
index 00000000000..4c932337f6e
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/utils/__tests__/getInviteTeamCreditsReward.test.ts
@@ -0,0 +1,40 @@
+import { type OnboardingConfig } from '@/client-config/types/OnboardingConfig';
+import { getInviteTeamCreditsReward } from '@/onboarding/utils/getInviteTeamCreditsReward';
+
+const onboardingConfig: OnboardingConfig = {
+ importContactsCreditsReward: 1,
+ inviteTeamCreditsRewardPerUser: 0.5,
+ installAppsCreditsReward: 0.5,
+ createProfileCreditsReward: 0.5,
+ upgradeCreditsReward: 2,
+ inviteTeamMaxInvites: 3,
+};
+
+describe('getInviteTeamCreditsReward', () => {
+ it('should reward each invited teammate', () => {
+ expect(
+ getInviteTeamCreditsReward({
+ invitedTeammatesCount: 2,
+ onboardingConfig,
+ }),
+ ).toBe(1);
+ });
+
+ it('should stop rewarding past the maximum invites', () => {
+ expect(
+ getInviteTeamCreditsReward({
+ invitedTeammatesCount: 5,
+ onboardingConfig,
+ }),
+ ).toBe(1.5);
+ });
+
+ it('should reward nothing before the config loads', () => {
+ expect(
+ getInviteTeamCreditsReward({
+ invitedTeammatesCount: 2,
+ onboardingConfig: null,
+ }),
+ ).toBe(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
index 420f334fd64..72553e8dded 100644
--- a/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditsProgress.test.ts
+++ b/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditsProgress.test.ts
@@ -2,6 +2,7 @@ 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 { type FullNameMetadata } from 'twenty-shared/types';
import { OnboardingStatus } from '~/generated-metadata/graphql';
const onboardingConfig: OnboardingConfig = {
@@ -13,6 +14,50 @@ const onboardingConfig: OnboardingConfig = {
inviteTeamMaxInvites: 4,
};
+const PROFILE_CREDITS_CASES: {
+ title: string;
+ onboardingStatus: OnboardingStatus;
+ isWorkspaceCreator: boolean;
+ profileName: FullNameMetadata | null;
+ createProfile: number;
+}[] = [
+ {
+ title: 'count the profile names on the profile step',
+ onboardingStatus: OnboardingStatus.PROFILE_CREATION,
+ isWorkspaceCreator: true,
+ profileName: { firstName: 'Tim', lastName: 'Apple' },
+ createProfile: 0.5,
+ },
+ {
+ title: 'not count the profile step while a name is empty',
+ onboardingStatus: OnboardingStatus.PROFILE_CREATION,
+ isWorkspaceCreator: true,
+ profileName: { firstName: 'Tim', lastName: '' },
+ createProfile: 0,
+ },
+ {
+ title: 'not count the profile step without a name',
+ onboardingStatus: OnboardingStatus.PROFILE_CREATION,
+ isWorkspaceCreator: true,
+ profileName: null,
+ createProfile: 0,
+ },
+ {
+ title: 'not count the profile step for a member who did not create it',
+ onboardingStatus: OnboardingStatus.PROFILE_CREATION,
+ isWorkspaceCreator: false,
+ profileName: { firstName: 'Tim', lastName: 'Apple' },
+ createProfile: 0,
+ },
+ {
+ title: 'not count the profile names before the profile step',
+ onboardingStatus: OnboardingStatus.APPS_INSTALLATION,
+ isWorkspaceCreator: true,
+ profileName: { firstName: 'Tim', lastName: 'Apple' },
+ createProfile: 0,
+ },
+];
+
const buildOnboardingFreeCredits = (
onboardingFreeCredits: Partial<OnboardingFreeCredits> = {},
): OnboardingFreeCredits => ({
@@ -29,13 +74,26 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.SYNC_EMAIL,
isWorkspaceCreator: true,
isPlanRequired: true,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
}),
).toEqual({
+ rewardCreditsByStep: {
+ importContacts: 2,
+ installApps: 1,
+ createProfile: 0.5,
+ inviteTeam: 2,
+ upgradeTrial: 0.5,
+ },
earnedCredits: 0,
earnedCreditsByStep: [],
goalCredits: 0,
currentStep: 'importContacts',
currentStepCredits: 2,
+ seenCredits: 0,
+ newlyEarnedCredits: 0,
+ isFirstCreditsGain: true,
+ inviteTeamButtonReward: { creditsReward: 0.5, isRewardPerItem: true },
});
});
@@ -53,11 +111,33 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.COMPLETED,
isWorkspaceCreator: true,
isPlanRequired: true,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
});
expect(progress.earnedCredits).toBe(5);
});
+ it('should announce the counted credits not seen yet', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({
+ importContacts: 2,
+ installApps: 1,
+ seenCredits: 2,
+ }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.PROFILE_CREATION,
+ isWorkspaceCreator: true,
+ isPlanRequired: false,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
+ });
+
+ expect(progress.earnedCredits).toBe(3);
+ expect(progress.newlyEarnedCredits).toBe(1);
+ expect(progress.isFirstCreditsGain).toBe(false);
+ });
+
it('should leave the step at hand out of the goal until it is done', () => {
const progress = getOnboardingCreditsProgress({
onboardingFreeCredits: buildOnboardingFreeCredits({ importContacts: 2 }),
@@ -65,6 +145,8 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.APPS_INSTALLATION,
isWorkspaceCreator: true,
isPlanRequired: false,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
});
expect(progress.earnedCredits).toBe(2);
@@ -83,13 +165,26 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.SYNC_EMAIL,
isWorkspaceCreator: true,
isPlanRequired: true,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
}),
).toEqual({
+ rewardCreditsByStep: {
+ importContacts: 2,
+ installApps: 1,
+ createProfile: 0.5,
+ inviteTeam: 2,
+ upgradeTrial: 0.5,
+ },
earnedCredits: 0,
earnedCreditsByStep: [],
goalCredits: 0,
currentStep: 'importContacts',
currentStepCredits: 2,
+ seenCredits: 0,
+ newlyEarnedCredits: 0,
+ isFirstCreditsGain: true,
+ inviteTeamButtonReward: { creditsReward: 0.5, isRewardPerItem: true },
});
});
@@ -100,6 +195,8 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.PROFILE_CREATION,
isWorkspaceCreator: true,
isPlanRequired: false,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
});
expect(progress.earnedCredits).toBe(0);
@@ -114,6 +211,8 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.INVITE_TEAM,
isWorkspaceCreator: true,
isPlanRequired: false,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
});
expect(progress.earnedCredits).toBe(0.5);
@@ -133,6 +232,8 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.BOOK_CALL,
isWorkspaceCreator: true,
isPlanRequired: true,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
});
expect(progress.earnedCredits).toBe(3.5);
@@ -146,6 +247,8 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.PLAN_REQUIRED,
isWorkspaceCreator: true,
isPlanRequired: true,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
});
expect(progress.goalCredits).toBe(4);
@@ -163,6 +266,8 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.PLAN_REQUIRED,
isWorkspaceCreator: true,
isPlanRequired: true,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
});
expect(progress.earnedCredits).toBe(2.5);
@@ -176,6 +281,8 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.COMPLETED,
isWorkspaceCreator: true,
isPlanRequired: false,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
});
expect(progress.goalCredits).toBe(3.5);
@@ -193,6 +300,8 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.COMPLETED,
isWorkspaceCreator: true,
isPlanRequired: false,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
});
expect(progress.earnedCredits).toBe(4);
@@ -210,6 +319,8 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.PLAN_REQUIRED,
isWorkspaceCreator: true,
isPlanRequired: true,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
});
expect(progress.earnedCreditsByStep).toEqual([
@@ -228,6 +339,8 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.APPS_INSTALLATION,
isWorkspaceCreator: true,
isPlanRequired: false,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
});
expect(progress.earnedCreditsByStep).toEqual([
@@ -242,10 +355,85 @@ describe('getOnboardingCreditsProgress', () => {
onboardingStatus: OnboardingStatus.SYNC_EMAIL,
isWorkspaceCreator: false,
isPlanRequired: false,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
});
expect(progress.goalCredits).toBe(0);
expect(progress.currentStep).toBeNull();
expect(progress.currentStepCredits).toBe(0);
});
+
+ it('should count the apps credits while the install runs on the apps step', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({ installApps: 1 }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.APPS_INSTALLATION,
+ isWorkspaceCreator: true,
+ isPlanRequired: false,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
+ });
+
+ expect(progress.earnedCredits).toBe(1);
+ expect(progress.currentStep).toBeNull();
+ expect(progress.currentStepCredits).toBe(0);
+ });
+
+ it.each(PROFILE_CREDITS_CASES)(
+ 'should $title',
+ ({ onboardingStatus, isWorkspaceCreator, profileName, createProfile }) => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits(),
+ onboardingConfig,
+ onboardingStatus,
+ isWorkspaceCreator,
+ isPlanRequired: false,
+ profileName,
+ inviteTeamValidEmailsCount: 0,
+ });
+
+ expect(progress.earnedCredits).toBe(createProfile);
+ },
+ );
+
+ it('should count the saved profile credits once the profile step is done', () => {
+ const progress = getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits({ createProfile: 0.5 }),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.INVITE_TEAM,
+ isWorkspaceCreator: true,
+ isPlanRequired: false,
+ profileName: null,
+ inviteTeamValidEmailsCount: 0,
+ });
+
+ expect(progress.earnedCredits).toBe(0.5);
+ });
+
+ it('should reward each teammate on the invite button until an email is typed', () => {
+ const buildInviteTeamButtonReward = (inviteTeamValidEmailsCount: number) =>
+ getOnboardingCreditsProgress({
+ onboardingFreeCredits: buildOnboardingFreeCredits(),
+ onboardingConfig,
+ onboardingStatus: OnboardingStatus.INVITE_TEAM,
+ isWorkspaceCreator: true,
+ isPlanRequired: false,
+ profileName: null,
+ inviteTeamValidEmailsCount,
+ }).inviteTeamButtonReward;
+
+ expect(buildInviteTeamButtonReward(0)).toEqual({
+ creditsReward: 0.5,
+ isRewardPerItem: true,
+ });
+ expect(buildInviteTeamButtonReward(3)).toEqual({
+ creditsReward: 1.5,
+ isRewardPerItem: false,
+ });
+ expect(buildInviteTeamButtonReward(6)).toEqual({
+ creditsReward: 2,
+ isRewardPerItem: false,
+ });
+ });
});
diff --git a/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditsRewardAriaLabel.test.ts b/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditsRewardAriaLabel.test.ts
index 96b20b29c13..9e53a29b8e9 100644
--- a/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditsRewardAriaLabel.test.ts
+++ b/packages/twenty-front/src/modules/onboarding/utils/__tests__/getOnboardingCreditsRewardAriaLabel.test.ts
@@ -31,6 +31,17 @@ describe('getOnboardingCreditsRewardAriaLabel', () => {
).toBe('Continue with Google, earn 2,5 free credits');
});
+ it('should say when the reward is per item', () => {
+ expect(
+ getOnboardingCreditsRewardAriaLabel({
+ label: 'Invite',
+ creditsReward: 0.5,
+ formattedCreditsReward: '0.5',
+ isRewardPerItem: true,
+ }),
+ ).toBe('Invite, earn 0.5 free credits each');
+ });
+
it('should leave the label alone without a reward', () => {
expect(
getOnboardingCreditsRewardAriaLabel({
diff --git a/packages/twenty-front/src/modules/onboarding/utils/__tests__/getValidInviteEmails.test.ts b/packages/twenty-front/src/modules/onboarding/utils/__tests__/getValidInviteEmails.test.ts
new file mode 100644
index 00000000000..6e5edafaa57
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/utils/__tests__/getValidInviteEmails.test.ts
@@ -0,0 +1,49 @@
+import { getValidInviteEmails } from '@/onboarding/utils/getValidInviteEmails';
+
+describe('getValidInviteEmails', () => {
+ it('should keep valid emails in their original order', () => {
+ expect(
+ getValidInviteEmails(['[email protected]', '[email protected]']),
+ });
+
+ it('should count a repeated email once', () => {
+ expect(
+ getValidInviteEmails([
+ ]),
+ });
+
+ it('should count an email once whatever its case', () => {
+ expect(
+ getValidInviteEmails([
+ ]),
+ });
+
+ it('should skip empty and undefined fields', () => {
+ expect(getValidInviteEmails(['', undefined, '[email protected]'])).toEqual([
+ ]);
+ });
+
+ it('should skip malformed emails', () => {
+ expect(
+ getValidInviteEmails([
+ 'katherine@example',
+ 'not an email',
+ ]),
+ ).toEqual(['[email protected]']);
+ });
+
+ it('should skip emails with surrounding whitespace', () => {
+ expect(getValidInviteEmails([' [email protected] '])).toEqual([]);
+ });
+});
diff --git a/packages/twenty-front/src/modules/onboarding/utils/getInviteTeamCreditsReward.ts b/packages/twenty-front/src/modules/onboarding/utils/getInviteTeamCreditsReward.ts
new file mode 100644
index 00000000000..6d79c8bc0a7
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/utils/getInviteTeamCreditsReward.ts
@@ -0,0 +1,25 @@
+import { type OnboardingConfig } from '@/client-config/types/OnboardingConfig';
+import { isDefined } from 'twenty-shared/utils';
+
+type GetInviteTeamCreditsRewardArgs = {
+ invitedTeammatesCount: number;
+ onboardingConfig: OnboardingConfig | null;
+};
+
+export const getInviteTeamCreditsReward = ({
+ invitedTeammatesCount,
+ onboardingConfig,
+}: GetInviteTeamCreditsRewardArgs) => {
+ if (!isDefined(onboardingConfig)) {
+ return 0;
+ }
+
+ const rewardedTeammatesCount = Math.min(
+ invitedTeammatesCount,
+ onboardingConfig.inviteTeamMaxInvites,
+ );
+
+ return (
+ rewardedTeammatesCount * onboardingConfig.inviteTeamCreditsRewardPerUser
+ );
+};
diff --git a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCountedFreeCredits.ts b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCountedFreeCredits.ts
deleted file mode 100644
index a7b8e0d9d05..00000000000
--- a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCountedFreeCredits.ts
+++ /dev/null
@@ -1,21 +0,0 @@
-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/getOnboardingCreditsProgress.ts b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsProgress.ts
index 06fce17d3f2..e85400d8cdf 100644
--- a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsProgress.ts
+++ b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsProgress.ts
@@ -1,12 +1,13 @@
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 { ONBOARDING_STATUS_ORDER } from '@/onboarding/constants/OnboardingStatusOrder';
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 { getInviteTeamCreditsReward } from '@/onboarding/utils/getInviteTeamCreditsReward';
+import { isNonEmptyString } from '@sniptt/guards';
+import { type FullNameMetadata } from 'twenty-shared/types';
import { isDefined } from 'twenty-shared/utils';
import { type OnboardingStatus } from '~/generated-metadata/graphql';
@@ -16,6 +17,8 @@ type GetOnboardingCreditsProgressArgs = {
onboardingStatus: OnboardingStatus | null | undefined;
isWorkspaceCreator: boolean;
isPlanRequired: boolean;
+ profileName: FullNameMetadata | null | undefined;
+ inviteTeamValidEmailsCount: number;
};
export const getOnboardingCreditsProgress = ({
@@ -24,12 +27,9 @@ export const getOnboardingCreditsProgress = ({
onboardingStatus,
isWorkspaceCreator,
isPlanRequired,
+ profileName,
+ inviteTeamValidEmailsCount,
}: GetOnboardingCreditsProgressArgs): OnboardingCreditsProgress => {
- const countedFreeCredits = getOnboardingCountedFreeCredits({
- onboardingFreeCredits,
- onboardingStatus,
- });
-
const rewardCreditsByStep: Record<OnboardingCreditsStep, number> = {
importContacts: isWorkspaceCreator
? onboardingConfig.importContactsCreditsReward
@@ -46,38 +46,95 @@ export const getOnboardingCreditsProgress = ({
upgradeTrial: isPlanRequired ? onboardingConfig.upgradeCreditsReward : 0,
};
+ const statusIndex = isDefined(onboardingStatus)
+ ? ONBOARDING_STATUS_ORDER.indexOf(onboardingStatus)
+ : -1;
+
+ const isStepDone = (step: OnboardingCreditsStep) => {
+ const stepStatusIndex = ONBOARDING_STATUS_ORDER.indexOf(
+ ONBOARDING_STATUS_BY_CREDITS_STEP[step],
+ );
+
+ return step === 'upgradeTrial'
+ ? statusIndex >= stepStatusIndex
+ : statusIndex > stepStatusIndex;
+ };
+
const onboardingStep = ONBOARDING_CREDITS_STEPS.find(
(step) => ONBOARDING_STATUS_BY_CREDITS_STEP[step] === onboardingStatus,
);
+ const hasProfileName =
+ isNonEmptyString(profileName?.firstName) &&
+ isNonEmptyString(profileName?.lastName);
+
+ const getCountedCredits = (step: OnboardingCreditsStep) => {
+ if (isStepDone(step)) {
+ return onboardingFreeCredits[step];
+ }
+
+ if (step !== onboardingStep) {
+ return 0;
+ }
+
+ if (step === 'installApps') {
+ return onboardingFreeCredits.installApps;
+ }
+
+ if (step === 'createProfile' && hasProfileName) {
+ return rewardCreditsByStep.createProfile;
+ }
+
+ return 0;
+ };
+
+ const earnedCredits = ONBOARDING_CREDITS_STEPS.reduce(
+ (total, step) => total + getCountedCredits(step),
+ 0,
+ );
+
const currentStepCredits = isDefined(onboardingStep)
? Math.max(
0,
- rewardCreditsByStep[onboardingStep] -
- countedFreeCredits[onboardingStep],
+ rewardCreditsByStep[onboardingStep] - getCountedCredits(onboardingStep),
)
: 0;
const goalCredits = ONBOARDING_CREDITS_STEPS.reduce(
(goal, step) =>
goal +
- (isOnboardingCreditsStepDone({ step, onboardingStatus }) &&
- step !== 'inviteTeam'
- ? Math.max(rewardCreditsByStep[step], countedFreeCredits[step])
- : countedFreeCredits[step]),
+ (isStepDone(step) && step !== 'inviteTeam'
+ ? Math.max(rewardCreditsByStep[step], getCountedCredits(step))
+ : getCountedCredits(step)),
0,
);
+ const { seenCredits } = onboardingFreeCredits;
+
+ const inviteTeamButtonReward =
+ inviteTeamValidEmailsCount > 0
+ ? {
+ creditsReward: getInviteTeamCreditsReward({
+ invitedTeammatesCount: inviteTeamValidEmailsCount,
+ onboardingConfig,
+ }),
+ isRewardPerItem: false,
+ }
+ : {
+ creditsReward: onboardingConfig.inviteTeamCreditsRewardPerUser,
+ isRewardPerItem: true,
+ };
+
return {
- earnedCredits: getOnboardingEarnedCredits(countedFreeCredits),
+ rewardCreditsByStep,
+ earnedCredits,
earnedCreditsByStep: ONBOARDING_CREDITS_STEPS.filter(
(step) =>
- countedFreeCredits[step] > 0 ||
- (isOnboardingCreditsStepDone({ step, onboardingStatus }) &&
- rewardCreditsByStep[step] > 0),
+ getCountedCredits(step) > 0 ||
+ (isStepDone(step) && rewardCreditsByStep[step] > 0),
).map((step) => ({
step,
- credits: countedFreeCredits[step],
+ credits: getCountedCredits(step),
rewardCredits: rewardCreditsByStep[step],
})),
goalCredits,
@@ -86,5 +143,9 @@ export const getOnboardingCreditsProgress = ({
? onboardingStep
: null,
currentStepCredits,
+ seenCredits,
+ newlyEarnedCredits: earnedCredits - seenCredits,
+ isFirstCreditsGain: seenCredits === 0,
+ inviteTeamButtonReward,
};
};
diff --git a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsRewardAriaLabel.ts b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsRewardAriaLabel.ts
index 083e6ca6fc1..6d34b5bf228 100644
--- a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsRewardAriaLabel.ts
+++ b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingCreditsRewardAriaLabel.ts
@@ -4,17 +4,26 @@ type GetOnboardingCreditsRewardAriaLabelArgs = {
label: string;
creditsReward: number;
formattedCreditsReward: string;
+ isRewardPerItem?: boolean;
};
export const getOnboardingCreditsRewardAriaLabel = ({
label,
creditsReward,
formattedCreditsReward,
+ isRewardPerItem = false,
}: GetOnboardingCreditsRewardAriaLabelArgs) => {
if (creditsReward <= 0) {
return undefined;
}
+ if (isRewardPerItem) {
+ return plural(creditsReward, {
+ one: `${label}, earn ${formattedCreditsReward} free credit each`,
+ other: `${label}, earn ${formattedCreditsReward} free credits each`,
+ });
+ }
+
return plural(creditsReward, {
one: `${label}, earn ${formattedCreditsReward} free credit`,
other: `${label}, earn ${formattedCreditsReward} free credits`,
diff --git a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingEarnedCredits.ts b/packages/twenty-front/src/modules/onboarding/utils/getOnboardingEarnedCredits.ts
deleted file mode 100644
index dd5eb63bab0..00000000000
--- a/packages/twenty-front/src/modules/onboarding/utils/getOnboardingEarnedCredits.ts
+++ /dev/null
@@ -1,10 +0,0 @@
-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/getValidInviteEmails.ts b/packages/twenty-front/src/modules/onboarding/utils/getValidInviteEmails.ts
new file mode 100644
index 00000000000..07a479f4e75
--- /dev/null
+++ b/packages/twenty-front/src/modules/onboarding/utils/getValidInviteEmails.ts
@@ -0,0 +1,11 @@
+import { sanitizeEmailList } from '@/workspace/utils/sanitizeEmailList';
+import { z } from 'zod';
+
+export const getValidInviteEmails = (
+ emails: (string | undefined)[],
+): string[] =>
+ sanitizeEmailList(
+ emails.filter(
+ (email): email is string => z.email().safeParse(email).success,
+ ),
+ );
diff --git a/packages/twenty-front/src/modules/onboarding/utils/isOnboardingCreditsStepDone.ts b/packages/twenty-front/src/modules/onboarding/utils/isOnboardingCreditsStepDone.ts
deleted file mode 100644
index 8342c11edac..00000000000
--- a/packages/twenty-front/src/modules/onboarding/utils/isOnboardingCreditsStepDone.ts
+++ /dev/null
@@ -1,26 +0,0 @@
-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/types/PageFocusId.ts b/packages/twenty-front/src/modules/types/PageFocusId.ts
index 3956eb97383..04e460dce23 100644
--- a/packages/twenty-front/src/modules/types/PageFocusId.ts
+++ b/packages/twenty-front/src/modules/types/PageFocusId.ts
@@ -5,6 +5,7 @@ export enum PageFocusId {
CreateProfile = 'create-profile',
InviteTeam = 'invite-team',
SyncEmail = 'sync-email',
+ InstallApps = 'install-apps',
PlanRequired = 'plan-required',
RecordShowPage = 'record-show-page',
RecordIndex = 'record-index',
diff --git a/packages/twenty-front/src/pages/onboarding/CreateProfile.tsx b/packages/twenty-front/src/pages/onboarding/CreateProfile.tsx
index 6d233e357fd..3440603b8eb 100644
--- a/packages/twenty-front/src/pages/onboarding/CreateProfile.tsx
+++ b/packages/twenty-front/src/pages/onboarding/CreateProfile.tsx
@@ -1,9 +1,9 @@
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 { OnboardingRewardMainButton } from '@/onboarding/components/OnboardingRewardMainButton';
import { OnboardingStepAnimatedItem } from '@/onboarding/components/OnboardingStepAnimatedItem';
import { StyledOnboardingStepHeading } from '@/onboarding/components/StyledOnboardingStepHeading';
import { StyledOnboardingStepPage } from '@/onboarding/components/StyledOnboardingStepPage';
@@ -13,6 +13,8 @@ import { ONBOARDING_CONTENT_BLOCK_WIDTH } from '@/onboarding/constants/Onboardin
import { usePrefetchInviteSuggestions } from '@/onboarding/hooks/usePrefetchInviteSuggestions';
import { useSetNextOnboardingStatus } from '@/onboarding/hooks/useSetNextOnboardingStatus';
import { useSetOnboardingStepFreeCredits } from '@/onboarding/hooks/useSetOnboardingStepFreeCredits';
+import { onboardingCreateProfileDraftState } from '@/onboarding/states/onboardingCreateProfileDraftState';
+import { onboardingCreditsProgressSelector } from '@/onboarding/states/selectors/onboardingCreditsProgressSelector';
import { useUpdateWorkspaceMemberSettings } from '@/settings/profile/hooks/useUpdateWorkspaceMemberSettings';
import { PageFocusId } from '@/types/PageFocusId';
import { TextInput } from '@/ui/input/components/TextInput';
@@ -24,11 +26,12 @@ import { styled } from '@linaria/react';
import { i18n } from '@lingui/core';
import { msg } from '@lingui/core/macro';
import { useLingui } from '@lingui/react/macro';
+import { useStore } from 'jotai';
import { useCallback, useState } from 'react';
import { Controller, type SubmitHandler, useForm } from 'react-hook-form';
import { Key } from 'ts-key-enum';
import { isDefined } from 'twenty-shared/utils';
-import { MainButton, useToast } from 'twenty-ui/components';
+import { useToast } from 'twenty-ui/components';
import { MOBILE_VIEWPORT, themeCssVariables } from 'twenty-ui/theme';
import { z } from 'zod';
@@ -88,9 +91,17 @@ export const CreateProfile = () => {
const { enqueueToast } = useToast();
const currentWorkspaceMember = useAtomStateValue(currentWorkspaceMemberState);
- const currentUser = useAtomStateValue(currentUserState);
+ const store = useStore();
+ const onboardingCreditsProgress = useAtomStateValue(
+ onboardingCreditsProgressSelector,
+ );
+ const setOnboardingCreateProfileDraft = useSetAtomState(
+ onboardingCreateProfileDraftState,
+ );
+ const [initialCreateProfileDraft] = useState(() =>
+ store.get(onboardingCreateProfileDraftState.atom),
+ );
const setCurrentUser = useSetAtomState(currentUserState);
- const onboardingConfig = useAtomStateValue(onboardingConfigState);
const setCurrentWorkspaceMembers = useSetAtomState(
currentWorkspaceMembersState,
);
@@ -101,17 +112,30 @@ export const CreateProfile = () => {
const {
control,
handleSubmit,
+ getValues,
formState: { isValid, isSubmitting },
} = useForm<Form>({
mode: 'onChange',
defaultValues: {
- firstName: currentWorkspaceMember?.name?.firstName ?? '',
- lastName: currentWorkspaceMember?.name?.lastName ?? '',
+ firstName:
+ initialCreateProfileDraft?.firstName ??
+ currentWorkspaceMember?.name?.firstName ??
+ '',
+ lastName:
+ initialCreateProfileDraft?.lastName ??
+ currentWorkspaceMember?.name?.lastName ??
+ '',
jobTitle: currentWorkspaceMember?.jobTitle ?? '',
},
resolver: zodResolver(validationSchema),
});
+ const setCreateProfileDraftFromForm = () =>
+ setOnboardingCreateProfileDraft({
+ firstName: getValues('firstName'),
+ lastName: getValues('lastName'),
+ });
+
const onSubmit: SubmitHandler<Form> = useCallback(
async (data) => {
try {
@@ -163,9 +187,8 @@ export const CreateProfile = () => {
setOnboardingStepFreeCredits(
'createProfile',
- currentUser?.isWorkspaceCreator
- ? (onboardingConfig?.createProfileCreditsReward ?? 0)
- : 0,
+ store.get(onboardingCreditsProgressSelector.atom).rewardCreditsByStep
+ .createProfile,
);
setNextOnboardingStatus({ stepHistoryEffect: 'recordAsReversible' });
setIsNavigating(true);
@@ -176,8 +199,7 @@ export const CreateProfile = () => {
},
[
currentWorkspaceMember?.id,
- currentUser?.isWorkspaceCreator,
- onboardingConfig?.createProfileCreditsReward,
+ store,
setNextOnboardingStatus,
setOnboardingStepFreeCredits,
enqueueToast,
@@ -203,7 +225,7 @@ export const CreateProfile = () => {
});
return (
- <StyledOnboardingStepPage>
+ <StyledOnboardingStepPage data-testid="onboarding-create-profile-step">
<StyledOnboardingStepHeading>
<OnboardingStepAnimatedItem index={0}>
<StyledOnboardingStepTitle>{t`Create profile`}</StyledOnboardingStepTitle>
@@ -240,7 +262,10 @@ export const CreateProfile = () => {
onBlur();
setIsEditingMode(false);
}}
- onChange={onChange}
+ onChange={(firstName) => {
+ onChange(firstName);
+ setCreateProfileDraftFromForm();
+ }}
placeholder={t`Tim`}
error={error?.message}
fullWidth
@@ -264,7 +289,10 @@ export const CreateProfile = () => {
onBlur();
setIsEditingMode(false);
}}
- onChange={onChange}
+ onChange={(lastName) => {
+ onChange(lastName);
+ setCreateProfileDraftFromForm();
+ }}
placeholder={t`Apple`}
error={error?.message}
fullWidth
@@ -296,11 +324,14 @@ export const CreateProfile = () => {
<OnboardingStepAnimatedItem index={3}>
<StyledButtonContainer>
- <MainButton
- onClick={handleSubmit(onSubmit)}
+ <OnboardingRewardMainButton
+ label={t`Continue`}
+ creditsReward={
+ onboardingCreditsProgress.rewardCreditsByStep.createProfile
+ }
disabled={!isValid || isSubmitting || isNavigating}
- fullWidth
- >{t`Continue`}</MainButton>
+ onClick={handleSubmit(onSubmit)}
+ />
</StyledButtonContainer>
</OnboardingStepAnimatedItem>
</StyledOnboardingStepPage>
diff --git a/packages/twenty-front/src/pages/onboarding/ImportContacts.tsx b/packages/twenty-front/src/pages/onboarding/ImportContacts.tsx
index 8454e5e3fab..51109868278 100644
--- a/packages/twenty-front/src/pages/onboarding/ImportContacts.tsx
+++ b/packages/twenty-front/src/pages/onboarding/ImportContacts.tsx
@@ -49,18 +49,16 @@ const StyledButtons = styled.div`
type ImportContactsProps = {
providerActions: OnboardingRewardAction[];
onSkip?: () => void;
- creditsReward?: number;
};
export const ImportContacts = ({
providerActions,
onSkip,
- creditsReward = 0,
}: ImportContactsProps) => {
const { t } = useLingui();
return (
- <StyledOnboardingStep>
+ <StyledOnboardingStep data-testid="onboarding-sync-emails-step">
<StyledOnboardingStepHeading>
<OnboardingStepAnimatedItem index={0}>
<StyledOnboardingStepTitle>{t`Import your contacts`}</StyledOnboardingStepTitle>
@@ -87,7 +85,8 @@ export const ImportContacts = ({
key={providerAction.label}
label={providerAction.label}
Icon={providerAction.Icon}
- creditsReward={creditsReward}
+ creditsReward={providerAction.creditsReward}
+ isRewardPerItem={providerAction.isRewardPerItem}
onClick={providerAction.onClick}
/>
))}
diff --git a/packages/twenty-front/src/pages/onboarding/InstallApps.tsx b/packages/twenty-front/src/pages/onboarding/InstallApps.tsx
index 4fb93c6a97a..9001c68e9d1 100644
--- a/packages/twenty-front/src/pages/onboarding/InstallApps.tsx
+++ b/packages/twenty-front/src/pages/onboarding/InstallApps.tsx
@@ -1,9 +1,6 @@
-import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
import { useMarketplaceApps } from '@/marketplace/hooks/useMarketplaceApps';
import { ONBOARDING_INSTALLABLE_APPS } from '@/onboarding/constants/OnboardingInstallableApps';
import { InstallAppsAutoSkipEffect } from '@/onboarding/effect-components/InstallAppsAutoSkipEffect';
-import { useInstallOnboardingApps } from '@/onboarding/hooks/useInstallOnboardingApps';
-import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { useCallback, useState } from 'react';
import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';
import { InstallAppsContent } from '~/pages/onboarding/InstallAppsContent';
@@ -19,14 +16,6 @@ export const InstallApps = () => {
} = useMarketplaceApps({
universalIdentifiers: ONBOARDING_INSTALLABLE_APP_UNIVERSAL_IDENTIFIERS,
});
- const onboardingConfig = useAtomStateValue(onboardingConfigState);
- const {
- selectedUniversalIdentifiers,
- isCompleting,
- toggleApp,
- installSelectedAppsAndContinue,
- skip,
- } = useInstallOnboardingApps();
const [hasAutoSkipFailed, setHasAutoSkipFailed] = useState(false);
const availableApps = ONBOARDING_INSTALLABLE_APPS.flatMap((app) => {
@@ -59,15 +48,5 @@ export const InstallApps = () => {
return <InstallAppsAutoSkipEffect onError={handleAutoSkipError} />;
}
- return (
- <InstallAppsContent
- apps={availableApps}
- selectedUniversalIdentifiers={selectedUniversalIdentifiers}
- creditsReward={onboardingConfig?.installAppsCreditsReward}
- isCompleting={isCompleting}
- onToggleApp={toggleApp}
- onInstall={installSelectedAppsAndContinue}
- onSkip={skip}
- />
- );
+ return <InstallAppsContent apps={availableApps} />;
};
diff --git a/packages/twenty-front/src/pages/onboarding/InstallAppsContent.tsx b/packages/twenty-front/src/pages/onboarding/InstallAppsContent.tsx
index 23ad4aff9f4..f00264ad5d2 100644
--- a/packages/twenty-front/src/pages/onboarding/InstallAppsContent.tsx
+++ b/packages/twenty-front/src/pages/onboarding/InstallAppsContent.tsx
@@ -1,76 +1,94 @@
+import { OnboardingRewardMainButton } from '@/onboarding/components/OnboardingRewardMainButton';
import { OnboardingSkipButton } from '@/onboarding/components/OnboardingSkipButton';
import { OnboardingStepAnimatedItem } from '@/onboarding/components/OnboardingStepAnimatedItem';
import { StyledOnboardingStepHeading } from '@/onboarding/components/StyledOnboardingStepHeading';
import { StyledOnboardingStepPage } from '@/onboarding/components/StyledOnboardingStepPage';
import { StyledOnboardingStepSubtitle } from '@/onboarding/components/StyledOnboardingStepSubtitle';
-import { StyledOnboardingStepTagsRow } from '@/onboarding/components/StyledOnboardingStepTagsRow';
import { StyledOnboardingStepTitle } from '@/onboarding/components/StyledOnboardingStepTitle';
-import { OnboardingCreditsRewardTag } from '@/onboarding/components/import-contacts/OnboardingCreditsRewardTag';
import { ONBOARDING_CONTENT_BLOCK_WIDTH } from '@/onboarding/constants/OnboardingContentBlockWidth';
+import { useInstallOnboardingApps } from '@/onboarding/hooks/useInstallOnboardingApps';
+import { useOnboardingStepEnterHotkey } from '@/onboarding/hooks/useOnboardingStepEnterHotkey';
+import { onboardingCreditsProgressSelector } from '@/onboarding/states/selectors/onboardingCreditsProgressSelector';
import { type OnboardingInstallableApp } from '@/onboarding/types/OnboardingInstallableApp';
+import { PageFocusId } from '@/types/PageFocusId';
+import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { styled } from '@linaria/react';
+import { plural } from '@lingui/core/macro';
import { useLingui } from '@lingui/react/macro';
-import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';
-import {
- AnimatedIconCrossfade,
- IconButton,
- MainButton,
-} from 'twenty-ui/components';
-import { IconCheck, IconPlus } from 'twenty-ui/icon';
+import { isNonEmptyArray } from 'twenty-shared/utils';
+import { IconCheck } from 'twenty-ui/icon';
import { Avatar } from 'twenty-ui/primitives/data-display';
import { themeCssVariables, useTheme } from 'twenty-ui/theme';
import { getAbsoluteImageUrl } from '~/utils/image/getAbsoluteImageUrl';
-const StyledTitleRow = styled.div`
- align-items: center;
- display: flex;
- gap: 10px;
-`;
-
-const StyledBetaTag = styled.span`
- align-items: center;
- background-color: ${themeCssVariables.grayScale.gray3};
- border: 1px solid ${themeCssVariables.border.color.light};
- border-radius: ${themeCssVariables.border.radius.pill};
- box-sizing: border-box;
- color: ${themeCssVariables.grayScale.gray10};
- corner-shape: round;
- display: flex;
- font-size: ${themeCssVariables.font.size.md};
- font-weight: ${themeCssVariables.font.weight.medium};
- height: ${themeCssVariables.spacing[6]};
- line-height: 1.4;
- padding: 0 ${themeCssVariables.spacing[2]};
+const StyledTiles = styled.div`
+ display: grid;
+ gap: ${themeCssVariables.spacing[3]};
+ grid-template-columns: repeat(3, minmax(0, 1fr));
+ max-width: 100%;
+ width: ${ONBOARDING_CONTENT_BLOCK_WIDTH}px;
`;
-const StyledCard = styled.div`
+const StyledTile = styled.button`
+ align-items: flex-start;
background-color: ${themeCssVariables.background.primary};
border: 1px solid ${themeCssVariables.border.color.medium};
border-radius: ${themeCssVariables.border.radius.md};
box-sizing: border-box;
+ cursor: pointer;
display: flex;
flex-direction: column;
- max-width: 100%;
- width: ${ONBOARDING_CONTENT_BLOCK_WIDTH}px;
+ font-family: inherit;
+ min-height: 156px;
+ padding: ${themeCssVariables.spacing[3]};
+ position: relative;
+ text-align: left;
+ transition: border-color 0.15s ease;
+
+ &:hover {
+ border-color: ${themeCssVariables.border.color.strong};
+ }
+
+ &:disabled {
+ cursor: default;
+ }
`;
-const StyledAppRow = styled.div`
- align-items: center;
+const StyledTileContent = styled.span`
display: flex;
- gap: ${themeCssVariables.spacing[3]};
- padding: ${themeCssVariables.spacing[4]};
+ flex-direction: column;
+ gap: 10px;
+ transition: opacity 0.15s ease;
- & + & {
- border-top: 1px solid ${themeCssVariables.border.color.light};
+ [aria-pressed='false'] > & {
+ opacity: 0.5;
+ }
+
+ [aria-pressed='false']:hover > & {
+ opacity: 0.8;
}
`;
-const StyledAppText = styled.div`
+const StyledTileCheck = styled.span`
+ align-items: center;
+ background-color: ${themeCssVariables.background.primary};
+ border: 1px solid ${themeCssVariables.border.color.strong};
+ border-radius: 50%;
+ box-sizing: border-box;
+ color: ${themeCssVariables.font.color.inverted};
+ corner-shape: round;
display: flex;
- flex: 1 1 0;
- flex-direction: column;
- gap: 10px;
- min-width: 0;
+ height: 18px;
+ justify-content: center;
+ position: absolute;
+ right: ${themeCssVariables.spacing[2]};
+ top: ${themeCssVariables.spacing[2]};
+ width: 18px;
+
+ [aria-pressed='true'] > & {
+ background-color: ${themeCssVariables.background.primaryInverted};
+ border-color: ${themeCssVariables.background.primaryInverted};
+ }
`;
const StyledAppLabel = styled.span`
@@ -101,56 +119,74 @@ const StyledInstallButton = styled.div`
type InstallAppsContentProps = {
apps: (OnboardingInstallableApp & { logoUrl: string | null })[];
- selectedUniversalIdentifiers: string[];
- creditsReward?: number;
- isCompleting: boolean;
- onToggleApp: (universalIdentifier: string) => void;
- onInstall: () => void;
- onSkip: () => void;
};
-export const InstallAppsContent = ({
- apps,
- selectedUniversalIdentifiers,
- creditsReward,
- isCompleting,
- onToggleApp,
- onInstall,
- onSkip,
-}: InstallAppsContentProps) => {
+export const InstallAppsContent = ({ apps }: InstallAppsContentProps) => {
const { t } = useLingui();
const theme = useTheme();
+ const {
+ selectedUniversalIdentifiers,
+ isCompleting,
+ toggleApp,
+ installSelectedAppsAndContinue,
+ skip,
+ } = useInstallOnboardingApps(apps.map((app) => app.universalIdentifier));
+ const onboardingCreditsProgress = useAtomStateValue(
+ onboardingCreditsProgressSelector,
+ );
+ const creditsReward =
+ onboardingCreditsProgress.rewardCreditsByStep.installApps;
+
+ useOnboardingStepEnterHotkey({
+ focusId: PageFocusId.InstallApps,
+ onEnter: () => {
+ void installSelectedAppsAndContinue();
+ },
+ });
const hasApps = isNonEmptyArray(apps);
+ const hasSelectedApps = isNonEmptyArray(selectedUniversalIdentifiers);
+ const selectedAppsCount = selectedUniversalIdentifiers.length;
+
+ const getInstallLabel = () => {
+ if (!hasSelectedApps) {
+ return t`Continue without apps`;
+ }
+
+ if (selectedAppsCount === apps.length) {
+ return plural(selectedAppsCount, {
+ one: 'Install # app',
+ other: 'Install all # apps',
+ });
+ }
+
+ return plural(selectedAppsCount, {
+ one: 'Install # app',
+ other: 'Install # apps',
+ });
+ };
return (
- <StyledOnboardingStepPage>
+ <StyledOnboardingStepPage data-testid="onboarding-install-apps-step">
<StyledOnboardingStepHeading>
<OnboardingStepAnimatedItem index={0}>
- <StyledTitleRow>
- <StyledOnboardingStepTitle>{t`Install your first apps`}</StyledOnboardingStepTitle>
- <StyledBetaTag>{t`Beta`}</StyledBetaTag>
- </StyledTitleRow>
+ <StyledOnboardingStepTitle>{t`Start with the essentials`}</StyledOnboardingStepTitle>
</OnboardingStepAnimatedItem>
<OnboardingStepAnimatedItem index={1}>
<StyledOnboardingStepSubtitle>
{hasApps
- ? t`Get the most out of your CRM by installing some apps`
+ ? plural(apps.length, {
+ one: 'One app, installed in one click.',
+ other: '# apps, installed in one click.',
+ })
: t`No apps are available to install right now`}
</StyledOnboardingStepSubtitle>
</OnboardingStepAnimatedItem>
- {isDefined(creditsReward) && hasApps && (
- <OnboardingStepAnimatedItem index={2}>
- <StyledOnboardingStepTagsRow>
- <OnboardingCreditsRewardTag amount={creditsReward} />
- </StyledOnboardingStepTagsRow>
- </OnboardingStepAnimatedItem>
- )}
</StyledOnboardingStepHeading>
{hasApps && (
- <OnboardingStepAnimatedItem index={3}>
- <StyledCard>
+ <OnboardingStepAnimatedItem index={2}>
+ <StyledTiles>
{apps.map((app) => {
const labelText = t(app.label);
const isSelected = selectedUniversalIdentifiers.includes(
@@ -158,59 +194,51 @@ export const InstallAppsContent = ({
);
return (
- <StyledAppRow key={app.universalIdentifier}>
- <Avatar
- src={getAbsoluteImageUrl(app.logoUrl)}
- name={labelText}
- colorSeed={app.universalIdentifier}
- size="lg"
- shape="square"
- />
- <StyledAppText>
+ <StyledTile
+ key={app.universalIdentifier}
+ type="button"
+ aria-pressed={isSelected}
+ disabled={isCompleting}
+ onClick={() => toggleApp(app.universalIdentifier)}
+ >
+ <StyledTileContent>
+ <Avatar
+ src={getAbsoluteImageUrl(app.logoUrl)}
+ name={labelText}
+ colorSeed={app.universalIdentifier}
+ size="xl"
+ shape="rounded-square"
+ />
<StyledAppLabel>{labelText}</StyledAppLabel>
<StyledAppDescription>
{t(app.description)}
</StyledAppDescription>
- </StyledAppText>
- <IconButton
- size="sm"
- variant="outline"
- color={isSelected ? 'accent' : 'neutral'}
- aria-label={
- isSelected
- ? t`Deselect ${labelText}`
- : t`Select ${labelText}`
- }
- onClick={() => onToggleApp(app.universalIdentifier)}
- >
- <AnimatedIconCrossfade
- isActive={isSelected}
- ActiveIcon={IconCheck}
- InactiveIcon={IconPlus}
- size={theme.icon.size.md}
- />
- </IconButton>
- </StyledAppRow>
+ </StyledTileContent>
+ <StyledTileCheck aria-hidden>
+ {isSelected && (
+ <IconCheck size={theme.icon.size.sm} stroke={3} />
+ )}
+ </StyledTileCheck>
+ </StyledTile>
);
})}
- </StyledCard>
+ </StyledTiles>
</OnboardingStepAnimatedItem>
)}
- <OnboardingStepAnimatedItem index={4}>
+ <OnboardingStepAnimatedItem index={3}>
<StyledFooter>
{hasApps && (
<StyledInstallButton>
- <MainButton
- onClick={onInstall}
- disabled={
- isCompleting || !isNonEmptyArray(selectedUniversalIdentifiers)
- }
- fullWidth
- >{t`Install`}</MainButton>
+ <OnboardingRewardMainButton
+ label={getInstallLabel()}
+ creditsReward={hasSelectedApps ? creditsReward : 0}
+ disabled={isCompleting}
+ onClick={installSelectedAppsAndContinue}
+ />
</StyledInstallButton>
)}
- <OnboardingSkipButton onClick={onSkip} disabled={isCompleting} />
+ <OnboardingSkipButton onClick={skip} disabled={isCompleting} />
</StyledFooter>
</OnboardingStepAnimatedItem>
</StyledOnboardingStepPage>
diff --git a/packages/twenty-front/src/pages/onboarding/InviteTeam.tsx b/packages/twenty-front/src/pages/onboarding/InviteTeam.tsx
index 6dde2e6d92b..92105c4833a 100644
--- a/packages/twenty-front/src/pages/onboarding/InviteTeam.tsx
+++ b/packages/twenty-front/src/pages/onboarding/InviteTeam.tsx
@@ -1,26 +1,24 @@
-import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
+import { OnboardingInviteTeamSkipDialog } from '@/onboarding/components/OnboardingInviteTeamSkipDialog';
+import { OnboardingRewardMainButton } from '@/onboarding/components/OnboardingRewardMainButton';
import { OnboardingSkipButton } from '@/onboarding/components/OnboardingSkipButton';
import { OnboardingStepAnimatedItem } from '@/onboarding/components/OnboardingStepAnimatedItem';
import { StyledOnboardingStepHeading } from '@/onboarding/components/StyledOnboardingStepHeading';
import { StyledOnboardingStepPage } from '@/onboarding/components/StyledOnboardingStepPage';
import { StyledOnboardingStepSubtitle } from '@/onboarding/components/StyledOnboardingStepSubtitle';
-import { StyledOnboardingStepTagsRow } from '@/onboarding/components/StyledOnboardingStepTagsRow';
import { StyledOnboardingStepTitle } from '@/onboarding/components/StyledOnboardingStepTitle';
-import { OnboardingCreditsRewardTag } from '@/onboarding/components/import-contacts/OnboardingCreditsRewardTag';
import { ONBOARDING_CONTENT_BLOCK_WIDTH } from '@/onboarding/constants/OnboardingContentBlockWidth';
import { ONBOARDING_MOTION_SLIDE_OFFSET } from '@/onboarding/constants/OnboardingMotionSlideOffset';
import { useInviteTeam } from '@/onboarding/hooks/useInviteTeam';
import { useOnboardingMotionTransition } from '@/onboarding/hooks/useOnboardingMotionTransition';
+import { onboardingCreditsProgressSelector } from '@/onboarding/states/selectors/onboardingCreditsProgressSelector';
import { TextInput } from '@/ui/input/components/TextInput';
import { useAtomStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomStateValue';
import { styled } from '@linaria/react';
import { useLingui } from '@lingui/react/macro';
import { AnimatePresence, motion } from 'framer-motion';
+import { useRef } from 'react';
import { Controller } from 'react-hook-form';
-import { isDefined } from 'twenty-shared/utils';
-import { MainButton } from 'twenty-ui/components';
import { IconX } from 'twenty-ui/icon';
-import { Loader } from 'twenty-ui/primitives/feedback';
import { themeCssVariables } from 'twenty-ui/theme';
const StyledForm = styled.div`
@@ -46,22 +44,25 @@ export const InviteTeam = () => {
control,
fields,
remove,
- handleSubmit,
- onSubmit,
handleSkip,
+ handleInvite,
+ openSkipDialog,
+ emailIndexToFocus,
getPlaceholder,
isValid,
isSubmitting,
isNavigating,
} = useInviteTeam();
- const onboardingConfig = useAtomStateValue(onboardingConfigState);
- const creditsRewardPerUser = onboardingConfig?.inviteTeamCreditsRewardPerUser;
+ const { inviteTeamButtonReward } = useAtomStateValue(
+ onboardingCreditsProgressSelector,
+ );
+ const emailInputToFocusRef = useRef<HTMLInputElement>(null);
const transition = useOnboardingMotionTransition();
const canRemoveEmailField = fields.length > 1;
return (
- <StyledOnboardingStepPage>
+ <StyledOnboardingStepPage data-testid="onboarding-invite-team-step">
<StyledOnboardingStepHeading>
<OnboardingStepAnimatedItem index={0}>
<StyledOnboardingStepTitle>{t`Invite your team`}</StyledOnboardingStepTitle>
@@ -71,19 +72,9 @@ export const InviteTeam = () => {
{t`Get the most out of your workspace by inviting your team.`}
</StyledOnboardingStepSubtitle>
</OnboardingStepAnimatedItem>
- {isDefined(creditsRewardPerUser) && (
- <OnboardingStepAnimatedItem index={2}>
- <StyledOnboardingStepTagsRow>
- <OnboardingCreditsRewardTag
- amount={creditsRewardPerUser}
- suffix={t`free credits per user`}
- />
- </StyledOnboardingStepTagsRow>
- </OnboardingStepAnimatedItem>
- )}
</StyledOnboardingStepHeading>
- <OnboardingStepAnimatedItem index={3}>
+ <OnboardingStepAnimatedItem index={2}>
<StyledForm>
<AnimatePresence initial={false}>
{fields.map((field, index) => (
@@ -103,6 +94,11 @@ export const InviteTeam = () => {
fieldState: { error },
}) => (
<TextInput
+ ref={
+ index === emailIndexToFocus
+ ? emailInputToFocusRef
+ : undefined
+ }
autoFocus={index === 0}
type="email"
value={value}
@@ -125,20 +121,28 @@ export const InviteTeam = () => {
</StyledForm>
</OnboardingStepAnimatedItem>
- <OnboardingStepAnimatedItem index={4}>
+ <OnboardingStepAnimatedItem index={3}>
<StyledFooter>
- <MainButton
- startIcon={isSubmitting || isNavigating ? <Loader /> : null}
- disabled={!isValid || isSubmitting || isNavigating}
- onClick={handleSubmit(onSubmit)}
- fullWidth
- >{t`Invite`}</MainButton>
+ <OnboardingRewardMainButton
+ label={t`Invite`}
+ creditsReward={inviteTeamButtonReward.creditsReward}
+ isRewardPerItem={inviteTeamButtonReward.isRewardPerItem}
+ disabled={!isValid}
+ isLoading={isSubmitting || isNavigating}
+ onClick={handleInvite}
+ />
<OnboardingSkipButton
- onClick={handleSkip}
+ onClick={() => void openSkipDialog()}
disabled={isSubmitting || isNavigating}
/>
</StyledFooter>
</OnboardingStepAnimatedItem>
+ <OnboardingInviteTeamSkipDialog
+ isValid={isValid}
+ finalFocus={emailInputToFocusRef}
+ onInvite={handleInvite}
+ onSkip={() => void handleSkip()}
+ />
</StyledOnboardingStepPage>
);
};
diff --git a/packages/twenty-front/src/pages/onboarding/SyncEmails.tsx b/packages/twenty-front/src/pages/onboarding/SyncEmails.tsx
index a40ce55b840..08b1f6ee004 100644
--- a/packages/twenty-front/src/pages/onboarding/SyncEmails.tsx
+++ b/packages/twenty-front/src/pages/onboarding/SyncEmails.tsx
@@ -1,11 +1,9 @@
-import { currentUserState } from '@/auth/states/currentUserState';
import { isCurrentUserLoadedState } from '@/auth/states/isCurrentUserLoadedState';
import { clientConfigApiStatusState } from '@/client-config/states/clientConfigApiStatusState';
import { isGoogleCalendarEnabledState } from '@/client-config/states/isGoogleCalendarEnabledState';
import { isGoogleMessagingEnabledState } from '@/client-config/states/isGoogleMessagingEnabledState';
import { isMicrosoftCalendarEnabledState } from '@/client-config/states/isMicrosoftCalendarEnabledState';
import { isMicrosoftMessagingEnabledState } from '@/client-config/states/isMicrosoftMessagingEnabledState';
-import { onboardingConfigState } from '@/client-config/states/onboardingConfigState';
import { OnboardingSkipDialog } from '@/onboarding/components/OnboardingSkipDialog';
import { OnboardingSkipDialogAvatars } from '@/onboarding/components/OnboardingSkipDialogAvatars';
import { ONBOARDING_NETWORK_PREVIEW_PEOPLE } from '@/onboarding/constants/OnboardingNetworkPreviewPeople';
@@ -14,6 +12,7 @@ import { SyncEmailsAutoSkipEffect } from '@/onboarding/effect-components/SyncEma
import { useOnboardingStepEnterHotkey } from '@/onboarding/hooks/useOnboardingStepEnterHotkey';
import { useSetOnboardingStepFreeCredits } from '@/onboarding/hooks/useSetOnboardingStepFreeCredits';
import { useSkipSyncEmailOnboardingStep } from '@/onboarding/hooks/useSkipSyncEmailOnboardingStep';
+import { onboardingCreditsProgressSelector } from '@/onboarding/states/selectors/onboardingCreditsProgressSelector';
import { useTriggerApisOAuth } from '@/settings/accounts/hooks/useTriggerApiOAuth';
import { useHasPermissionFlag } from '@/settings/roles/hooks/useHasPermissionFlag';
import { PageFocusId } from '@/types/PageFocusId';
@@ -33,11 +32,9 @@ import {
export const SyncEmails = () => {
const { t } = useLingui();
const { openDialog } = useDialog();
- const onboardingConfig = useAtomStateValue(onboardingConfigState);
- const currentUser = useAtomStateValue(currentUserState);
- const importContactsCreditsReward = currentUser?.isWorkspaceCreator
- ? (onboardingConfig?.importContactsCreditsReward ?? 0)
- : 0;
+ const importContactsCreditsReward = useAtomStateValue(
+ onboardingCreditsProgressSelector,
+ ).rewardCreditsByStep.importContacts;
const { triggerApisOAuth } = useTriggerApisOAuth();
const skipSyncEmailOnboardingStep = useSkipSyncEmailOnboardingStep();
const setOnboardingStepFreeCredits = useSetOnboardingStepFreeCredits();
@@ -94,12 +91,14 @@ export const SyncEmails = () => {
isEnabled: isMicrosoftProviderEnabled,
label: t`Continue with Microsoft`,
Icon: IconMicrosoft,
+ creditsReward: importContactsCreditsReward,
onClick: () => connectWithProvider(ConnectedAccountProvider.MICROSOFT),
},
{
isEnabled: isGoogleProviderEnabled,
label: t`Continue with Google`,
Icon: IconGoogle,
+ creditsReward: importContactsCreditsReward,
onClick: () => connectWithProvider(ConnectedAccountProvider.GOOGLE),
},
].filter((providerAction) => providerAction.isEnabled);
@@ -139,11 +138,7 @@ export const SyncEmails = () => {
return (
<>
- <ImportContacts
- providerActions={providerActions}
- onSkip={handleSkip}
- creditsReward={importContactsCreditsReward}
- />
+ <ImportContacts providerActions={providerActions} onSkip={handleSkip} />
<OnboardingSkipDialog
dialogId={ONBOARDING_SKIP_DIALOG_IDS.syncEmails}
visual={
@@ -159,7 +154,6 @@ export const SyncEmails = () => {
title={t`Start with your whole network`}
description={t`Twenty adds the people you email and meet, and keeps them up to date without manual data entry.`}
actions={providerActions}
- creditsReward={importContactsCreditsReward}
onSkip={() => void handleSkipConfirm()}
/>
</>
diff --git a/packages/twenty-front/src/pages/onboarding/__stories__/ImportContacts.stories.tsx b/packages/twenty-front/src/pages/onboarding/__stories__/ImportContacts.stories.tsx
index 59c2b9574ae..195f68c56f2 100644
--- a/packages/twenty-front/src/pages/onboarding/__stories__/ImportContacts.stories.tsx
+++ b/packages/twenty-front/src/pages/onboarding/__stories__/ImportContacts.stories.tsx
@@ -18,16 +18,17 @@ const meta: Meta<typeof ImportContacts> = {
component: ImportContacts,
parameters: { layout: 'fullscreen' },
args: {
- creditsReward: 2,
providerActions: [
{
label: 'Continue with Microsoft',
Icon: IconMicrosoft,
+ creditsReward: 2,
onClick: action('continue-with-microsoft'),
},
{
label: 'Continue with Google',
Icon: IconGoogle,
+ creditsReward: 2,
onClick: action('continue-with-google'),
},
],
diff --git a/packages/twenty-front/src/pages/onboarding/__stories__/InstallApps.stories.tsx b/packages/twenty-front/src/pages/onboarding/__stories__/InstallApps.stories.tsx
index f613df96bdc..03e28a57d5b 100644
--- a/packages/twenty-front/src/pages/onboarding/__stories__/InstallApps.stories.tsx
+++ b/packages/twenty-front/src/pages/onboarding/__stories__/InstallApps.stories.tsx
@@ -18,7 +18,8 @@ import { mockedOnboardingUserData } from '~/testing/mock-data/users';
const CALL_RECORDER_UNIVERSAL_IDENTIFIER =
'8da4b8b5-5edf-4880-b51f-ab6e679ec617';
-const ENRICHMENT_UNIVERSAL_IDENTIFIER = '4a1178c1-3535-4a47-b592-231d3216b36f';
+const PEOPLE_DATA_LABS_UNIVERSAL_IDENTIFIER =
+ '4a1178c1-3535-4a47-b592-231d3216b36f';
const LAST_CONTACT_UNIVERSAL_IDENTIFIER =
'66a504cc-0a75-410e-a43f-cdeae1db1522';
@@ -74,7 +75,10 @@ const meta: Meta<PageDecoratorArgs> = {
CALL_RECORDER_UNIVERSAL_IDENTIFIER,
'Call recorder',
),
- buildMarketplaceApp(ENRICHMENT_UNIVERSAL_IDENTIFIER, 'Enrichment'),
+ buildMarketplaceApp(
+ PEOPLE_DATA_LABS_UNIVERSAL_IDENTIFIER,
+ 'People Data Labs',
+ ),
buildMarketplaceApp(LAST_CONTACT_UNIVERSAL_IDENTIFIER, 'Last contact'),
]),
},
@@ -88,9 +92,9 @@ export type Story = StoryObj<typeof InstallApps>;
export const Default: Story = {
play: async ({ canvasElement }) => {
const canvas = within(canvasElement.ownerDocument.body);
- await canvas.findByText('Install your first apps');
+ await canvas.findByText('Start with the essentials');
await canvas.findByText('Call recorder');
- await canvas.findByText('Enrichment');
+ await canvas.findByText('People Data Labs');
await canvas.findByText('Last contact');
},
};
@@ -109,7 +113,7 @@ export const OnlyAvailableApps: Story = {
play: async ({ canvasElement }) => {
const canvas = within(canvasElement.ownerDocument.body);
await canvas.findByText('Call recorder');
- expect(canvas.queryByText('Enrichment')).toBeNull();
+ expect(canvas.queryByText('People Data Labs')).toBeNull();
expect(canvas.queryByText('Last contact')).toBeNull();
},
};
@@ -123,8 +127,8 @@ export const OnlyVettedApps: Story = {
'Call recorder',
),
buildMarketplaceApp(
- ENRICHMENT_UNIVERSAL_IDENTIFIER,
- 'Enrichment',
+ PEOPLE_DATA_LABS_UNIVERSAL_IDENTIFIER,
+ 'People Data Labs',
false,
),
buildMarketplaceApp(
@@ -138,7 +142,7 @@ export const OnlyVettedApps: Story = {
play: async ({ canvasElement }) => {
const canvas = within(canvasElement.ownerDocument.body);
await canvas.findByText('Call recorder');
- expect(canvas.queryByText('Enrichment')).toBeNull();
+ expect(canvas.queryByText('People Data Labs')).toBeNull();
expect(canvas.queryByText('Last contact')).toBeNull();
},
};
@@ -163,7 +167,11 @@ export const MarketplaceUnavailable: Story = {
play: async ({ canvasElement }) => {
const canvas = within(canvasElement.ownerDocument.body);
await canvas.findByText('No apps are available to install right now');
- expect(canvas.queryByText('Install')).toBeNull();
+ expect(
+ canvas.queryByRole('button', {
+ name: /^(Install|Continue without apps)/,
+ }),
+ ).toBeNull();
await canvas.findByText('Skip');
},
};
diff --git a/packages/twenty-front/src/pages/onboarding/__stories__/InviteTeam.stories.tsx b/packages/twenty-front/src/pages/onboarding/__stories__/InviteTeam.stories.tsx
index 7d049855f77..2afe05181e6 100644
--- a/packages/twenty-front/src/pages/onboarding/__stories__/InviteTeam.stories.tsx
+++ b/packages/twenty-front/src/pages/onboarding/__stories__/InviteTeam.stories.tsx
@@ -85,3 +85,28 @@ export const RemovesAllInputsButTheLast: Story = {
);
},
};
+
+export const FocusesTheInvalidEmailAfterAddTeammates: Story = {
+ play: async ({ canvasElement }) => {
+ const canvas = within(canvasElement.ownerDocument.body);
+
+ await canvas.findByText('Invite your team');
+
+ const [firstEmailInput, secondEmailInput] = await findEmailInputs(canvas);
+
+ await userEvent.type(firstEmailInput, '[email protected]');
+ await userEvent.type(secondEmailInput, 'alan@');
+ await userEvent.click(canvas.getByRole('button', { name: 'Skip' }));
+
+ const dialog = await canvas.findByRole('dialog', {
+ name: "Your invite isn't sent yet",
+ });
+
+ await userEvent.click(
+ within(dialog).getByRole('button', { name: /^Add teammates/ }),
+ );
+
+ await waitFor(() => expect(dialog).not.toBeInTheDocument());
+ await waitFor(() => expect(secondEmailInput).toHaveFocus());
+ },
+};