feat(onboarding) - enable onboarding reserves (#795)

* feat(onboarding-reserves) - add feature flag to test onboarding reserves

* fix endpoint

Author: gabrielseco

example/src/Onboarding.tsx

@@ -264,6 +264,7 @@ const OnboardingWithProps = ({
       employmentId={employmentId}
       externalId={externalId}
       options={{
+        features: ['onboarding_reserves'],
         jsonSchemaVersionByCountry: {
           DEU: {
             contract_details: 1,

src/flows/Onboarding/hooks.tsx

@@ -213,9 +213,10 @@ export const useOnboarding = ({
     refetch: refetchCompany,
   } = useCompany(companyId);
 
-  // TODO: remove this once the onboarding reserves are enabled, change this to stepState.currentStep.name === 'review'
-  // TODO: Go to src/flows/Onboarding/tests/OnboardingInvite.test.tsx and unskip test should render "Create Reserve" button when onboardingReservesStatus is deposit_required
-  const isOnboardingReservesEnabled = false;
+  const isOnboardingReservesEnabled =
+    (options?.features?.includes('onboarding_reserves') &&
+      stepState.currentStep.name === 'review') ||
+    false;
 
   const { data: onboardingReservesStatus } =
     useEmploymentOnboardingReservesStatus(

src/flows/Onboarding/tests/OnboardingInvite.test.tsx

@@ -630,8 +630,7 @@ describe('OnboardingInvite', () => {
     });
   });
 
-  // TODO: unskip this test once the onboarding reserves are enabled
-  it.skip('should render "Create Reserve" button when onboardingReservesStatus is deposit_required', async () => {
+  it('should render "Create Reserve" button when onboardingReservesStatus is deposit_required', async () => {
     let onboardingBagRef: OnboardingRenderProps['onboardingBag'] | null = null;
 
     const testRender = ({
@@ -685,6 +684,9 @@ describe('OnboardingInvite', () => {
         {...defaultProps}
         skipSteps={['select_country']}
         render={testRender}
+        options={{
+          features: ['onboarding_reserves'],
+        }}
       />,
       { wrapper: TestProviders },
     );

src/flows/Onboarding/types.ts

@@ -49,6 +49,8 @@ export type OnboardingRenderProps = {
   };
 };
 
+type OnboardingFeatures = 'onboarding_reserves';
+
 export type OnboardingFlowProps = {
   /**
    * The country code to use for the onboarding.
@@ -102,6 +104,12 @@ export type OnboardingFlowProps = {
         contract_details?: number | 'latest';
       };
     };
+    /**
+     * The features to use for the onboarding.
+     * This is used to enable or disable features for the onboarding.
+     * Currently only supports enabling the onboarding reserves feature.
+     */
+    features?: OnboardingFeatures[];
   };
   /**
    * The render prop function with the params passed by the useOnboarding hook and the components available to use for this flow