caccl-api

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>ECatCourse/ECatAssignment.js - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> <script src="scripts/nav.js" defer></script> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav style="border-right: 2px solid #ccc; padding-bottom: 25px;" > <h2><a style="font-size: 30px;" href="index.html">CACCL API</a></h2><h3>Endpoint Functions</h3><ul><li><a href="api.account.html">api.account</a><ul class='methods'><li data-type='method'><a href="api.account.html#get">get</a></li><li data-type='method'><a href="api.account.html#list">list</a></li><li data-type='method'><a href="api.account.html#listAdmins">listAdmins</a></li><li data-type='method'><a href="api.account.html#listCourses">listCourses</a></li></ul></li><li><a href="api.conversation.html">api.conversation</a><ul class='methods'><li data-type='method'><a href="api.conversation.html#create">create</a></li></ul></li><li><a href="api.course.html">api.course</a><ul class='methods'><li data-type='method'><a href="api.course.html#get">get</a></li><li data-type='method'><a href="api.course.html#getUser">getUser</a></li><li data-type='method'><a href="api.course.html#listDesignerEnrollments">listDesignerEnrollments</a></li><li data-type='method'><a href="api.course.html#listDesigners">listDesigners</a></li><li data-type='method'><a href="api.course.html#listEnrollments">listEnrollments</a></li><li data-type='method'><a href="api.course.html#listObserverEnrollments">listObserverEnrollments</a></li><li data-type='method'><a href="api.course.html#listObservers">listObservers</a></li><li data-type='method'><a href="api.course.html#listStudentEnrollments">listStudentEnrollments</a></li><li data-type='method'><a href="api.course.html#listStudents">listStudents</a></li><li data-type='method'><a href="api.course.html#listTAs">listTAs</a></li><li data-type='method'><a href="api.course.html#listTeachers">listTeachers</a></li><li data-type='method'><a href="api.course.html#listTeachingTeamMemberEnrollments">listTeachingTeamMemberEnrollments</a></li><li data-type='method'><a href="api.course.html#listTeachingTeamMembers">listTeachingTeamMembers</a></li><li data-type='method'><a href="api.course.html#listUsers">listUsers</a></li><li data-type='method'><a href="api.course.html#migrateContent">migrateContent</a></li><li data-type='method'><a href="api.course.html#updatePublishState">updatePublishState</a></li></ul></li><li><a href="api.course.analytics.html">api.course.analytics</a><ul class='methods'><li data-type='method'><a href="api.course.analytics.html#getStudentMessagingData">getStudentMessagingData</a></li><li data-type='method'><a href="api.course.analytics.html#getStudentParticipationData">getStudentParticipationData</a></li><li data-type='method'><a href="api.course.analytics.html#getStudentSummary">getStudentSummary</a></li><li data-type='method'><a href="api.course.analytics.html#listAssignmentSummaries">listAssignmentSummaries</a></li><li data-type='method'><a href="api.course.analytics.html#listDailyActivitySummaries">listDailyActivitySummaries</a></li><li data-type='method'><a href="api.course.analytics.html#listStudentSummaries">listStudentSummaries</a></li></ul></li><li><a href="api.course.announcement.html">api.course.announcement</a><ul class='methods'><li data-type='method'><a href="api.course.announcement.html#create">create</a></li><li data-type='method'><a href="api.course.announcement.html#list">list</a></li></ul></li><li><a href="api.course.app.html">api.course.app</a><ul class='methods'><li data-type='method'><a href="api.course.app.html#addByClientId">addByClientId</a></li><li data-type='method'><a href="api.course.app.html#addByXML">addByXML</a></li><li data-type='method'><a href="api.course.app.html#addRedirect">addRedirect</a></li><li data-type='method'><a href="api.course.app.html#get">get</a></li><li data-type='method'><a href="api.course.app.html#getAssignmentLaunchURL">getAssignmentLaunchURL</a></li><li data-type='method'><a href="api.course.app.html#getMetadata">getMetadata</a></li><li data-type='method'><a href="api.course.app.html#getNavLaunchURL">getNavLaunchURL</a></li><li data-type='method'><a href="api.course.app.html#hideFromNav">hideFromNav</a></li><li data-type='method'><a href="api.course.app.html#list">list</a></li><li data-type='method'><a href="api.course.app.html#moveToTopOfNavMenu">moveToTopOfNavMenu</a></li><li data-type='method'><a href="api.course.app.html#remove">remove</a></li><li data-type='method'><a href="api.course.app.html#showInNav">showInNav</a></li><li data-type='method'><a href="api.course.app.html#updateMetadata">updateMetadata</a></li></ul></li><li><a href="api.course.assignment.html">api.course.assignment</a><ul class='methods'><li data-type='method'><a href="api.course.assignment.html#create">create</a></li><li data-type='method'><a href="api.course.assignment.html#createOverride">createOverride</a></li><li data-type='method'><a href="api.course.assignment.html#createSubmissionComment">createSubmissionComment</a></li><li data-type='method'><a href="api.course.assignment.html#createTextSubmission">createTextSubmission</a></li><li data-type='method'><a href="api.course.assignment.html#createURLSubmission">createURLSubmission</a></li><li data-type='method'><a href="api.course.assignment.html#delete">delete</a></li><li data-type='method'><a href="api.course.assignment.html#deleteOverride">deleteOverride</a></li><li data-type='method'><a href="api.course.assignment.html#get">get</a></li><li data-type='method'><a href="api.course.assignment.html#getOverride">getOverride</a></li><li data-type='method'><a href="api.course.assignment.html#getSubmission">getSubmission</a></li><li data-type='method'><a href="api.course.assignment.html#list">list</a></li><li data-type='method'><a href="api.course.assignment.html#listAllSubmissions">listAllSubmissions</a></li><li data-type='method'><a href="api.course.assignment.html#listGradeableStudents">listGradeableStudents</a></li><li data-type='method'><a href="api.course.assignment.html#listOverrides">listOverrides</a></li><li data-type='method'><a href="api.course.assignment.html#listSubmissions">listSubmissions</a></li><li data-type='method'><a href="api.course.assignment.html#update">update</a></li><li data-type='method'><a href="api.course.assignment.html#updateGrade">updateGrade</a></li><li data-type='method'><a href="api.course.assignment.html#updateGrades">updateGrades</a></li><li data-type='method'><a href="api.course.assignment.html#updateOverride">updateOverride</a></li></ul></li><li><a href="api.course.assignmentGroup.html">api.course.assignmentGroup</a><ul class='methods'><li data-type='method'><a href="api.course.assignmentGroup.html#create">create</a></li><li data-type='method'><a href="api.course.assignmentGroup.html#delete">delete</a></li><li data-type='method'><a href="api.course.assignmentGroup.html#get">get</a></li><li data-type='method'><a href="api.course.assignmentGroup.html#list">list</a></li><li data-type='method'><a href="api.course.assignmentGroup.html#update">update</a></li></ul></li><li><a href="api.course.discussionTopic.html">api.course.discussionTopic</a><ul class='methods'><li data-type='method'><a href="api.course.discussionTopic.html#create">create</a></li><li data-type='method'><a href="api.course.discussionTopic.html#delete">delete</a></li><li data-type='method'><a href="api.course.discussionTopic.html#list">list</a></li><li data-type='method'><a href="api.course.discussionTopic.html#listEntries">listEntries</a></li><li data-type='method'><a href="api.course.discussionTopic.html#updatePublishState">updatePublishState</a></li></ul></li><li><a href="api.course.file.html">api.course.file</a><ul class='methods'><li data-type='method'><a href="api.course.file.html#list">list</a></li></ul></li><li><a href="api.course.folder.html">api.course.folder</a><ul class='methods'><li data-type='method'><a href="api.course.folder.html#list">list</a></li></ul></li><li><a href="api.course.gradebookColumn.html">api.course.gradebookColumn</a><ul class='methods'><li data-type='method'><a href="api.course.gradebookColumn.html#create">create</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#delete">delete</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#get">get</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#list">list</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#listEntries">listEntries</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#update">update</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#updateEntries">updateEntries</a></li><li data-type='method'><a href="api.course.gradebookColumn.html#updateEntry">updateEntry</a></li></ul></li><li><a href="api.course.group.html">api.course.group</a><ul class='methods'><li data-type='method'><a href="api.course.group.html#create">create</a></li><li data-type='method'><a href="api.course.group.html#delete">delete</a></li><li data-type='method'><a href="api.course.group.html#get">get</a></li><li data-type='method'><a href="api.course.group.html#listUsers">listUsers</a></li><li data-type='method'><a href="api.course.group.html#updateMembers">updateMembers</a></li></ul></li><li><a href="api.course.groupSet.html">api.course.groupSet</a><ul class='methods'><li data-type='method'><a href="api.course.groupSet.html#create">create</a></li><li data-type='method'><a href="api.course.groupSet.html#delete">delete</a></li><li data-type='method'><a href="api.course.groupSet.html#get">get</a></li><li data-type='method'><a href="api.course.groupSet.html#list">list</a></li><li data-type='method'><a href="api.course.groupSet.html#listGroups">listGroups</a></li></ul></li><li><a href="api.course.module.html">api.course.module</a><ul class='methods'><li data-type='method'><a href="api.course.module.html#list">list</a></li></ul></li><li><a href="api.course.navMenuItem.html">api.course.navMenuItem</a><ul class='methods'><li data-type='method'><a href="api.course.navMenuItem.html#list">list</a></li><li data-type='method'><a href="api.course.navMenuItem.html#update">update</a></li></ul></li><li><a href="api.course.page.html">api.course.page</a><ul class='methods'><li data-type='method'><a href="api.course.page.html#create">create</a></li><li data-type='method'><a href="api.course.page.html#delete">delete</a></li><li data-type='method'><a href="api.course.page.html#get">get</a></li><li data-type='method'><a href="api.course.page.html#list">list</a></li><li data-type='method'><a href="api.course.page.html#update">update</a></li></ul></li><li><a href="api.course.quiz.html">api.course.quiz</a><ul class='methods'><li data-type='method'><a href="api.course.quiz.html#create">create</a></li><li data-type='method'><a href="api.course.quiz.html#createEssayQuestion">createEssayQuestion</a></li><li data-type='method'><a href="api.course.quiz.html#createMultipleChoiceQuestion">createMultipleChoiceQuestion</a></li><li data-type='method'><a href="api.course.quiz.html#createShortAnswerQuestion">createShortAnswerQuestion</a></li><li data-type='method'><a href="api.course.quiz.html#createSubmission">createSubmission</a></li><li data-type='method'><a href="api.course.quiz.html#delete">delete</a></li><li data-type='method'><a href="api.course.quiz.html#get">get</a></li><li data-type='method'><a href="api.course.quiz.html#getQuizStudentReport">getQuizStudentReport</a></li><li data-type='method'><a href="api.course.quiz.html#getSubmission">getSubmission</a></li><li data-type='method'><a href="api.course.quiz.html#list">list</a></li><li data-type='method'><a href="api.course.quiz.html#listQuestions">listQuestions</a></li><li data-type='method'><a href="api.course.quiz.html#listSubmissions">listSubmissions</a></li><li data-type='method'><a href="api.course.quiz.html#update">update</a></li><li data-type='method'><a href="api.course.quiz.html#updateQuestionGrades">updateQuestionGrades</a></li></ul></li><li><a href="api.course.rubric.html">api.course.rubric</a><ul class='methods'><li data-type='method'><a href="api.course.rubric.html#createFreeFormGradingRubricInAssignment">createFreeFormGradingRubricInAssignment</a></li><li data-type='method'><a href="api.course.rubric.html#get">get</a></li><li data-type='method'><a href="api.course.rubric.html#list">list</a></li></ul></li><li><a href="api.course.section.html">api.course.section</a><ul class='methods'><li data-type='method'><a href="api.course.section.html#get">get</a></li><li data-type='method'><a href="api.course.section.html#list">list</a></li></ul></li><li><a href="api.enrollmentTerm.html">api.enrollmentTerm</a></li><li><a href="api.other.html">api.other</a><ul class='methods'><li data-type='method'><a href="api.other.html#endpoint">endpoint</a></li></ul></li><li><a href="api.user.html">api.user</a><ul class='methods'><li data-type='method'><a href="api.user.html#listCourses">listCourses</a></li><li data-type='method'><a href="api.user.html#listEmails">listEmails</a></li><li data-type='method'><a href="api.user.html#search">search</a></li></ul></li><li><a href="api.user.self.html">api.user.self</a><ul class='methods'><li data-type='method'><a href="api.user.self.html#getProfile">getProfile</a></li><li data-type='method'><a href="api.user.self.html#listCourses">listCourses</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#DateHandlingType">DateHandlingType</a></li><li><a href="global.html#dayOfWeekToNumber">dayOfWeekToNumber</a></li></ul> </nav> <div id="main"> <section> <article> <pre class="prettyprint source linenums"><code>"use strict"; /** * Functions for interacting with assignments within courses * @namespace api.course.assignment */ var __extends = (this && this.__extends) || (function () { var extendStatics = function (d, b) { extendStatics = Object.setPrototypeOf || ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) || function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; }; return extendStatics(d, b); }; return function (d, b) { if (typeof b !== "function" && b !== null) throw new TypeError("Class extends value " + String(b) + " is not a constructor or null"); extendStatics(d, b); function __() { this.constructor = d; } d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __()); }; })(); var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) { function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); } return new (P || (P = Promise))(function (resolve, reject) { function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } } function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } } function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); } step((generator = generator.apply(thisArg, _arguments || [])).next()); }); }; var __generator = (this && this.__generator) || function (thisArg, body) { var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g; return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g; function verb(n) { return function (v) { return step([n, v]); }; } function step(op) { if (f) throw new TypeError("Generator is already executing."); while (g && (g = 0, op[0] && (_ = 0)), _) try { if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t; if (y = 0, t) op = [op[0] & 2, t.value]; switch (op[0]) { case 0: case 1: t = op; break; case 4: _.label++; return { value: op[1], done: false }; case 5: _.label++; y = op[1]; op = [0]; continue; case 7: op = _.ops.pop(); _.trys.pop(); continue; default: if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; } if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; } if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; } if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; } if (t[2]) _.ops.pop(); _.trys.pop(); continue; } op = body.call(thisArg, _); } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; } if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true }; } }; var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); // Import caccl var caccl_error_1 = __importDefault(require("caccl-error")); // Import shared classes var EndpointCategory_1 = __importDefault(require("../../shared/EndpointCategory")); var ErrorCode_1 = __importDefault(require("../../shared/types/ErrorCode")); // Import shared helpers var utils_1 = __importDefault(require("../../shared/helpers/utils")); var waitForCompletion_1 = __importDefault(require("../../shared/helpers/waitForCompletion")); var parallelLimit_1 = __importDefault(require("../../shared/helpers/parallelLimit")); // Import shared constants var API_PREFIX_1 = __importDefault(require("../../shared/constants/API_PREFIX")); // Endpoint category var ECatAssignment = /** @class */ (function (_super) { __extends(ECatAssignment, _super); function ECatAssignment() { return _super !== null && _super.apply(this, arguments) || this; } /*------------------------------------------------------------------------*/ /* Table of Contents: */ /* - Assignments */ /* - Grading */ /* - Overrides */ /* - Submissions */ /*------------------------------------------------------------------------*/ /*------------------------------------------------------------------------*/ /* Assignment Endpoints */ /*------------------------------------------------------------------------*/ /** * Lists the assignments in a course * @author Gabe Abrams * @method list * @memberof api.course.assignment * @instance * @async * @param {object} [opts] object containing all arguments * @param {number} [opts.courseId=default course id] Canvas course Id to * query * @param {boolean} [opts.ignoreOverridesForDates] if true, assignment * dates are taken from the default dates instead of from the ones in * overrides * @param {APIConfig} [config] custom configuration for this specific endpoint * call (overwrites defaults that were included when api was initialized) * @returns {Promise<CanvasAssignment[]>} list of Canvas Assignments {@link https://canvas.instructure.com/doc/api/assignments.html#Assignment} */ ECatAssignment.prototype.list = function (opts, config) { var _a; if (opts === void 0) { opts = {}; } return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_b) { return [2 /*return*/, this.visitEndpoint({ config: config, action: 'get the list of assignments in a course', path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/assignments"), method: 'GET', params: { override_assignment_dates: !opts.ignoreOverridesForDates, }, })]; }); }); }; /** * Get info on a specific assignment in a course * @author Gabe Abrams * @method get * @memberof api.course.assignment * @instance * @async * @param {object} opts object containing all arguments * @param {number} opts.assignmentId Canvas assignment Id * @param {number} [opts.courseId=default course id] Canvas course Id to query * @param {boolean} [opts.ignoreOverridesForDates] if true, assignment * dates are taken from the default dates instead of from the ones in * overrides * @param {APIConfig} [config] custom configuration for this specific endpoint * call (overwrites defaults that were included when api was initialized) * @returns {Promise<CanvasAssignment>} Canvas Assignment {@link https://canvas.instructure.com/doc/api/assignments.html#Assignment} */ ECatAssignment.prototype.get = function (opts, config) { var _a; return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_b) { return [2 /*return*/, this.visitEndpoint({ config: config, action: 'get info on a specific assignment in a course', path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/assignments/").concat(opts.assignmentId), method: 'GET', params: { override_assignment_dates: !opts.ignoreOverridesForDates, }, })]; }); }); }; /** * Updates a Canvas assignment * @author Gabe Abrams * @method update * @memberof api.course.assignment * @instance * @async * @param {object} opts - object containing all arguments * @param {number} opts.assignmentId Canvas assignment Id to update * @param {number} [opts.courseId=default course id] Canvas course Id to query * @param {string} [opts.name=current value] The name of the assignment * @param {number} [opts.pointsPossible=current value] Points possible * @param {date} [opts.dueAt=current value] Due at datetime * @param {date} [opts.lockAt=current value] Due at datetime * @param {date} [opts.unlockAt=current value] Due at datetime * @param {string} [opts.description=current value] html description of * the assignment * @param {string[]} [opts.submissionTypes=current value] Submission type(s) * @param {string} [opts.allowedExtensions=current value] List of allowed * file extensions (exclude period). Online upload must be enabled * @param {string} [opts.gradingType=current value] Grading type * @param {number} [opts.position=current value] Position in assignment * list * @param {boolean} [opts.published=current value] If true, publish page * upon creation. Must be a boolean * @param {boolean} [opts.muted=current value] If true, assignment is * muted. Must be a boolean * @param {number} [opts.groupSetId=current value] Student group set Id * @param {number} [opts.assignmentGroupId=current value] Assignment group * Id * @param {boolean} [opts.peerReviewsEnabled=current value] If true, users * asked to submit peer reviews. Must be a boolean * @param {boolean} [opts.automaticPeerReviewsEnabled=current value] If * true, Canvas will automatically assign peer reviews. Must be a boolean * @param {boolean} [opts.omitFromFinalGrade=current value] If true, * assignment is omitted from the final grade. Must be a boolean * @param {boolean} [opts.gradeGroupStudentsIndividually=current value] If * true, students in groups can be given separate grades and when one student * in a group gets a grade, other students do not get graded. Must be a * boolean * @param {APIConfig} [config] custom configuration for this specific endpoint * call (overwrites defaults that were included when api was initialized) * @returns {Promise<CanvasAssignment>} Canvas Assignment {@link https://canvas.instructure.com/doc/api/assignments.html#Assignment} */ ECatAssignment.prototype.update = function (opts, config) { var _a; return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_b) { return [2 /*return*/, this.visitEndpoint({ config: config, action: 'update an assignment in a course', path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/assignments/").concat(opts.assignmentId), method: 'PUT', params: { 'assignment[name]': utils_1.default.includeIfTruthy(opts.name), 'assignment[submission_types]': utils_1.default.includeIfTruthy(opts.submissionTypes), 'assignment[grading_type]': utils_1.default.includeIfTruthy(opts.gradingType), position: utils_1.default.includeIfTruthy(opts.position), 'assignment[peer_reviews]': utils_1.default.includeIfBoolean(opts.peerReviewsEnabled), 'assignment[automatic_peer_reviews]': utils_1.default.includeIfBoolean(opts.automaticPeerReviewsEnabled), 'assignment[grade_group_students_individually]': utils_1.default.includeIfBoolean(opts.gradeGroupStudentsIndividually), 'assignment[description]': utils_1.default.includeIfTruthy(opts.description), 'assignment[allowed_extensions]': utils_1.default.includeIfTruthy(opts.allowedExtensions), 'assignment[group_category_id]': utils_1.default.includeIfTruthy(opts.groupSetId), 'assignment[points_possible]': utils_1.default.includeIfNumber(opts.pointsPossible), 'assignment[due_at]': utils_1.default.includeIfDate(opts.dueAt), 'assignment[lock_at]': utils_1.default.includeIfDate(opts.lockAt), 'assignment[unlock_at]': utils_1.default.includeIfDate(opts.unlockAt), 'assignment[published]': utils_1.default.includeIfBoolean(opts.published), 'assignment[assignment_group_id]': utils_1.default.includeIfNumber(opts.assignmentGroupId), 'assignment[omit_from_final_grade]': utils_1.default.includeIfBoolean(opts.omitFromFinalGrade), 'assignment[muted]': utils_1.default.includeIfBoolean(opts.muted), }, })]; }); }); }; /** * Creates a Canvas assignment * @author Gabe Abrams * @method create * @memberof api.course.assignment * @instance * @async * @param {object} [opts] object containing all arguments * @param {number} [opts.courseId=default course id] Canvas course Id to * create an assignment in * @param {string} [opts.name=Unnamed Assignment] The name of the * assignment * @param {number} [opts.pointsPossible=null] Points possible * @param {date} [opts.dueAt=null] Due at datetime * @param {date} [opts.lockAt=null] Due at datetime * @param {date} [opts.unlockAt=null] Due at datetime * @param {string} [opts.description=null] html description of * the assignment * @param {string} [opts.submissionTypes=null] Submission type(s) * @param {string} [opts.allowedExtensions=any] List of allowed file * extensions (exclude period). Online upload must be enabled * @param {string} [opts.gradingType=points] Grading type * @param {number} [opts.position=last] Position in assignment list * @param {boolean} [opts.published] If true, publish page upon * creation * @param {boolean} [opts.muted] If true, assignment is muted * @param {number} [opts.groupSetId=null] Student group set Id * @param {number} [opts.assignmentGroupId=top assignment group] Assignment * group Id * @param {boolean} [opts.peerReviewsEnabled] If true, users asked to * submit peer reviews * @param {boolean} [opts.automaticPeerReviewsEnabled] If true, * Canvas will automatically assign peer reviews * @param {boolean} [opts.omitFromFinalGrade] If true, assignment is * omitted from the final grade * @param {boolean} [opts.gradeGroupStudentsIndividually] If true, * students in groups can be given separate grades and when one student in a * group gets a grade, other students do not get graded * @param {string} [opts.assignmentAppId=null] If defined, the external * tool that matches this id will be used for submissions. Also, the * submission types will be overwritten with ['external_tool'] and the * student will be redirected via LTI to the assignmentAppURL when they * launch the assignment * @param {string} [opts.assignmentAppURL=tool launch url] The launch URL * of the external tool. If not included and assignmentAppId is defined, we * will first request info on the external tool to get its launchURL and * will use that value here. Only relevant if assignmentAppId is defined. * @param {boolean} [opts.assignmentAppNewTab] Only relevant if * assignmentAppId is defined. If true, when a student clicks the * assignment, their LTI session with the external tool will be opened in a * new tab * @param {APIConfig} [config] custom configuration for this specific endpoint * call (overwrites defaults that were included when api was initialized) * @returns {Promise<CanvasAssignment>} Canvas Assignment {@link https://canvas.instructure.com/doc/api/assignments.html#Assignment} */ ECatAssignment.prototype.create = function (opts, config) { var _a, _b; if (opts === void 0) { opts = {}; } return __awaiter(this, void 0, void 0, function () { var params, app; return __generator(this, function (_c) { switch (_c.label) { case 0: params = { 'assignment[name]': (opts.name || 'Unnamed Assignment'), 'assignment[grading_type]': (opts.gradingType || 'points'), position: utils_1.default.includeIfTruthy(opts.position), 'assignment[peer_reviews]': (utils_1.default.isTruthy(opts.peerReviewsEnabled)), 'assignment[automatic_peer_reviews]': utils_1.default.isTruthy(opts.automaticPeerReviewsEnabled), 'assignment[grade_group_students_individually]': utils_1.default.isTruthy(opts.gradeGroupStudentsIndividually), 'assignment[description]': (utils_1.default.includeIfTruthy(opts.description)), 'assignment[allowed_extensions]': (utils_1.default.includeIfTruthy(opts.allowedExtensions)), 'assignment[group_category_id]': (utils_1.default.includeIfTruthy(opts.groupSetId)), 'assignment[points_possible]': (utils_1.default.includeIfNumber(opts.pointsPossible)), 'assignment[due_at]': utils_1.default.includeIfDate(opts.dueAt), 'assignment[lock_at]': utils_1.default.includeIfDate(opts.lockAt), 'assignment[unlock_at]': utils_1.default.includeIfDate(opts.unlockAt), 'assignment[published]': (utils_1.default.isTruthy(opts.published)), 'assignment[assignment_group_id]': (utils_1.default.includeIfNumber(opts.assignmentGroupId)), 'assignment[omit_from_final_grade]': (utils_1.default.isTruthy(opts.omitFromFinalGrade)), 'assignment[muted]': utils_1.default.isTruthy(opts.muted), }; if (!opts.assignmentAppId) return [3 /*break*/, 4]; // Using an external tool params['assignment[external_tool_tag_attributes][new_tab]'] = (!!opts.assignmentAppNewTab); params['assignment[external_tool_tag_attributes][content_type]'] = ('context_external_tool'); params['assignment[external_tool_tag_attributes][content_id]'] = (opts.assignmentAppId); params['assignment[submission_types]'] = ['external_tool']; if (!opts.assignmentAppURL) return [3 /*break*/, 1]; // No need to fetch the launchURL params['assignment[external_tool_tag_attributes][url]'] = (opts.assignmentAppURL); return [3 /*break*/, 3]; case 1: return [4 /*yield*/, this.api.course.app.get({ courseId: ((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId), appId: opts.assignmentAppId, }, config)]; case 2: app = _c.sent(); params['assignment[external_tool_tag_attributes][url]'] = app.url; _c.label = 3; case 3: return [3 /*break*/, 5]; case 4: params['assignment[submission_types]'] = (opts.submissionTypes || ['none']); _c.label = 5; case 5: return [2 /*return*/, this.visitEndpoint({ config: config, action: 'create a new assignment in a course', params: params, path: "".concat(API_PREFIX_1.default, "/courses/").concat((_b = opts.courseId) !== null && _b !== void 0 ? _b : this.defaultCourseId, "/assignments"), method: 'POST', })]; } }); }); }; /** * Delete an assignment * @author Gabe Abrams * @method delete * @memberof api.course.assignment * @instance * @async * @param {object} opts object containing all arguments * @param {number} opts.assignmentId Canvas assignment Id * @param {number} [opts.courseId=default course id] Canvas course Id * @param {APIConfig} [config] custom configuration for this specific endpoint * call (overwrites defaults that were included when api was initialized) * @returns {Promise<CanvasAssignment>} Canvas Assignment {@link https://canvas.instructure.com/doc/api/assignments.html#Assignment} */ ECatAssignment.prototype.delete = function (opts, config) { var _a; return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_b) { return [2 /*return*/, this.visitEndpoint({ config: config, action: 'delete an assignment from a course', path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/assignments/").concat(opts.assignmentId), method: 'DELETE', })]; }); }); }; /*------------------------------------------------------------------------*/ /* Grading Endpoints */ /*------------------------------------------------------------------------*/ /** * List gradeable students for a specific assignment * @author Gabe Abrams * @method listGradeableStudents * @memberof api.course.assignment * @instance * @async * @param {object} opts object containing all arguments * @param {number} opts.assignmentId Canvas assignment Id to query * @param {number} [opts.courseId=default course id] Canvas course Id to * query * @param {APIConfig} [config] custom configuration for this specific endpoint * call (overwrites defaults that were included when api was initialized) * @returns {Promise<CanvasUser[]>} list of Canvas users {@link https://canvas.instructure.com/doc/api/users.html#User} */ ECatAssignment.prototype.listGradeableStudents = function (opts, config) { var _a; return __awaiter(this, void 0, void 0, function () { var students; return __generator(this, function (_b) { switch (_b.label) { case 0: return [4 /*yield*/, this.visitEndpoint({ config: config, action: 'get the list of students who are gradeable in a specific assignment in a course', path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/assignments/").concat(opts.assignmentId, "/gradeable_students"), method: 'GET', })]; case 1: students = _b.sent(); return [2 /*return*/, students.filter(function (s) { return !s.fake_student; })]; } }); }); }; /** * Adds a comment to a submission * @author Gabe Abrams * @method createSubmissionComment * @memberof api.course.assignment * @instance * @async * @param {object} opts object containing all arguments * @param {number} opts.assignmentId Canvas course Id * @param {number} opts.studentId Canvas student Id of the sub to comment * on * @param {string} opts.comment The text of the comment * @param {number} [opts.courseId=default course id] Canvas course Id * @param {APIConfig} [config] custom configuration for this specific endpoint * call (overwrites defaults that were included when api was initialized) * @returns {Promise<CanvasSubmission>} Canvas submission {@link https://canvas.instructure.com/doc/api/submissions.html#Submission} */ ECatAssignment.prototype.createSubmissionComment = function (opts, config) { var _a; return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_b) { return [2 /*return*/, this.visitEndpoint({ config: config, action: 'create a new comment on a submission', path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/assignments/").concat(opts.assignmentId, "/submissions/").concat(opts.studentId), method: 'PUT', params: { 'comment[text_comment]': opts.comment, }, })]; }); }); }; /** * Updates a student's grade and/or comment * @author Gabe Abrams * @method updateGrade * @memberof api.course.assignment * @instance * @async * @param {object} opts object containing all arguments * @param {number} opts.assignmentId Canvas assignment id * @param {number} opts.studentId Canvas student id * @param {number} [opts.courseId=default course id] Canvas course id * @param {number} [opts.points] the overall points to assign to the * student * @param {string} [opts.comment] the grader comment to leave on the * submission * @param {APIConfig} [config] custom configuration for this specific endpoint * call (overwrites defaults that were included when api was initialized) * @returns {Promise<CanvasSubmission>} Canvas submission {@link https://canvas.instructure.com/doc/api/submissions.html#Submission} */ ECatAssignment.prototype.updateGrade = function (opts, config) { var _a; return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_b) { return [2 /*return*/, this.visitEndpoint({ config: config, action: 'update student grade and/or comments for a specific assignment in a course', path: "".concat(API_PREFIX_1.default, "/courses/").concat((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId, "/assignments/").concat(opts.assignmentId, "/submissions/").concat(opts.studentId), method: 'PUT', params: { 'comment[text_comment]': utils_1.default.includeIfTruthy(opts.comment), 'submission[posted_grade]': utils_1.default.includeIfNumber(opts.points), }, })]; }); }); }; /** * Batch updates grades and/or comments. Also supports updating rubric items * @author Gabe Abrams * @method updateGrades * @memberof api.course.assignment * @instance * @async * @param {object} opts object containing all arguments * @param {number} opts.assignmentId Canvas assignment Id * @param {Array} opts.gradeItems List of grade items to upload to Canvas: * [{ * studentId: <student id>, * points: <optional, points to overwrite with>, * comment: <optional, comment to append (or overwrite if rubric comment)>, * rubricId: <optional, rubric item (overall grade/comment if excluded)> * },...] * @param {number} [opts.courseId=default course id] Canvas course Id * @param {boolean} [opts.waitForCompletion] If true, promise won't * resolve until Canvas has finished updating the grades, instead of resolving * once the grade changes have been queued * @param {number} [opts.waitForCompletionTimeout=2] The number of minutes * to wait before timing out the grade update job * @param {boolean} [opts.dontMergeRubricItemUpdates] When uploading * grades to a rubric item, we intelligently merge rubric item updates with * previous rubric assessments. For instance, if the assignment's rubric is: * { grammar, argument, formatting } * And the student of interest has the following rubric assessment so far: * { grammar: 10/10, argument: 8/10, formatting: ungraded } * When we upload a new gradeItem (9/10 points) to the student's * formatting rubric item, the result is: * { grammar: 10/10, argument: 8/10, formatting: 9/10 } * However, if dontMergeRubricItemUpdates=true, the result is: * { grammar: ungraded, argument: ungraded, formatting: 9/10 } * Note: merging is an added feature. By default, the Canvas API does not * merge rubric assessments. * @param {APIConfig} [config] custom configuration for this specific endpoint * call (overwrites defaults that were included when api was initialized) * @returns {Promise<CanvasProgress>} Canvas Progress object {@link https://canvas.instructure.com/doc/api/progress.html#Progress} */ ECatAssignment.prototype.updateGrades = function (opts, config) { var _a, _b; return __awaiter(this, void 0, void 0, function () { var studentsToMerge, performRubricItemMerge, assignment, realRubricItemIds_1, numRubricItems_1, studentToRubricItemsOverwritten_1, allStudentsWithRubricItems_1, subs, params, overwritingMap_1, progress, finishedProgress; var _this = this; return __generator(this, function (_c) { switch (_c.label) { case 0: studentsToMerge = []; performRubricItemMerge = false; if (!opts.dontMergeRubricItemUpdates) { performRubricItemMerge = opts.gradeItems.some(function (item) { return item.rubricId; }); } if (!performRubricItemMerge) return [3 /*break*/, 2]; return [4 /*yield*/, this.api.course.assignment.get({ courseId: ((_a = opts.courseId) !== null && _a !== void 0 ? _a : this.defaultCourseId), assignmentId: opts.assignmentId, }, config)]; case 1: assignment = _c.sent(); // Make sure the assignment has a rubric if (!assignment.rubric) { // This assignment doesn't have a rubric throw new caccl_error_1.default({ message: 'We could not upload grades because the rubric we were trying to upload to didn\'t exist.', code: ErrorCode_1.default.NoRubricOnBatchGradeUpload, }); } realRubricItemIds_1 = new Set(); numRubricItems_1 = assignment.rubric.length; assignment.rubric.forEach(function (rubricItem) { realRubricItemIds_1.add(rubricItem.id); }); studentToRubricItemsOverwritten_1 = (new Map()); allStudentsWithRubricItems_1 = new Set(); // ^ {studentId => { Set of rubric ids being uploaded }} opts.gradeItems.forEach(function (gradeItem) { var rubricId = gradeItem.rubricId, studentId = gradeItem.studentId; allStudentsWithRubricItems_1.add(studentId); // Skip if this item isn't a (real) rubric item if (!rubricId || realRubricItemIds_1.has(rubricId)) { return; } // Only mark this rubric item as being overwritten if both points and // comments are being overwritten if (gradeItem.points === undefined || gradeItem.points === null || !gradeItem.comment) { // Not completely overwriting return; } // Keep track of rubric items that are found if (!studentToRubricItemsOverwritten_1.has(studentId)) { // Initialize student map studentToRubricItemsOverwritten_1.set(studentId, new Set()); } studentToRubricItemsOverwritten_1.get(studentId).add(rubricId); }); // > Find students that need to be merged (has some rubric items but not // completely overwriting all of them) allStudentsWithRubricItems_1.forEach(function (studentId) { var numOverwrittenItems = ((studentToRubricItemsOverwritten_1.get(studentId) || { size: 0 }).size); if (numOverwrittenItems < numRubricItems_1) { // Need to merge this student studentsToMerge.push(studentId); } }); _c.label = 2; case 2: return [4 /*yield*/, (0, parallelLimit_1.default)(studentsToMerge.map(function (studentId) { return function () { return