add mitxonline certificate api (#2410)

gumaerc · jonkafton · web-flow · commit 77e1d306ed70 · 2025-08-07T14:26:02.000-04:00
* use v2 mitxonline api's everywhere, add certificate api's

* fix yarn lock

* move back to official package now that it is released

* add course run cert info to transform

* fix tests surrounding certificate info on course runs

* Update frontends/api/src/mitxonline/hooks/certificates/queries.ts

Co-authored-by: Jon Kafton &lt;939376+jonkafton@users.noreply.github.com&gt;

---------

Co-authored-by: Jon Kafton &lt;939376+jonkafton@users.noreply.github.com&gt;
diff --git a/frontends/api/package.json b/frontends/api/package.json
@@ -30,7 +30,7 @@
     "ol-test-utilities": "0.0.0"
   },
   "dependencies": {
-    "@mitodl/mitxonline-api-axios": "2025.7.28",
+    "@mitodl/mitxonline-api-axios": "2025.8.6",
     "@tanstack/react-query": "^5.66.0",
     "axios": "^1.6.3"
   }
diff --git a/frontends/api/src/mitxonline/clients.ts b/frontends/api/src/mitxonline/clients.ts
@@ -1,11 +1,13 @@
 import {
   B2bApi,
   CoursesApi,
+  CourseCertificatesApi,
   EnrollmentsApi,
   ProgramCollectionsApi,
   ProgramsApi,
+  ProgramCertificatesApi,
   UsersApi,
-} from "@mitodl/mitxonline-api-axios/v1"
+} from "@mitodl/mitxonline-api-axios/v2"
 import axios from "axios"
 
 const axiosInstance = axios.create({
@@ -29,7 +31,17 @@ const programCollectionsApi = new ProgramCollectionsApi(
   BASE_PATH,
   axiosInstance,
 )
+const programCertificatesApi = new ProgramCertificatesApi(
+  undefined,
+  BASE_PATH,
+  axiosInstance,
+)
 const coursesApi = new CoursesApi(undefined, BASE_PATH, axiosInstance)
+const courseCertificatesApi = new CourseCertificatesApi(
+  undefined,
+  BASE_PATH,
+  axiosInstance,
+)
 
 export {
   usersApi,
@@ -38,5 +50,7 @@ export {
   programsApi,
   programCollectionsApi,
   coursesApi,
+  programCertificatesApi,
+  courseCertificatesApi,
   axiosInstance,
 }
diff --git a/frontends/api/src/mitxonline/hooks/certificates/index.ts b/frontends/api/src/mitxonline/hooks/certificates/index.ts
@@ -0,0 +1,3 @@
+import { certificateQueries } from "./queries"
+
+export { certificateQueries }
diff --git a/frontends/api/src/mitxonline/hooks/certificates/queries.ts b/frontends/api/src/mitxonline/hooks/certificates/queries.ts
@@ -0,0 +1,46 @@
+import { queryOptions } from "@tanstack/react-query"
+import type {
+  CourseCertificatesApiCourseCertificatesRetrieveRequest,
+  ProgramCertificatesApiProgramCertificatesRetrieveRequest,
+  V2CourseRunCertificate,
+  V2ProgramCertificate,
+} from "@mitodl/mitxonline-api-axios/v2"
+import { courseCertificatesApi, programCertificatesApi } from "../../clients"
+
+const certificateKeys = {
+  root: ["mitxonline", "certificates"],
+  courseCertificatesRetrieve: (
+    opts?: CourseCertificatesApiCourseCertificatesRetrieveRequest,
+  ) => [...certificateKeys.root, "retrieve", opts],
+  programCertificatesRetrieve: (
+    opts?: ProgramCertificatesApiProgramCertificatesRetrieveRequest,
+  ) => [...certificateKeys.root, "retrieve", opts],
+}
+
+const certificateQueries = {
+  courseCertificatesRetrieve: (
+    opts: CourseCertificatesApiCourseCertificatesRetrieveRequest,
+  ) =>
+    queryOptions({
+      queryKey: certificateKeys.courseCertificatesRetrieve(opts),
+      queryFn: async (): Promise<V2CourseRunCertificate> => {
+        return courseCertificatesApi
+          .courseCertificatesRetrieve(opts)
+          .then((res) => res.data)
+      },
+      enabled: !!opts.cert_uuid,
+    }),
+  programCertificatesRetrieve: (
+    opts: ProgramCertificatesApiProgramCertificatesRetrieveRequest,
+  ) =>
+    queryOptions({
+      queryKey: certificateKeys.programCertificatesRetrieve(opts),
+      queryFn: async (): Promise<V2ProgramCertificate> => {
+        return programCertificatesApi
+          .programCertificatesRetrieve(opts)
+          .then((res) => res.data)
+      },
+    }),
+}
+
+export { certificateQueries, certificateKeys }
diff --git a/frontends/api/src/mitxonline/hooks/courses/queries.ts b/frontends/api/src/mitxonline/hooks/courses/queries.ts
@@ -2,7 +2,7 @@ import { queryOptions } from "@tanstack/react-query"
 import type {
   CoursesApiApiV2CoursesListRequest,
   PaginatedV2CourseWithCourseRunsList,
-} from "@mitodl/mitxonline-api-axios/v1"
+} from "@mitodl/mitxonline-api-axios/v2"
 import { coursesApi } from "../../clients"
 
 const coursesKeys = {
diff --git a/frontends/api/src/mitxonline/hooks/enrollment/index.ts b/frontends/api/src/mitxonline/hooks/enrollment/index.ts
@@ -4,7 +4,7 @@ import { b2bApi, enrollmentsApi } from "../../clients"
 import {
   B2bApiB2bEnrollCreateRequest,
   EnrollmentsApiEnrollmentsPartialUpdateRequest,
-} from "@mitodl/mitxonline-api-axios/v1"
+} from "@mitodl/mitxonline-api-axios/v2"
 
 const useCreateEnrollment = (opts: B2bApiB2bEnrollCreateRequest) => {
   const queryClient = useQueryClient()
diff --git a/frontends/api/src/mitxonline/hooks/enrollment/queries.ts b/frontends/api/src/mitxonline/hooks/enrollment/queries.ts
@@ -1,5 +1,5 @@
 import { queryOptions } from "@tanstack/react-query"
-import type { CourseRunEnrollment } from "@mitodl/mitxonline-api-axios/v1"
+import type { CourseRunEnrollment } from "@mitodl/mitxonline-api-axios/v2"
 
 import { enrollmentsApi } from "../../clients"
 
diff --git a/frontends/api/src/mitxonline/hooks/organizations/queries.ts b/frontends/api/src/mitxonline/hooks/organizations/queries.ts
@@ -1,5 +1,5 @@
 import { B2bApiB2bOrganizationsRetrieveRequest } from "@mitodl/mitxonline-api-axios/v0"
-import { OrganizationPage } from "@mitodl/mitxonline-api-axios/v1"
+import { OrganizationPage } from "@mitodl/mitxonline-api-axios/v2"
 import { queryOptions } from "@tanstack/react-query"
 import { b2bApi } from "../../clients"
 
diff --git a/frontends/api/src/mitxonline/hooks/programs/queries.ts b/frontends/api/src/mitxonline/hooks/programs/queries.ts
@@ -6,7 +6,7 @@ import type {
   ProgramsApiProgramsListV2Request,
   ProgramsApiProgramsRetrieveV2Request,
   V2Program,
-} from "@mitodl/mitxonline-api-axios/v1"
+} from "@mitodl/mitxonline-api-axios/v2"
 import { programCollectionsApi, programsApi } from "../../clients"
 
 const programsKeys = {
diff --git a/frontends/api/src/mitxonline/hooks/user/index.ts b/frontends/api/src/mitxonline/hooks/user/index.ts
@@ -1,6 +1,6 @@
 import { useQuery } from "@tanstack/react-query"
 import { usersApi } from "../../clients"
-import type { User } from "@mitodl/mitxonline-api-axios/v1"
+import type { User } from "@mitodl/mitxonline-api-axios/v2"
 
 const useMitxOnlineCurrentUser = (opts: { enabled?: boolean } = {}) =>
   useQuery({
diff --git a/frontends/api/src/mitxonline/test-utils/factories/courses.ts b/frontends/api/src/mitxonline/test-utils/factories/courses.ts
@@ -1,6 +1,6 @@
 import { mergeOverrides, makePaginatedFactory } from "ol-test-utilities"
 import type { PartialFactory } from "ol-test-utilities"
-import type { V2CourseWithCourseRuns } from "@mitodl/mitxonline-api-axios/v1"
+import type { V2CourseWithCourseRuns } from "@mitodl/mitxonline-api-axios/v2"
 import { faker } from "@faker-js/faker/locale/en"
 import { UniqueEnforcer } from "enforce-unique"
 
diff --git a/frontends/api/src/mitxonline/test-utils/factories/enrollment.ts b/frontends/api/src/mitxonline/test-utils/factories/enrollment.ts
@@ -4,7 +4,7 @@ import type { PartialFactory } from "ol-test-utilities"
 import type {
   CourseRunEnrollment,
   CourseRunGrade,
-} from "@mitodl/mitxonline-api-axios/v1"
+} from "@mitodl/mitxonline-api-axios/v2"
 import { UniqueEnforcer } from "enforce-unique"
 
 const uniqueEnrollmentId = new UniqueEnforcer()
@@ -34,7 +34,10 @@ const courseEnrollment: PartialFactory<CourseRunEnrollment> = (
 
   const defaults: CourseRunEnrollment = {
     id: uniqueEnrollmentId.enforce(() => faker.number.int()),
-    certificate: null,
+    certificate: {
+      uuid: faker.string.uuid(),
+      link: faker.internet.url(),
+    },
     approved_flexible_price_exists: faker.datatype.boolean(),
     grades: [],
     enrollment_mode: faker.helpers.arrayElement(["audit", "verified"]),
diff --git a/frontends/api/src/mitxonline/test-utils/factories/organization.ts b/frontends/api/src/mitxonline/test-utils/factories/organization.ts
@@ -1,5 +1,5 @@
 import { faker } from "@faker-js/faker/locale/en"
-import { OrganizationPage } from "@mitodl/mitxonline-api-axios/v1"
+import { OrganizationPage } from "@mitodl/mitxonline-api-axios/v2"
 import { mergeOverrides } from "ol-test-utilities"
 
 const organization = (
diff --git a/frontends/api/src/mitxonline/test-utils/factories/programs.ts b/frontends/api/src/mitxonline/test-utils/factories/programs.ts
@@ -3,7 +3,7 @@ import type { PartialFactory } from "ol-test-utilities"
 import type {
   V2Program,
   V2ProgramCollection,
-} from "@mitodl/mitxonline-api-axios/v1"
+} from "@mitodl/mitxonline-api-axios/v2"
 import { faker } from "@faker-js/faker/locale/en"
 import { UniqueEnforcer } from "enforce-unique"
 
diff --git a/frontends/api/src/mitxonline/test-utils/factories/user.ts b/frontends/api/src/mitxonline/test-utils/factories/user.ts
@@ -5,7 +5,7 @@ import type {
   LegalAddress,
   UserProfile,
   UserOrganization,
-} from "@mitodl/mitxonline-api-axios/v1"
+} from "@mitodl/mitxonline-api-axios/v2"
 import { UniqueEnforcer } from "enforce-unique"
 
 const enforcerId = new UniqueEnforcer()
diff --git a/frontends/api/src/mitxonline/test-utils/urls.ts b/frontends/api/src/mitxonline/test-utils/urls.ts
@@ -2,7 +2,7 @@ import type {
   CoursesApiApiV2CoursesListRequest,
   ProgramCollectionsApiProgramCollectionsListRequest,
   ProgramsApiProgramsListV2Request,
-} from "@mitodl/mitxonline-api-axios/v1"
+} from "@mitodl/mitxonline-api-axios/v2"
 import { RawAxiosRequestConfig } from "axios"
 import { queryify } from "ol-test-utilities"
 
diff --git a/frontends/main/package.json b/frontends/main/package.json
@@ -14,7 +14,7 @@
     "@emotion/cache": "^11.13.1",
     "@emotion/styled": "^11.11.0",
     "@mitodl/course-search-utils": "3.3.2",
-    "@mitodl/mitxonline-api-axios": "2025.7.28",
+    "@mitodl/mitxonline-api-axios": "2025.8.6",
     "@mitodl/smoot-design": "^6.10.0",
     "@next/bundle-analyzer": "^14.2.15",
     "@remixicon/react": "^4.2.0",
diff --git a/frontends/main/src/app-pages/DashboardPage/CoursewareDisplay/transform.test.tsx b/frontends/main/src/app-pages/DashboardPage/CoursewareDisplay/transform.test.tsx
@@ -41,6 +41,10 @@ describe("Transforming mitxonline enrollment data to DashboardResource", () => {
           certificateUpgradeDeadline: apiData.run.upgrade_deadline,
           certificateUpgradePrice: apiData.run.products[0]?.price,
           canUpgrade: expect.any(Boolean), // check this in a moment
+          certificate: {
+            uuid: apiData.certificate?.uuid ?? "",
+            link: apiData.certificate?.link ?? "",
+          },
         },
         enrollment: {
           id: apiData.id,
diff --git a/frontends/main/src/app-pages/DashboardPage/CoursewareDisplay/transform.ts b/frontends/main/src/app-pages/DashboardPage/CoursewareDisplay/transform.ts
@@ -9,7 +9,7 @@ import {
   V2CourseWithCourseRuns,
   V2Program,
   V2ProgramCollection,
-} from "@mitodl/mitxonline-api-axios/v1"
+} from "@mitodl/mitxonline-api-axios/v2"
 
 import { DashboardResourceType, EnrollmentStatus } from "./types"
 import type {
@@ -53,6 +53,10 @@ const mitxonlineEnrollment = (raw: CourseRunEnrollment): DashboardCourse => {
       certificateUpgradePrice: raw.run.products[0]?.price,
       canUpgrade: raw.run.is_upgradable,
       coursewareUrl: raw.run.courseware_url,
+      certificate: {
+        uuid: raw.certificate?.uuid ?? "",
+        link: raw.certificate?.link ?? "",
+      },
     },
     enrollment: {
       id: raw.id,
diff --git a/frontends/main/src/app-pages/DashboardPage/CoursewareDisplay/types.ts b/frontends/main/src/app-pages/DashboardPage/CoursewareDisplay/types.ts
@@ -31,6 +31,10 @@ type DashboardCourse = {
     certificateUpgradePrice?: string | null
     coursewareUrl?: string | null
     canUpgrade: boolean
+    certificate?: {
+      uuid: string
+      link: string
+    }
   }
   enrollment?: {
     id: number
diff --git a/frontends/main/src/app-pages/DashboardPage/DashboardLayout.test.tsx b/frontends/main/src/app-pages/DashboardPage/DashboardLayout.test.tsx
@@ -22,7 +22,7 @@ import {
 import { faker } from "@faker-js/faker/locale/en"
 import invariant from "tiny-invariant"
 import { useFeatureFlagEnabled } from "posthog-js/react"
-import { OrganizationPage } from "@mitodl/mitxonline-api-axios/v1"
+import { OrganizationPage } from "@mitodl/mitxonline-api-axios/v2"
 
 jest.mock("posthog-js/react")
 const mockedUseFeatureFlagEnabled = jest.mocked(useFeatureFlagEnabled)
diff --git a/frontends/main/src/app-pages/DashboardPage/OrganizationContent.tsx b/frontends/main/src/app-pages/DashboardPage/OrganizationContent.tsx
@@ -22,7 +22,7 @@ import graduateLogo from "@/public/images/dashboard/graduate.png"
 import {
   CourseRunEnrollment,
   OrganizationPage,
-} from "@mitodl/mitxonline-api-axios/v1"
+} from "@mitodl/mitxonline-api-axios/v2"
 import { useMitxOnlineCurrentUser } from "api/mitxonline-hooks/user"
 
 const HeaderRoot = styled.div({
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@`
`30`	`30`	`"ol-test-utilities": "0.0.0"`
`31`	`31`	`},`
`32`	`32`	`"dependencies": {`
`33`		`- "@mitodl/mitxonline-api-axios": "2025.7.28",`
	`33`	`+ "@mitodl/mitxonline-api-axios": "2025.8.6",`
`34`	`34`	`"@tanstack/react-query": "^5.66.0",`
`35`	`35`	`"axios": "^1.6.3"`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { certificateQueries } from "./queries"`
	`2`	`+`
	`3`	`+export { certificateQueries }`