type api requests

modeled-mobx now expects an object for hydration

Author: nathanstitt

tutor/src/helpers/course-enrollment.tsx

@@ -13,6 +13,7 @@ import Enroll from '../components/enroll';
 import urlFor from '../api';
 import { ApiErrorData, isApiError } from 'shared/api/request';
 import type { User, CoursesMap } from '../models';
+import { CourseData } from '../models/types';
 
 export class CourseEnrollment extends BaseModel {
 
@@ -188,7 +189,7 @@ export class CourseEnrollment extends BaseModel {
     @action async create() {
         if (this.needsPeriodSelection) {
             this.courseToJoin = new Course()
-            const courseData = await this.api.request(
+            const courseData = await this.api.request<CourseData>(
                 urlFor('fetchEnrollmentChoices', { enrollmentCode: this.originalEnrollmentCode }),
             )
             this.courseToJoin = hydrateModel(Course, courseData)

tutor/src/models/course.ts

@@ -325,7 +325,7 @@ export class Course extends BaseModel {
 
     @action async saveExerciseExclusion({ exercise, is_excluded }: { exercise: Exercise, is_excluded: boolean }) {
         exercise.is_excluded = is_excluded; // eagerly set exclusion
-        const data = await this.api.request(
+        const data = await this.api.request<CourseData>(
             urlFor('saveExerciseExclusion', { courseId: this.id }),
             { data: [{ id: exercise.id, is_excluded }] },
         )

tutor/src/models/course/lms.ts

@@ -5,6 +5,7 @@ import urlFor from '../../api'
 import type { Course } from '../../models'
 import Time from 'shared/model/time';
 import UiSettings from 'shared/model/ui-settings';
+import { CourseLMSData } from '../types';
 
 const LMS_VENDOR = 'lmsv';
 
@@ -36,7 +37,7 @@ export class CourseLMS extends BaseModel {
     }
 
     async fetch() {
-        const json = await this.api.request(urlFor('fetchCourseLMS', { courseId: this.course.id }))
+        const json = await this.api.request<CourseLMSData>(urlFor('fetchCourseLMS', { courseId: this.course.id }))
         hydrateInstance(this, json)
     }
 

tutor/src/models/types.ts

@@ -44,6 +44,17 @@ export interface TeacherProfileData {
     name: string
 }
 
+export interface CourseLMSData {
+    id: ID
+    key: string
+    secret: string
+    launch_url: string
+    configuration_url: string
+    xml: string
+    created_at: string
+    updated_at: string
+}
+
 export interface CoursePeriodData {
     id: ID
     enrollment_code: string