canvas-client - npm Package Compare versions

Comparing version 1.3.5 to 1.3.6

lib-esm/canvas.d.ts

@@ -1,2 +0,2 @@
-import { CanvasAccount, CanvasCourse, CanvasSection, CanvasEnrollment, CanvasEnrollmentPayload, CanvasCoursePayload, CanvasSectionPayload, CanvasGradingStandard, CanvasID, SpecialUserID, SpecialSectionID, SISSectionID, SISUserID, SpecialCourseID, SISTermID, SpecialTermID, CanvasEnrollmentTerm, CanvasCourseParams, CanvasEnrollmentParams, CanvasCourseSettings, CanvasCourseSettingsUpdate, CanvasUserUpdatePayload, CanvasCourseListFilters, CanvasEnrollmentTermPayload, CanvasEnrollmentTermParams, CanvasCourseUsersParams, CanvasUser } from './interfaces';
+import { CanvasAccount, CanvasCourse, CanvasSection, CanvasEnrollment, CanvasEnrollmentPayload, CanvasCoursePayload, CanvasSectionPayload, CanvasGradingStandard, CanvasID, SpecialUserID, SpecialSectionID, SISSectionID, SISUserID, SpecialCourseID, SISTermID, SpecialTermID, CanvasEnrollmentTerm, CanvasCourseParams, CanvasEnrollmentParams, CanvasCourseSettings, CanvasCourseSettingsUpdate, CanvasUserUpdatePayload, CanvasCourseListFilters, CanvasEnrollmentTermPayload, CanvasEnrollmentTermParams, CanvasCourseUsersParams, CanvasUser, CanvasAssignment, CanvasAssignmentNew, CanvasAssignmentSubmission, CanvasAssignmentSubmissionNew, UserDisplay } from './interfaces';
 import { ExternalTool, ExternalToolPayload } from './interfaces/externaltool';
@@ -46,2 +46,9 @@ export declare class CanvasConnector {
     getCourseUsers(courseId: CanvasID, params?: CanvasCourseUsersParams): Promise<CanvasUser[]>;
+    createCourseAssignment(courseId: CanvasID, assignment: CanvasAssignmentNew): Promise<CanvasAssignment>;
+    getCourseAssignment(courseId: CanvasID, assignmentId: CanvasID): Promise<CanvasAssignment>;
+    getCourseAssignments(courseId: CanvasID): Promise<CanvasAssignment[]>;
+    deleteCourseAssignment(courseId: CanvasID, assignmentId: CanvasID): Promise<CanvasAssignment>;
+    getGradeableStudents(courseId: CanvasID, assignmentId: CanvasID): Promise<UserDisplay[]>;
+    getAssignmentSubmission(courseId: CanvasID, assignmentId: CanvasID, userId: CanvasID): Promise<CanvasAssignmentSubmission>;
+    updateAssignmentSubmission(submission: CanvasAssignmentSubmissionNew): Promise<CanvasAssignmentSubmission>;
     getGradingStandards(accountId?: CanvasID): Promise<CanvasGradingStandard[]>;
@@ -48,0 +55,0 @@ courseSections(courseId?: CanvasID): Promise<CanvasSection[]>;

lib-esm/canvas.js

@@ -182,2 +182,25 @@ import { HttpsAgent } from 'agentkeepalive';
     }
+    // ASSIGNMENTS
+    async createCourseAssignment(courseId, assignment) {
+        return await this.post(`/courses/${courseId}/assignments`, { assignment });
+    }
+    async getCourseAssignment(courseId, assignmentId) {
+        return await this.get(`/courses/${courseId}/assignments/${assignmentId}`);
+    }
+    async getCourseAssignments(courseId) {
+        return await this.getall(`/courses/${courseId}/assignments`);
+    }
+    async deleteCourseAssignment(courseId, assignmentId) {
+        return await this.delete(`/courses/${courseId}/assignments/${assignmentId}`);
+    }
+    async getGradeableStudents(courseId, assignmentId) {
+        return await this.getall(`/courses/${courseId}/assignments/${assignmentId}/gradeable_students`);
+    }
+    // ASSIGNMENT SUBMISSIONS (GRADES)
+    async getAssignmentSubmission(courseId, assignmentId, userId) {
+        return await this.get(`/courses/${courseId}/assignments/${assignmentId}/submissions/${userId}`);
+    }
+    async updateAssignmentSubmission(submission) {
+        return await this.put(`/courses/${submission.course_id}/assignments/${submission.assignment_id}/submissions/${submission.user_id}`, { submission });
+    }
     // GRADING STANDARDS
@@ -184,0 +207,0 @@ async getGradingStandards(accountId) {

lib-esm/interfaces/course.d.ts

@@ -39,3 +39,3 @@ import { CanvasEnrollmentShortType, SpecialTermID, CanvasID, SISCourseID, UserDisplay, CanvasEnrollmentDisplay } from '.';
 }
-export declare enum CanvasWorkflowState {
+export declare enum CanvasCourseWorkflowState {
     Available = "available",
@@ -53,3 +53,3 @@ Unpublished = "unpublished",
     sis_import_id: CanvasID | null;
-    workflow_state: CanvasWorkflowState;
+    workflow_state: CanvasCourseWorkflowState;
     term_id?: CanvasID;
@@ -56,0 +56,0 @@ enrollment_term_id: CanvasID;

lib-esm/interfaces/course.js

@@ -31,9 +31,9 @@ export class CanvasCourseNew {
 }
-export var CanvasWorkflowState;
-(function (CanvasWorkflowState) {
-    CanvasWorkflowState["Available"] = "available";
-    CanvasWorkflowState["Unpublished"] = "unpublished";
-    CanvasWorkflowState["Completed"] = "completed";
-    CanvasWorkflowState["Deleted"] = "deleted";
-})(CanvasWorkflowState || (CanvasWorkflowState = {}));
+export var CanvasCourseWorkflowState;
+(function (CanvasCourseWorkflowState) {
+    CanvasCourseWorkflowState["Available"] = "available";
+    CanvasCourseWorkflowState["Unpublished"] = "unpublished";
+    CanvasCourseWorkflowState["Completed"] = "completed";
+    CanvasCourseWorkflowState["Deleted"] = "deleted";
+})(CanvasCourseWorkflowState || (CanvasCourseWorkflowState = {}));
 export class CanvasCourse extends CanvasCourseNew {
@@ -64,3 +64,3 @@ constructor(apiresponse) {
     isPublished() {
-        return this.workflow_state === CanvasWorkflowState.Available;
+        return this.workflow_state === CanvasCourseWorkflowState.Available;
     }
@@ -67,0 +67,0 @@ }

lib-esm/interfaces/index.d.ts

 export * from './account';
+export * from './assignment';
 export * from './course';
@@ -9,2 +10,3 @@ export * from './enrollment';
 export * from './externaltool';
+export * from './progress';
 export declare type CanvasID = number;
@@ -11,0 +13,0 @@ export declare type SISUserID = string;

lib-esm/interfaces/index.js

 export * from './account';
+export * from './assignment';
 export * from './course';
@@ -9,1 +10,2 @@ export * from './enrollment';
 export * from './externaltool';
+export * from './progress';

lib/browser.js

@@ -10,8 +10,7 @@ "use strict";
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CanvasAPI = void 0;
 __exportStar(require("./interfaces"), exports);
 var canvas_1 = require("./canvas");
 Object.defineProperty(exports, "CanvasAPI", { enumerable: true, get: function () { return canvas_1.CanvasAPI; } });

lib/canvas.d.ts

@@ -1,2 +0,2 @@
-import { CanvasAccount, CanvasCourse, CanvasSection, CanvasEnrollment, CanvasEnrollmentPayload, CanvasCoursePayload, CanvasSectionPayload, CanvasGradingStandard, CanvasID, SpecialUserID, SpecialSectionID, SISSectionID, SISUserID, SpecialCourseID, SISTermID, SpecialTermID, CanvasEnrollmentTerm, CanvasCourseParams, CanvasEnrollmentParams, CanvasCourseSettings, CanvasCourseSettingsUpdate, CanvasUserUpdatePayload, CanvasCourseListFilters, CanvasEnrollmentTermPayload, CanvasEnrollmentTermParams, CanvasCourseUsersParams, CanvasUser } from './interfaces';
+import { CanvasAccount, CanvasCourse, CanvasSection, CanvasEnrollment, CanvasEnrollmentPayload, CanvasCoursePayload, CanvasSectionPayload, CanvasGradingStandard, CanvasID, SpecialUserID, SpecialSectionID, SISSectionID, SISUserID, SpecialCourseID, SISTermID, SpecialTermID, CanvasEnrollmentTerm, CanvasCourseParams, CanvasEnrollmentParams, CanvasCourseSettings, CanvasCourseSettingsUpdate, CanvasUserUpdatePayload, CanvasCourseListFilters, CanvasEnrollmentTermPayload, CanvasEnrollmentTermParams, CanvasCourseUsersParams, CanvasUser, CanvasAssignment, CanvasAssignmentNew, CanvasAssignmentSubmission, CanvasAssignmentSubmissionNew, UserDisplay } from './interfaces';
 import { ExternalTool, ExternalToolPayload } from './interfaces/externaltool';
@@ -46,2 +46,9 @@ export declare class CanvasConnector {
     getCourseUsers(courseId: CanvasID, params?: CanvasCourseUsersParams): Promise<CanvasUser[]>;
+    createCourseAssignment(courseId: CanvasID, assignment: CanvasAssignmentNew): Promise<CanvasAssignment>;
+    getCourseAssignment(courseId: CanvasID, assignmentId: CanvasID): Promise<CanvasAssignment>;
+    getCourseAssignments(courseId: CanvasID): Promise<CanvasAssignment[]>;
+    deleteCourseAssignment(courseId: CanvasID, assignmentId: CanvasID): Promise<CanvasAssignment>;
+    getGradeableStudents(courseId: CanvasID, assignmentId: CanvasID): Promise<UserDisplay[]>;
+    getAssignmentSubmission(courseId: CanvasID, assignmentId: CanvasID, userId: CanvasID): Promise<CanvasAssignmentSubmission>;
+    updateAssignmentSubmission(submission: CanvasAssignmentSubmissionNew): Promise<CanvasAssignmentSubmission>;
     getGradingStandards(accountId?: CanvasID): Promise<CanvasGradingStandard[]>;
@@ -48,0 +55,0 @@ courseSections(courseId?: CanvasID): Promise<CanvasSection[]>;

lib/canvas.js

@@ -189,2 +189,25 @@ "use strict";
     }
+    // ASSIGNMENTS
+    async createCourseAssignment(courseId, assignment) {
+        return await this.post(`/courses/${courseId}/assignments`, { assignment });
+    }
+    async getCourseAssignment(courseId, assignmentId) {
+        return await this.get(`/courses/${courseId}/assignments/${assignmentId}`);
+    }
+    async getCourseAssignments(courseId) {
+        return await this.getall(`/courses/${courseId}/assignments`);
+    }
+    async deleteCourseAssignment(courseId, assignmentId) {
+        return await this.delete(`/courses/${courseId}/assignments/${assignmentId}`);
+    }
+    async getGradeableStudents(courseId, assignmentId) {
+        return await this.getall(`/courses/${courseId}/assignments/${assignmentId}/gradeable_students`);
+    }
+    // ASSIGNMENT SUBMISSIONS (GRADES)
+    async getAssignmentSubmission(courseId, assignmentId, userId) {
+        return await this.get(`/courses/${courseId}/assignments/${assignmentId}/submissions/${userId}`);
+    }
+    async updateAssignmentSubmission(submission) {
+        return await this.put(`/courses/${submission.course_id}/assignments/${submission.assignment_id}/submissions/${submission.user_id}`, { submission });
+    }
     // GRADING STANDARDS
@@ -191,0 +214,0 @@ async getGradingStandards(accountId) {

lib/index.js

@@ -10,3 +10,3 @@ "use strict";
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
 };
@@ -13,0 +13,0 @@ var _a;

lib/interfaces/course.d.ts

@@ -39,3 +39,3 @@ import { CanvasEnrollmentShortType, SpecialTermID, CanvasID, SISCourseID, UserDisplay, CanvasEnrollmentDisplay } from '.';
 }
-export declare enum CanvasWorkflowState {
+export declare enum CanvasCourseWorkflowState {
     Available = "available",
@@ -53,3 +53,3 @@ Unpublished = "unpublished",
     sis_import_id: CanvasID | null;
-    workflow_state: CanvasWorkflowState;
+    workflow_state: CanvasCourseWorkflowState;
     term_id?: CanvasID;
@@ -56,0 +56,0 @@ enrollment_term_id: CanvasID;

lib/interfaces/course.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CanvasCourseSettings = exports.CanvasCourseState = exports.CanvasCourseIncludes = exports.CanvasCoursePayload = exports.CanvasCourse = exports.CanvasWorkflowState = exports.CanvasCourseNew = void 0;
+exports.CanvasCourseSettings = exports.CanvasCourseState = exports.CanvasCourseIncludes = exports.CanvasCoursePayload = exports.CanvasCourse = exports.CanvasCourseWorkflowState = exports.CanvasCourseNew = void 0;
 class CanvasCourseNew {
@@ -35,9 +35,9 @@ constructor(course) {
 exports.CanvasCourseNew = CanvasCourseNew;
-var CanvasWorkflowState;
-(function (CanvasWorkflowState) {
-    CanvasWorkflowState["Available"] = "available";
-    CanvasWorkflowState["Unpublished"] = "unpublished";
-    CanvasWorkflowState["Completed"] = "completed";
-    CanvasWorkflowState["Deleted"] = "deleted";
-})(CanvasWorkflowState = exports.CanvasWorkflowState || (exports.CanvasWorkflowState = {}));
+var CanvasCourseWorkflowState;
+(function (CanvasCourseWorkflowState) {
+    CanvasCourseWorkflowState["Available"] = "available";
+    CanvasCourseWorkflowState["Unpublished"] = "unpublished";
+    CanvasCourseWorkflowState["Completed"] = "completed";
+    CanvasCourseWorkflowState["Deleted"] = "deleted";
+})(CanvasCourseWorkflowState = exports.CanvasCourseWorkflowState || (exports.CanvasCourseWorkflowState = {}));
 class CanvasCourse extends CanvasCourseNew {
@@ -68,3 +68,3 @@ constructor(apiresponse) {
     isPublished() {
-        return this.workflow_state === CanvasWorkflowState.Available;
+        return this.workflow_state === CanvasCourseWorkflowState.Available;
     }
@@ -71,0 +71,0 @@ }

lib/interfaces/index.d.ts

 export * from './account';
+export * from './assignment';
 export * from './course';
@@ -9,2 +10,3 @@ export * from './enrollment';
 export * from './externaltool';
+export * from './progress';
 export declare type CanvasID = number;
@@ -11,0 +13,0 @@ export declare type SISUserID = string;

lib/interfaces/index.js

@@ -10,6 +10,7 @@ "use strict";
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./account"), exports);
+__exportStar(require("./assignment"), exports);
 __exportStar(require("./course"), exports);
@@ -22,1 +23,2 @@ __exportStar(require("./enrollment"), exports);
 __exportStar(require("./externaltool"), exports);
+__exportStar(require("./progress"), exports);

package.json

 {
   "name": "canvas-client",
-  "version": "1.3.5",
+  "version": "1.3.6",
   "description": "Typescript library to make accessing the Canvas API more convenient.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

No alert changes

Improved metrics

Total package byte prevSize

124553

increased by22.72%

Number of package files

71

increased by20.34%

Lines of code

2892

increased by24.92%

No dependency changes