@pipedream/canvas 0.6.0 → 0.8.0

package/actions/list-assignments/list-assignments.mjs

@@ -0,0 +1,52 @@
+import canvas from "../../canvas.app.mjs";
+
+export default {
+  key: "canvas-list-assignments",
+  name: "List Assignments",
+  description: "Retrieve a list of assignments for a course. [See the documentation](https://mitt.uib.no/doc/api/all_resources.html#method.assignments_api.user_index)",
+  version: "0.0.2",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    canvas,
+    accountId: {
+      propDefinition: [
+        canvas,
+        "accountId",
+      ],
+    },
+    userId: {
+      propDefinition: [
+        canvas,
+        "userId",
+        (c) => ({
+          accountId: c.accountId,
+        }),
+      ],
+    },
+    courseId: {
+      propDefinition: [
+        canvas,
+        "courseId",
+        (c) => ({
+          userId: c.userId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const assignments = await this.canvas.listAssignments({
+      $,
+      userId: this.userId,
+      courseId: this.courseId,
+    });
+    $.export("$summary", `${assignments.length} assignment${assignments.length > 1
+      ? "s"
+      : ""} were successfully retrieved.`);
+    return assignments;
+  },
+};

package/actions/list-courses/list-courses.mjs

@@ -0,0 +1,42 @@
+import canvas from "../../canvas.app.mjs";
+
+export default {
+  key: "canvas-list-courses",
+  name: "List Courses",
+  description: "List all the courses associated with a given user. [See the documentation](https://mitt.uib.no/doc/api/all_resources.html#method.courses.user_index)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    canvas,
+    accountId: {
+      propDefinition: [
+        canvas,
+        "accountId",
+      ],
+    },
+    userId: {
+      propDefinition: [
+        canvas,
+        "userId",
+        (c) => ({
+          accountId: c.accountId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const courses = await this.canvas.listCourses({
+      $,
+      userId: this.userId,
+    });
+    $.export("$summary", `${courses.length} course${courses.length > 1
+      ? "s"
+      : ""} were successfully retrieved.`);
+    return courses;
+  },
+};

package/actions/search-course-content/search-course-content.mjs

@@ -0,0 +1,59 @@
+import canvas from "../../canvas.app.mjs";
+
+export default {
+  key: "canvas-search-course-content",
+  name: "Search Course Content",
+  description: "Search for content in a course. [See the documentation](https://mitt.uib.no/doc/api/all_resources.html#method.smart_search.search)",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    canvas,
+    accountId: {
+      propDefinition: [
+        canvas,
+        "accountId",
+      ],
+    },
+    userId: {
+      propDefinition: [
+        canvas,
+        "userId",
+        (c) => ({
+          accountId: c.accountId,
+        }),
+      ],
+    },
+    courseId: {
+      propDefinition: [
+        canvas,
+        "courseId",
+        (c) => ({
+          userId: c.userId,
+        }),
+      ],
+    },
+    query: {
+      type: "string",
+      label: "Query",
+      description: "The query to search for",
+    },
+  },
+  async run({ $ }) {
+    const results = await this.canvas.searchCourseContent({
+      $,
+      courseId: this.courseId,
+      params: {
+        q: this.query,
+      },
+    });
+    $.export("$summary", `${results.length} result${results.length > 1
+      ? "s"
+      : ""} were found.`);
+    return results;
+  },
+};

package/actions/update-assignment/update-assignment.mjs

@@ -0,0 +1,149 @@
+import canvas from "../../canvas.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+import constants from "../../common/constants.mjs";
+
+export default {
+  key: "canvas-update-assignment",
+  name: "Update Assignment",
+  description: "Update an assignment. [See the documentation](https://mitt.uib.no/doc/api/all_resources.html#method.assignments_api.update)",
+  version: "0.0.2",
+  type: "action",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    canvas,
+    accountId: {
+      propDefinition: [
+        canvas,
+        "accountId",
+      ],
+    },
+    userId: {
+      propDefinition: [
+        canvas,
+        "userId",
+        (c) => ({
+          accountId: c.accountId,
+        }),
+      ],
+    },
+    courseId: {
+      propDefinition: [
+        canvas,
+        "courseId",
+        (c) => ({
+          userId: c.userId,
+        }),
+      ],
+    },
+    assignmentId: {
+      propDefinition: [
+        canvas,
+        "assignmentId",
+        (c) => ({
+          courseId: c.courseId,
+          userId: c.userId,
+        }),
+      ],
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The name of the assignment",
+      optional: true,
+    },
+    description: {
+      type: "string",
+      label: "Description",
+      description: "The description of the assignment, supports HTML",
+      optional: true,
+    },
+    submissionType: {
+      type: "string",
+      label: "Submission Type",
+      description: "The type of submission for the assignment",
+      options: constants.SUBMISSION_TYPES,
+      optional: true,
+    },
+    notifyOfUpdate: {
+      type: "boolean",
+      label: "Notify of Update",
+      description: "Whether to notify the students of the update",
+      optional: true,
+    },
+    pointsPossible: {
+      type: "integer",
+      label: "Points Possible",
+      description: "The maximum points possible on the assignment",
+      optional: true,
+    },
+    gradingType: {
+      type: "string",
+      label: "Grading Type",
+      description: "The strategy used for grading the assignment. The assignment defaults to “points” if this field is omitted.",
+      options: constants.GRADING_TYPES,
+      optional: true,
+    },
+    dueAt: {
+      type: "string",
+      label: "Due At",
+      description: "The day/time the assignment is due. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.",
+      optional: true,
+    },
+    omitFromFinalGrade: {
+      type: "boolean",
+      label: "Omit From Final Grade",
+      description: "Whether this assignment is counted towards a student's final grade.",
+      optional: true,
+    },
+    allowedAttempts: {
+      type: "integer",
+      label: "Allowed Attempts",
+      description: "The number of submission attempts allowed for this assignment. Set to -1 for unlimited attempts.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    if (
+      !this.name
+      && !this.description
+      && !this.submissionType
+      && !this.notifyOfUpdate
+      && !this.pointsPossible
+      && !this.gradingType
+      && !this.dueAt
+      && !this.omitFromFinalGrade
+      && !this.allowedAttempts
+    ) {
+      throw new ConfigurationError("At least one field must be provided to update the assignment");
+    }
+
+    const assignment = await this.canvas.updateAssignment({
+      $,
+      courseId: this.courseId,
+      assignmentId: this.assignmentId,
+      data: {
+        assignment: {
+          name: this.name,
+          description: this.description,
+          submission_types: this.submissionType
+            ? [
+              this.submissionType,
+            ]
+            : undefined,
+          notify_of_update: this.notifyOfUpdate,
+          points_possible: this.pointsPossible,
+          grading_type: this.gradingType,
+          due_at: this.dueAt,
+          omit_from_final_grade: this.omitFromFinalGrade,
+          allowed_attempts: this.allowedAttempts,
+        },
+      },
+    });
+    $.export("$summary", `Successfully updated assignment with ID: '${this.assignmentId}'`);
+    return assignment;
+  },
+};

package/canvas.app.mjs

@@ -1,11 +1,136 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "canvas",
-  propDefinitions: {},
+  propDefinitions: {
+    accountId: {
+      type: "string",
+      label: "Account ID",
+      description: "The ID of an account",
+      async options() {
+        const accounts = await this.listAccounts();
+        return accounts?.map(({
+          id: value, name: label,
+        }) => ({
+          value,
+          label,
+        })) ?? [];
+      },
+    },
+    userId: {
+      type: "string",
+      label: "User ID",
+      description: "The ID of a user",
+      async options({ accountId }) {
+        const users = await this.listUsers({
+          accountId,
+        });
+        return users?.map(({
+          id: value, name: label,
+        }) => ({
+          value,
+          label,
+        })) ?? [];
+      },
+    },
+    courseId: {
+      type: "string",
+      label: "Course ID",
+      description: "The ID of a course",
+      async options({ userId }) {
+        const courses = await this.listCourses({
+          userId,
+        });
+        return courses?.map(({
+          id: value, name: label,
+        }) => ({
+          value,
+          label,
+        })) ?? [];
+      },
+    },
+    assignmentId: {
+      type: "string",
+      label: "Assignment ID",
+      description: "The ID of an assignment",
+      async options({
+        userId, courseId,
+      }) {
+        const assignments = await this.listAssignments({
+          userId,
+          courseId,
+        });
+        return assignments?.map(({
+          id: value, name: label,
+        }) => ({
+          value,
+          label,
+        })) ?? [];
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return `https://${this.$auth.domain}/api/v1`;
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: {
+          Authorization: `Bearer ${this.$auth.oauth_access_token}`,
+        },
+        ...opts,
+      });
+    },
+    listAccounts(opts = {}) {
+      return this._makeRequest({
+        path: "/accounts",
+        ...opts,
+      });
+    },
+    listUsers({
+      accountId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/accounts/${accountId}/users`,
+        ...opts,
+      });
+    },
+    listCourses({
+      userId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/users/${userId}/courses`,
+        ...opts,
+      });
+    },
+    listAssignments({
+      userId, courseId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/users/${userId}/courses/${courseId}/assignments`,
+        ...opts,
+      });
+    },
+    updateAssignment({
+      courseId, assignmentId, ...opts
+    }) {
+      return this._makeRequest({
+        method: "PUT",
+        path: `/courses/${courseId}/assignments/${assignmentId}`,
+        ...opts,
+      });
+    },
+    searchCourseContent({
+      courseId, ...opts
+    }) {
+      return this._makeRequest({
+        path: `/courses/${courseId}/smartsearch`,
+        ...opts,
+      });
     },
   },
 };

package/common/constants.mjs

@@ -0,0 +1,26 @@
+const SUBMISSION_TYPES = [
+  "online_quiz",
+  "none",
+  "on_paper",
+  "discussion_topic",
+  "external_tool",
+  "online_upload",
+  "online_text_entry",
+  "online_url",
+  "media_recording",
+  "student_annotation",
+];
+
+const GRADING_TYPES = [
+  "pass_fail",
+  "percent",
+  "letter_grade",
+  "gpa_scale",
+  "points",
+  "not_graded",
+];
+
+export default {
+  SUBMISSION_TYPES,
+  GRADING_TYPES,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/canvas",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Pipedream canvas Components",
   "main": "canvas.app.mjs",
   "keywords": [
@@ -13,6 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^3.0.0"
+    "@pipedream/platform": "^3.1.1"
   }
 }