@ueu/ueu-canvas 0.0.2 → 0.0.4

package/src/course/references/mockCiteAsResponse.ts

@@ -1,320 +0,0 @@
-import {CanvasData} from "@/canvasDataDefs";
-
-export default {
-  "citations": [
-    {
-      "citation": "(n.d.). Citation - The very hungry caterpillar - UW-Madison Libraries. Retrieved from https://search.library.wisc.edu/catalog/9910611455202121/cite",
-      "style_fullname": "American Psychological Association 6th edition",
-      "style_shortname": "apa"
-    },
-    {
-      "citation": "Anon, Citation - The very hungry caterpillar - UW-Madison Libraries. Available at: https://search.library.wisc.edu/catalog/9910611455202121/cite.",
-      "style_fullname": "Harvard Reference format 1 (author-date)",
-      "style_shortname": "harvard1"
-    },
-    {
-      "citation": "1.Citation - The very hungry caterpillar - UW-Madison Libraries.",
-      "style_fullname": "Nature",
-      "style_shortname": "nature"
-    },
-    {
-      "citation": "“Citation - the Very Hungry Caterpillar - Uw-madison Libraries”. “Citation - the Very Hungry Caterpillar - Uw-madison Libraries”. Web. \u003Chttps://search.library.wisc.edu/catalog/9910611455202121/cite\u003E...",
-      "style_fullname": "Modern Language Association 7th edition (with URL)",
-      "style_shortname": "modern-language-association-with-url"
-    },
-    {
-      "citation": "“Citation - the Very Hungry Caterpillar - Uw-madison Libraries”. n.d.. “Citation - the Very Hungry Caterpillar - Uw-madison Libraries”. https://search.library.wisc.edu/catalog/9910611455202121/cite.",
-      "style_fullname": "Chicago Manual of Style 16th edition (author-date)",
-      "style_shortname": "chicago-author-date"
-    },
-    {
-      "citation": "1. Citation - The very hungry caterpillar - UW-Madison Libraries [Internet]. Available from: https://search.library.wisc.edu/catalog/9910611455202121/cite",
-      "style_fullname": "Vancouver",
-      "style_shortname": "vancouver"
-    }
-  ],
-  "exports": [
-    {
-      "export": "type,title,URL,id\nmisc,Citation - The very hungry caterpillar - UW-Madison Libraries,https://search.library.wisc.edu/catalog/9910611455202121/cite,ITEM-1",
-      "export_name": "csv"
-    },
-    {
-      "export": "%T Citation - The very hungry caterpillar - UW-Madison Libraries\n%J \n%V \n%N \n%P \n%D \n%I \n0% Journal Article",
-      "export_name": "enw"
-    },
-    {
-      "export": "TY - JOUR\nT1 - Citation - The very hungry caterpillar - UW-Madison Libraries\nJO - \nVL - \nIS - \nSP - \nV1 - \nPB - \nER - ",
-      "export_name": "ris"
-    },
-    {
-      "export": "@misc{ITEM1, title={Citation - The very hungry caterpillar - UW-Madison Libraries},\njournal={},\nvolume={},\nnumber={},\npages={},\nyear={},\npublisher={},\nauthor={}}",
-      "export_name": "bibtex"
-    }
-  ],
-  "metadata": {
-    "URL": "https://search.library.wisc.edu/catalog/9910611455202121/cite",
-    "id": "ITEM-1",
-    "title": "Citation - The very hungry caterpillar - UW-Madison Libraries",
-    "type": "misc"
-  },
-  "name": "Citation - The very hungry caterpillar - UW-Madison Libraries",
-  "provenance": [
-    {
-      "additional_content_url": null,
-      "content_url": "the hungry hungry caterpillar",
-      "found_via_proxy_type": null,
-      "has_content": true,
-      "host": null,
-      "key_word": "the hungry hungry caterpillar",
-      "name": "UserInputStep",
-      "original_url": null,
-      "parent_step_name": "NoneType",
-      "parent_subject": null,
-      "source_preview": {
-        "title": null
-      },
-      "subject": "user input"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": "https://search.library.wisc.edu/catalog/9910611455202121/cite",
-      "found_via_proxy_type": "google",
-      "has_content": true,
-      "host": null,
-      "key_word": null,
-      "name": "GoogleStep",
-      "original_url": null,
-      "parent_step_name": "UserInputStep",
-      "parent_subject": "user input",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "google search result"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": null,
-      "found_via_proxy_type": "arXiv ID",
-      "has_content": false,
-      "host": null,
-      "key_word": null,
-      "name": "ArxivResponseStep",
-      "original_url": null,
-      "parent_step_name": "GoogleStep",
-      "parent_subject": "google search result",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "ArXiv page"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": null,
-      "found_via_proxy_type": "link",
-      "has_content": false,
-      "host": "github",
-      "key_word": null,
-      "name": "GithubRepoStep",
-      "original_url": null,
-      "parent_step_name": "GoogleStep",
-      "parent_subject": "google search result",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "GitHub repository main page"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": null,
-      "found_via_proxy_type": "link",
-      "has_content": false,
-      "host": null,
-      "key_word": null,
-      "name": "BitbucketRepoStep",
-      "original_url": null,
-      "parent_step_name": "GoogleStep",
-      "parent_subject": "google search result",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "Bitbucket repository main page"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": null,
-      "found_via_proxy_type": "link",
-      "has_content": false,
-      "host": "cran",
-      "key_word": null,
-      "name": "CranLibraryStep",
-      "original_url": null,
-      "parent_step_name": "GoogleStep",
-      "parent_subject": "google search result",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "R CRAN package webpage"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": null,
-      "found_via_proxy_type": "link",
-      "has_content": false,
-      "host": "pypi",
-      "key_word": null,
-      "name": "PypiLibraryStep",
-      "original_url": null,
-      "parent_step_name": "GoogleStep",
-      "parent_subject": "google search result",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "Python PyPI package webpage"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": "https://search.library.wisc.edu/catalog/9910611455202121/cite",
-      "found_via_proxy_type": "link",
-      "has_content": true,
-      "host": "webpage",
-      "key_word": null,
-      "name": "WebpageStep",
-      "original_url": null,
-      "parent_step_name": "GoogleStep",
-      "parent_subject": "google search result",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "webpage"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": "https://search.library.wisc.edu/catalog/9910611455202121/cite",
-      "found_via_proxy_type": "link",
-      "has_content": false,
-      "host": null,
-      "key_word": null,
-      "name": "RelationHeaderStep",
-      "original_url": null,
-      "parent_step_name": "WebpageStep",
-      "parent_subject": "webpage",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "cite-as relation header"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": null,
-      "found_via_proxy_type": "doi",
-      "has_content": false,
-      "host": "crossref",
-      "key_word": null,
-      "name": "CrossrefResponseStep",
-      "original_url": null,
-      "parent_step_name": "WebpageStep",
-      "parent_subject": "webpage",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "DOI API response"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": "https://search.library.wisc.edu/catalog/9910611455202121/cite",
-      "found_via_proxy_type": "pmid or pmcid",
-      "has_content": false,
-      "host": "pmid or pmcid",
-      "key_word": null,
-      "name": "PMIDStep",
-      "original_url": null,
-      "parent_step_name": "WebpageStep",
-      "parent_subject": "webpage",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "PubMed identifier"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": null,
-      "found_via_proxy_type": "arXiv ID",
-      "has_content": false,
-      "host": null,
-      "key_word": null,
-      "name": "ArxivResponseStep",
-      "original_url": null,
-      "parent_step_name": "WebpageStep",
-      "parent_subject": "webpage",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "ArXiv page"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": null,
-      "found_via_proxy_type": "link",
-      "has_content": false,
-      "host": "github",
-      "key_word": null,
-      "name": "GithubRepoStep",
-      "original_url": null,
-      "parent_step_name": "WebpageStep",
-      "parent_subject": "webpage",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "GitHub repository main page"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": null,
-      "found_via_proxy_type": "link",
-      "has_content": false,
-      "host": null,
-      "key_word": null,
-      "name": "BitbucketRepoStep",
-      "original_url": null,
-      "parent_step_name": "WebpageStep",
-      "parent_subject": "webpage",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "Bitbucket repository main page"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": "https://search.library.wisc.edu/catalog/9910611455202121/cite",
-      "found_via_proxy_type": null,
-      "has_content": false,
-      "host": null,
-      "key_word": null,
-      "name": "BibtexStep",
-      "original_url": null,
-      "parent_step_name": "WebpageStep",
-      "parent_subject": "webpage",
-      "source_preview": {
-        "title": null
-      },
-      "subject": "BibTeX"
-    },
-    {
-      "additional_content_url": null,
-      "content_url": "https://search.library.wisc.edu/catalog/9910611455202121/cite",
-      "found_via_proxy_type": null,
-      "has_content": true,
-      "host": "webpage",
-      "key_word": null,
-      "name": "WebpageMetadataStep",
-      "original_url": null,
-      "parent_step_name": "WebpageStep",
-      "parent_subject": "webpage",
-      "source_preview": {
-        "title": "\u003Ci\u003ESnapshot of title data found at https://search.library.wisc.edu/catalog/9910611455202121/cite.\u003C/i\u003E\u003Cbr\u003E;> \t<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons"> \t<link rel="stylesheet" href="https://use.typekit.net/dwu5mei.css"> \t<link rel="stylesheet" crossorigin href="https://cdn.wisc.cloud/fonts/uw-rh/fonts-woff2.0.0.1.css"> \t<link rel="stylesheet" crossorigin href="https://cdn.wisc.cloud/fonts/languages/0.0.1/uw-language-font-files.css"> \t \t\t<title>\u003Cspan class=\"highlight\"\u003ECitation - The very hungry caterpillar - UW-Madison Libraries\u003C/span\u003E</title> \t<link rel="stylesheet" media="all" href="/assets/application-3d7855b0bde27e1916896e2fd9fb0a674994158303dbb2a75a5672d5434e9449.css" /> \t<script src="https://web.lib.wisc.edu/globaljs/global-2.0.2.min.js"></script> \t<script src="https://cdn.wisc.cloud/cookie-consent/uwcookieconsent.min.js"></script> \t<script src="/assets/application-2d"
-      },
-      "subject": "webpage"
-    }
-  ],
-  "url": "the hungry hungry caterpillar"
-};

package/src/course/retireBlueprint.ts

@@ -1,21 +0,0 @@
-import {Course} from "@canvas/course/Course";
-import {ICanvasCallConfig} from "@canvas/canvasUtils";
-import {MalformedCourseCodeError} from "@canvas/course/code";
-
-import {NotABlueprintError} from "@canvas/course/notABlueprintError";
-
-export async function retireBlueprint(course: Course, termName: string | null, config?: ICanvasCallConfig) {
-
-    if (!course.parsedCourseCode) throw new MalformedCourseCodeError(course.courseCode);
-    const isCurrentBlueprint = course.parsedCourseCode?.match('BP_');
-    if (!isCurrentBlueprint) throw new NotABlueprintError("This blueprint is not named BP_; are you trying to retire a retired blueprint?")
-
-    const newCode = `BP-${termName}_${course.baseCode}`;
-    const saveData: Record<string, any> = {};
-
-    saveData[Course.nameProperty] = course.name.replace(course.parsedCourseCode, newCode);
-    saveData['course_code'] = newCode
-    await course.saveData({
-        course: saveData
-    }, config);
-}

package/src/course/toolbox.ts

@@ -1,107 +0,0 @@
-import {deepObjectMerge, formDataify, generatorMap, ICanvasCallConfig, IQueryParams} from "@/canvasUtils";
-
-import {GetCourseOptions, GetCoursesFromAccountOptions, IGradingStandardData} from "./courseTypes";
-import {Course} from "./Course";
-import {Term} from "@canvas/term/Term";
-
-import {ICourseData} from "@/types";
-import {getPagedData, getPagedDataGenerator, mergePagedDataGenerators} from "@/fetch/getPagedDataGenerator";
-
-import {fetchJson} from "@canvas/fetch/fetchJson";
-import {overrideConfig} from "@canvas/fetch/utils";
-
-
-export async function getGradingStandards(contextId: number, contextType: 'account' | 'course', config?: ICanvasCallConfig) {
-    const url = `/api/v1/${contextType}s/${contextId}/grading_standards`
-    return await getPagedData<IGradingStandardData>(url, config)
-}
-
-
-export function getCourseData(id: number, config?: ICanvasCallConfig<GetCourseOptions>) {
-    const url = `/api/v1/courses/${id}`;
-    return fetchJson(url, config) as Promise<ICourseData>;
-}
-
-
-export function getCourseDataGenerator(
-    queryString: string | undefined | null, accountIds: number[] | number, term?: Term|number, config?: ICanvasCallConfig<GetCoursesFromAccountOptions>
-): AsyncGenerator<ICourseData, void, unknown> {
-    if (!Array.isArray(accountIds)) accountIds = [accountIds];
-
-    const defaultConfig: ICanvasCallConfig<GetCoursesFromAccountOptions> = queryString ? {
-        queryParams: {
-            search_term: queryString,
-        }
-    } : {};
-
-    const termId = typeof term ==='number' ? term : term?.id;
-    if (termId && defaultConfig.queryParams) defaultConfig.queryParams.enrollment_term_id = termId;
-    config = overrideConfig(defaultConfig, config);
-    const generators = accountIds.map(accountId => {
-        const url = `/api/v1/accounts/${accountId}/courses`;
-        return getPagedDataGenerator<ICourseData>(url, config);
-    })
-    return mergePagedDataGenerators(generators);
-}
-
-export function getCourseGenerator(
-    queryString: string | undefined | null, accountIds: number[] | number, term?: Term, config?: ICanvasCallConfig<GetCoursesFromAccountOptions>) {
-    return generatorMap(getCourseDataGenerator(queryString, accountIds, term, config), courseData => new Course(courseData));
-}
-
-export async function getSingleCourse(queryString: string, accountIds: number[], term?: Term, config?: ICanvasCallConfig<GetCoursesFromAccountOptions>) {
-    for (const accountId of accountIds) {
-        const courseDatas = await fetchJson<ICourseData[]>(
-            `/api/v1/accounts/${accountId}/courses`,
-            overrideConfig({queryParams: {search_term: queryString}}, config)
-        )
-
-        if (courseDatas.length > 0) return new Course(courseDatas[0]);
-    }
-    return undefined;
-}
-
-export async function getCourseById(id: number, config?: ICanvasCallConfig<GetCoursesFromAccountOptions>) {
-    return new Course(await fetchJson(`/api/v1/courses/${id}`, config));
-}
-
-export async function createNewCourse(courseCode: string, accountId: number, name?: string, config?: ICanvasCallConfig) {
-    name ??= courseCode;
-    const createUrl = `/api/v1/accounts/${accountId}/courses/`
-    const createConfig: ICanvasCallConfig = {
-        fetchInit: {
-            method: 'POST',
-            body: formDataify({
-                course: {
-                    name,
-                    course_code: courseCode
-                }
-            })
-        }
-    }
-    return await fetchJson(createUrl, deepObjectMerge(createConfig, config, true)) as ICourseData;
-}
-
-export class CourseNotFoundException extends Error {
-}
-
-export async function saveCourseData(courseId: number, data: Partial<ICourseData>, config?: ICanvasCallConfig) {
-    const url = `/api/v1/courses/${courseId}`
-    return await fetchJson<ICourseData>(url, overrideConfig(config, {
-        fetchInit: {
-            method: 'PUT',
-            body: formDataify({course: data})
-        }
-    }))
-}
-
-export async function setGradingStandardForCourse(courseId: number, standardId: number, config?: ICanvasCallConfig) {
-    return await saveCourseData(courseId, {grading_standard_id: standardId})
-}
-
-export function getCourseName(data:ICourseData) {
-    const [full, withoutCode] = /[^:]*:\s*(.*)/.exec(data.name) ?? [];
-    if(withoutCode) return withoutCode;
-    return data.name;
-
-}

package/src/date.ts

@@ -1,119 +0,0 @@
-import assert from "assert";
-import {range} from "@canvas/canvasUtils";
-import {Temporal} from "temporal-polyfill";
-
-function getMonthNames(style: "numeric" | "2-digit" | "long" | "short" | "narrow" = "long", locale = 'en-US') {
-    return Array.from(range(1, 12)).map((monthInt) => {
-        return Temporal.PlainDate.from({
-            day: 1,
-            month: monthInt,
-            year: Temporal.Now.plainDateISO().year
-        }).toLocaleString(locale, {
-            month: style
-        })
-    })
-}
-
-/**
- * takes a string of formatted [monthname] [date] and give a plain date
- * @param value the string to evaluate
- * @param locale the locale to use to generate month names, e.g. en-US
- * @param year the year to give the date object. If not provided defaults to current year.
- */
-function plainDateFromMonthDayString(value: string, locale: string, year?:number) {
-    year ??= Temporal.Now.plainDateISO().year;
-    const match = value.match(getDateRegexString(locale));
-    if (!match) throw new MalformedDateError(value);
-    const fullDate = match[1];
-    return Temporal.PlainDate.from({
-        month: getMonthNumberLut(locale)[match[2]],
-        day: parseInt(match[3]),
-        year
-    })
-}
-
-const monthNumberLutCache: Record<string, Record<string, number>> = {};
-
-/**
- * returns a string with 3 capturing groups -- 1 - month date, 2 month, 3 date. cuts off rd/th...
- * @param locale
- */
-function getMonthNumberLut(locale: string) {
-    if (monthNumberLutCache[locale]) return monthNumberLutCache[locale];
-
-    const monthNames = getMonthNames('long', locale);
-    const shortMonthNames = getMonthNames('short', locale);
-
-    const monthNumberLut: Record<string, number> = {};
-    assert(monthNames.length === shortMonthNames.length);
-    for (let i = 0; i < monthNames.length; i++) {
-        monthNumberLut[monthNames[i]] = i + 1;
-        monthNumberLut[shortMonthNames[i]] = i + 1;
-    }
-    monthNumberLutCache[locale] = monthNumberLut;
-    return monthNumberLut;
-
-}
-
-const dateRegexStringCache: Record<string, string> = {};
-
-//TODO: Make the capture groups in this optional
-function getDateRegexString(locale = 'en-US') {
-    if (dateRegexStringCache[locale]) return dateRegexStringCache[locale];
-
-    const monthNames = getMonthNames('long', locale);
-    const shortMonthNames = getMonthNames('short', locale);
-    const monthRegexDatePart = `(?:${[...monthNames, ...shortMonthNames].join('|')})`;
-    const output = `((${monthRegexDatePart}) (\\d+))(?:\\w{2}|)`;
-    dateRegexStringCache[locale] = output;
-    return output;
-}
-
-/**
- * Looks for a date range in text and, if found, returns an object with start and end params as Temporal PlainDates
- * @param textToSearch
- * @param locale
- */
-export function findDateRange(textToSearch: string, locale = 'en-US') {
-    const dateRegExString = getDateRegexString(locale);
-
-    const searchRegex = new RegExp(`(${dateRegExString}).*(${dateRegExString})`, 'i');
-    const dateRegex = new RegExp(dateRegExString, 'i')
-
-    const matchRange = textToSearch.match(searchRegex);
-    if (!matchRange) return null; //No date range found in syllabus
-
-    let start, end;
-    for(const separator of ['-', 'to']) {
-        [start, end] = matchRange[0].split(separator)
-        if(start && end) break;
-    }
-    if(!start || !end) throw new MalformedDateError('Cannot find date range in syllabus');
-
-    const startMatch = start.match(dateRegex);
-    const endMatch = end.match(dateRegex);
-    if(!startMatch) throw new MalformedDateError(`Missing Start Date ${start}`)
-    if(!endMatch) throw new MalformedDateError(`Missing End Date ${end}`)
-
-    return {
-        start: plainDateFromMonthDayString(startMatch[0], locale),
-        end: plainDateFromMonthDayString(endMatch[0], locale)
-    }
-}
-
-export function oldDateToPlainDate(date: Date) {
-    const data = {
-        day: date.getDate(),
-        month: date.getMonth() + 1,
-        year: date.getFullYear(),
-    };
-    return Temporal.PlainDate.from(data)
-}
-
-export class StringNotAMonthDateError extends Error {
-    name = "StringNotAMonthDateError"
-}
-
-export class MalformedDateError extends Error {
-    name="MalformedDateError"
-}

package/src/enrollments/EnrollmentTypes.ts

@@ -1,76 +0,0 @@
-import {EnrollmentRole} from "@/enrollments/enrollmentRole";
-import {IUserData} from "@/canvasDataDefs";
-
-export type EnrollmentData = {
-    id: number,
-    course_id: number,
-    sis_course_id?: string,
-    course_integration_id?: string,
-    course_section_id?: number,
-    section_integration_id?: string,
-    sis_account_id?: string,
-    sis_section_id?: string,
-    sis_user_id?: string,
-    enrollment_state: EnrollmentState,
-    limit_privileges_to_course_section?: boolean,
-    root_account_id: number,
-    type: EnrollmentType,
-    user_id: number,
-    associated_user_id?: number | null,
-    role: EnrollmentRole,
-    role_id: number,
-    created_at: string,
-    updated_at: string,
-    start_at: string,
-    end_at: string,
-    last_activity_at?: string,
-    last_attended_at?: string,
-    total_activity_time: number,
-    html_url: string,
-    grades?: Grade,
-    user: IUserData,
-    override_grade?: string,
-    override_score?: number,
-    has_grading_periods?: boolean,
-    totals_for_all_grading_periods_option?: boolean,
-    current_grading_period_title?: string,
-    current_grading_period_id?: number,
-    current_period_unposted_current_score?: number,
-    current_period_unposted_final_score?: number,
-    current_period_unposted_current_grade?: string,
-    current_period_unposted_final_grade?: string,
-
-} & UnpostedGradeParams
-export type Grade = {
-    html_url?: string,
-    current_grade?: string,
-    final_grade?: string,
-    current_score?: number,
-    final_score?: number,
-    current_points?: number,
-} & UnpostedGradeParams
-type UnpostedGradeParams = {
-    unposted_current_grade?: string,
-    unposted_current_score?: number,
-    unposted_final_score?: number
-    unposted_current_points: number,
-}
-export type EnrollmentType = 'StudentEnrollment' |
-    'TeacherEnrollment' |
-    'DesignerEnrollment' |
-    'ObserverEnrollment'
-export type EnrollmentState = 'active' |
-    'invited' |
-    'creation_pending' |
-    'deleted' |
-    'rejected' |
-    'completed' |
-    'inactive' |
-    'current_and_invited' |
-    'current_and_future' |
-    'current_and_future_and_restricted' |
-    'current_and_concluded'
-export type EnrollmentUserState = EnrollmentState | 'current_and_invited' |
-    'current_and_future' |
-    'current_and_future_and_restricted' |
-    'current_and_concluded'

package/src/enrollments/enrollmentRole.ts

@@ -1,6 +0,0 @@
-export type EnrollmentRole = string & { readonly __brand: unique symbol };
-
-export function createEnrollmentRole(role: string): EnrollmentRole {
-    return role as EnrollmentRole;
-}
-