@ueu/ueu-canvas 0.0.2 → 0.0.3

package/src/profile.ts

@@ -1,253 +0,0 @@
-import assert from "assert";
-import {IUserData} from "./canvasDataDefs";
-import {parentElement} from "./canvasUtils";
-
-import {Course} from "./course/Course";
-import {Account} from "@/Account";
-import {getSingleCourse} from "@/course/toolbox";
-import {Page} from "@/content/pages/Page";
-
-import {IProfile, IProfileWithUser} from "@/types";
-
-
-let facultyCourseCached: Course;
-
-async function getFacultyCourse() {
-    const facultyCourse = facultyCourseCached ?? await getSingleCourse('Faculty Bios', (await Account.getAll()).map(a => a.id));
-    facultyCourseCached = facultyCourse;
-    assert(facultyCourse);
-    return facultyCourse;
-}
-
-export async function getFacultyPages(searchTerm: string) {
-    const facultyCourse = await getFacultyCourse();
-    return await facultyCourse.getPages({
-        queryParams: {
-            include: ['body'],
-            search_term: searchTerm
-        }
-    })
-}
-
-async function getPotentialFacultyProfiles(user:IUserData) {
-    let pages: Page[] = [];
-    const [lastName, firstName] = user.name.split(' ')
-    for(const query of [
-        user.name,
-        lastName,
-        firstName,
-    ]) {
-        console.log(query);
-        pages = await getFacultyPages(query);
-        if(pages.length > 0) break;
-    }
-
-    const profiles = pages.map((page) => getProfileFromPage(page, user), true)
-
-    if(profiles.length > 0) {
-        for(const profile of profiles) {
-            profile.displayName ??= user.name;
-        }
-    }
-    return profiles;
-}
-
-export function getProfileFromPage(page:Page, user:IUserData) {
-    const profile = getProfileFromPageHtml(page.body, user);
-    profile.sourcePage = page;
-    return profile;
-}
-
-function getProfileFromPageHtml(html:string, user: IUserData) {
-    const el = document.createElement('div')
-    el.innerHTML = html;
-
-    const displayName = getDisplayName(el);
-    const body = getProfileBody(el);
-    const image = getImageLink(el);
-
-    return {
-        user,
-        bio: body,
-        displayName,
-        image,
-        imageLink: image?.src,
-    } as IProfileWithUser
-}
-function getProfileBody(el:Element) {
-    const h4s = el.querySelectorAll('h4');
-    const instructorHeaders = Array.from(h4s).filter((el) => {
-        return el.innerHTML.search(/instructor/i)
-    })
-    let potentials:string[] = [];
-    for(const header of instructorHeaders) {
-        const potentialParent = header.parentElement;
-        if(potentialParent) {
-            header.remove();
-            potentials.push(potentialParent.innerHTML);
-        }
-    }
-
-    potentials = winnow(potentials, [
-        (potential) => potential.length > 0,
-    ]);
-
-    /* just guess if we can't find anything */
-    if (potentials.length > 0) {
-        return potentials[0];
-    }
-    return null;
-}
-
-function getDisplayName(el:Element) {
-    let titles = Array.from(el.querySelectorAll('strong em'));
-
-    if (titles.length === 0) {
-        const enclosedImages = Array.from(el.querySelectorAll('p img'));
-
-        titles = enclosedImages.map((el) => parentElement(el, 'p')?.nextElementSibling)
-            .filter((el) => el instanceof Element) as Element[];
-    }
-
-    if (titles.length === 0) {
-        const headings = Array.from(el.querySelectorAll('p strong'));
-        const instructorHeaders = headings.filter(el => el.innerHTML.search(/Instructor/));
-        titles = instructorHeaders.map((el) => el.previousElementSibling)
-            .filter((el) => el instanceof Element) as Element[]
-    }
-
-    titles = titles.filter((title) => title.textContent && title.textContent.length > 0)
-    if (titles.length > 0) return titles[0].textContent;
-    return null;
-}
-
-/**
- * Finds all the image links in the content and returns the biggest.
- * @param el
- */
-function getImageLink(el:Element) {
-    const imgs = el.querySelectorAll('img');
-    if(imgs.length === 0) return null;
-    return Array.from(imgs)[1];
-}
-
-type WinnowFunc<T> = ((value:T, number?: number, array?: T[])=>boolean);
-/**
- * Takes in a list of parameters and a set of filter functions. Runs filter functions until there are one or fewer elements,
- * or it runs out of filter functions. Returns post-filtered list.
- * @param originalList The list of items to run
- * @param winnowFuncs A list of filter functions, run in order
- * @param returnLastNonEmpty If true, will return the last non-empty array found if elements are winnowed to 0
- */
-function winnow<T=string>(originalList: T[], winnowFuncs: WinnowFunc<T>[], returnLastNonEmpty=false) {
-    let copyList = [...originalList];
-    if(copyList.length === 1) return copyList; //already at 1 element
-    let lastSet = [...copyList];
-    for(const winnowFunc of winnowFuncs) {
-        lastSet = [...copyList];
-        copyList = copyList.filter(winnowFunc);
-        if(copyList.length === 1) break;
-    }
-    if(copyList.length === 0 && returnLastNonEmpty) return lastSet;
-    return copyList;
-}
-
-function getCurioPageFrontPageProfile(html:string, user?: IUserData):IProfile {
-    const el = document.createElement('div');
-    el.innerHTML = html;
-    try {
-        const header = getCurioHeader(el);
-        const match = header.innerHTML.match(/Meet your instructor, ?(.*)!/i);
-        const displayName = match ? match[1] : null;
-        const bio = getCurioBio(el);
-        const image = getCurioProfileImage(el);
-        return {
-            user,
-            displayName,
-            image,
-            imageLink: image ? image.src : null,
-            bio: bio?.innerHTML
-       }
-    } catch(e) {
-        return {
-            user,
-            displayName: "CANNOT LOCATE PROFILE",
-            bio: (e as Error).toString(),
-        }
-    }
-}
-
-export function frontPageBio(profile:IProfile & {user:IUserData}) {
-    return profile.bio + `<p>${profile.displayName} should be contacted during the term using Canvas Inbox,
- but can be reached after and before the term via their email address: ${profile.user.email}</p>`
-    
-}
-
-export function renderProfileIntoCurioFrontPage(html: string, profile: IProfile & {user:IUserData}) {
-    const el = document.createElement('div');
-    el.innerHTML = html;
-    if(profile.displayName) {
-        const header = getCurioHeader(el);
-        header.innerHTML = `Meet your instructor, ${profile.displayName}!`
-    }
-
-    if(profile.bio) {
-        const bio = getCurioBio(el);
-        if(bio) {
-            const classes = bio.classList;
-            if(!classes.contains('cbt-instructor-bio')) classes.add('cbt-instructor-bio')
-            bio.innerHTML = frontPageBio(profile);
-        }
-    }
-
-    if(profile.image) {
-        const image = getCurioProfileImage(el);
-        if(image) {
-            image.src = profile.image.src;
-            image.alt = profile.image.alt;
-        }
-    } else if (profile.imageLink) {
-        const image = getCurioProfileImage(el);
-        if(image) {
-            image.src = profile.imageLink;
-        }
-    }
-    return el.innerHTML;
-}
-
-function getCurioHeader(el:Element) {
-    let h2s = Array.from(el.querySelectorAll('h2'));
-    h2s = h2s.filter((h2) => h2.innerHTML.match(/Meet your instructor/i));
-    if(h2s.length <= 0) throw new Error(`Can't find bio section of front page.\n${h2s.map(a => a.innerHTML)}\n${el.innerHTML}`);
-    return h2s[0];
-
-}
-function getCurioProfileDiv(el:Element) {
-    const header = getCurioHeader(el);
-    const sectionEl = header.nextElementSibling;
-    assert(sectionEl, "Body element of bio not found on page.")
-    return sectionEl;
-
-}
-
-function getCurioBio(el:Element) {
-    const profileDiv = getCurioProfileDiv(el);
-    const bio = profileDiv.querySelector('.cbt-instructor-bio');
-    if(bio && bio.innerHTML) return bio;
-    const div = getCurioProfileDiv(el);
-    const p = div.querySelector('p');
-    return p?.parentElement;
-
-
-}
-
-function getCurioProfileImage(el:Element) {
-    return getCurioProfileDiv(el).querySelector('img');
-
-}
-
-export {
-    getPotentialFacultyProfiles,
-    getCurioPageFrontPageProfile,
-    winnow
-}

package/src/rubricTypes.ts

@@ -1,82 +0,0 @@
-export interface IRubricCriterionData {
-    id: string,
-    description?: string | null,
-    long_description?: string | null,
-    points: number,
-    criterion_use_range?: boolean,
-    ratings: IRubricRatingData[]
-}
-
-export interface IRubricRatingData {
-    id: string,
-    description?: string | null,
-    long_description?: string | null,
-    points: number,
-}
-
-export interface IRubricAssessmentData {
-    id: number,
-    rubric_id: number,
-    rubric_association_id: number,
-    score: number,
-    artifact_type: string,
-    artifact_id: number,
-    artifact_attempt: number,
-    assessment_type: 'grading' | 'peer_review' | 'provisional_grade',
-    assessor_id: number,
-    data?: any,
-    comments?: string,
-}
-
-export type RubricAssessment = Record<string, {
-    points: number,
-    rating_id: string,
-    comments?: string,
-}>
-
-export interface IRubricAssociationData {
-    id: number,
-    rubric_id: number,
-    association_id: number,
-    association_type: "Assignment" | "Course" | "Account",
-    use_for_grading: boolean,
-    summary_data?: string,
-    purpose: 'grading' | 'bookmark',
-    hide_score_total: boolean,
-    hide_points: boolean,
-    hide_outcome_results: boolean,
-}
-
-export interface RubricTypes {
-    id: number,
-    title: string,
-    context_id: number,
-    context_type: string,
-    points_possible: number,
-    reusable: boolean,
-    read_only: boolean,
-    free_form_criterion_comments: boolean,
-    hide_score_total: boolean,
-    data: null,
-    assessments?: IRubricAssessmentData[],
-    associations?: IRubricAssociationData[],
-}
-
-type RubricCallIncludeTypes = 'assessments' | 'graded_assessments' | 'peer_assessments' |
-    'associations' | 'assignment_associations' | 'course_associations' | 'account_associations'
-export type GetRubricsForCourseOptions = {
-    include?: RubricCallIncludeTypes[]
-}
-export type RubricAssociationUpdateOptions = {
-    id: number,
-    rubric_association: Partial<Pick<IRubricAssociationData,
-        'rubric_id' |
-        'association_id' |
-        'association_type' |
-        'use_for_grading' |
-        'hide_score_total' |
-        'purpose'>> & {
-        title?: string
-        bookmarked?: boolean
-    }
-}

package/src/rubrics.ts

@@ -1,48 +0,0 @@
-import {deepObjectMerge, formDataify, ICanvasCallConfig} from "./canvasUtils";
-import {getPagedDataGenerator} from "@/fetch/getPagedDataGenerator";
-
-import {fetchJson} from "@/fetch/fetchJson";
-
-import {GetRubricsForCourseOptions, RubricTypes, RubricAssociationUpdateOptions} from "@canvas/rubricTypes";
-
-
-export function getRubricsFetchUrl(courseId:number) { return `/api/v1/courses/${courseId}/rubrics`}
-export function rubricApiUrl(courseId:number, rubricId:number) { return `/api/v1/courses/${courseId}/rubrics/${rubricId}` }
-
-export function rubricsForCourseGen(courseId: number, options?: GetRubricsForCourseOptions, config?: ICanvasCallConfig) {
-    const url = getRubricsFetchUrl(courseId);
-    const dataGenerator = getPagedDataGenerator<RubricTypes>(url, config);
-    if (options?.include) {
-        return async function* () {
-            for await(const rubric of dataGenerator) {
-
-                yield await getRubric(rubric.context_id, rubric.id, options, config)
-            }
-        }();
-    }
-    return dataGenerator;
-
-}
-
-export async function getRubric(courseId: number, rubricId: number, options?: GetRubricsForCourseOptions, config?: ICanvasCallConfig) {
-    const url = rubricApiUrl(courseId, rubricId);
-    if (options?.include) {
-        config ??= {};
-        config.queryParams = deepObjectMerge(config?.queryParams, {include: options.include})
-    }
-    return await fetchJson(url, config) as RubricTypes
-}
-
-export function rubricAssociationUrl(courseId:number, rubricAssociationId:number) {
-    return `/api/v1/courses/${courseId}/rubric_associations/${rubricAssociationId}`;
-}
-
-export async function updateRubricAssociation(courseId: number, rubricAssociationId: number, data: RubricAssociationUpdateOptions, config?:ICanvasCallConfig) {
-    const url = rubricAssociationUrl(courseId, rubricAssociationId);
-    return await fetchJson(url, deepObjectMerge(config, {
-        fetchInit: {
-            method: 'PUT',
-            body: formDataify(data)
-        },
-    }, true));
-}

package/src/term/Term.ts

@@ -1,77 +0,0 @@
-import {BaseCanvasObject} from "@/baseCanvasObject";
-import {ICanvasCallConfig} from "@/canvasUtils";
-import {Account, RootAccountNotFoundError} from "@/Account";
-import assert from "assert";
-import {CanvasData} from "@/canvasDataDefs";
-import {getPagedData} from "@/fetch/getPagedDataGenerator";
-import {fetchJson} from "@/fetch/fetchJson";
-
-export type TermWorkflowState = 'all' | 'active' | 'deleted'
-
-export interface ITermData extends CanvasData {
-    id: number,
-    start_at: string,
-    end_at: string,
-    name: string,
-    workflow_state: TermWorkflowState,
-    overrides?: Record<string, any>,
-    course_count: number
-}
-
-export class Term extends BaseCanvasObject<ITermData> {
-    static nameProperty = "name";
-
-    static async getTerm(code: string, workflowState: 'all' | 'active' | 'deleted' = 'all', config: ICanvasCallConfig | undefined = undefined) {
-        const terms = await this.searchTerms(code, workflowState, config);
-        if (!Array.isArray(terms) || terms.length <= 0) {
-            return null;
-        }
-        return terms[0];
-    }
-
-    static async getTermById(termId: number, config: ICanvasCallConfig | null = null) {
-        const account = await Account.getRootAccount();
-        if(!account) throw new RootAccountNotFoundError();
-        const url = `/api/v1/accounts/${account.id}/terms/${termId}`;
-        const termData = await fetchJson(url, config) as ITermData | null;
-        if (termData) return new Term(termData);
-        return null;
-    }
-
-    static async getAllActiveTerms(config: ICanvasCallConfig | null = null) {
-        return await this.searchTerms(null, 'active', config);
-    }
-
-    static async searchTerms(
-        code: string | null = null,
-        workflowState: 'all' | 'active' | 'deleted' = 'all',
-        config: ICanvasCallConfig | null = null) {
-
-        config = config || {};
-        config.queryParams = config.queryParams || {};
-
-        const queryParams = config.queryParams;
-        if (workflowState) queryParams['workflow_state'] = workflowState;
-        if (code) queryParams['term_name'] = code;
-        const rootAccount = await Account.getRootAccount();
-        assert(rootAccount);
-        const url = `/api/v1/accounts/${rootAccount.id}/terms`;
-        const data = await getPagedData<ITermData>(url, config);
-        const terms: ITermData[] = [];
-        for (const datum of data) {
-            if (datum.hasOwnProperty('enrollment_terms')) {
-                for (const termData of datum['enrollment_terms']) {
-                    terms.push(termData);
-                }
-            } else {
-                terms.push(datum);
-            }
-        }
-
-        if (!terms || terms.length === 0) {
-            return null;
-        }
-        return terms.map(term => new Term(term));
-    }
-
-}

package/src/term/__tests__/dateFromTermName.test.ts

@@ -1,22 +0,0 @@
-import dateFromTermName from "@/term/dateFromTermName";
-import { Temporal } from "temporal-polyfill";
-
-
-const month = 7;
-const day = 12;
-const year = 2024;
-const date = Temporal.PlainDate.from    ({ month, day, year})
-describe('dateFromTermName', () => {
-    it('works for undergrad', () => {
-        expect(dateFromTermName('DE5W07.12.24')).toEqual(date)
-    })
-    it('works for grad', () => {
-        expect(dateFromTermName('DE8W07.12.24')).toEqual(date);
-    })
-    it('works when part of a course name', () => {
-        expect(dateFromTermName('DE8W07.12.24_TEST000-1: Test')).toEqual(date);
-    })
-    it('is undefined if it doesnt see a term name', () => {
-        expect(dateFromTermName('ABCD1223.234.1')).toBeUndefined();
-    })
-})

package/src/term/__tests__/getTermsGenerator.test.ts

@@ -1,24 +0,0 @@
-import {getTermsGenerator} from "@/term/getTermsGenerator";
-
-jest.mock("@/fetch/getPagedDataGenerator")
-
-import {getPagedDataGenerator} from "@/fetch/getPagedDataGenerator";
-import {mockAsyncGen} from "@/__mocks__/utils";
-
-
-describe("getTermsGenerator", function () {
-
-    const rootAccountId = 10;
-    const mockTerms = [
-        {id: 1},
-        {id: 2},
-    ];
-
-    it("returns terms", async function () {
-        const termGenerator = getTermsGenerator(rootAccountId);
-        (getPagedDataGenerator as jest.Mock).mockReturnValueOnce(mockAsyncGen(mockTerms));
-        expect(getPagedDataGenerator).toHaveBeenCalledWith(`/api/v1/accounts/${rootAccountId}/terms`, expect.anything())
-    })
-
-
-})

package/src/term/dateFromTermName.ts

@@ -1,17 +0,0 @@
-import {Temporal} from "temporal-polyfill";
-
-export function dateFromTermName(termName:string) {
-    const [newCode, month, day, year] = /DE\dW(\d+)\.(\d+)\.(\d+)/i.exec(termName) ?? [];
-    if(newCode) {
-        const yearInt = parseInt(year);
-        return Temporal.PlainDate.from({
-            month: parseInt(month),
-            day: parseInt(day),
-            year: yearInt < 100? 2000 + yearInt : yearInt
-        })
-    }
-
-}
-
-
-export default dateFromTermName;

package/src/term/getTermsGenerator.ts

@@ -1,21 +0,0 @@
-import {getPagedDataGenerator} from "@/fetch/getPagedDataGenerator";
-
-
-export type TermQueryParams = {
-    workflow_state?: 'active' | 'deleted' | 'all',
-    include?: ('overrides' | 'course_count')[],
-    term_name?: string,
-}
-
-const defaultTermQueryParams = {
-    workflow_state: 'active',
-}
-export const getTermsGenerator = (rootAccountId:number, queryParams?: TermQueryParams) => {
-
-
-    const generator = getPagedDataGenerator(`/api/v1/accounts/${rootAccountId}/terms`, {
-        queryParams: {...defaultTermQueryParams, ...queryParams ?? {}},
-    });
-    return generator;
-
-}

package/src/term/index.ts

@@ -1,3 +0,0 @@
-export * from './dateFromTermName';
-export * from './Term';
-export * from './getTermsGenerator';

package/src/toolbox.ts

@@ -1,19 +0,0 @@
-export function sleep(milliseconds: number): Promise<void> {
-    return new Promise((resolve, reject) => {
-        setTimeout(resolve, milliseconds)
-    })
-}
-
-export function isNotNullOrUndefined(value: any) {
-    if (value === null) return false;
-    if (typeof value === 'undefined') return false;
-    return true;
-}
-
-export function aMinusBSortFn<T>(func: (value: T) => number) {
-    return (a: T, b: T) => func(a) - func(b);
-}
-
-export function bMinusASortFn<T>(func: (value: T) => number) {
-    return (a: T, b: T) => func(b) - func(a);
-}