richie-education 3.4.1-dev14 → 3.4.1-dev18

package/i18n/locales/pt-PT.json

@@ -27,6 +27,18 @@
     "description": "Label for the field asking the company address",
     "message": "Endereço"
   },
+  "batchOrder.agreement.organizationSignedOn": {
+    "description": "Label displayed once the organization has counter-signed the agreement",
+    "message": "Signed by the organization on {date}."
+  },
+  "batchOrder.agreement.title": {
+    "description": "Step label for the agreement document in the batch order detail",
+    "message": "Agreement"
+  },
+  "batchOrder.agreement.waitingOrganization": {
+    "description": "Label displayed when the agreement is waiting for the organization counter-signature",
+    "message": "Waiting for the organization to counter-sign the agreement."
+  },
   "batchOrder.bankTransfer": {
     "description": "Option label for selecting bank transfer payment",
     "message": "Transferência bancária"
@@ -59,6 +71,26 @@
     "description": "Label for the field asking the email address of the contact person",
     "message": "E-mail"
   },
+  "batchOrder.enrollmentManagement.enrolledParticipants": {
+    "description": "Progress label showing enrolled participants out of total seats",
+    "message": "{seats_owned}/{nb_seats} enrolled participants"
+  },
+  "batchOrder.enrollmentManagement.loadMore": {
+    "description": "Button to load more seats",
+    "message": "Load {count} more"
+  },
+  "batchOrder.enrollmentManagement.noResults": {
+    "description": "Message shown when the student search returns no results",
+    "message": "No student matches your search."
+  },
+  "batchOrder.enrollmentManagement.searchPlaceholder": {
+    "description": "Placeholder for the seat search input (student name or voucher)",
+    "message": "Student name"
+  },
+  "batchOrder.enrollmentManagement.title": {
+    "description": "Title for enrollment management section",
+    "message": "Enrollment"
+  },
   "batchOrder.firstName": {
     "description": "Label for the field asking the first name of the contact person",
     "message": "Nome próprio"
@@ -197,11 +229,11 @@
   },
   "batchOrder.seats": {
     "description": "Text displayed for seats value in batch order",
-    "message": "Seats"
+    "message": "{nb_seats} seats"
   },
   "batchOrder.seatsCount": {
-    "description": "Text displayed for seats count with pluralization in batch order",
-    "message": "{seats} {seats, plural, one {seat} other {seats}}"
+    "description": "Text displayed for seats count in batch order (owned / total)",
+    "message": "{seats_owned}/{nb_seats} seats"
   },
   "batchOrder.status.assigned": {
     "description": "Status label for an assigned batch order",
@@ -1371,6 +1403,26 @@
     "description": "Accessible label for user menu button",
     "message": "Acesso às suas configurações de perfil"
   },
+  "components.DownloadAgreementButton.download": {
+    "description": "Label for the button to download a signed agreement PDF",
+    "message": "Download agreement"
+  },
+  "components.DownloadAgreementButton.generating": {
+    "description": "Accessible label displayed while agreement PDF is being downloaded.",
+    "message": "Downloading..."
+  },
+  "components.DownloadBatchOrderSeatsButton.download": {
+    "description": "Label for the button to export batch order seats as CSV",
+    "message": "Export CSV"
+  },
+  "components.DownloadBatchOrderSeatsButton.generating": {
+    "description": "Accessible label displayed while CSV export is being generated.",
+    "message": "Generating export..."
+  },
+  "components.DownloadBatchOrderSeatsButton.noSeatsOwned": {
+    "description": "Error message displayed when trying to export seats but no seats are owned yet.",
+    "message": "No participants have claimed their seat yet. The export will be available once at least one participant has enrolled."
+  },
   "components.DownloadCertificateButton.download": {
     "description": "Label for the download button of a certificate",
     "message": "Descarregar"
@@ -2137,7 +2189,7 @@
   },
   "components.SaleTunnelSuccess.successDetailMessage": {
     "description": "Text to explain when the user will be able to start its training.",
-    "message": "Poderá iniciar a sua formação após o pagamento da primeira prestação."
+    "message": "You’ll be able to start your training once the first installment has been paid, or once access opens if no payment is required."
   },
   "components.SaleTunnelSuccess.successMessage": {
     "description": "Message to confirm that order has been created",
@@ -2457,7 +2509,7 @@
   },
   "components.TeacherDashboard.TeacherDashboardRoutes.course.product.learnerList.label": {
     "description": "Label to display the product's learner list view.",
-    "message": "Alunos"
+    "message": "Buyers"
   },
   "components.TeacherDashboard.TeacherDashboardRoutes.generalInformation.label": {
     "description": "Label of the course general information view.",
@@ -2489,7 +2541,7 @@
   },
   "components.TeacherDashboard.TeacherDashboardRoutes.organization.course.product.learnerList.label": {
     "description": "Label to display the organization product's learner list view.",
-    "message": "Alunos"
+    "message": "Buyers"
   },
   "components.TeacherDashboard.TeacherDashboardRoutes.organization.courses.label": {
     "description": "Label of the organization courses view.",

package/i18n/locales/ru-RU.json

@@ -27,6 +27,18 @@
     "description": "Label for the field asking the company address",
     "message": "Address"
   },
+  "batchOrder.agreement.organizationSignedOn": {
+    "description": "Label displayed once the organization has counter-signed the agreement",
+    "message": "Signed by the organization on {date}."
+  },
+  "batchOrder.agreement.title": {
+    "description": "Step label for the agreement document in the batch order detail",
+    "message": "Agreement"
+  },
+  "batchOrder.agreement.waitingOrganization": {
+    "description": "Label displayed when the agreement is waiting for the organization counter-signature",
+    "message": "Waiting for the organization to counter-sign the agreement."
+  },
   "batchOrder.bankTransfer": {
     "description": "Option label for selecting bank transfer payment",
     "message": "Bank transfer"
@@ -59,6 +71,26 @@
     "description": "Label for the field asking the email address of the contact person",
     "message": "Email"
   },
+  "batchOrder.enrollmentManagement.enrolledParticipants": {
+    "description": "Progress label showing enrolled participants out of total seats",
+    "message": "{seats_owned}/{nb_seats} enrolled participants"
+  },
+  "batchOrder.enrollmentManagement.loadMore": {
+    "description": "Button to load more seats",
+    "message": "Load {count} more"
+  },
+  "batchOrder.enrollmentManagement.noResults": {
+    "description": "Message shown when the student search returns no results",
+    "message": "No student matches your search."
+  },
+  "batchOrder.enrollmentManagement.searchPlaceholder": {
+    "description": "Placeholder for the seat search input (student name or voucher)",
+    "message": "Student name"
+  },
+  "batchOrder.enrollmentManagement.title": {
+    "description": "Title for enrollment management section",
+    "message": "Enrollment"
+  },
   "batchOrder.firstName": {
     "description": "Label for the field asking the first name of the contact person",
     "message": "First name"
@@ -197,11 +229,11 @@
   },
   "batchOrder.seats": {
     "description": "Text displayed for seats value in batch order",
-    "message": "Seats"
+    "message": "{nb_seats} seats"
   },
   "batchOrder.seatsCount": {
-    "description": "Text displayed for seats count with pluralization in batch order",
-    "message": "{seats} {seats, plural, one {seat} other {seats}}"
+    "description": "Text displayed for seats count in batch order (owned / total)",
+    "message": "{seats_owned}/{nb_seats} seats"
   },
   "batchOrder.status.assigned": {
     "description": "Status label for an assigned batch order",
@@ -1371,6 +1403,26 @@
     "description": "Accessible label for user menu button",
     "message": "Доступ к настройкам вашего профиля"
   },
+  "components.DownloadAgreementButton.download": {
+    "description": "Label for the button to download a signed agreement PDF",
+    "message": "Download agreement"
+  },
+  "components.DownloadAgreementButton.generating": {
+    "description": "Accessible label displayed while agreement PDF is being downloaded.",
+    "message": "Downloading..."
+  },
+  "components.DownloadBatchOrderSeatsButton.download": {
+    "description": "Label for the button to export batch order seats as CSV",
+    "message": "Export CSV"
+  },
+  "components.DownloadBatchOrderSeatsButton.generating": {
+    "description": "Accessible label displayed while CSV export is being generated.",
+    "message": "Generating export..."
+  },
+  "components.DownloadBatchOrderSeatsButton.noSeatsOwned": {
+    "description": "Error message displayed when trying to export seats but no seats are owned yet.",
+    "message": "No participants have claimed their seat yet. The export will be available once at least one participant has enrolled."
+  },
   "components.DownloadCertificateButton.download": {
     "description": "Label for the download button of a certificate",
     "message": "Download"
@@ -2137,7 +2189,7 @@
   },
   "components.SaleTunnelSuccess.successDetailMessage": {
     "description": "Text to explain when the user will be able to start its training.",
-    "message": "You will be able to start your training once the first installment will be paid."
+    "message": "You’ll be able to start your training once the first installment has been paid, or once access opens if no payment is required."
   },
   "components.SaleTunnelSuccess.successMessage": {
     "description": "Message to confirm that order has been created",
@@ -2457,7 +2509,7 @@
   },
   "components.TeacherDashboard.TeacherDashboardRoutes.course.product.learnerList.label": {
     "description": "Label to display the product's learner list view.",
-    "message": "Learners"
+    "message": "Buyers"
   },
   "components.TeacherDashboard.TeacherDashboardRoutes.generalInformation.label": {
     "description": "Label of the course general information view.",
@@ -2489,7 +2541,7 @@
   },
   "components.TeacherDashboard.TeacherDashboardRoutes.organization.course.product.learnerList.label": {
     "description": "Label to display the organization product's learner list view.",
-    "message": "Learners"
+    "message": "Buyers"
   },
   "components.TeacherDashboard.TeacherDashboardRoutes.organization.courses.label": {
     "description": "Label of the organization courses view.",

package/i18n/locales/vi-VN.json

@@ -27,6 +27,18 @@
     "description": "Label for the field asking the company address",
     "message": "Address"
   },
+  "batchOrder.agreement.organizationSignedOn": {
+    "description": "Label displayed once the organization has counter-signed the agreement",
+    "message": "Signed by the organization on {date}."
+  },
+  "batchOrder.agreement.title": {
+    "description": "Step label for the agreement document in the batch order detail",
+    "message": "Agreement"
+  },
+  "batchOrder.agreement.waitingOrganization": {
+    "description": "Label displayed when the agreement is waiting for the organization counter-signature",
+    "message": "Waiting for the organization to counter-sign the agreement."
+  },
   "batchOrder.bankTransfer": {
     "description": "Option label for selecting bank transfer payment",
     "message": "Bank transfer"
@@ -59,6 +71,26 @@
     "description": "Label for the field asking the email address of the contact person",
     "message": "Email"
   },
+  "batchOrder.enrollmentManagement.enrolledParticipants": {
+    "description": "Progress label showing enrolled participants out of total seats",
+    "message": "{seats_owned}/{nb_seats} enrolled participants"
+  },
+  "batchOrder.enrollmentManagement.loadMore": {
+    "description": "Button to load more seats",
+    "message": "Load {count} more"
+  },
+  "batchOrder.enrollmentManagement.noResults": {
+    "description": "Message shown when the student search returns no results",
+    "message": "No student matches your search."
+  },
+  "batchOrder.enrollmentManagement.searchPlaceholder": {
+    "description": "Placeholder for the seat search input (student name or voucher)",
+    "message": "Student name"
+  },
+  "batchOrder.enrollmentManagement.title": {
+    "description": "Title for enrollment management section",
+    "message": "Enrollment"
+  },
   "batchOrder.firstName": {
     "description": "Label for the field asking the first name of the contact person",
     "message": "First name"
@@ -197,11 +229,11 @@
   },
   "batchOrder.seats": {
     "description": "Text displayed for seats value in batch order",
-    "message": "Seats"
+    "message": "{nb_seats} seats"
   },
   "batchOrder.seatsCount": {
-    "description": "Text displayed for seats count with pluralization in batch order",
-    "message": "{seats} {seats, plural, one {seat} other {seats}}"
+    "description": "Text displayed for seats count in batch order (owned / total)",
+    "message": "{seats_owned}/{nb_seats} seats"
   },
   "batchOrder.status.assigned": {
     "description": "Status label for an assigned batch order",
@@ -1371,6 +1403,26 @@
     "description": "Accessible label for user menu button",
     "message": "Access to your profile settings"
   },
+  "components.DownloadAgreementButton.download": {
+    "description": "Label for the button to download a signed agreement PDF",
+    "message": "Download agreement"
+  },
+  "components.DownloadAgreementButton.generating": {
+    "description": "Accessible label displayed while agreement PDF is being downloaded.",
+    "message": "Downloading..."
+  },
+  "components.DownloadBatchOrderSeatsButton.download": {
+    "description": "Label for the button to export batch order seats as CSV",
+    "message": "Export CSV"
+  },
+  "components.DownloadBatchOrderSeatsButton.generating": {
+    "description": "Accessible label displayed while CSV export is being generated.",
+    "message": "Generating export..."
+  },
+  "components.DownloadBatchOrderSeatsButton.noSeatsOwned": {
+    "description": "Error message displayed when trying to export seats but no seats are owned yet.",
+    "message": "No participants have claimed their seat yet. The export will be available once at least one participant has enrolled."
+  },
   "components.DownloadCertificateButton.download": {
     "description": "Label for the download button of a certificate",
     "message": "Download"
@@ -2137,7 +2189,7 @@
   },
   "components.SaleTunnelSuccess.successDetailMessage": {
     "description": "Text to explain when the user will be able to start its training.",
-    "message": "You will be able to start your training once the first installment will be paid."
+    "message": "You’ll be able to start your training once the first installment has been paid, or once access opens if no payment is required."
   },
   "components.SaleTunnelSuccess.successMessage": {
     "description": "Message to confirm that order has been created",
@@ -2457,7 +2509,7 @@
   },
   "components.TeacherDashboard.TeacherDashboardRoutes.course.product.learnerList.label": {
     "description": "Label to display the product's learner list view.",
-    "message": "Learners"
+    "message": "Buyers"
   },
   "components.TeacherDashboard.TeacherDashboardRoutes.generalInformation.label": {
     "description": "Label of the course general information view.",
@@ -2489,7 +2541,7 @@
   },
   "components.TeacherDashboard.TeacherDashboardRoutes.organization.course.product.learnerList.label": {
     "description": "Label to display the organization product's learner list view.",
-    "message": "Learners"
+    "message": "Buyers"
   },
   "components.TeacherDashboard.TeacherDashboardRoutes.organization.courses.label": {
     "description": "Label of the organization courses view.",

package/js/api/joanie.ts

@@ -16,6 +16,7 @@ import { JOANIE_API_VERSION } from 'settings';
 import { ResourcesQuery } from 'hooks/useResources';
 import { ObjectHelper } from 'utils/ObjectHelper';
 import { Maybe, Nullable } from 'types/utils';
+import { HttpError, HttpStatusCode } from 'utils/errors/HttpError';
 import { checkStatus, getFileFromResponse } from './utils';
 
 /*
@@ -366,10 +367,15 @@ const API = (): Joanie.API => {
             );
           },
         },
-        seats_export: async (id: string): Promise<File> =>
-          fetchWithJWT(ROUTES.user.batchOrders.seats_export.replace(':id', id))
-            .then(checkStatus)
-            .then(getFileFromResponse),
+        seats_export: async (id: string): Promise<File> => {
+          const response = await fetchWithJWT(
+            ROUTES.user.batchOrders.seats_export.replace(':id', id),
+          );
+          if (response.status === HttpStatusCode.UNPROCESSABLE_ENTITY) {
+            throw new HttpError(response.status, response.statusText);
+          }
+          return checkStatus(response).then(getFileFromResponse);
+        },
       },
       enrollments: {
         create: async (payload) =>

package/js/components/DownloadBatchOrderSeatsButton/index.tsx

@@ -1,7 +1,9 @@
 import { useId } from 'react';
-import { Button } from '@openfun/cunningham-react';
+import { Alert, Button, VariantType } from '@openfun/cunningham-react';
 import { FormattedMessage, defineMessages, useIntl } from 'react-intl';
 import { Spinner } from 'components/Spinner';
+import { Icon, IconTypeEnum } from 'components/Icon';
+import { HttpStatusCode } from 'utils/errors/HttpError';
 import { useDownloadBatchOrderSeats } from 'hooks/useDownloadBatchOrderSeats';
 
 const messages = defineMessages({
@@ -20,6 +22,12 @@ const messages = defineMessages({
     description: 'Text displayed for seats value in batch order',
     id: 'batchOrder.seats',
   },
+  noSeatsOwned: {
+    defaultMessage:
+      'No participants have claimed their seat yet. The export will be available once at least one participant has enrolled.',
+    description: 'Error message displayed when trying to export seats but no seats are owned yet.',
+    id: 'components.DownloadBatchOrderSeatsButton.noSeatsOwned',
+  },
 });
 
 export const sanitizeForFilename = (str: string) =>
@@ -46,7 +54,7 @@ const DownloadBatchOrderSeatsButton = ({
   batchOrderId,
   productTitle,
 }: DownloadBatchOrderSeatsButtonProps) => {
-  const { download, loading } = useDownloadBatchOrderSeats();
+  const { download, loading, error } = useDownloadBatchOrderSeats();
   const labelId = useId();
   const intl = useIntl();
 
@@ -56,24 +64,33 @@ const DownloadBatchOrderSeatsButton = ({
   };
 
   return (
-    <Button
-      size="small"
-      color="brand"
-      variant="primary"
-      className="dashboard-item__action-button"
-      disabled={loading}
-      onClick={handleClick}
-    >
-      {loading ? (
-        <Spinner theme="primary" aria-labelledby={labelId}>
-          <span id={labelId}>
-            <FormattedMessage {...messages.generating} />
-          </span>
-        </Spinner>
-      ) : (
-        <FormattedMessage {...messages.download} />
+    <>
+      <Button
+        size="small"
+        color="brand"
+        variant="primary"
+        className="dashboard-item__action-button"
+        icon={<Icon name={IconTypeEnum.DOWNLOAD} size="small" />}
+        iconPosition="left"
+        disabled={loading}
+        onClick={handleClick}
+      >
+        {loading ? (
+          <Spinner theme="primary" aria-labelledby={labelId}>
+            <span id={labelId}>
+              <FormattedMessage {...messages.generating} />
+            </span>
+          </Spinner>
+        ) : (
+          <FormattedMessage {...messages.download} />
+        )}
+      </Button>
+      {error?.code === HttpStatusCode.UNPROCESSABLE_ENTITY && (
+        <Alert type={VariantType.ERROR} className="mt-s">
+          <FormattedMessage {...messages.noSeatsOwned} />
+        </Alert>
       )}
-    </Button>
+    </>
   );
 };
 

package/js/components/Icon/index.tsx

@@ -38,6 +38,7 @@ export enum IconTypeEnum {
   COURSES = 'icon-courses',
   CREDIT_CARD = 'icon-creditCard',
   CROSS = 'icon-cross',
+  DOWNLOAD = 'icon-download',
   DURATION = 'icon-duration',
   ENVELOPE = 'icon-envelope',
   FACEBOOK = 'icon-facebook',

package/js/components/SaleTunnel/_styles.scss

@@ -31,10 +31,13 @@
     &__left,
     &__right {
       flex: 1;
-      overflow: hidden;
       position: relative;
     }
 
+    &__left {
+      overflow: hidden;
+    }
+
     &__column {
       display: flex;
       flex-direction: column;

package/js/hooks/useDownloadBatchOrderSeats/index.spec.tsx

@@ -129,4 +129,32 @@ describe('useDownloadBatchOrderSeats', () => {
       expect(result.current.loading).toBe(false);
     });
   });
+
+  it('exposes a 422 HttpError when seats export fails because no seats are owned', async () => {
+    const batchOrder = BatchOrderReadFactory().one();
+    const DOWNLOAD_URL = `https://joanie.test/api/v1.0/batch-orders/${batchOrder.id}/seats-export/`;
+    fetchMock.get(DOWNLOAD_URL, {
+      status: HttpStatusCode.UNPROCESSABLE_ENTITY,
+      body: { detail: 'Batch order has no seats owned, cannot export seats.' },
+    });
+
+    const { result } = renderHook(() => useDownloadBatchOrderSeats(), {
+      wrapper: Wrapper,
+    });
+    await waitFor(() => expect(result.current).not.toBeNull());
+
+    expect(result.current.error).toBeUndefined();
+
+    act(() => {
+      result.current.download(batchOrder.id);
+    });
+
+    await waitFor(() => {
+      expect(fetchMock.called(DOWNLOAD_URL)).toBe(true);
+      expect(result.current.error?.code).toBe(HttpStatusCode.UNPROCESSABLE_ENTITY);
+      // eslint-disable-next-line compat/compat
+      expect(URL.createObjectURL).toHaveBeenCalledTimes(0);
+      expect(result.current.loading).toBe(false);
+    });
+  });
 });

package/js/hooks/useDownloadBatchOrderSeats/index.tsx

@@ -1,24 +1,34 @@
 import { useState } from 'react';
 import { useJoanieApi } from 'contexts/JoanieApiContext';
 import { browserDownloadFromBlob } from 'utils/download';
+import { HttpError, HttpStatusCode } from 'utils/errors/HttpError';
 
 export const useDownloadBatchOrderSeats = () => {
   const [loading, setLoading] = useState(false);
+  const [error, setError] = useState<HttpError | undefined>();
   const API = useJoanieApi();
 
   return {
     download: async (batchOrderId: string, filename?: string) => {
       setLoading(true);
+      setError(undefined);
       try {
-        await browserDownloadFromBlob(
-          () => API.user.batchOrders.seats_export(batchOrderId),
-          false,
-          filename,
-        );
+        const downloadFn = async () => {
+          try {
+            return await API.user.batchOrders.seats_export(batchOrderId);
+          } catch (err) {
+            if (err instanceof HttpError && err.code === HttpStatusCode.UNPROCESSABLE_ENTITY) {
+              setError(err);
+            }
+            throw err;
+          }
+        };
+        await browserDownloadFromBlob(downloadFn, false, filename);
       } finally {
         setLoading(false);
       }
     },
     loading,
+    error,
   };
 };