richie-education 3.1.3-dev12 → 3.1.3-dev17

package/js/pages/TeacherDashboardContractsLayout/components/ContractActionsBar/index.spec.tsx

@@ -97,21 +97,21 @@ describe('TeacherDashboardContractsLayout/ContractActionsBar', () => {
     {
       label: "doesn't have contract to download",
       hasContractToDownload: false,
-      offerId: undefined,
+      offeringId: undefined,
     },
     {
-      label: "doesn't have contract to download  and offerId",
+      label: "doesn't have contract to download and offeringId",
       hasContractToDownload: false,
-      offerId: faker.string.uuid(),
+      offeringId: faker.string.uuid(),
     },
-  ])('should only display sign button when $label', ({ hasContractToDownload, offerId }) => {
+  ])('should only display sign button when $label', ({ hasContractToDownload, offeringId }) => {
     mockHasContractToDownload = hasContractToDownload;
     mockCanSignContracts = true;
     mockContractsToSignCount = 1;
 
     render(
       <Wrapper>
-        <ContractActionsBar offerId={offerId} organizationId={faker.string.uuid()} />
+        <ContractActionsBar offeringId={offeringId} organizationId={faker.string.uuid()} />
       </Wrapper>,
     );
 

package/js/pages/TeacherDashboardContractsLayout/components/ContractActionsBar/index.tsx

@@ -1,5 +1,5 @@
 import classNames from 'classnames';
-import { Organization, Offer } from 'types/Joanie';
+import { Organization, Offering } from 'types/Joanie';
 import useTeacherContractsToSign from 'pages/TeacherDashboardContractsLayout/hooks/useTeacherContractsToSign';
 import useHasContractToDownload from 'pages/TeacherDashboardContractsLayout/hooks/useHasContractToDownload';
 import SignOrganizationContractButton from '../SignOrganizationContractButton';
@@ -7,18 +7,18 @@ import BulkDownloadContractButton from '../BulkDownloadContractButton';
 
 interface ContractActionsProps {
   organizationId: Organization['id'];
-  offerId?: Offer['id'];
+  offeringId?: Offering['id'];
 }
 
-const ContractActionsBar = ({ organizationId, offerId }: ContractActionsProps) => {
+const ContractActionsBar = ({ organizationId, offeringId }: ContractActionsProps) => {
   const { canSignContracts, contractsToSignCount } = useTeacherContractsToSign({
     organizationId,
-    offerId,
+    offeringId,
   });
-  const hasContractToDownload = useHasContractToDownload(organizationId, offerId);
+  const hasContractToDownload = useHasContractToDownload(organizationId, offeringId);
 
   const nbAvailableActions = [canSignContracts, hasContractToDownload].filter((val) => val).length;
-  const offerIds = offerId ? [offerId] : undefined;
+  const offeringIds = offeringId ? [offeringId] : undefined;
   return (
     nbAvailableActions > 0 && (
       <div
@@ -31,14 +31,14 @@ const ContractActionsBar = ({ organizationId, offerId }: ContractActionsProps) =
         {canSignContracts && (
           <div>
             <SignOrganizationContractButton
-              offerIds={offerIds}
+              offeringIds={offeringIds}
               organizationId={organizationId}
               contractToSignCount={contractsToSignCount}
             />
           </div>
         )}
         {hasContractToDownload && (
-          <BulkDownloadContractButton organizationId={organizationId} offerId={offerId} />
+          <BulkDownloadContractButton organizationId={organizationId} offeringId={offeringId} />
         )}
       </div>
     )

package/js/pages/TeacherDashboardContractsLayout/components/SignOrganizationContractButton/index.spec.tsx

@@ -70,19 +70,19 @@ describe('TeacherDashboardContractsLayout/SignOrganizationContractButton', () =>
     {
       label: "organization's contracts",
       organizationId: faker.string.uuid(),
-      offerIds: undefined,
+      offeringIds: undefined,
     },
     {
       label: "organization's training contracts",
       organizationId: faker.string.uuid(),
-      offerIds: [faker.string.uuid()],
+      offeringIds: [faker.string.uuid()],
     },
-  ])('should open $label frame on click', async ({ organizationId, offerIds }) => {
+  ])('should open $label frame on click', async ({ organizationId, offeringIds }) => {
     render(
       <Wrapper>
         <SignOrganizationContractButton
           organizationId={organizationId}
-          offerIds={offerIds}
+          offeringIds={offeringIds}
           contractToSignCount={12}
         />
       </Wrapper>,
@@ -92,8 +92,8 @@ describe('TeacherDashboardContractsLayout/SignOrganizationContractButton', () =>
     const user = userEvent.setup();
 
     let getInvitationLinkUrl = `https://joanie.test/api/v1.0/organizations/${organizationId}/contracts-signature-link/`;
-    if (offerIds) {
-      getInvitationLinkUrl += `?offer_ids=${offerIds[0]}`;
+    if (offeringIds) {
+      getInvitationLinkUrl += `?offering_ids=${offeringIds[0]}`;
     }
 
     fetchMock.get(getInvitationLinkUrl, {

package/js/pages/TeacherDashboardContractsLayout/components/SignOrganizationContractButton/index.tsx

@@ -3,7 +3,7 @@ import { defineMessages, FormattedMessage } from 'react-intl';
 import { Button } from '@openfun/cunningham-react';
 import { OrganizationContractFrame } from 'components/ContractFrame';
 
-import { Offer, Organization } from 'types/Joanie';
+import { Offering, Organization } from 'types/Joanie';
 
 const messages = defineMessages({
   signAllPendingContracts: {
@@ -14,7 +14,7 @@ const messages = defineMessages({
 });
 
 interface Props {
-  offerIds?: Offer['id'][];
+  offeringIds?: Offering['id'][];
   organizationId: Organization['id'];
   contractToSignCount: number;
 }
@@ -22,7 +22,7 @@ interface Props {
 const SignOrganizationContractButton = ({
   organizationId,
   contractToSignCount,
-  offerIds = [],
+  offeringIds = [],
 }: Props) => {
   const [contractFrameOpened, setContractFrameOpened] = useState(false);
   const hasContractToSign = contractToSignCount > 0;
@@ -48,7 +48,7 @@ const SignOrganizationContractButton = ({
         </Button>
       )}
       <OrganizationContractFrame
-        offerIds={offerIds}
+        offeringIds={offeringIds}
         organizationId={organizationId}
         isOpen={contractFrameOpened}
         onClose={() => setContractFrameOpened(false)}

package/js/pages/TeacherDashboardContractsLayout/hooks/useCheckContractArchiveExists/index.spec.tsx

@@ -5,7 +5,7 @@ import { IntlProvider } from 'react-intl';
 import { PropsWithChildren } from 'react';
 import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
 import JoanieApiProvider from 'contexts/JoanieApiContext';
-import { OfferFactory, OrganizationFactory } from 'utils/test/factories/joanie';
+import { OfferingFactory, OrganizationFactory } from 'utils/test/factories/joanie';
 import {
   LocalStorageArchiveFilters,
   storeContractArchiveId,
@@ -41,24 +41,24 @@ describe.each([
   {
     testLabel: 'for all organization and all trainings',
     organization: undefined,
-    offer: undefined,
+    offering: undefined,
   },
   {
     testLabel: 'for a training in an organization',
     organization: OrganizationFactory().one(),
-    offer: OfferFactory().one(),
+    offering: OfferingFactory().one(),
   },
   {
     testLabel: 'for an organization',
     organization: OrganizationFactory().one(),
-    offer: undefined,
+    offering: undefined,
   },
   {
     testLabel: 'for a training',
     organization: undefined,
-    offer: OfferFactory().one(),
+    offering: OfferingFactory().one(),
   },
-])('useCheckContractArchiveExists $testLabel', ({ organization, offer }) => {
+])('useCheckContractArchiveExists $testLabel', ({ organization, offering }) => {
   const Wrapper = ({ children }: PropsWithChildren) => {
     return (
       <IntlProvider locale="en">
@@ -71,7 +71,7 @@ describe.each([
   beforeEach(() => {
     localStorageArchiveFilters = {
       organizationId: organization ? organization.id : undefined,
-      offerId: offer ? offer.id : undefined,
+      offeringId: offering ? offering.id : undefined,
     };
 
     // Joanie providers calls

package/js/pages/TeacherDashboardContractsLayout/hooks/useCheckContractArchiveExists/index.tsx

@@ -2,17 +2,17 @@ import { useEffect, useRef, useState } from 'react';
 import useContractArchive from 'hooks/useContractArchive';
 import { CONTRACT_DOWNLOAD_SETTINGS } from 'settings';
 import { Nullable } from 'types/utils';
-import { Offer, Organization } from 'types/Joanie';
+import { Offering, Organization } from 'types/Joanie';
 import { getStoredContractArchiveId } from '../useDownloadContractArchive/contractArchiveLocalStorage';
 
 export interface UseCheckContractArchiveExistsProps {
   organizationId?: Organization['id'];
-  offerId?: Offer['id'];
+  offeringId?: Offering['id'];
   enable?: boolean;
 }
 
 const useCheckContractArchiveExist = (
-  { organizationId, offerId, enable = true }: UseCheckContractArchiveExistsProps = {
+  { organizationId, offeringId, enable = true }: UseCheckContractArchiveExistsProps = {
     enable: true,
   },
 ) => {
@@ -55,7 +55,7 @@ const useCheckContractArchiveExist = (
   useEffect(() => {
     const storedContractArchiveId = getStoredContractArchiveId({
       organizationId,
-      offerId,
+      offeringId,
     });
 
     if (enable && storedContractArchiveId) {
@@ -63,7 +63,7 @@ const useCheckContractArchiveExist = (
     } else {
       setIsContractArchiveExists(false);
     }
-  }, [enable, organizationId, offerId]);
+  }, [enable, organizationId, offeringId]);
 
   // Be sure to clear any timeout before unmouting the hook.
   useEffect(() => {

package/js/pages/TeacherDashboardContractsLayout/hooks/useDownloadContractArchive/contractArchiveLocalStorage.spec.ts

@@ -1,6 +1,6 @@
 import { faker } from '@faker-js/faker';
 import { CONTRACT_DOWNLOAD_SETTINGS } from 'settings';
-import { OfferFactory, OrganizationFactory } from 'utils/test/factories/joanie';
+import { OfferingFactory, OrganizationFactory } from 'utils/test/factories/joanie';
 import {
   LocalStorageArchiveFilters,
   generateLocalStorageKey,
@@ -14,56 +14,56 @@ describe.each([
   {
     testLabel: 'for all organization and all trainings',
     organization: undefined,
-    offer: undefined,
+    offering: undefined,
     existingOrganization: undefined,
-    existingOffer: undefined,
+    existingOffering: undefined,
   },
   {
     testLabel: 'for a training in an organization',
     organization: OrganizationFactory().one(),
-    offer: OfferFactory().one(),
+    offering: OfferingFactory().one(),
     existingOrganization: undefined,
-    existingOffer: undefined,
+    existingOffering: undefined,
   },
   {
     testLabel: 'for an organization',
     organization: OrganizationFactory().one(),
-    offer: undefined,
+    offering: undefined,
     existingOrganization: undefined,
-    existingOffer: undefined,
+    existingOffering: undefined,
   },
   {
     testLabel: 'for a training',
     organization: undefined,
-    offer: OfferFactory().one(),
+    offering: OfferingFactory().one(),
     existingOrganization: undefined,
-    existingOffer: undefined,
+    existingOffering: undefined,
   },
   {
     testLabel: 'for all organization and all trainings, with a other id already stored',
     organization: undefined,
-    offer: undefined,
+    offering: undefined,
     existingOrganization: OrganizationFactory().one(),
-    existingOffer: OfferFactory().one(),
+    existingOffering: OfferingFactory().one(),
   },
   {
     testLabel: 'for a training in an organization, with a other id already stored',
     organization: OrganizationFactory().one(),
-    offer: OfferFactory().one(),
+    offering: OfferingFactory().one(),
   },
   {
     testLabel: 'for an organization, with a other id already stored',
     organization: OrganizationFactory().one(),
-    offer: undefined,
+    offering: undefined,
     existingOrganization: OrganizationFactory().one(),
-    existingOffer: OfferFactory().one(),
+    existingOffering: OfferingFactory().one(),
   },
   {
     testLabel: 'for a training, with a other id already stored',
     organization: undefined,
-    offer: OfferFactory().one(),
+    offering: OfferingFactory().one(),
     existingOrganization: OrganizationFactory().one(),
-    existingOffer: OfferFactory().one(),
+    existingOffering: OfferingFactory().one(),
   },
 
   {
@@ -72,11 +72,11 @@ describe.each([
   {
     testLabel: 'Testing with a other id already stored',
     existingOrganization: OrganizationFactory().one(),
-    existingOffer: OfferFactory().one(),
+    existingOffering: OfferingFactory().one(),
   },
 ])(
   'contractArchiveLocalStorage $testLabel',
-  ({ organization, offer, existingOrganization, existingOffer }) => {
+  ({ organization, offering, existingOrganization, existingOffering }) => {
     let localStorageArchiveFilters: LocalStorageArchiveFilters;
     let localStorageExistingArchiveFilters: LocalStorageArchiveFilters;
     let exsitingContractId: string;
@@ -84,15 +84,15 @@ describe.each([
     beforeEach(() => {
       localStorageArchiveFilters = {
         organizationId: organization ? organization.id : undefined,
-        offerId: offer ? offer.id : undefined,
+        offeringId: offering ? offering.id : undefined,
       };
       localStorageExistingArchiveFilters = {
         organizationId: existingOrganization ? existingOrganization.id : undefined,
-        offerId: existingOffer ? existingOffer.id : undefined,
+        offeringId: existingOffering ? existingOffering.id : undefined,
       };
       exsitingContractId = faker.string.uuid();
 
-      if (existingOffer && existingOrganization) {
+      if (existingOffering && existingOrganization) {
         // everything should work fine with multiple archive stored
         storeContractArchiveId({
           ...localStorageExistingArchiveFilters,

package/js/pages/TeacherDashboardContractsLayout/hooks/useDownloadContractArchive/contractArchiveLocalStorage.ts

@@ -1,13 +1,16 @@
 import { CONTRACT_DOWNLOAD_SETTINGS } from 'settings';
-import { Offer, Organization } from 'types/Joanie';
+import { Offering, Organization } from 'types/Joanie';
 
 export interface LocalStorageArchiveFilters {
   organizationId?: Organization['id'];
-  offerId?: Offer['id'];
+  offeringId?: Offering['id'];
 }
 
-const generateLocalStorageKey = ({ organizationId, offerId }: LocalStorageArchiveFilters = {}) => {
-  return `${CONTRACT_DOWNLOAD_SETTINGS.contractArchiveLocalStorageKey}::${organizationId ?? 'all'}::${offerId ?? 'all'}`;
+const generateLocalStorageKey = ({
+  organizationId,
+  offeringId,
+}: LocalStorageArchiveFilters = {}) => {
+  return `${CONTRACT_DOWNLOAD_SETTINGS.contractArchiveLocalStorageKey}::${organizationId ?? 'all'}::${offeringId ?? 'all'}`;
 };
 
 const generateLocalStorageId = (contractArchiveId: string) => {
@@ -17,27 +20,30 @@ const generateLocalStorageId = (contractArchiveId: string) => {
 const storeContractArchiveId = ({
   contractArchiveId,
   organizationId,
-  offerId,
+  offeringId,
 }: {
   contractArchiveId: string;
   organizationId?: Organization['id'];
-  offerId?: Offer['id'];
+  offeringId?: Offering['id'];
 }) => {
   localStorage.setItem(
-    generateLocalStorageKey({ organizationId, offerId }),
+    generateLocalStorageKey({ organizationId, offeringId }),
     generateLocalStorageId(contractArchiveId),
   );
 };
 
-const unstoreContractArchiveId = ({ organizationId, offerId }: LocalStorageArchiveFilters = {}) => {
-  localStorage.removeItem(generateLocalStorageKey({ organizationId, offerId }));
+const unstoreContractArchiveId = ({
+  organizationId,
+  offeringId,
+}: LocalStorageArchiveFilters = {}) => {
+  localStorage.removeItem(generateLocalStorageKey({ organizationId, offeringId }));
 };
 
 const getStoredContractArchiveId = ({
   organizationId,
-  offerId,
+  offeringId,
 }: LocalStorageArchiveFilters = {}) => {
-  const value = localStorage.getItem(generateLocalStorageKey({ organizationId, offerId }));
+  const value = localStorage.getItem(generateLocalStorageKey({ organizationId, offeringId }));
   if (value === null) {
     return value;
   }
@@ -48,9 +54,9 @@ const getStoredContractArchiveId = ({
 
 const isStoredContractArchiveIdExpired = ({
   organizationId,
-  offerId,
+  offeringId,
 }: LocalStorageArchiveFilters = {}) => {
-  const value = localStorage.getItem(generateLocalStorageKey({ organizationId, offerId }));
+  const value = localStorage.getItem(generateLocalStorageKey({ organizationId, offeringId }));
   if (value === null) {
     return false;
   }

package/js/pages/TeacherDashboardContractsLayout/hooks/useDownloadContractArchive/index.spec.tsx

@@ -5,7 +5,7 @@ import { PropsWithChildren } from 'react';
 import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
 import JoanieApiProvider from 'contexts/JoanieApiContext';
 import { CONTRACT_DOWNLOAD_SETTINGS } from 'settings';
-import { OfferFactory, OrganizationFactory } from 'utils/test/factories/joanie';
+import { OfferingFactory, OrganizationFactory } from 'utils/test/factories/joanie';
 import {
   LocalStorageArchiveFilters,
   getStoredContractArchiveId,
@@ -50,30 +50,30 @@ describe.each([
   {
     testLabel: 'for all organization and all trainings',
     organization: undefined,
-    offer: undefined,
+    offering: undefined,
   },
   {
     testLabel: 'for a training in an organization',
     organization: OrganizationFactory().one(),
-    offer: OfferFactory().one(),
+    offering: OfferingFactory().one(),
   },
   {
     testLabel: 'for an organization',
     organization: OrganizationFactory().one(),
-    offer: undefined,
+    offering: undefined,
   },
   {
     testLabel: 'for a training',
     organization: undefined,
-    offer: OfferFactory().one(),
+    offering: OfferingFactory().one(),
   },
-])('useDownloadContractArchive $testLabel', ({ organization, offer }) => {
+])('useDownloadContractArchive $testLabel', ({ organization, offering }) => {
   let localStorageArchiveFilters: LocalStorageArchiveFilters;
 
   beforeEach(() => {
     localStorageArchiveFilters = {
       organizationId: organization ? organization.id : undefined,
-      offerId: offer ? offer.id : undefined,
+      offeringId: offering ? offering.id : undefined,
     };
   });
 
@@ -97,20 +97,20 @@ describe.each([
     {
       testLabel: 'Testing with a other id already stored',
       existingOrganization: OrganizationFactory().one(),
-      existingOffer: OfferFactory().one(),
+      existingOffering: OfferingFactory().one(),
     },
-  ])('$testLabel', ({ existingOrganization, existingOffer }) => {
+  ])('$testLabel', ({ existingOrganization, existingOffering }) => {
     let localStorageExistingArchiveFilters: LocalStorageArchiveFilters;
     let exsitingContractId: string;
 
     beforeEach(() => {
       localStorageExistingArchiveFilters = {
         organizationId: existingOrganization ? existingOrganization.id : undefined,
-        offerId: existingOffer ? existingOffer.id : undefined,
+        offeringId: existingOffering ? existingOffering.id : undefined,
       };
       exsitingContractId = faker.string.uuid();
 
-      if (existingOffer && existingOrganization) {
+      if (existingOffering && existingOrganization) {
         // everything should work fine with multiple archive stored
         storeContractArchiveId({
           ...localStorageExistingArchiveFilters,

package/js/pages/TeacherDashboardContractsLayout/hooks/useDownloadContractArchive/index.tsx

@@ -1,6 +1,6 @@
 import { useEffect, useMemo, useState } from 'react';
 import useContractArchive from 'hooks/useContractArchive';
-import { Offer, Organization } from 'types/Joanie';
+import { Offering, Organization } from 'types/Joanie';
 import useCheckContractArchiveExists from '../useCheckContractArchiveExists';
 import useHasContractToDownload from '../useHasContractToDownload';
 import {
@@ -19,16 +19,16 @@ export enum ContractDownloadStatus {
 
 interface UseTeacherContractsBulkDownloadProps {
   organizationId?: Organization['id'];
-  offerId?: Offer['id'];
+  offeringId?: Offering['id'];
 }
 
 const useDownloadContractArchive = ({
   organizationId,
-  offerId,
+  offeringId,
 }: UseTeacherContractsBulkDownloadProps) => {
   const localstorageArchiveFilters = {
     organizationId,
-    offerId,
+    offeringId,
   };
 
   // Contract's archive api interface
@@ -37,7 +37,7 @@ const useDownloadContractArchive = ({
   } = useContractArchive();
 
   // Simple hook that verifiy if current user have some fully signed contracts to download.
-  const hasContractToDownload = useHasContractToDownload(organizationId, offerId);
+  const hasContractToDownload = useHasContractToDownload(organizationId, offeringId);
 
   // Component state of the localstorage contract's archive id
   const [contractArchiveId, setContractArchiveId] = useState<string | null>(
@@ -116,7 +116,7 @@ const useDownloadContractArchive = ({
   const createContractArchive = async () => {
     let newContractArchiveId;
     if (contractArchiveId === null) {
-      newContractArchiveId = await createArchive(organizationId, offerId);
+      newContractArchiveId = await createArchive(organizationId, offeringId);
       setContractArchiveId(newContractArchiveId);
       storeContractArchiveId({
         ...localstorageArchiveFilters,

package/js/pages/TeacherDashboardContractsLayout/hooks/useHasContractToDownload/index.tsx

@@ -1,14 +1,17 @@
 import { useOrganizationContracts } from 'hooks/useContracts';
 import { PER_PAGE } from 'settings';
-import { ContractState, Offer, Organization } from 'types/Joanie';
+import { ContractState, Offering, Organization } from 'types/Joanie';
 
-const useHasContractToDownload = (organizationId?: Organization['id'], offerId?: Offer['id']) => {
+const useHasContractToDownload = (
+  organizationId?: Organization['id'],
+  offeringId?: Offering['id'],
+) => {
   const {
     items: contracts,
     states: { isFetched },
   } = useOrganizationContracts({
     organization_id: organizationId,
-    offer_id: offerId,
+    offering_id: offeringId,
     signature_state: ContractState.SIGNED,
     page: 1,
     page_size: PER_PAGE.teacherContractList,