richie-education 3.1.3-dev11 → 3.1.3-dev15

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

@@ -1,6 +1,6 @@
 import { useEffect, useMemo, useState } from 'react';
 import useContractArchive from 'hooks/useContractArchive';
-import { CourseProductRelation, Organization } from 'types/Joanie';
+import { Offer, 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'];
-  courseProductRelationId?: CourseProductRelation['id'];
+  offerId?: Offer['id'];
 }
 
 const useDownloadContractArchive = ({
   organizationId,
-  courseProductRelationId,
+  offerId,
 }: UseTeacherContractsBulkDownloadProps) => {
   const localstorageArchiveFilters = {
     organizationId,
-    courseProductRelationId,
+    offerId,
   };
 
   // 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, courseProductRelationId);
+  const hasContractToDownload = useHasContractToDownload(organizationId, offerId);
 
   // 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, courseProductRelationId);
+      newContractArchiveId = await createArchive(organizationId, offerId);
       setContractArchiveId(newContractArchiveId);
       storeContractArchiveId({
         ...localstorageArchiveFilters,

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

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

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

@@ -7,7 +7,7 @@ import { MemoryRouter, Route, Routes } from 'react-router';
 import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
 import { createTestQueryClient } from 'utils/test/createTestQueryClient';
 import JoanieSessionProvider from 'contexts/SessionContext/JoanieSessionProvider';
-import { CourseProductRelationFactory, OrganizationFactory } from 'utils/test/factories/joanie';
+import { OfferFactory, OrganizationFactory } from 'utils/test/factories/joanie';
 import { ContractState } from 'types/Joanie';
 import useTeacherContractFilters from '.';
 
@@ -67,13 +67,13 @@ describe('useTeacherContractFilters', () => {
       expect(result.current.initialFilters).toStrictEqual({
         contract_ids: [],
         organization_id: defaultOrganization.id,
-        course_product_relation_id: undefined,
+        offer_id: undefined,
         signature_state: ContractState.SIGNED,
       });
       expect(result.current.filters).toStrictEqual({
         contract_ids: [],
         organization_id: defaultOrganization.id,
-        course_product_relation_id: undefined,
+        offer_id: undefined,
         signature_state: ContractState.SIGNED,
       });
     });
@@ -83,7 +83,7 @@ describe('useTeacherContractFilters', () => {
     const defaultOrganization = OrganizationFactory({ id: 'default' }).one();
     const filteredOrganization = OrganizationFactory({ id: 'filtered' }).one();
     const routeOrganization = OrganizationFactory({ id: 'route' }).one();
-    const routeCourseProductRelation = CourseProductRelationFactory().one();
+    const routeOffer = OfferFactory().one();
     // fetching user's organizations to initialize default organizationId.
     fetchMock.get('https://joanie.test/api/v1.0/organizations/', [
       defaultOrganization,
@@ -92,8 +92,8 @@ describe('useTeacherContractFilters', () => {
     const { result } = renderHook(useTeacherContractFilters, {
       wrapper: ({ children }) => (
         <Wrapper
-          routePath="/:organizationId/:courseProductRelationId"
-          initialEntry={`/${routeOrganization.id}/${routeCourseProductRelation.id}?organization_id=${filteredOrganization.id}&signature_state=${ContractState?.UNSIGNED}&contract_ids=1&contract_ids=2`}
+          routePath="/:organizationId/:offerId"
+          initialEntry={`/${routeOrganization.id}/${routeOffer.id}?organization_id=${filteredOrganization.id}&signature_state=${ContractState?.UNSIGNED}&contract_ids=1&contract_ids=2`}
         >
           {children}
         </Wrapper>
@@ -104,13 +104,13 @@ describe('useTeacherContractFilters', () => {
       expect(result.current.initialFilters).toStrictEqual({
         contract_ids: ['1', '2'],
         organization_id: routeOrganization.id,
-        course_product_relation_id: routeCourseProductRelation.id,
+        offer_id: routeOffer.id,
         signature_state: ContractState.UNSIGNED,
       });
       expect(result.current.filters).toStrictEqual({
         contract_ids: ['1', '2'],
         organization_id: routeOrganization.id,
-        course_product_relation_id: routeCourseProductRelation.id,
+        offer_id: routeOffer.id,
         signature_state: ContractState.UNSIGNED,
       });
     });
@@ -119,7 +119,7 @@ describe('useTeacherContractFilters', () => {
   it("should use organizationId from query parameters when it's not in route params", async () => {
     const defaultOrganization = OrganizationFactory({ id: 'default' }).one();
     const filteredOrganization = OrganizationFactory({ id: 'filtered' }).one();
-    const routeCourseProductRelation = CourseProductRelationFactory({ id: 'route' }).one();
+    const routeOffer = OfferFactory({ id: 'route' }).one();
     // fetching user's organizations to initialize default organizationId.
     fetchMock.get('https://joanie.test/api/v1.0/organizations/', [
       defaultOrganization,
@@ -128,8 +128,8 @@ describe('useTeacherContractFilters', () => {
     const { result } = renderHook(useTeacherContractFilters, {
       wrapper: ({ children }) => (
         <Wrapper
-          routePath="/:courseProductRelationId"
-          initialEntry={`/${routeCourseProductRelation.id}/?organization_id=${filteredOrganization.id}&signature_state=${ContractState?.UNSIGNED}&contract_ids=1&contract_ids=2`}
+          routePath="/:offerId"
+          initialEntry={`/${routeOffer.id}/?organization_id=${filteredOrganization.id}&signature_state=${ContractState?.UNSIGNED}&contract_ids=1&contract_ids=2`}
         >
           {children}
         </Wrapper>
@@ -140,13 +140,13 @@ describe('useTeacherContractFilters', () => {
       expect(result.current.initialFilters).toStrictEqual({
         contract_ids: ['1', '2'],
         organization_id: filteredOrganization.id,
-        course_product_relation_id: routeCourseProductRelation.id,
+        offer_id: routeOffer.id,
         signature_state: ContractState.UNSIGNED,
       });
       expect(result.current.filters).toStrictEqual({
         contract_ids: ['1', '2'],
         organization_id: filteredOrganization.id,
-        course_product_relation_id: routeCourseProductRelation.id,
+        offer_id: routeOffer.id,
         signature_state: ContractState.UNSIGNED,
       });
     });
@@ -155,7 +155,7 @@ describe('useTeacherContractFilters', () => {
   it('setFilters should update filter state', async () => {
     const defaultOrganization = OrganizationFactory({ id: 'default' }).one();
     const routeOrganization = OrganizationFactory({ id: 'route' }).one();
-    const routeCourseProductRelation = CourseProductRelationFactory().one();
+    const routeOffer = OfferFactory().one();
     // fetching user's organizations to initialize default organizationId.
     fetchMock.get('https://joanie.test/api/v1.0/organizations/', [defaultOrganization]);
     const { result } = renderHook(useTeacherContractFilters, {
@@ -169,7 +169,7 @@ describe('useTeacherContractFilters', () => {
     const expectedInitialFilters = {
       contract_ids: [],
       organization_id: defaultOrganization.id,
-      course_product_relation_id: undefined,
+      offer_id: undefined,
       signature_state: ContractState.SIGNED,
     };
     await waitFor(() => {
@@ -179,7 +179,7 @@ describe('useTeacherContractFilters', () => {
     const newFilters = {
       contract_ids: ['1', '2'],
       organization_id: routeOrganization.id,
-      course_product_relation_id: routeCourseProductRelation.id,
+      offer_id: routeOffer.id,
       signature_state: ContractState.UNSIGNED,
     };
     act(() => {

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

@@ -5,16 +5,16 @@ import { ContractResourceQuery, ContractState } from 'types/Joanie';
 
 export type TeacherDashboardContractsParams = {
   organizationId?: string;
-  courseProductRelationId?: string;
+  offerId?: string;
 };
 
 const useTeacherContractFilters = () => {
-  const { courseProductRelationId } = useParams<TeacherDashboardContractsParams>();
+  const { offerId } = useParams<TeacherDashboardContractsParams>();
   const [searchParams] = useSearchParams();
   const searchFilters: ContractResourceQuery = useMemo(() => {
     return {
       organization_id: searchParams.get('organization_id') || undefined,
-      course_product_relation_id: searchParams.get('course_product_relation_id') || undefined,
+      offer_id: searchParams.get('offer_id') || undefined,
       contract_ids: searchParams.getAll('contract_ids') || undefined,
       signature_state:
         (searchParams.get('signature_state') as ContractState) || ContractState.SIGNED,
@@ -28,7 +28,7 @@ const useTeacherContractFilters = () => {
     return {
       ...searchFilters,
       organization_id: defaultOrganizationId,
-      course_product_relation_id: courseProductRelationId,
+      offer_id: offerId,
     };
   }, [defaultOrganizationId]);
   const [filters, setFilters] = useState<ContractResourceQuery>(initialFilters);

package/js/pages/TeacherDashboardContractsLayout/hooks/useTeacherContractsToSign.tsx

@@ -1,22 +1,19 @@
 import useContractAbilities from 'hooks/useContractAbilities';
 import { useOrganizationContracts } from 'hooks/useContracts';
-import { ContractState, Organization, CourseProductRelation } from 'types/Joanie';
+import { ContractState, Organization, Offer } from 'types/Joanie';
 import { ContractActions } from 'utils/AbilitiesHelper/types';
 
 interface UseTeacherContractsToSignProps {
   organizationId?: Organization['id'];
-  courseProductRelationId?: CourseProductRelation['id'];
+  offerId?: Offer['id'];
 }
 
-const useTeacherContractsToSign = ({
-  organizationId,
-  courseProductRelationId,
-}: UseTeacherContractsToSignProps) => {
+const useTeacherContractsToSign = ({ organizationId, offerId }: UseTeacherContractsToSignProps) => {
   const { items: contractsToSign, meta: contractsToSignMeta } = useOrganizationContracts(
     {
       signature_state: ContractState.LEARNER_SIGNED,
       organization_id: organizationId,
-      course_product_relation_id: courseProductRelationId,
+      offer_id: offerId,
     },
     { enabled: !!organizationId },
   );

package/js/pages/TeacherDashboardCourseLearnersLayout/hooks/useCourseLearnersFilters/index.spec.tsx

@@ -1,7 +1,7 @@
 import fetchMock from 'fetch-mock';
 import { renderHook, waitFor, act } from '@testing-library/react';
 import { RichieContextFactory as mockRichieContextFactory } from 'utils/test/factories/richie';
-import { CourseProductRelationFactory, OrganizationFactory } from 'utils/test/factories/joanie';
+import { OfferFactory, OrganizationFactory } from 'utils/test/factories/joanie';
 import { JoanieAppWrapper, setupJoanieSession } from 'utils/test/wrappers/JoanieAppWrapper';
 import useCourseLearnersFilters from '.';
 
@@ -32,12 +32,12 @@ describe('useCourseLearnersFilters', () => {
       expect(result.current.initialFilters).toStrictEqual({
         organization_id: undefined,
         course_id: undefined,
-        course_product_relation_id: undefined,
+        offer_id: undefined,
       });
       expect(result.current.filters).toStrictEqual({
         organization_id: undefined,
         course_id: undefined,
-        course_product_relation_id: undefined,
+        offer_id: undefined,
       });
     });
   });
@@ -46,7 +46,7 @@ describe('useCourseLearnersFilters', () => {
     const defaultOrganization = OrganizationFactory().one();
     const filteredOrganization = OrganizationFactory({ id: 'filtered' }).one();
     const routeOrganization = OrganizationFactory({ id: 'route' }).one();
-    const routeCourseProductRelation = CourseProductRelationFactory().one();
+    const routeOffer = OfferFactory().one();
     // fetching user's organizations to initialize default organizationId.
     fetchMock.get('https://joanie.endpoint/api/v1.0/organizations/', [
       defaultOrganization,
@@ -56,9 +56,9 @@ describe('useCourseLearnersFilters', () => {
       wrapper: ({ children }) => (
         <JoanieAppWrapper
           routerOptions={{
-            path: '/:organizationId/:courseId/:courseProductRelationId',
+            path: '/:organizationId/:courseId/:offerId',
             initialEntries: [
-              `/${routeOrganization.id}/${routeCourseProductRelation.course.id}/${routeCourseProductRelation.id}?organization_id=${filteredOrganization.id}`,
+              `/${routeOrganization.id}/${routeOffer.course.id}/${routeOffer.id}?organization_id=${filteredOrganization.id}`,
             ],
           }}
         >
@@ -70,13 +70,13 @@ describe('useCourseLearnersFilters', () => {
     await waitFor(() => {
       expect(result.current.initialFilters).toStrictEqual({
         organization_id: routeOrganization.id,
-        course_id: routeCourseProductRelation.course.id,
-        course_product_relation_id: routeCourseProductRelation.id,
+        course_id: routeOffer.course.id,
+        offer_id: routeOffer.id,
       });
       expect(result.current.filters).toStrictEqual({
         organization_id: routeOrganization.id,
-        course_id: routeCourseProductRelation.course.id,
-        course_product_relation_id: routeCourseProductRelation.id,
+        course_id: routeOffer.course.id,
+        offer_id: routeOffer.id,
       });
     });
   });
@@ -84,7 +84,7 @@ describe('useCourseLearnersFilters', () => {
   it("should use organizationId from query parameters when it's not in route params", async () => {
     const defaultOrganization = OrganizationFactory().one();
     const filteredOrganization = OrganizationFactory({ id: 'filtered' }).one();
-    const routeCourseProductRelation = CourseProductRelationFactory({ id: 'route' }).one();
+    const routeOffer = OfferFactory({ id: 'route' }).one();
     // fetching user's organizations to initialize default organizationId.
     fetchMock.get('https://joanie.endpoint/api/v1.0/organizations/', [
       defaultOrganization,
@@ -94,9 +94,9 @@ describe('useCourseLearnersFilters', () => {
       wrapper: ({ children }) => (
         <JoanieAppWrapper
           routerOptions={{
-            path: '/:courseId/:courseProductRelationId',
+            path: '/:courseId/:offerId',
             initialEntries: [
-              `/${routeCourseProductRelation.course.id}/${routeCourseProductRelation.id}/?organization_id=${filteredOrganization.id}`,
+              `/${routeOffer.course.id}/${routeOffer.id}/?organization_id=${filteredOrganization.id}`,
             ],
           }}
         >
@@ -108,13 +108,13 @@ describe('useCourseLearnersFilters', () => {
     await waitFor(() => {
       expect(result.current.initialFilters).toStrictEqual({
         organization_id: filteredOrganization.id,
-        course_id: routeCourseProductRelation.course.id,
-        course_product_relation_id: routeCourseProductRelation.id,
+        course_id: routeOffer.course.id,
+        offer_id: routeOffer.id,
       });
       expect(result.current.filters).toStrictEqual({
         organization_id: filteredOrganization.id,
-        course_id: routeCourseProductRelation.course.id,
-        course_product_relation_id: routeCourseProductRelation.id,
+        course_id: routeOffer.course.id,
+        offer_id: routeOffer.id,
       });
     });
   });
@@ -122,7 +122,7 @@ describe('useCourseLearnersFilters', () => {
   it('setFilters should update filter state', async () => {
     const defaultOrganization = OrganizationFactory({ id: 'all' }).one();
     const routeOrganization = OrganizationFactory({ id: 'route' }).one();
-    const routeCourseProductRelation = CourseProductRelationFactory().one();
+    const routeOffer = OfferFactory().one();
     // fetching user's organizations to initialize default organizationId.
     fetchMock.get('https://joanie.endpoint/api/v1.0/organizations/', [defaultOrganization]);
     const { result } = renderHook(useCourseLearnersFilters, {
@@ -136,7 +136,7 @@ describe('useCourseLearnersFilters', () => {
     const expectedInitialFilters = {
       organization_id: defaultOrganization.id,
       course_id: undefined,
-      course_product_relation_id: undefined,
+      offer_id: undefined,
     };
     await waitFor(() => {
       expect(result.current.initialFilters).toStrictEqual(expectedInitialFilters);
@@ -144,8 +144,8 @@ describe('useCourseLearnersFilters', () => {
 
     const newFilters = {
       organization_id: routeOrganization.id,
-      course_id: routeCourseProductRelation.course.id,
-      course_product_relation_id: routeCourseProductRelation.id,
+      course_id: routeOffer.course.id,
+      offer_id: routeOffer.id,
     };
     act(() => {
       result.current.setFilters(newFilters);

package/js/pages/TeacherDashboardCourseLearnersLayout/hooks/useCourseLearnersFilters/index.ts

@@ -1,27 +1,22 @@
 import { useEffect, useMemo, useState } from 'react';
 import { useParams, useSearchParams } from 'react-router';
 import useDefaultOrganizationId from 'hooks/useDefaultOrganizationId';
-import {
-  CourseListItem,
-  CourseOrderResourceQuery,
-  CourseProductRelation,
-  Organization,
-} from 'types/Joanie';
+import { CourseListItem, CourseOrderResourceQuery, Offer, Organization } from 'types/Joanie';
 
 export type CourseLearnersParams = {
   courseId: CourseListItem['id'];
-  courseProductRelationId?: CourseProductRelation['id'];
+  offerId?: Offer['id'];
   organizationId?: Organization['id'];
 };
 
 const useCourseLearnersFilters = () => {
-  const { courseId, courseProductRelationId } = useParams<CourseLearnersParams>();
+  const { courseId, offerId } = useParams<CourseLearnersParams>();
   const [searchParams] = useSearchParams();
   const searchFilters: CourseOrderResourceQuery = useMemo(() => {
     return {
       course_id: courseId,
       organization_id: searchParams.get('organization_id') || undefined,
-      course_product_relation_id: searchParams.get('course_product_relation_id') || undefined,
+      offer_id: searchParams.get('offer_id') || undefined,
     };
   }, Array.from(searchParams.entries()));
 
@@ -32,7 +27,7 @@ const useCourseLearnersFilters = () => {
     return {
       ...searchFilters,
       organization_id: defaultOrganizationId,
-      course_product_relation_id: courseProductRelationId,
+      offer_id: offerId,
     };
   }, [defaultOrganizationId]);
   const [filters, setFilters] = useState<CourseOrderResourceQuery>(initialFilters);