caccl-api/src/endpoints/ECatCourse/types/DateHandling.ts

A class that defines a set of smart Canvas endpoints that actually behave how you'd expect them to.

/**
 * Two ways to handle dates when performing a course migration.
 * @author Yuen Ler Chow
 */
export enum DateHandlingType {
  ShiftDates = 'shift-dates',
  RemoveDates = 'remove-dates',
}

export enum DayOfWeek {
  Sunday = 'sunday',
  Monday = 'monday',
  Tuesday = 'tuesday',
  Wednesday = 'wednesday',
  Thursday = 'thursday',
  Friday = 'friday',
  Saturday = 'saturday',
}

/**
 * Convert DayOfWeek to a number.
 * @author Yuen Ler Chow
 */
export const dayOfWeekToNumber = {
  [DayOfWeek.Sunday]: 0,
  [DayOfWeek.Monday]: 1,
  [DayOfWeek.Tuesday]: 2,
  [DayOfWeek.Wednesday]: 3,
  [DayOfWeek.Thursday]: 4,
  [DayOfWeek.Friday]: 5,
  [DayOfWeek.Saturday]: 6,
};

/**
 * All the information needed to shift dates.
 * @author Yuen Ler Chow
 */
export type DateShiftOptions = (
    {
      dateHandling: DateHandlingType.RemoveDates,
    }
    | {
      dateHandling: DateHandlingType.ShiftDates,
      oldStart: Date,
      oldEnd: Date,
      newStart: Date,
      newEnd: Date,
      daySubstitutionMap?: {
        [k in DayOfWeek]: DayOfWeek
      }
    }
);