Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

ueu-canvas

This is the source code for the @ueu/ueu-canvas npm package — a TypeScript library for interacting with the Canvas LMS API. It provides typed interfaces, data fetching utilities, and helpers for working with Canvas objects such as courses, enrollments, content items, terms, users, rubrics, and files.

The package is built with Webpack and TypeScript and publishes its compiled output from the dist/ directory.

What's in here

  • Courses — fetch course data, manage blueprint courses, modules, sections, and course start dates
  • Content — typed wrappers for Canvas content items: assignments, discussions, pages, and quizzes
  • Enrollments — enrollment generators and role helpers
  • Terms — term fetching and date parsing from term names
  • Users — user generators
  • Fetch — low-level utilities for paginated Canvas API requests (getPagedDataGenerator, fetchJson, typed GET/write configs)
  • Rubrics — rubric and rubric association types and helpers
  • Files — Canvas file types
  • Mocks — mock data for testing

Installation

npm install @ueu/ueu-canvas

Build

npm run build

Test

npx jest

Tag a release to get auto-publish to run

First merge a version bump of package.json to main. The publish workflow refuses a tag that does not equal v<package.json version> or that points at a commit not on main. The publish job runs in the npm-publish environment, so it waits for approval when that environment has required reviewers. Push one release tag at a time. A publish run that has started blocks later ones until it finishes, including while it waits for approval, so a tag pushed meanwhile queues as pending. GitHub keeps only one pending publish run, so a further tag pushed while one is pending cancels the pending run, and that version is not published.

git tag v1.1.1
git push origin v1.1.1

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages