richie-education 3.1.2 → 3.1.3-dev12

package/js/pages/TeacherDashboardTraining/index.spec.tsx

@@ -11,7 +11,7 @@ import {
   UserFactory,
 } from 'utils/test/factories/richie';
 import JoanieSessionProvider from 'contexts/SessionContext/JoanieSessionProvider';
-import { CourseProductRelationFactory, OrganizationFactory } from 'utils/test/factories/joanie';
+import { OfferFactory, OrganizationFactory } from 'utils/test/factories/joanie';
 import { createTestQueryClient } from 'utils/test/createTestQueryClient';
 import { expectNoSpinner } from 'utils/test/expectSpinner';
 import { DashboardBreadcrumbsProvider } from 'widgets/Dashboard/contexts/DashboardBreadcrumbsContext';
@@ -46,15 +46,9 @@ describe('components/TeacherDashboardTrainingLoader', () => {
   });
 
   it('should render TeacherDashboardTrainingLoader page', async () => {
-    const courseProductRelation = CourseProductRelationFactory().one();
-    fetchMock.get(
-      `https://joanie.endpoint/api/v1.0/organizations/?course_product_relation_id=${courseProductRelation.id}`,
-      [],
-    );
-    fetchMock.get(
-      `https://joanie.endpoint/api/v1.0/course-product-relations/${courseProductRelation.id}/`,
-      courseProductRelation,
-    );
+    const offer = OfferFactory().one();
+    fetchMock.get(`https://joanie.endpoint/api/v1.0/organizations/?offer_id=${offer.id}`, []);
+    fetchMock.get(`https://joanie.endpoint/api/v1.0/offers/${offer.id}/`, offer);
 
     const user = UserFactory().one();
     render(
@@ -67,12 +61,12 @@ describe('components/TeacherDashboardTrainingLoader', () => {
                   router={createMemoryRouter(
                     [
                       {
-                        path: ':courseProductRelationId',
+                        path: ':offerId',
                         element: <TeacherDashboardTrainingLoader />,
                       },
                     ],
                     {
-                      initialEntries: [`/${courseProductRelation.id}`],
+                      initialEntries: [`/${offer.id}`],
                     },
                   )}
                 />
@@ -88,12 +82,10 @@ describe('components/TeacherDashboardTrainingLoader', () => {
     await expectNoSpinner('Loading course...');
 
     nbApiCalls += 1; // organizations api call
-    nbApiCalls += 1; // course-product-relations api call
+    nbApiCalls += 1; // offers api call
     const calledUrls = fetchMock.calls().map((call) => call[0]);
     expect(calledUrls).toHaveLength(nbApiCalls);
-    expect(calledUrls).toContain(
-      `https://joanie.endpoint/api/v1.0/course-product-relations/${courseProductRelation.id}/`,
-    );
+    expect(calledUrls).toContain(`https://joanie.endpoint/api/v1.0/offers/${offer.id}/`);
 
     // main titles
     expect(
@@ -102,28 +94,28 @@ describe('components/TeacherDashboardTrainingLoader', () => {
       }),
     ).toBeInTheDocument();
 
-    expect(
-      screen.getAllByRole('heading', { name: capitalize(courseProductRelation.product.title) }),
-    ).toHaveLength(2);
+    expect(screen.getAllByRole('heading', { name: capitalize(offer.product.title) })).toHaveLength(
+      2,
+    );
 
-    const nbCourseRun = courseProductRelation.product.target_courses.reduce(
+    const nbCourseRun = offer.product.target_courses.reduce(
       (acc, course) => acc + course.course_runs.length,
       0,
     );
     expect(screen.getAllByRole('link', { name: 'Go to course area' })).toHaveLength(nbCourseRun);
   });
 
-  it('should fetch course product relation with organization id if there is one in the path', async () => {
+  it('should fetch offer with organization id if there is one in the path', async () => {
     const organization = OrganizationFactory().one();
-    const courseProductRelation = CourseProductRelationFactory({
+    const offer = OfferFactory({
       organizations: [organization],
     }).one();
     fetchMock.get(
-      `https://joanie.endpoint/api/v1.0/organizations/${organization.id}/course-product-relations/${courseProductRelation.id}/`,
-      courseProductRelation,
+      `https://joanie.endpoint/api/v1.0/organizations/${organization.id}/offers/${offer.id}/`,
+      offer,
     );
     fetchMock.get(
-      `https://joanie.endpoint/api/v1.0/organizations/${organization.id}/contracts/?course_product_relation_id=${courseProductRelation.id}&signature_state=half_signed&page=1&page_size=25`,
+      `https://joanie.endpoint/api/v1.0/organizations/${organization.id}/contracts/?offer_id=${offer.id}&signature_state=half_signed&page=1&page_size=25`,
       [],
     );
 
@@ -138,12 +130,12 @@ describe('components/TeacherDashboardTrainingLoader', () => {
                   router={createMemoryRouter(
                     [
                       {
-                        path: '/:organizationId/:courseProductRelationId',
+                        path: '/:organizationId/:offerId',
                         element: <TeacherDashboardTrainingLoader />,
                       },
                     ],
                     {
-                      initialEntries: [`/${organization.id}/${courseProductRelation.id}`],
+                      initialEntries: [`/${organization.id}/${offer.id}`],
                     },
                   )}
                 />
@@ -159,11 +151,11 @@ describe('components/TeacherDashboardTrainingLoader', () => {
     await expectNoSpinner('Loading course...');
 
     nbApiCalls += 1; // contracts api call
-    nbApiCalls += 1; // course-product-relations api call
+    nbApiCalls += 1; // offers api call
     const calledUrls = fetchMock.calls().map((call) => call[0]);
     expect(calledUrls).toHaveLength(nbApiCalls);
     expect(calledUrls).toContain(
-      `https://joanie.endpoint/api/v1.0/organizations/${organization.id}/course-product-relations/${courseProductRelation.id}/`,
+      `https://joanie.endpoint/api/v1.0/organizations/${organization.id}/offers/${offer.id}/`,
     );
 
     // main titles
@@ -173,11 +165,11 @@ describe('components/TeacherDashboardTrainingLoader', () => {
       }),
     ).toBeInTheDocument();
 
-    expect(
-      screen.getAllByRole('heading', { name: capitalize(courseProductRelation.product.title) }),
-    ).toHaveLength(2);
+    expect(screen.getAllByRole('heading', { name: capitalize(offer.product.title) })).toHaveLength(
+      2,
+    );
 
-    const nbCourseRun = courseProductRelation.product.target_courses.reduce(
+    const nbCourseRun = offer.product.target_courses.reduce(
       (acc, course) => acc + course.course_runs.length,
       0,
     );

package/js/pages/TeacherDashboardTraining/index.tsx

@@ -6,37 +6,33 @@ import { DashboardLayout } from 'widgets/Dashboard/components/DashboardLayout';
 import { DashboardCard } from 'widgets/Dashboard/components/DashboardCard';
 import { Icon, IconTypeEnum } from 'components/Icon';
 import Banner, { BannerType } from 'components/Banner';
-import { CourseProductRelation } from 'types/Joanie';
+import { Offer } from 'types/Joanie';
 
 const messages = defineMessages({
-  errorNoCourseProductRelation: {
+  errorNoOffer: {
     defaultMessage: "This product doesn't exist",
-    description: 'Message displayed when requested course product relation is not found',
-    id: 'components.TeacherDashboardTraining.errorNoCourseProductRelation',
+    description: 'Message displayed when requested offer is not found',
+    id: 'components.TeacherDashboardTraining.errorNoOffer',
   },
 });
 
 interface TeacherDashboardTrainingProps {
-  courseProductRelation: CourseProductRelation;
+  offer: Offer;
 }
 
-export const TeacherDashboardTraining = ({
-  courseProductRelation,
-}: TeacherDashboardTrainingProps) => {
+export const TeacherDashboardTraining = ({ offer }: TeacherDashboardTrainingProps) => {
   const intl = useIntl();
-  return courseProductRelation ? (
+  return offer ? (
     <div className="teacher-course-page">
       <DashboardCard
         className="icon-arrow-right-rounded"
         header={
           <div>
             <div className="dashboard__title_container--small">
-              <h2 className="dashboard__title--large">
-                {capitalize(courseProductRelation.product.title)}
-              </h2>
+              <h2 className="dashboard__title--large">{capitalize(offer.product.title)}</h2>
             </div>
-            {courseProductRelation.product.description && (
-              <div className="dashboard__quote">{courseProductRelation.product.description}</div>
+            {offer.product.description && (
+              <div className="dashboard__quote">{offer.product.description}</div>
             )}
           </div>
         }
@@ -44,7 +40,7 @@ export const TeacherDashboardTraining = ({
         fullWidth
       />
       <DashboardLayout.NestedSection>
-        {courseProductRelation.product.target_courses.map((course) => (
+        {offer.product.target_courses.map((course) => (
           <DashboardLayout.Section key={`course_target_${course.code}`}>
             <DashboardCard
               className="icon-arrow-right-rounded"
@@ -66,11 +62,7 @@ export const TeacherDashboardTraining = ({
       </DashboardLayout.NestedSection>
     </div>
   ) : (
-    <Banner
-      message={intl.formatMessage(messages.errorNoCourseProductRelation)}
-      type={BannerType.ERROR}
-      rounded
-    />
+    <Banner message={intl.formatMessage(messages.errorNoOffer)} type={BannerType.ERROR} rounded />
   );
 };
 

package/js/types/Joanie.ts

@@ -38,7 +38,7 @@ export interface Organization {
 }
 
 export interface OrganizationResourceQuery extends ResourcesQuery {
-  course_product_relation_id?: CourseProductRelation['id'];
+  offer_id?: Offer['id'];
 }
 
 export interface ContractDefinition {
@@ -174,7 +174,7 @@ export interface DefinitionResourcesProduct {
   contract_definition_id: Nullable<ContractDefinition['id']>;
 }
 
-export interface CourseProductRelationLight {
+export interface OfferLight {
   id: string;
   course: CourseLight;
   organizations: Organization[];
@@ -182,13 +182,18 @@ export interface CourseProductRelationLight {
   created_on: string;
 }
 
-export interface CourseProductRelation extends CourseProductRelationLight {
-  order_groups: OrderGroup[];
+export interface Offer extends OfferLight {
   is_withdrawable: boolean;
-}
-export function isCourseProductRelation(
-  entity: CourseListItem | CourseProductRelationLight | RichieCourse,
-): entity is CourseProductRelationLight {
+  discounted_price: Nullable<number>;
+  discount_rate: Nullable<number>;
+  discount_amount: Nullable<number>;
+  discount_start: Nullable<string>;
+  discount_end: Nullable<string>;
+  description: Nullable<string>;
+  nb_seats_available: Nullable<number>;
+  seats: Nullable<number>;
+}
+export function isOffer(entity: CourseListItem | OfferLight | RichieCourse): entity is OfferLight {
   return 'course' in entity && 'product' in entity;
 }
 
@@ -233,7 +238,7 @@ export interface Enrollment {
   was_created_by_order: boolean;
   created_on: string;
   orders: OrderEnrollment[];
-  product_relations: CourseProductRelation[];
+  offers: Offer[];
   certificate_id: Nullable<string>;
 }
 export const isEnrollment = (obj: unknown | Enrollment | OpenEdXEnrollment): obj is Enrollment => {
@@ -247,7 +252,7 @@ export const isEnrollment = (obj: unknown | Enrollment | OpenEdXEnrollment): obj
     'was_created_by_order' in obj &&
     'created_on' in obj &&
     'orders' in obj &&
-    'product_relations' in obj &&
+    'offers' in obj &&
     'certificate_id' in obj
   );
 };
@@ -325,7 +330,6 @@ export interface Order {
   enrollment: Nullable<EnrollmentLight>;
   organization_id: Organization['id'];
   organization: Organization;
-  order_group_id?: OrderGroup['id'];
   payment_schedule?: PaymentSchedule;
   credit_card_id?: CreditCard['id'];
 }
@@ -398,18 +402,11 @@ export interface NestedCourseOrder {
 
 export interface CourseOrderResourceQuery extends PaginatedResourceQuery {
   course_id?: CourseListItem['id'];
-  course_product_relation_id?: CourseProductRelation['id'];
+  offer_id?: Offer['id'];
   organization_id?: Organization['id'];
   product_id?: Product['id'];
 }
 
-export interface OrderGroup {
-  id: string;
-  is_active: boolean;
-  nb_seats: number;
-  nb_available_seats: number;
-}
-
 export enum CreditCardBrand {
   MASTERCARD = 'mastercard',
   MAESTRO = 'maestro',
@@ -481,7 +478,6 @@ export interface AddressCreationPayload extends Omit<Address, 'id' | 'is_main'>
 
 interface AbstractOrderProductCreationPayload {
   product_id: Product['id'];
-  order_group_id?: OrderGroup['id'];
   billing_address: Omit<Address, 'id' | 'is_main'>;
   has_waived_withdrawal_right: boolean;
 }
@@ -541,8 +537,8 @@ export interface CourseProductQueryFilters extends ResourcesQuery {
   id?: Product['id'];
   course_id?: CourseListItem['id'];
 }
-export interface CourseProductRelationQueryFilters extends PaginatedResourceQuery {
-  id?: CourseProductRelation['id'];
+export interface OfferQueryFilters extends PaginatedResourceQuery {
+  id?: Offer['id'];
   organization_id?: Organization['id'];
   product_type?: ProductType;
   query?: string;
@@ -555,7 +551,7 @@ export enum ContractState {
 }
 export interface ContractResourceQuery extends PaginatedResourceQuery {
   organization_id?: Organization['id'];
-  course_product_relation_id?: CourseProductRelation['id'];
+  offer_id?: Offer['id'];
   contract_ids?: Contract['id'][];
   signature_state?: ContractState;
 }
@@ -563,7 +559,7 @@ export interface ContractResourceQuery extends PaginatedResourceQuery {
 export interface OrganizationContractSignatureLinksFilters {
   contracts_ids?: string[];
   organization_id: Organization['id'];
-  course_product_relation_ids?: CourseProductRelation['id'][];
+  offer_ids?: Offer['id'][];
 }
 
 export interface ContractInvitationLinkResponse {
@@ -657,10 +653,10 @@ interface APIUser {
       check: (id: string) => Promise<Response>;
       create: ({
         organization_id,
-        course_product_relation_id,
+        offer_id,
       }: {
         organization_id?: Organization['id'];
-        course_product_relation_id?: CourseProductRelation['id'];
+        offer_id?: Offer['id'];
       }) => Promise<{ url: string }>;
       get: (id: string) => Promise<File>;
     };
@@ -676,7 +672,7 @@ export interface API {
       ? Promise<Nullable<CourseListItem>>
       : Promise<PaginatedResponse<CourseListItem>>;
     products: {
-      get(filters?: CourseProductQueryFilters): Promise<Nullable<CourseProductRelation>>;
+      get(filters?: CourseProductQueryFilters): Promise<Nullable<Offer>>;
       paymentSchedule: {
         get(filters?: CourseProductQueryFilters): Promise<Nullable<PaymentSchedule>>;
       };
@@ -709,12 +705,12 @@ export interface API {
       filters?: CourseRunFilters,
     ): CourseRunFilters extends { id: string } ? Promise<Nullable<CourseRun>> : Promise<CourseRun>;
   };
-  courseProductRelations: {
+  offers: {
     get<Filters extends PaginatedResourceQuery = PaginatedResourceQuery>(
       filters?: Filters,
     ): Filters extends { id: string }
-      ? Promise<Nullable<CourseProductRelation>>
-      : Promise<PaginatedResponse<CourseProductRelationLight>>;
+      ? Promise<Nullable<Offer>>
+      : Promise<PaginatedResponse<OfferLight>>;
   };
   contractDefinitions: {
     previewTemplate(id: string): Promise<File>;

package/js/utils/ProductHelper/index.ts

@@ -1,5 +1,5 @@
 import { IntlShape } from 'react-intl';
-import { CourseProductRelation, Product, TargetCourse } from 'types/Joanie';
+import { Product, TargetCourse } from 'types/Joanie';
 import { Maybe } from 'types/utils';
 import { IntlHelper } from 'utils/IntlHelper';
 import * as Joanie from 'types/Joanie';
@@ -44,10 +44,6 @@ export class ProductHelper {
     return IntlHelper.getLocalizedLanguages(uniqueLanguages, intl);
   }
 
-  static getActiveOrderGroups(courseProductRelation: CourseProductRelation) {
-    return courseProductRelation.order_groups?.filter((orderGroup) => orderGroup.is_active);
-  }
-
   static hasRemainingSeats(product: Maybe<Product>) {
     if (!product) return false;
     return typeof product?.remaining_order_count !== 'number' || product.remaining_order_count > 0;

package/js/utils/test/factories/joanie.ts

@@ -12,7 +12,7 @@ import {
   CourseLight,
   CourseListItem,
   CourseProduct,
-  CourseProductRelation,
+  Offer,
   CourseRun,
   CredentialOrder,
   CredentialProduct,
@@ -28,7 +28,6 @@ import {
   NestedCredentialOrder,
   Order,
   OrderEnrollment,
-  OrderGroup,
   PaymentInstallment,
   OrderLite,
   OrderState,
@@ -90,7 +89,7 @@ export const EnrollmentFactory = factory((): Enrollment => {
     id: faker.string.uuid(),
     course_run: CourseRunWithCourseFactory().one(),
     is_active: true,
-    product_relations: CourseProductRelationFactory().many(1),
+    offers: OfferFactory().many(1),
     state: EnrollmentState.SET,
     was_created_by_order: false,
     created_on: faker.date.past({ years: 1 }).toISOString(),
@@ -197,7 +196,7 @@ export const CredentialProductFactory = factory((): CredentialProduct => {
     created_on: faker.date.past().toISOString(),
     title: FactoryHelper.sequence((counter) => `Certificate Product ${counter}`),
     type: ProductType.CREDENTIAL,
-    price: faker.number.int(),
+    price: faker.number.int({ min: 1, max: 1000, multipleOf: 10 }),
     price_currency: faker.finance.currencyCode(),
     call_to_action: faker.lorem.words(3),
     certificate_definition: CertificationDefinitionFactory().one(),
@@ -294,25 +293,6 @@ export const CourseLightFactory = factory((): CourseLight => {
   };
 });
 
-export const OrderGroupFactory = factory((): OrderGroup => {
-  const seats = faker.number.int({ min: 5, max: 100 });
-  return {
-    id: faker.string.uuid(),
-    is_active: true,
-    nb_seats: seats,
-    nb_available_seats: faker.number.int({ min: 2, max: seats }),
-  };
-});
-
-export const OrderGroupFullFactory = factory((): OrderGroup => {
-  return {
-    id: faker.string.uuid(),
-    is_active: true,
-    nb_seats: faker.number.int({ min: 5, max: 100 }),
-    nb_available_seats: 0,
-  };
-});
-
 export const NestedCourseOrderFactory = factory((): NestedCourseOrder => {
   return {
     id: faker.string.uuid(),
@@ -329,15 +309,22 @@ export const NestedCourseOrderFactory = factory((): NestedCourseOrder => {
   };
 });
 
-export const CourseProductRelationFactory = factory((): CourseProductRelation => {
+export const OfferFactory = factory((): Offer => {
   return {
     id: faker.string.uuid(),
     created_on: faker.date.past().toISOString(),
     course: CourseFactory().one(),
     product: ProductFactory().one(),
     organizations: OrganizationFactory().many(1),
-    order_groups: [],
     is_withdrawable: true,
+    discounted_price: null,
+    discount_rate: null,
+    discount_amount: null,
+    discount_start: null,
+    discount_end: null,
+    description: null,
+    seats: null,
+    nb_seats_available: null,
   };
 });
 

package/js/utils/test/mockCourseProductWithOrder.ts

@@ -3,14 +3,14 @@ import { CredentialOrder } from 'types/Joanie';
 import {
   ContractDefinitionFactory,
   CourseFactory,
-  CourseProductRelationFactory,
+  OfferFactory,
   ProductFactory,
 } from 'utils/test/factories/joanie';
 
 export const mockCourseProductWithOrder = (order: CredentialOrder) => {
   const courseCode = order.course.code;
   const productId = order.product_id;
-  const relation = CourseProductRelationFactory({
+  const offer = OfferFactory({
     product: ProductFactory({
       id: order.product_id,
       contract_definition: order.contract ? ContractDefinitionFactory().one() : undefined,
@@ -22,7 +22,7 @@ export const mockCourseProductWithOrder = (order: CredentialOrder) => {
 
   fetchMock.get(
     `https://joanie.endpoint/api/v1.0/courses/${courseCode}/products/${productId}/`,
-    relation,
+    offer,
   );
-  return relation;
+  return offer;
 };

package/js/widgets/Dashboard/components/DashboardItem/Enrollment/DashboardItemEnrollment.tsx

@@ -33,7 +33,7 @@ export const DashboardItemEnrollment = ({ enrollment }: DashboardItemCourseRunPr
         </div>
       </div>,
     ];
-    enrollment.product_relations.forEach(({ product, is_withdrawable }) => {
+    enrollment.offers.forEach(({ product, is_withdrawable }) => {
       if (isCertificateProduct(product)) {
         partialFooterList.push(
           <ProductCertificateFooter

package/js/widgets/Dashboard/components/DashboardItem/Enrollment/ProductCertificateFooter/index.spec.tsx

@@ -249,7 +249,7 @@ describe('<ProductCertificateFooter/>', () => {
         course,
       }).one(),
     }).one();
-    enrollment.product_relations[0].product = CertificateProductFactory().one();
+    enrollment.offers[0].product = CertificateProductFactory().one();
 
     fetchMock.get(
       `https://joanie.endpoint/api/v1.0/enrollments/?was_created_by_order=false&is_active=true&page=1&page_size=${PER_PAGE.useOrdersEnrollments}`,

package/js/widgets/Dashboard/components/DashboardItem/Order/DashboardItemOrder.tsx

@@ -67,15 +67,15 @@ export const DashboardItemOrder = ({
 }: DashboardItemOrderProps) => {
   const { course } = order;
   const intl = useIntl();
-  const { item: courseProductRelation } = useCourseProduct({
+  const { item: offer } = useCourseProduct({
     product_id: order.product_id,
     course_id: course.code,
   });
-  const { product } = courseProductRelation || {};
+  const { product } = offer || {};
   const needsSignature = OrderHelper.orderNeedsSignature(order);
   const needsPaymentMethod = order.state === OrderState.TO_SAVE_PAYMENT_METHOD;
   const isActive = OrderHelper.isActive(order);
-  const isProductPurchasable = ProductHelper.isPurchasable(courseProductRelation?.product);
+  const isProductPurchasable = ProductHelper.isPurchasable(offer?.product);
   const isNotResumable = !isActive && !isProductPurchasable;
   const canEnroll = OrderHelper.allowEnrollment(order);
 

package/js/widgets/Dashboard/components/DashboardItem/Order/DashboardItemOrderContract.useUnionResource.cache.spec.tsx

@@ -57,7 +57,7 @@ describe('<DashboardItemOrder/> Contract', () => {
         contract: ContractFactory({ student_signed_on: null }).one(),
       }).one();
 
-      // learner dashboard course page do one call to course product relation per order
+      // learner dashboard course page do one call to offer per order
       const { product } = mockCourseProductWithOrder(order);
 
       // overwrite useOmniscientOrders call

package/js/widgets/Dashboard/components/DashboardItem/Order/Installment/index.tsx

@@ -94,7 +94,7 @@ const Installment = ({ order }: Props) => {
 
 const PaymentMethodManager = ({ order }: Props) => {
   const needsPaymentMethod = order.state === OrderState.TO_SAVE_PAYMENT_METHOD;
-  const { item: relation, states } = useCourseProduct({
+  const { item: offer, states } = useCourseProduct({
     course_id: order.course.code,
     product_id: order.product_id,
   });
@@ -118,9 +118,9 @@ const PaymentMethodManager = ({ order }: Props) => {
       )}
       <SaleTunnel
         {...modal}
-        product={relation.product as CredentialProduct}
-        course={relation.course}
-        isWithdrawable={relation.is_withdrawable}
+        product={offer.product as CredentialProduct}
+        course={offer.course}
+        isWithdrawable={offer.is_withdrawable}
       />
     </>
   );

package/js/widgets/Dashboard/components/DashboardItem/stories.mock.ts

@@ -25,6 +25,6 @@ export const enrollment: Enrollment = {
     },
     languages: ['en'],
   },
-  product_relations: [],
+  offers: [],
   certificate_id: null,
 };