richie 2.29.1__py2.py3-none-any.whl → 2.30.0__py2.py3-none-any.whl

frontend/js/api/joanie.ts

@@ -15,7 +15,8 @@ import context from 'utils/context';
 import { JOANIE_API_VERSION } from 'settings';
 import { ResourcesQuery } from 'hooks/useResources';
 import { ObjectHelper } from 'utils/ObjectHelper';
-import { Maybe } from 'types/utils';
+import { Maybe, Nullable } from 'types/utils';
+import { PaymentSchedule } from 'types/Joanie';
 import { checkStatus, getFileFromResponse } from './utils';
 
 /*
@@ -79,9 +80,9 @@ export const getRoutes = () => {
       },
       creditCards: {
         get: `${baseUrl}/credit-cards/:id/`,
-        create: `${baseUrl}/credit-cards/`,
         update: `${baseUrl}/credit-cards/:id/`,
         delete: `${baseUrl}/credit-cards/:id/`,
+        tokenize: `${baseUrl}/credit-cards/tokenize-card/`,
       },
       addresses: {
         get: `${baseUrl}/addresses/:id/`,
@@ -90,14 +91,15 @@ export const getRoutes = () => {
         delete: `${baseUrl}/addresses/:id/`,
       },
       orders: {
-        abort: `${baseUrl}/orders/:id/abort/`,
+        cancel: `${baseUrl}/orders/:id/cancel/`,
         create: `${baseUrl}/orders/`,
-        submit: `${baseUrl}/orders/:id/submit/`,
         get: `${baseUrl}/orders/:id/`,
         invoice: {
           download: `${baseUrl}/orders/:id/invoice/`,
         },
         submit_for_signature: `${baseUrl}/orders/:id/submit_for_signature/`,
+        submit_installment_payment: `${baseUrl}/orders/:id/submit-installment-payment/`,
+        set_payment_method: `${baseUrl}/orders/:id/payment-method/`,
       },
       certificates: {
         download: `${baseUrl}/certificates/:id/download/`,
@@ -142,6 +144,9 @@ export const getRoutes = () => {
       },
       products: {
         get: `${baseUrl}/courses/:course_id/products/:id/`,
+        paymentSchedule: {
+          get: `${baseUrl}/courses/:course_id/products/:id/payment-schedule/`,
+        },
       },
       orders: {
         get: `${baseUrl}/courses/:course_id/orders/:id/`,
@@ -225,11 +230,6 @@ const API = (): Joanie.API => {
         get: async (filters?: ResourcesQuery) => {
           return fetchWithJWT(buildApiUrl(ROUTES.user.creditCards.get, filters)).then(checkStatus);
         },
-        create: async (creditCard) =>
-          fetchWithJWT(ROUTES.user.creditCards.create, {
-            method: 'POST',
-            body: JSON.stringify(creditCard),
-          }).then(checkStatus),
         update: async ({ id, ...creditCard }) => {
           return fetchWithJWT(ROUTES.user.creditCards.update.replace(':id', id), {
             method: 'PUT',
@@ -240,6 +240,8 @@ const API = (): Joanie.API => {
           fetchWithJWT(ROUTES.user.creditCards.delete.replace(':id', id), {
             method: 'DELETE',
           }).then(checkStatus),
+        tokenize: async () =>
+          fetchWithJWT(ROUTES.user.creditCards.tokenize, { method: 'POST' }).then(checkStatus),
       },
       addresses: {
         get: (id?: string) => {
@@ -261,10 +263,9 @@ const API = (): Joanie.API => {
           }).then(checkStatus),
       },
       orders: {
-        abort: async ({ id, payment_id }) => {
-          return fetchWithJWT(ROUTES.user.orders.abort.replace(':id', id), {
+        cancel: async (id) => {
+          return fetchWithJWT(ROUTES.user.orders.cancel.replace(':id', id), {
             method: 'POST',
-            body: payment_id ? JSON.stringify({ payment_id }) : undefined,
           }).then(checkStatus);
         },
         create: async (payload) =>
@@ -272,11 +273,6 @@ const API = (): Joanie.API => {
             method: 'POST',
             body: JSON.stringify(payload),
           }).then(checkStatus),
-        submit: async ({ id, ...payload }) =>
-          fetchWithJWT(ROUTES.user.orders.submit.replace(':id', id), {
-            method: 'PATCH',
-            body: JSON.stringify(payload),
-          }).then(checkStatus),
         get: async (filters) => {
           return fetchWithJWT(buildApiUrl(ROUTES.user.orders.get, filters)).then(checkStatus);
         },
@@ -292,6 +288,16 @@ const API = (): Joanie.API => {
           fetchWithJWT(ROUTES.user.orders.submit_for_signature.replace(':id', id), {
             method: 'POST',
           }).then(checkStatus),
+        submit_installment_payment: async (id, payload) =>
+          fetchWithJWT(ROUTES.user.orders.submit_installment_payment.replace(':id', id), {
+            method: 'POST',
+            body: JSON.stringify(payload),
+          }).then(checkStatus),
+        set_payment_method: async ({ id, ...payload }) =>
+          fetchWithJWT(ROUTES.user.orders.set_payment_method.replace(':id', id), {
+            method: 'POST',
+            body: JSON.stringify(payload),
+          }).then(checkStatus),
       },
       enrollments: {
         create: async (payload) =>
@@ -419,6 +425,25 @@ const API = (): Joanie.API => {
 
           return fetchWithJWT(buildApiUrl(ROUTES.courses.products.get, filters)).then(checkStatus);
         },
+        paymentSchedule: {
+          get: async (
+            filters?: Joanie.CourseProductQueryFilters,
+          ): Promise<Nullable<PaymentSchedule>> => {
+            if (!filters) {
+              throw new Error(
+                'A course code and a product id are required to fetch a course product',
+              );
+            } else if (!filters.course_id) {
+              throw new Error('A course code is required to fetch a course product');
+            } else if (!filters.id) {
+              throw new Error('A product id is required to fetch a course product');
+            }
+
+            return fetchWithJWT(
+              buildApiUrl(ROUTES.courses.products.paymentSchedule.get, filters),
+            ).then(checkStatus);
+          },
+        },
       },
       orders: {
         get: async (filters?: Joanie.CourseOrderResourceQuery) => {

frontend/js/api/lms/dummy.ts

@@ -68,7 +68,7 @@ const API = (APIConf: LMSBackend | AuthenticationBackend): APILms => {
 
   const dummyOpenEdxApiProfile: OpenEdxApiProfile = {
     username: 'j_do',
-    name: 'John Do',
+    name: 'John Doe',
     email: 'j.do@whois.net',
     country: 'fr',
     level_of_education: OpenEdxLevelOfEducation.MASTER_OR_PROFESSIONNAL_DEGREE,
@@ -112,17 +112,6 @@ const API = (APIConf: LMSBackend | AuthenticationBackend): APILms => {
       account: {
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
         get: (username: string): Promise<OpenEdxApiProfile> => {
-          return Promise.resolve({
-            username: 'j_do',
-            name: 'John Do',
-            email: 'j.do@whois.net',
-            country: 'fr',
-            level_of_education: OpenEdxLevelOfEducation.MASTER_OR_PROFESSIONNAL_DEGREE,
-            gender: OpenEdxGender.MALE,
-            year_of_birth: '1971',
-            'pref-lang': OpenEdxLanguageIsoCode.ENGLISH,
-            language_proficiencies: [{ code: OpenEdxLanguageIsoCode.ENGLISH }],
-          } as OpenEdxApiProfile);
           return Promise.resolve(dummyOpenEdxApiProfile);
         },
         // eslint-disable-next-line @typescript-eslint/no-unused-vars

frontend/js/components/ContractFrame/AbstractContractFrame.spec.tsx

@@ -4,6 +4,7 @@ import fetchMock from 'fetch-mock';
 import { render, screen, waitFor, act } from '@testing-library/react';
 import userEvent from '@testing-library/user-event';
 import { PropsWithChildren } from 'react';
+import { CunninghamProvider } from '@openfun/cunningham-react';
 import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
 import { createTestQueryClient } from 'utils/test/createTestQueryClient';
 import JoanieSessionProvider from 'contexts/SessionContext/JoanieSessionProvider';
@@ -33,11 +34,13 @@ jest.mock('settings', () => ({
 describe('<AbstractContractFrame />', () => {
   const Wrapper = ({ children }: PropsWithChildren) => {
     return (
-      <QueryClientProvider client={createTestQueryClient({ user: true })}>
-        <IntlProvider locale="en">
-          <JoanieSessionProvider>{children}</JoanieSessionProvider>
-        </IntlProvider>
-      </QueryClientProvider>
+      <CunninghamProvider>
+        <QueryClientProvider client={createTestQueryClient({ user: true })}>
+          <IntlProvider locale="en">
+            <JoanieSessionProvider>{children}</JoanieSessionProvider>
+          </IntlProvider>
+        </QueryClientProvider>
+      </CunninghamProvider>
     );
   };
 
@@ -78,7 +81,7 @@ describe('<AbstractContractFrame />', () => {
     expect(await screen.findByTestId('dashboard-contract-frame')).toBeInTheDocument();
 
     const user = userEvent.setup();
-    await user.click(screen.getByRole('button', { name: 'Close dialog' }));
+    await user.click(screen.getByRole('button', { name: 'close' }));
     expect(mockOnClose).toHaveBeenCalled();
   });
 
@@ -115,6 +118,7 @@ describe('<AbstractContractFrame />', () => {
     const mockCheckSignature = jest.fn(async () => checkSignatureDeferred.promise);
     const mockOnDone = jest.fn();
     const mockOnClose = jest.fn();
+    fetchMock.post('https://joanie.endpoint/api/v1.0/signature/notifications/', 200);
 
     await act(async () => {
       render(
@@ -138,7 +142,7 @@ describe('<AbstractContractFrame />', () => {
     await user.click(button);
 
     // The dummy interface should be loading
-    screen.getByRole('heading', { name: 'Signing the contract ...' });
+    await screen.findByRole('heading', { name: 'Signing the contract ...' });
 
     // Then the signature check polling should be started
     await waitFor(() => {
@@ -176,6 +180,7 @@ describe('<AbstractContractFrame />', () => {
     const mockCheckSignature = jest.fn(async () => checkSignatureDeferred.promise);
     const mockOnDone = jest.fn();
     const mockOnClose = jest.fn();
+    fetchMock.post('https://joanie.endpoint/api/v1.0/signature/notifications/', 200);
 
     await act(async () => {
       render(
@@ -222,7 +227,7 @@ describe('<AbstractContractFrame />', () => {
     // have been called
     await expectBannerError('An error happened while verifying signature. Please come back later.');
     expect(mockOnDone).not.toHaveBeenCalled();
-    button = screen.getByRole('button', { name: 'Close dialog' });
+    button = screen.getByRole('button', { name: 'close' });
     await user.click(button);
 
     expect(mockOnClose).toHaveBeenCalledTimes(1);
@@ -237,6 +242,7 @@ describe('<AbstractContractFrame />', () => {
     const mockCheckSignature = jest.fn(async () => checkSignatureDeferred.promise);
     const mockOnDone = jest.fn();
     const mockOnClose = jest.fn();
+    fetchMock.post('https://joanie.endpoint/api/v1.0/signature/notifications/', 200);
 
     await act(async () => {
       render(
@@ -285,7 +291,7 @@ describe('<AbstractContractFrame />', () => {
       'The signature is taking more time than expected ... please come back later.',
     );
     expect(mockOnDone).not.toHaveBeenCalled();
-    button = screen.getByRole('button', { name: 'Close dialog' });
+    button = screen.getByRole('button', { name: 'close' });
     await user.click(button);
 
     expect(mockOnClose).toHaveBeenCalledTimes(1);
@@ -300,6 +306,7 @@ describe('<AbstractContractFrame />', () => {
     const mockCheckSignature = jest.fn(async () => checkSignatureDeferred.promise);
     const mockOnDone = jest.fn();
     const mockOnClose = jest.fn();
+    fetchMock.post('https://joanie.endpoint/api/v1.0/signature/notifications/', 200);
 
     await act(async () => {
       render(
@@ -323,7 +330,7 @@ describe('<AbstractContractFrame />', () => {
     );
 
     // Dummy signature interface should have been rendered
-    const button = screen.getByRole('button', { name: 'Close dialog' });
+    const button = screen.getByRole('button', { name: 'close' });
     await user.click(button);
 
     expect(mockOnClose).toHaveBeenCalledTimes(1);

frontend/js/components/ContractFrame/AbstractContractFrame.tsx

@@ -1,11 +1,11 @@
 import React, { lazy, Suspense, useEffect, useRef, useState } from 'react';
-import { Button, Loader } from '@openfun/cunningham-react';
+import { Button, Loader, Modal, ModalSize } from '@openfun/cunningham-react';
 import { defineMessages, FormattedMessage, useIntl } from 'react-intl';
-import { Modal } from 'components/Modal';
 import { Maybe } from 'types/utils';
 import { CONTRACT_SETTINGS } from 'settings';
 import Banner, { BannerType } from 'components/Banner';
 import { SuccessIcon } from 'components/SuccessIcon';
+import { noop } from 'utils';
 
 /*
   /!\ This component should not be used directly, only its implementations should be.
@@ -63,7 +63,7 @@ export const messages = defineMessages({
   },
   finishedDescription: {
     defaultMessage:
-      'You will receive an email once your contract will be fully signed. You can now enroll in your course runs!',
+      'You will receive an email once your contract will be fully signed. You can now finalize your subscription.',
     description: 'Message displayed inside the contract signin modal when the contract is signed.',
     id: 'components.DashboardItem.Order.ContractFrame.finishedDescription',
   },
@@ -109,15 +109,16 @@ export interface SignatureProps {
   invitationLink: string;
 }
 
-const AbstractContractFrame = ({ isOpen, ...props }: Props) => {
+const AbstractContractFrame = ({ isOpen, onClose = noop, ...props }: Props) => {
   return (
     <Modal
       isOpen={isOpen}
-      shouldCloseOnOverlayClick={false}
-      shouldCloseOnEsc={false}
-      onRequestClose={props.onClose}
+      closeOnClickOutside={false}
+      closeOnEsc={false}
+      onClose={onClose}
+      size={ModalSize.LARGE}
     >
-      <ContractFrameContent {...props} />
+      <ContractFrameContent {...props} onClose={onClose} />
     </Modal>
   );
 };
@@ -222,11 +223,13 @@ const ContractFrameContent = ({
 
   const renderLoadingContract = () => {
     return (
-      <div className="ContractFrame__loading-container">
+      <div className="ContractFrame__container">
         <h3 className="ContractFrame__caption">
           <FormattedMessage {...messages.loadingContract} />
         </h3>
-        <Loader />
+        <div className="ContractFrame__footer">
+          <Loader />
+        </div>
       </div>
     );
   };
@@ -258,20 +261,20 @@ const ContractFrameContent = ({
         </Suspense>
       )}
       {step === ContractSteps.POLLING && (
-        <div className="ContractFrame__loading-container">
-          <div>
-            <h3 className="ContractFrame__caption">
-              <FormattedMessage {...messages.polling} />
-            </h3>
-            <p className="ContractFrame__content">
-              <FormattedMessage {...messages.pollingDescription} />
-            </p>
+        <div className="ContractFrame__container">
+          <h3 className="ContractFrame__caption">
+            <FormattedMessage {...messages.polling} />
+          </h3>
+          <p className="ContractFrame__content">
+            <FormattedMessage {...messages.pollingDescription} />
+          </p>
+          <div className="ContractFrame__footer">
+            <Loader />
           </div>
-          <Loader />
         </div>
       )}
       {step === ContractSteps.FINISHED && (
-        <div className="ContractFrame__finished">
+        <div className="ContractFrame__container">
           <SuccessIcon />
           <h3 className="ContractFrame__caption">
             <FormattedMessage {...messages.finishedCaption} />
@@ -279,9 +282,11 @@ const ContractFrameContent = ({
           <p className="ContractFrame__content">
             <FormattedMessage {...messages.finishedDescription} />
           </p>
-          <Button onClick={onClose}>
-            <FormattedMessage {...messages.finishedButton} />
-          </Button>
+          <div className="ContractFrame__footer">
+            <Button onClick={onClose}>
+              <FormattedMessage {...messages.finishedButton} />
+            </Button>
+          </div>
         </div>
       )}
     </div>

frontend/js/components/ContractFrame/LearnerContractFrame.tsx

@@ -1,12 +1,12 @@
 import { useQueryClient } from '@tanstack/react-query';
-import { CredentialOrder, NestedCredentialOrder } from 'types/Joanie';
+import { Order, AbstractNestedOrder } from 'types/Joanie';
 import { useJoanieApi } from 'contexts/JoanieApiContext';
 import AbstractContractFrame, {
   AbstractProps,
 } from 'components/ContractFrame/AbstractContractFrame';
 
 interface Props extends AbstractProps {
-  order: CredentialOrder | NestedCredentialOrder;
+  order: Order | AbstractNestedOrder;
 }
 
 const LearnerContractFrame = ({ order, onDone, ...props }: Props) => {

frontend/js/components/ContractFrame/_styles.scss

@@ -17,15 +17,13 @@ iframe#lex-persona {
 
 .ContractFrame {
   &__modal-body {
-    padding: 0 3rem 1.5rem 3rem;
+    padding: 1.5rem 3rem;
   }
 
-  &__loading-container {
+  &__container {
     display: flex;
     flex-direction: column;
     align-items: center;
-    padding: 3rem 0;
-    gap: 4rem;
   }
 
   &__caption {
@@ -33,16 +31,6 @@ iframe#lex-persona {
     font-size: 1.5rem;
   }
 
-  &__finished {
-    display: flex;
-    flex-direction: column;
-    align-items: center;
-
-    button {
-      margin-top: 2.5rem;
-    }
-  }
-
   &__content {
     color: r-theme-val(contract-frame, content-color);
     font-size: 0.875rem;
@@ -59,4 +47,8 @@ iframe#lex-persona {
     align-items: center;
     gap: 2rem;
   }
+
+  &__footer {
+    margin-top: 2.5rem;
+  }
 }

frontend/js/components/ContractStatus/index.spec.tsx

@@ -23,7 +23,7 @@ describe('<ContractStatus />', () => {
     );
 
     expect(
-      screen.queryByText('You have to sign this training contract to access your training.'),
+      screen.queryByText('You have to sign this training contract to finalize your subscription.'),
     ).toBeInTheDocument();
 
     expect(screen.queryByText(/You signed this training contract/)).not.toBeInTheDocument();

frontend/js/components/ContractStatus/index.tsx

@@ -15,7 +15,7 @@ const messages = defineMessages({
     id: 'components.ContractStatus.organizationSignedOn',
   },
   waitingLearnerSignature: {
-    defaultMessage: 'You have to sign this training contract to access your training.',
+    defaultMessage: 'You have to sign this training contract to finalize your subscription.',
     description: 'Label displayed when a training contract need to be signed by the learner',
     id: 'components.ContractStatus.waitingSignature',
   },