@ueu/ueu-canvas 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Unity Environmental University
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/html-loader.js

@@ -0,0 +1,7 @@
+module.exports = {
+  process(src) {
+    return {
+      code: `module.exports = ${JSON.stringify(src)};`, // Returns the HTML as a string
+    };
+  },
+};

package/jest.config.js

@@ -0,0 +1,20 @@
+const path = require('path')
+const {pathsToModuleNameMapper} = require("ts-jest");
+const {compilerOptions} = require("./tsconfig.json");
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+    preset: 'ts-jest',
+    testEnvironment: 'jsdom',
+    "transformIgnorePatterns": [
+        "node_modules/(?!isomorphic-git)"
+    ],
+    transform: {
+        "^.+\\.html$": "<rootDir>/html-loader.js",
+    },
+    moduleNameMapper: {
+        ...pathsToModuleNameMapper(compilerOptions.paths, {prefix: '<rootDir>/src/'}),
+        // "^webextension-polyfill$":
+        //     path.join(process.cwd(), "src", "__mocks__", "runtime.ts"),
+        // '\\.(css|scss)$': 'identity-obj-proxy',
+    }
+}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@ueu/ueu-canvas",
+  "version": "0.0.2",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "scripts": {
+    "test": "ts-jest",
+    "build": "webpack && tsc --emitDeclarationOnly",
+    "build:webpack": "webpack",
+    "build:types": "tsc --emitDeclarationOnly"
+  },
+  "keywords": ["canvas", "lms", "course", "education"],
+  "author": "Unity Environmental University",
+  "license": "MIT",
+  "description": "Canvas LMS API client and utilities for course management at Unity Environmental University",
+  "devDependencies": {
+    "@testing-library/jest-dom": "^6.6.3",
+    "@types/aria-query": "^5.0.4",
+    "@types/assert": "^1.5.11",
+    "@types/jest": "^29.5.14",
+    "@types/webpack": "^5.28.5",
+    "copy-webpack-plugin": "^12.0.2",
+    "dotenv": "^16.4.7",
+    "html-webpack-plugin": "^5.6.3",
+    "jest": "^29.7.0",
+    "jest-dom": "^4.0.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "jest-fetch-mock": "^3.0.3",
+    "process": "^0.11.10",
+    "ts-jest": "^29.2.5",
+    "ts-loader": "^9.5.2",
+    "tsconfig-paths-webpack-plugin": "^4.2.0",
+    "typescript": "^5.7.3",
+    "webpack": "^5.97.1",
+    "webpack-cli": "^6.0.1"
+  },
+  "dependencies": {
+    "assert": "^2.1.0",
+    "redux-persist": "^6.0.0",
+    "temporal-polyfill": "^0.2.5"
+  }
+}

package/src/Account.ts

@@ -0,0 +1,69 @@
+import {BaseCanvasObject} from "./baseCanvasObject";
+import {CanvasData} from "./canvasDataDefs";
+import {ICanvasCallConfig} from "./canvasUtils";
+import {getPagedDataGenerator} from "./fetch/getPagedDataGenerator";
+import {fetchJson} from "./fetch/fetchJson";
+
+/**
+ *  A base class for objects that interact with the Canvas API
+ */
+export class Account extends BaseCanvasObject<CanvasData> {
+    static nameProperty = 'name'; // The field name of the primary name of the canvas object type
+    static contentUrlTemplate = '/api/v1/accounts/{content_id}'; // A templated url to get a single item
+    static allContentUrlTemplate = '/api/v1/accounts'; // A templated url to get all items
+    private static account: Account;
+
+    static async getFromUrl(url: string | null = null) {
+        if (url === null) {
+            url = document.documentURI
+        }
+        const match = /accounts\/(\d+)/.exec(url);
+        if (match) {
+            console.log(match);
+            return await this.getAccountById(parseInt(match[1]));
+        }
+        return null;
+    }
+
+    static async getAccountById(accountId: number, config: ICanvasCallConfig | undefined = undefined): Promise<Account> {
+        const data = await fetchJson(`/api/v1/accounts/${accountId}`, config)
+        return new Account(data);
+    }
+
+
+    static async getRootAccount(resetCache = false) {
+        if (!resetCache && this.hasOwnProperty('account') && this.account) {
+            return this.account;
+        }
+        const accountGen = getPagedDataGenerator('/api/v1/accounts')
+        for await (const account of accountGen) {
+            if (account.root_account_id) continue; //if there is a root_account_id, this is not the root account
+            const root = new Account(account);
+            this.account = root;
+            return root;
+        }
+    }
+
+
+    get rootAccountId() {
+        return this.canvasData['root_account_id']
+    }
+
+}
+
+export class RootAccountNotFoundError extends Error {
+    name = 'RootAccountNotFoundError';
+}
+
+const getAccountIdFromUrl = (url: string | null = null) =>
+{
+    if (url === null) {
+        url = document.documentURI;
+    }
+    const match = /accounts\/(\d+)/.exec(url);
+    return match ? parseInt(match[1]) : null;
+}
+
+export {
+    getAccountIdFromUrl,
+}

package/src/NotImplementedException.ts

@@ -0,0 +1,3 @@
+export class NotImplementedException extends Error {
+    name = "NotImplementedException"
+}

package/src/__mocks__/Account.ts

@@ -0,0 +1,55 @@
+import { ICanvasCallConfig } from '@/canvasUtils';
+import { CanvasData } from '@/canvasDataDefs';
+import {BaseCanvasObject} from "@/baseCanvasObject";
+
+// Create a type alias for the original Account class
+export class MockAccount extends BaseCanvasObject<CanvasData> {
+    static override nameProperty = 'name';
+    static override contentUrlTemplate = '/api/v1/accounts/{content_id}';
+    static override allContentUrlTemplate = '/api/v1/accounts';
+    private static mockAccount: MockAccount;
+
+    static mockAccounts: MockAccount[] = [];
+    static mockDataById: Record<number, CanvasData> = {};
+
+    static resetMocks() {
+        this.mockAccounts = [];
+        this.mockDataById = {};
+        this.mockAccount = undefined as unknown as MockAccount;
+    }
+
+    static async getFromUrl(url: string | null = null) {
+        if (url === null) {
+            url = document.documentURI;
+        }
+        const match = /accounts\/(\d+)/.exec(url);
+        if (match) {
+            return await this.getAccountById(parseInt(match[1]));
+        }
+        return null;
+    }
+
+    static async getAccountById(accountId: number, _config: ICanvasCallConfig | undefined = undefined): Promise<MockAccount> {
+        const data = this.mockDataById[accountId];
+        if (!data) {
+            throw new Error(`No mock data found for account ID: ${accountId}`);
+        }
+        return new MockAccount(data);
+    }
+
+    static async getRootAccount(resetCache = false): Promise<MockAccount> {
+        if (!resetCache && this.mockAccount) {
+            return this.mockAccount;
+        }
+        const root = this.mockAccounts.find((a) => a.rootAccountId === null);
+        if (!root) {
+            throw new Error('No root account found in mock data');
+        }
+        this.mockAccount = root;
+        return root;
+    }
+
+    get rootAccountId() {
+        return this.canvasData['root_account_id'];
+    }
+}

package/src/__mocks__/index.ts

@@ -0,0 +1,8 @@
+export * from './Account'
+export * from './mockAccountData'
+export * from './mockEnrollment'
+export * from './mockRubricData'
+export * from './mockTabData'
+export * from './mockUserData'
+export * from './mockTermData'
+export * from './utils'

package/src/__mocks__/mockAccountData.ts

@@ -0,0 +1,43 @@
+import {IAccountData} from "../canvasDataDefs";
+
+/**
+ * From Canvas Api Docs - https://canvas.instructure.com/doc/api/accounts.html
+ */
+export const mockAccountData: IAccountData = {
+    // the ID of the Account object
+    "id": 2,
+    // The display name of the account
+    "name": "Canvas Account",
+    // The UUID of the account
+    "uuid": "WvAHhY5FINzq5IyRIJybGeiXyFkG3SqHUPb7jZY5",
+    // The account's parent ID, or null if this is the root account
+    "parent_account_id": 1,
+    // The ID of the root account, or null if this is the root account
+    "root_account_id": 1,
+    // The storage quota for the account in megabytes, if not otherwise specified
+    "default_storage_quota_mb": 500,
+    // The storage quota for a user in the account in megabytes, if not otherwise
+    // specified
+    "default_user_storage_quota_mb": 50,
+    // The storage quota for a group in the account in megabytes, if not otherwise
+    // specified
+    "default_group_storage_quota_mb": 50,
+    // The default time zone of the account. Allowed time zones are
+    // {http://www.iana.org/time-zones IANA time zones} or friendlier
+    // {http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html Ruby on Rails
+    // time zones}.
+    "default_time_zone": "America/Denver",
+    // The account's identifier in the Student Information System. Only included if
+    // the user has permission to view SIS information.
+    "sis_account_id": "123xyz",
+    // The account's identifier in the Student Information System. Only included if
+    // the user has permission to view SIS information.
+    "integration_id": "123xyz",
+    // The id of the SIS import if created through SIS. Only included if the user
+    // has permission to manage SIS information.
+    "sis_import_id": 12,
+    // The account's identifier that is sent as context_id in LTI launches.
+    "lti_guid": "123xyz",
+    // The state of the account. Can be 'active' or 'deleted'.
+    "workflow_state": "active"
+}

package/src/__mocks__/mockEnrollment.ts

@@ -0,0 +1,22 @@
+import {IUserData} from "@/canvasDataDefs";
+import {mockUserData} from "@/__mocks__/mockUserData";
+import {createEnrollmentRole, EnrollmentData} from "@/enrollments";
+
+export const mockEnrollment: EnrollmentData = {
+    created_at: "",
+    end_at: "",
+    html_url: "",
+    role: createEnrollmentRole(""),
+    role_id: 0,
+    root_account_id: 0,
+    start_at: "",
+    total_activity_time: 0,
+    unposted_current_points: 0,
+    updated_at: "",
+    id: 1,
+    user_id: 1,
+    type: 'StudentEnrollment',
+    enrollment_state: 'active',
+    course_id: 1,
+    user: {...mockUserData, id: 1, name: 'Student Name', sis_user_id: '12345'} as IUserData
+};

package/src/__mocks__/mockRubricData.ts

@@ -0,0 +1,71 @@
+import mock = jest.mock;
+
+
+import {IAssignmentData} from "@canvas/content/types";
+
+import {IRubricAssessmentData, IRubricAssociationData, RubricTypes} from "@canvas/rubricTypes";
+
+
+export const mockRubricAssociation:IRubricAssociationData = {
+  association_id: 0,
+  association_type: "Assignment",
+  hide_outcome_results: false,
+  hide_points: false,
+  hide_score_total: false,
+  id: 0,
+  purpose: 'grading',
+  rubric_id: 0,
+  use_for_grading: false
+}
+
+export const mockRubricAssessment: IRubricAssessmentData = {
+  artifact_attempt: 0,
+  artifact_id: 0,
+  artifact_type: "",
+  assessment_type: 'grading',
+  assessor_id: 0,
+  id: 0,
+  rubric_association_id: 0,
+  rubric_id: 0,
+  score: 0
+
+}
+
+export const mockRubric:RubricTypes = {
+  // the ID of the rubric
+  "id": 1,
+  // title of the rubric
+  "title": "some title",
+  // the context owning the rubric
+  "context_id": 1,
+  "context_type": "Course",
+  "points_possible": 10.0,
+  "reusable": false,
+  "read_only": true,
+  "free_form_criterion_comments": true,
+  "hide_score_total": true,
+  "data": null,
+  "assessments": [mockRubricAssessment],
+  "associations": [mockRubricAssociation]
+  }
+
+
+  export function mockRubricsForAssignments(
+      assignmentIds:number[],
+      rubricOverride?:Partial<RubricTypes>,
+      associationOverride?:Partial<IRubricAssociationData>
+  ) {
+
+    return assignmentIds.map((association_id, index) => {
+      const rubric_id = 1000 + index;
+      return {
+        ...mockRubric,
+        id: rubric_id,
+        associations: [{...mockRubricAssociation, rubric_id, association_id, ...associationOverride}],
+        ...rubricOverride
+      }
+    })
+  }
+
+
+  export default mockRubric;

package/src/__mocks__/mockTabData.ts

@@ -0,0 +1,13 @@
+import {ITabData} from "@/types";
+
+export const mockTabData:ITabData = {
+    full_url: "/api/v1/...",
+    html_url: "http://localhost",
+    id: "0",
+    label: "tab",
+    position: 0,
+    type: "",
+    visibility: ""
+}
+
+export default mockTabData;

package/src/__mocks__/mockTermData.ts

@@ -0,0 +1,7 @@
+import {ITermData} from "@/term/Term";
+
+export const mockTermData: ITermData = {
+    id: 1,
+    course_count: 0, end_at: "", name: "", start_at: "", workflow_state: "active"
+
+}

package/src/__mocks__/mockUserData.ts

@@ -0,0 +1,14 @@
+//Generated by ChatGPT-4o
+
+import {IUserData} from "../canvasDataDefs";
+
+export const mockUserData: IUserData = {
+    id: 1,
+    name: 'John Doe',
+    sortable_name: 'Doe, John',
+    last_name: 'Doe',
+    first_name: 'John',
+    short_name: 'J. Doe',
+    email: 'john.doe@example.com',
+    bio: 'This is a bio for John Doe.',
+};

package/src/__mocks__/utils.ts

@@ -0,0 +1,9 @@
+export function returnMockAsyncGen<T>(dataSet: T[]) {
+    return async function* () {
+        for (const value of dataSet) yield value;
+    }
+}
+
+export function mockAsyncGen<T>(dataSet: T[]) {
+    return returnMockAsyncGen<T>(dataSet)();
+}