SWAMPy

✎ CARVE FLESH

EDITING: gradebook.d.ts

/*
 * Copyright (C) 2022 - present Instructure, Inc.
 *
 * This file is part of Canvas.
 *
 * Canvas is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License as published by the Free
 * Software Foundation, version 3 of the License.
 *
 * Canvas is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 * A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */

import StudentDatastore from './stores/StudentDatastore'
import type {StatusColors} from './constants/colors'
import type {
  AssignmentGroup,
  AttachmentData,
  GradingPeriod,
  GradingPeriodSet,
  GradingScheme,
  GradingStandard,
  Module,
  ModuleMap,
  Section,
  Student,
  StudentGrade,
  StudentGroupCategoryMap,
  StudentMap,
} from '../api.d'

export type SortDirection = 'ascending' | 'descending'

export type CourseSettingsType = {
  filter_speed_grader_by_student_group: boolean
  allow_final_grade_override: boolean
}

export type GradebookSettings = {
  enter_grades_as: any
  filter_columns_by: {
    assignment_group_id: string | null
    grading_period_id: string | null
    context_module_id: string | null
    end_date: string | null
    start_date: string | null
    submissions: SubmissionFilterValue | null // affects rows too
  }
  filter_rows_by: {
    section_id: string | null
    student_group_id: string | null
  }
  hide_assignment_group_totals: 'false' | 'true'
  hide_total: 'false' | 'true'
  selected_view_options_filters: string[]
  show_concluded_enrollments: 'false' | 'true'
  show_inactive_enrollments: 'false' | 'true'
  show_separate_first_last_names: 'false' | 'true'
  show_unpublished_assignments: 'false' | 'true'
  sort_rows_by_column_id: string
  sort_rows_by_direction: SortDirection
  sort_rows_by_setting_key: SortRowsSettingKey
  student_column_display_as: 'last_first' | 'first_last'
  student_column_secondary_info: string
  view_ungraded_as_zero: 'false' | 'true'
  colors?: StatusColors
}

export type PerformanceControlValues = {
  activeRequestLimit?: number
  apiMaxPerPage?: number
  assignmentGroupsPerPage?: number
  contextModulesPerPage?: number
  customColumnDataPerPage?: number
  customColumnsPerPage?: number
  studentsChunkSize?: number
  submissionsChunkSize?: number
  submissionsPerPage?: number
}

export type GradebookOptions = {
  active_grading_periods: GradingPeriod[]
  allow_apply_score_to_ungraded: boolean
  allow_separate_first_last_names: boolean
  allow_view_ungraded_as_zero: boolean
  assignment_missing_shortcut: boolean
  attachment_url: null | string
  attachment: null | AttachmentData
  change_grade_url: string
  change_gradebook_version_url: string
  colors: StatusColors
  context_allows_gradebook_uploads: boolean
  context_code: string
  context_id: string
  context_sis_id: null | string
  context_url: string
  course_is_concluded: boolean
  course_name: string
  course_settings: CourseSettingsType
  course_url: string
  current_grading_period_id: string
  currentUserId: string
  custom_column_datum_url: string
  default_grading_standard: GradingStandard[]
  download_assignment_submissions_url: string
  enhanced_gradebook_filters: boolean
  hide_zero_point_quizzes: boolean
  enrollments_url: string
  enrollments_with_concluded_url: string
  export_gradebook_csv_url: string
  final_grade_override_enabled: boolean
  grade_calc_ignore_unposted_anonymous_enabled: boolean
  grade_calc_ignore_unposted_anonymous_enabled: boolean
  gradebook_column_order_settings_url: string
  gradebook_column_order_settings: ColumnOrderSettings
  gradebook_column_size_settings_url: string
  gradebook_column_size_settings: ColumnSizeSettings
  gradebook_csv_progress: null | ProgressData
  gradebook_import_url: string
  gradebook_is_editable: boolean
  gradebook_score_to_ungraded_progress: null | ProgressData
  graded_late_submissions_exist: boolean
  grading_period_set: GradingPeriodSet
  grading_schemes: GradingScheme[]
  grading_standard: boolean
  group_weighting_scheme: null | string
  has_modules: boolean
  individual_gradebook_enhancements: boolean
  late_policy: LatePolicy | null
  login_handle_name: null | string
  message_attachment_upload_folder_id: string
  outcome_gradebook_enabled: boolean
  performance_controls: PerformanceControlValues
  post_grades_feature: boolean
  post_grades_ltis: Lti[]
  post_manually: boolean
  publish_to_sis_enabled: boolean
  publish_to_sis_url: string
  re_upload_submissions_url: string
  reorder_custom_columns_url: string
  sections: Section[]
  setting_update_url: string
  settings_update_url: string
  settings: GradebookSettings
  show_message_students_with_observers_dialog: boolean
  show_message_students_with_observers_dialog: boolean
  show_similarity_score: boolean
  show_total_grade_as_points: boolean
  sis_app_token: null | string
  sis_app_url: null | string
  sis_name: string
  speed_grader_enabled: boolean
  student_groups: StudentGroupCategoryMap
  user_asset_string: string
  teacher_notes: {
    hidden: boolean
    id: string
    position: number
    read_only: boolean
    teacher_notes: boolean
    title: string
  }
  version: null | string
}

export type GradebookViewOptions = {
  columnSortSettings: {
    criterion: string
    direction: SortDirection
  }
  hideTotal: boolean
  showNotes: boolean
  showSeparateFirstLastNames: boolean
  showUnpublishedAssignments: boolean
  hideAssignmentGroupTotals: boolean
  statusColors: StatusColors
  viewUngradedAsZero: boolean
}

export type LatePolicy = {
  late_submission_deduction_enabled: boolean
  late_submission_deduction: number
  late_submission_interval: 'day' | 'hour'
  late_submission_minimum_percent_enabled: boolean
  late_submission_minimum_percent: number
  missing_submission_deduction_enabled: boolean
  missing_submission_deduction: number
}

// TODO: remove the need for this type
export type LatePolicyCamelized = {
  lateSubmissionDeduction: number
  lateSubmissionDeductionEnabled: boolean
  lateSubmissionInterval: 'day' | 'hour'
  lateSubmissionMinimumPercent: number
  lateSubmissionMinimumPercentEnabled: boolean
  missingSubmissionDeduction: number
  missingSubmissionDeductionEnabled: boolean
  newRecord?: boolean
}

export type LatePolicyValidationErrors = {
  missingSubmissionDeduction?: string
  lateSubmissionDeduction?: string
  lateSubmissionMinimumPercent?: string
}

export type GradingPeriodAssignmentMap = {
  [gradingPeriodId: string]: string[]
}

export type CourseContent = {
  contextModules: Module[]
  courseGradingScheme: GradingScheme | null
  defaultGradingScheme: GradingScheme | null
  gradingSchemes: GradingScheme[]
  gradingPeriodAssignments: GradingPeriodAssignmentMap
  assignmentStudentVisibility: {[assignmentId: string]: null | StudentMap}
  latePolicy?: LatePolicyCamelized
  students: StudentDatastore
  modulesById: ModuleMap
}

export type ContentLoadStates = {
  assignmentGroupsLoaded: boolean
  contextModulesLoaded: boolean
  assignmentsLoaded: {
    all: boolean
    gradingPeriod: {
      [gradingPeriodId: string]: boolean
    }
  }
  customColumnsLoaded: boolean
  gradingPeriodAssignmentsLoaded: boolean
  overridesColumnUpdating: boolean
  studentIdsLoaded: boolean
  studentsLoaded: boolean
  submissionsLoaded: boolean
  teacherNotesColumnUpdating: boolean
}

export type PendingGradeInfo = {
  assignmentId?: string
  enteredAs?: string | null
  excused: boolean
  grade: string | null
  score: number | null
  userId?: string
  valid: boolean
}

export type InitialActionStates = {
  pendingGradeInfo: PendingGradeInfo[]
}

export type FlashMessage = {
  key: string
  message: string
  variant?: 'error' | 'success' | 'warning' | 'info'
}

export type Filter = {
  id: string
  type?: FilterType
  value?: string | null
  created_at: string
}

export type FilterPreset = {
  id: string
  name: string
  filters: Filter[]
  created_at: string
  updated_at: string
}

export type PartialFilterPreset = Omit<FilterPreset, 'id'> & {id?: string}

export type FilterDrilldownData = {
  [key: string]: FilterDrilldownMenuItem
}

export type FilterDrilldownMenuItem = {
  id: string
  parentId?: null | string
  name: string
  isSelected?: boolean
  onToggle?: () => void
  items?: FilterDrilldownMenuItem[]
  itemGroups?: FilterDrilldownMenuItem[]
}

export type GradebookFilterApiRequest = {
  name: string
  payload: {
    conditions: Filter[]
  }
}

export type GradebookFilterApiResponse = {
  gradebook_filter: GradebookFilterApiResponseFilter
}

export type GradebookFilterApiResponseFilter = {
  course_id: string
  id: string
  user_id: string
  name: string
  payload: {
    conditions: Filter[]
  }
  created_at: string
  updated_at: string
}

export type ColumnSizeSettings = {
  [key: string]: string
}

export type Lti = {
  id: string
  name: string
  data_url: string
}

export type ColumnOrderSettings = {
  customOrder?: string[]
  direction?: SortDirection
  freezeTotalGrade?: boolean | 'true'
  sortType: string
}

export type ProgressData = {
  progress: Progress
}

export type FilteredContentInfo = {
  invalidAssignmentGroups: AssignmentGroup[]
  totalPointsPossible: number
}

export type AssignmentStudentMap = {
  [assignmentId: string]: StudentMap
}

// TODO: store student grades in separate map so that the
//   student object isn't rendered "any"
export type GradebookStudent = Student & {
  [assignmentGroupGradeKey: `assignment_group_${string}`]: StudentGrade
} & {
  [assignmentGradeKey: `assignment_${string}`]: StudentGrade
} & {
  [columnGradeKey: `custom_col_${string}`]: any
}

export type GradebookStudentMap = {
  [studentId: string]: GradebookStudent
}

export type CustomColumn = {
  hidden: boolean
  id: string
  position: number
  read_only: boolean
  teacher_notes: boolean
  title: string
}

export type CustomColumnData = {
  user_id: string
  content: unknown
}

export type SerializedComment = {
  id: string
  comment: string
  createdAt: Date
  editedAt: null | Date
  authorId?: string
  author?: string
  authorAvatarUrl?: string
  authorUrl?: string
}

export type AssignmentWithOverride = {
  id: string
  name: string
  due_at: string | null
  please_ignore: boolean
  recentlyUpdated: boolean
  hadOriginalErrors: boolean
  overrides: unknown[]
  original_error?: boolean
  needs_grading_count: number
  currentlySelected: {
    id: string
    type: string
  }
  selectedSectionForEveryone: string
  overrideForThisSection: {
    id: string
    course_section_id: string
    due_at: null | Date
  }
}

export type Progress = {
  id: string
  workflow_state: string
  message?: string
  updated_at?: string
}

export type ProgressCamelized = {
  progressId: string
  workflowState?: string
}

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📁 __tests__/	DIR	—	2023-09-24 03:39
📁 apis/	DIR	—	2023-09-24 03:36
📁 components/	DIR	—	2023-09-24 03:39
📁 constants/	DIR	—	2023-09-24 03:36
📁 CourseSettings/	DIR	—	2023-09-24 03:36
📁 FinalGradeOverrides/	DIR	—	2023-09-24 03:39
📁 GradebookGrid/	DIR	—	2023-09-24 03:36
📁 PostPolicies/	DIR	—	2023-09-24 03:36
📁 propTypes/	DIR	—	2023-09-24 03:36
📁 stores/	DIR	—	2023-09-24 03:39
📄 AsyncComponents.tsx	TSX	2.7 KB	2023-09-24 03:36	EDIT
📄 CurveGradesDialogManager.ts	TS	2.1 KB	2023-09-24 03:36	EDIT
📄 gradebook.d.ts	TS	11.3 KB	2023-09-24 03:39	EDIT
📄 Gradebook.sorting.ts	TS	5 KB	2023-09-24 03:36	EDIT
📄 Gradebook.tsx	TSX	178 KB	2023-09-24 03:39	EDIT
📄 Gradebook.utils.ts	TS	21.8 KB	2023-09-24 03:39	EDIT
📄 GradebookData.tsx	TSX	8.7 KB	2023-09-24 03:39	EDIT
📄 grid.d.ts	TS	4 KB	2023-09-24 03:36	EDIT
📄 initialState.ts	TS	5.2 KB	2023-09-24 03:39	EDIT
📄 PerformanceControls.ts	TS	2.7 KB	2023-09-24 03:36	EDIT