@ueu/ueu-canvas 0.0.2 → 0.0.4

package/src/course/blueprint.ts

@@ -1,116 +0,0 @@
-import {formDataify, getItemTypeAndId, ICanvasCallConfig, renderAsyncGen} from "../canvasUtils";
-import {IModuleData, IModuleItemData} from "../canvasDataDefs";
-import {getCourseDataGenerator, getCourseGenerator} from "./toolbox";
-import {GetCoursesFromAccountOptions} from "./courseTypes";
-import {baseCourseCode} from "@/course/code";
-import {ICourseData, SectionData} from "@/types";
-import {getPagedDataGenerator} from "@/fetch/getPagedDataGenerator";
-import {fetchGetConfig} from "@/fetch/utils";
-import {fetchJson} from "@/fetch/fetchJson";
-import apiWriteConfig from "@/fetch/apiWriteConfig";
-
-export function isBlueprint({blueprint}: { blueprint?: boolean | undefined }) {
-    return !!blueprint;
-}
-//W
-export function genBlueprintDataForCode(courseCode:string | null, accountIds:number[], queryParams?: GetCoursesFromAccountOptions) {
-    if(!courseCode) {
-        console.warn("Course code not present")
-        return null;
-    }
-    const baseCode = baseCourseCode(courseCode);
-    if(!baseCode) {
-        console.warn(`Code ${courseCode} invalid`);
-        return null;
-    }
-
-    return getCourseDataGenerator(baseCode, accountIds, undefined, fetchGetConfig<GetCoursesFromAccountOptions>({
-        blueprint: true,
-        include: ['concluded'],
-    }, {queryParams}));
-}
-
-export function sectionDataGenerator(courseId:number, config?: ICanvasCallConfig<GetCoursesFromAccountOptions>) {
-    const url = `/api/v1/courses/${courseId}/blueprint_templates/default/associated_courses`;
-    return getPagedDataGenerator<SectionData>(url, config);
-}
-
-
-type BeginSyncOptions = {
-    config?: ICanvasCallConfig,
-    copy_settings?: boolean,
-    message?: string,
-}
-export async function beginBpSync(courseId:number, {message, copy_settings, config
-}:BeginSyncOptions) {
-    const url = `/api/v1/courses/${courseId}/blueprint_templates/default/migrations`;
-    if(typeof  copy_settings === 'undefined') copy_settings = true;
-    return await fetchJson(url, apiWriteConfig('POST', {
-        message,
-        copy_settings
-    }, config))
-}
-
-
-export async function getBlueprintsFromCode(code: string, accountIds: number[], config?: ICanvasCallConfig<GetCoursesFromAccountOptions>) {
-    const [_, baseCode] = code.match(/_(\w{4}\d{3})$/) || [];
-    if (!baseCode) return null;
-    const bps = getCourseGenerator(`BP_${baseCode}`, accountIds, undefined, config);
-    return (await renderAsyncGen(bps)).toSorted((a, b) => b.name.length - a.name.length);
-}
-
-export async function lockBlueprint(courseId:number, modules: IModuleData[]) {
-    let items: IModuleItemData[] = [];
-
-    items = items.concat(...modules.map(a => (<IModuleItemData[]>[]).concat(...a.items)));
-    const promises = items.map(async (item) => {
-        const url = `/api/v1/courses/${courseId}/blueprint_templates/default/restrict_item`;
-        const {type, id} = await getItemTypeAndId(item);
-        if ( typeof id === 'undefined') return;
-        const body = {
-            "content_type": type,
-            "content_id": id,
-            "restricted": true,
-            "_method": 'PUT'
-        }
-        await fetchJson(url, {
-            fetchInit: {
-                method: 'PUT',
-                body: formDataify(body)
-            }
-        });
-
-    });
-    await Promise.all(promises);
-
-}
-
-export async function setAsBlueprint(courseId: number, config?: ICanvasCallConfig) {
-    const url = `/api/v1/courses/${courseId}`;
-    const payload = {
-        course: {
-            blueprint: true,
-            use_blueprint_restrictions_by_object_type: 0,
-            blueprint_restrictions: {
-                content: 1,
-                points: 1,
-                due_dates: 1,
-                availability_dates: 1,
-            }
-        }
-    }
-    return await fetchJson(url, apiWriteConfig('PUT', payload, config)) as ICourseData;
-}
-
-
-export async function unSetAsBlueprint(courseId: number, config?: ICanvasCallConfig) {
-    const url = `/api/v1/courses/${courseId}`;
-    const payload = {
-        course: {
-            blueprint: false
-        }
-    };
-    return await fetchJson(url, apiWriteConfig("PUT", payload, config)) as ICourseData;
-}
-
-

package/src/course/cachedGetAssociatedCoursesFunc.ts

@@ -1,13 +0,0 @@
-import {IBlueprintCourse} from "@canvas/course/IBlueprintCourse";
-import {Course} from "@canvas/course/Course";
-
-import {getSections} from "@canvas/course/getSections";
-
-export function cachedGetAssociatedCoursesFunc(course: IBlueprintCourse) {
-    let cache: Course[] | null = null;
-    return async (redownload = false) => {
-        if (!redownload && cache) return cache;
-        cache = await getSections(course.id);
-        return cache;
-    }
-}

package/src/course/changeStartDate.ts

@@ -1,139 +0,0 @@
-import {Temporal} from "temporal-polyfill";
-import {IModuleData} from "../canvasDataDefs";
-import {findDateRange, oldDateToPlainDate} from "@/date";
-
-import {Assignment} from "@/content/assignments/Assignment";
-
-import {IAssignmentData} from "@canvas/content/types";
-
-const DEFAULT_LOCALE = 'en-US';
-
-export function getModuleUnlockStartDate(modules: IModuleData[]) {
-    if (modules.length == 0) throw new NoOverviewModuleFoundError();
-    const overviewModule = modules[0];
-    const unlockDateString = overviewModule.unlock_at;
-    if(!unlockDateString) return null;
-    const oldDate = new Date(unlockDateString);
-    return oldDateToPlainDate(oldDate);
-}
-
-export function sortAssignmentsByDueDate(assignments:Assignment[]|IAssignmentData[]) {
-    return assignments
-        .toSorted((a, b) =>
-        {
-            a = a instanceof Assignment ? a.rawData : a;
-            b = b instanceof Assignment ? b.rawData : b;
-
-
-            if(a.due_at && b.due_at) {
-
-                return oldDateToPlainDate(new Date(b.due_at)).until(oldDateToPlainDate(new Date(a.due_at))).days;
-            }
-            if(a.due_at) return -1;
-            if(b.due_at) return 1;
-            return 0;
-        }
-    );
-
-}
-
-export function getStartDateAssignments(assignments:Assignment[]|IAssignmentData[]) {
-    const sorted = sortAssignmentsByDueDate(assignments).map(a => a.rawData ?? a).filter(a => a.due_at);
-    if (sorted.length == 0) throw new NoAssignmentsWithDueDatesError();
-    const firstAssignmentDue = new Date(sorted[0].due_at);
-
-    //Set to monday of that week.
-    const plainDateDue = oldDateToPlainDate(firstAssignmentDue);
-    const dayOfWeekOffset = 1 - plainDateDue.dayOfWeek;
-    return plainDateDue.add({days: dayOfWeekOffset});
-}
-
-export function getUpdatedStyleTermName(termStart:Temporal.PlainDate, weekCount:string|number, locale=DEFAULT_LOCALE) {
-    const month = termStart.toLocaleString(locale, { month: '2-digit'})
-    const day = termStart.toLocaleString(locale, { day: '2-digit'})
-    const year = termStart.toLocaleString(locale, { year: '2-digit'})
-    return `DE${weekCount}W${month}.${day}.${year}`;
-}
-
-export function getOldUgTermName(termStart:Temporal.PlainDate, locale=DEFAULT_LOCALE) {
-    const year = termStart.toLocaleString(DEFAULT_LOCALE, { year: '2-digit'})
-    const month = termStart.toLocaleString(DEFAULT_LOCALE, { month: 'short'})
-    return `DE-${year}-${month}`;
-}
-
-export function getNewTermName(oldTermName:string, newTermStart:Temporal.PlainDate, locale= DEFAULT_LOCALE) {
-    const [termName, weekCount] = oldTermName.match(/DE(\d)W\d\d\.\d\d\.\d\d/) || [];
-    if (termName) return getUpdatedStyleTermName(newTermStart, weekCount);
-    const termNameUg = oldTermName.match(/(DE(?:.HL|)-\d\d)-(\w+)\w{2}?/i);
-    if (termNameUg) return getUpdatedStyleTermName(newTermStart, 5);
-    throw new MalformedSyllabusError(`Can't Recognize Term Name ${oldTermName}`)
-}
-
-export function updatedDateSyllabusHtml(html: string, newStartDate: Temporal.PlainDate, locale = DEFAULT_LOCALE) {
-    const syllabusBody = document.createElement('div');
-    syllabusBody.innerHTML = html;
-    const syllabusCalloutBox = syllabusBody.querySelector('div.cbt-callout-box');
-    if(!syllabusCalloutBox) throw new MalformedSyllabusError("Can't find syllabus callout box");
-
-    const paras = Array.from(syllabusCalloutBox.querySelectorAll('p'));
-    const strongParas = paras.filter((para) => para.querySelector('strong'));
-    if (strongParas.length < 5) throw new MalformedSyllabusError(`Missing syllabus headers\n${strongParas}`);
-
-    const [
-        _courseNameEl,
-        termNameEl,
-        datesEl,
-        _instructorNameEl,
-        _instructorContactInfoEl,
-        _creditsEl
-    ] = strongParas;
-
-    const changedText: string[] = [];
-
-    const oldTermName = termNameEl.textContent || '';
-    const oldDates = datesEl.textContent || '';
-    const dateRange = findDateRange(datesEl.innerHTML, locale);
-    if (!dateRange) throw new MalformedSyllabusError("Date range not found in syllabus");
-
-    const courseDuration = dateRange.start.until(dateRange.end);
-    const newEndDate = newStartDate.add(courseDuration);
-    const newTermName = getNewTermName(oldTermName, newStartDate)
-    
-    const dateRangeText = `${dateToSyllabusString(newStartDate)} - ${dateToSyllabusString(newEndDate)}`;
-
-    termNameEl.innerHTML = `<strong>${syllabusHeaderName(termNameEl)}:</strong><span> ${newTermName}</span>`;
-    datesEl.innerHTML = `<strong>${syllabusHeaderName(datesEl)}:</strong><span> ${dateRangeText}</span>`;
-
-    changedText.push(`${oldTermName} -> ${termNameEl.textContent}`)
-    changedText.push(`${oldDates} -> ${datesEl.textContent}`)
-
-    const output = {
-        html : syllabusBody.innerHTML.replaceAll(/<p>\s*(&nbsp;)?<\/p>/ig, ''),
-        changedText,
-    }
-    syllabusBody.remove();
-    return output;
-}
-
-function dateToSyllabusString(date:Temporal.PlainDate) {
-    return `${date.toLocaleString(DEFAULT_LOCALE, { month: 'long', day: 'numeric' })}`;
-}
-
-export function syllabusHeaderName(el:HTMLElement) {
-
-    let [_, head] =  /([^:]*):/.exec(el.innerHTML) ?? [];
-    head = head?.replaceAll(/<[^>]*>/g, '')
-    return head;
-}
-
-export class NoOverviewModuleFoundError extends Error {
-    public name = "NoOverviewModuleFoundError"
-}
-
-export class MalformedSyllabusError extends Error {
-    public name="MalformedSyllabusError"
-}
-
-export class NoAssignmentsWithDueDatesError extends Error {
-    public name = "NoAssignmentsWithDueDatesError"
-}

package/src/course/code.ts

@@ -1,32 +0,0 @@
-import {COURSE_CODE_REGEX} from "@/course/Course";
-
-export function parseCourseCode(code: string) {
-    const match = COURSE_CODE_REGEX.exec(code);
-    if (!match) return null;
-    const prefix = match[1] || "";
-    const courseCode = match[2] || "";
-    if (prefix.length > 0) {
-        return `${prefix}_${courseCode}`;
-    }
-    return courseCode;
-}
-
-export function baseCourseCode(code: string) {
-    const match = COURSE_CODE_REGEX.exec(code);
-    if (!match) return null;
-    return match[2];
-}
-
-export function stringIsCourseCode(code: string) {
-    return COURSE_CODE_REGEX.exec(code);
-}
-
-export class MalformedCourseCodeError extends Error {
-    name = "MalformedCourseCodeError";
-    courseCode:string|null;
-    constructor(courseCode:string|null, message?: string, options?:ErrorOptions) {
-        if(!message) message = `${courseCode} is not a valid course code`;
-        super(message, options);
-        this.courseCode = courseCode;
-    }
-}

package/src/course/courseTypes.ts

@@ -1,161 +0,0 @@
-//const HOMETILE_WIDTH = 500;
-import {ICanvasCallConfig} from "../canvasUtils";
-import {ILatePolicyData, IModuleData} from "../canvasDataDefs";
-
-import {ICourseData, ICourseSettings} from "@/types";
-import {Quiz} from "@/content/quizzes/Quiz";
-import {Page} from "@/content/pages/Page";
-import {Discussion} from "@/content/discussions/Discussion";
-import {Assignment} from "@/content/assignments/Assignment";
-
-export interface IIdHaver<IdType = number> {
-    id: IdType,
-}
-
-export interface ICourseDataHaver {
-    rawData: ICourseData,
-}
-
-export interface ICourseCodeHaver {
-    name: string,
-    parsedCourseCode: string | null,
-    courseCode: string | null,
-    baseCode: string | null,
-}
-
-export interface ISyllabusHaver extends IIdHaver {
-    getSyllabus: (config?: ICanvasCallConfig<GetCourseOptions>) => Promise<string>,
-    changeSyllabus: (this:ISyllabusHaver, newHtml: string, config?: ICanvasCallConfig) => any
-}
-
-export interface ICourseSettingsHaver extends IIdHaver {
-    id: number,
-    getSettings: (config?: ICanvasCallConfig) => Promise<ICourseSettings>
-}
-
-export interface ILatePolicyHaver extends IIdHaver {
-    id: number,
-    getLatePolicy: (config?: ICanvasCallConfig) => Promise<ILatePolicyData | undefined>
-}
-
-export interface IAssignmentsHaver extends IIdHaver {
-    getAssignments: (config?: ICanvasCallConfig) => Promise<Assignment[]>;
-
-}
-
-export interface IPagesHaver extends IIdHaver {
-    id: number,
-
-    getPages(config?: ICanvasCallConfig): Promise<Page[]>
-}
-
-export interface IDiscussionsHaver extends IIdHaver {
-    id: number,
-
-    getDiscussions(config?: ICanvasCallConfig): Promise<Discussion[]>
-}
-
-export interface IQuizzesHaver extends IIdHaver {
-    getQuizzes(config?: ICanvasCallConfig): Promise<Quiz[]>
-}
-
-export interface IModulesHaver extends IIdHaver {
-    getModules(config?: ICanvasCallConfig): Promise<IModuleData[]>,
-
-    getModulesByWeekNumber(config?: ICanvasCallConfig): Promise<Record<number | string, IModuleData>>
-}
-
-export interface IGradingStandardsHaver extends IIdHaver {
-    getAvailableGradingStandards(config?: ICanvasCallConfig): Promise<IGradingStandardData[]>,
-
-    getCurrentGradingStandard(config?: ICanvasCallConfig): Promise<IGradingStandardData | null>
-}
-
-export interface IGradingStandardData {
-    id: number,
-    title: string,
-    context_type: 'Course' | 'Account',
-    grading_scheme: IGradingSchemeEntry[]
-}
-
-export interface IGradingSchemeEntry {
-    name: string,
-    value: number
-}
-
-
-export interface IContentHaver extends IAssignmentsHaver, IPagesHaver, IDiscussionsHaver, ISyllabusHaver, IQuizzesHaver {
-    name: string,
-
-    getContent(config?: ICanvasCallConfig<Record<string, any>>, refresh?: boolean): Promise<(Discussion | Assignment | Page | Quiz)[]>,
-
-}
-
-
-export type GetOptions = {
-    per_page?: number
-}
-
-
-export type GetCoursesFromAccountOptions = GetOptions & {
-  with_enrollments?: boolean;
-  enrollment_type?: ('teacher' | 'student' | 'ta' | 'observer' | 'designer')[];
-  published?: boolean;
-  completed?: boolean;
-  blueprint?: boolean;
-  blueprint_associated?: boolean;
-  public?: boolean;
-  by_teachers?: number[];
-  by_subaccounts?: number[];
-  hide_enrollmentless_courses?: boolean;
-  state?: ('created' | 'claimed' | 'available' | 'completed' | 'deleted' | 'all')[];
-  enrollment_term_id?: number;
-  search_term?: string;
-  include?: (
-    | 'syllabus_body'
-    | 'term'
-    | 'course_progress'
-    | 'storage_quota_used_mb'
-    | 'total_students'
-    | 'teachers'
-    | 'account_name'
-    | 'concluded'
-  )[];
-  sort?: 'course_name' | 'sis_course_id' | 'teacher' | 'account_name';
-  order?: 'asc' | 'desc';
-  search_by?: 'course' | 'teacher';
-  starts_before?: string; // Date formatted as yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ
-  ends_after?: string; // Date formatted as yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ
-  homeroom?: boolean;
-};
-
-export type GetCourseOptions = {
-    enrollment_type?: 'teacher' | 'student' | 'ta' | 'observer' | 'designer';
-    enrollment_role?: string; // Deprecated
-    enrollment_role_id?: number;
-    enrollment_state?: 'active' | 'invited_or_pending' | 'completed';
-    exclude_blueprint_courses?: boolean;
-    include?: (
-        | 'needs_grading_count'
-        | 'syllabus_body'
-        | 'public_description'
-        | 'total_scores'
-        | 'current_grading_period_scores'
-        | 'grading_periods'
-        | 'term'
-        | 'account'
-        | 'course_progress'
-        | 'sections'
-        | 'storage_quota_used_mb'
-        | 'total_students'
-        | 'passback_status'
-        | 'favorites'
-        | 'teachers'
-        | 'observed_users'
-        | 'tabs'
-        | 'course_image'
-        | 'banner_image'
-        | 'concluded'
-        )[];
-    state?: ('unpublished' | 'available' | 'completed' | 'deleted')[];
-};

package/src/course/getCourseIdFromUrl.ts

@@ -1,7 +0,0 @@
-export default function getCourseIdFromUrl(url: string) {
-    const match = /courses\/(\d+)/.exec(url);
-    if (match) {
-        return parseInt(match[1]);
-    }
-    return null;
-}

package/src/course/getSections.ts

@@ -1,9 +0,0 @@
-import {ICanvasCallConfig, renderAsyncGen} from "@canvas/canvasUtils";
-import {GetCoursesFromAccountOptions} from "@canvas/course/courseTypes";
-import {Course} from "@canvas/course/Course";
-import {ICourseData} from "@/types";
-import {sectionDataGenerator} from "@canvas/course/blueprint";
-
-export async function getSections(courseId: number, config?: ICanvasCallConfig<GetCoursesFromAccountOptions>) {
-    return (await renderAsyncGen(sectionDataGenerator(courseId, config))).map(section => new Course(section as ICourseData));
-}

package/src/course/getTermNameFromSections.ts

@@ -1,9 +0,0 @@
-import {Course} from "@canvas/course/Course";
-
-export async function getTermNameFromSections(sections: Course[]) {
-    const [section] = sections;
-    if (!section) throw new Error("Cannot determine term name by sections; there are no sections.")
-    const sectionTerm = await section.getTerm();
-    if (!sectionTerm) throw new Error("Section does not have associated term: " + section.name);
-    return sectionTerm.name;
-}

package/src/course/index.ts

@@ -1,12 +0,0 @@
-export * from './blueprint'
-export * from './toolbox'
-export * from './Course'
-
-export * from './courseTypes'
-export * from './getCourseIdFromUrl'
-export * from './getSections'
-export * from './getTermNameFromSections'
-export * from './IBlueprintCourse'
-export * from './modules'
-export * from './notABlueprintError'
-export * from './retireBlueprint'

package/src/course/migration/__mocks__/mockMigrationData.ts

@@ -1,39 +0,0 @@
-import {IMigrationData} from "../index";
-
-/**
- * From canvas api docs
- */
-export const mockMigrationData: IMigrationData = {
-    // the unique identifier for the migration
-    "id": 370663,
-    // the type of content migration
-    "migration_type": "course_copy_importer",
-    // the name of the content migration type
-    "migration_type_title": "Canvas Cartridge Importer",
-    // API url to the content migration's issues
-    "migration_issues_url": "https://example.com/api/v1/courses/1/content_migrations/1/migration_issues",
-    // attachment api object for the uploaded file may not be present for all
-    // migrations
-    "attachment": {"url": "https://example.com/api/v1/courses/1/content_migrations/1/download_archive"},
-    // The api endpoint for polling the current progress
-    "progress_url": "https://example.com/api/v1/progress/4",
-    // The user who started the migration
-    "user_id": 4,
-    // Current state of the content migration: pre_processing, pre_processed,
-    // running, waiting_for_select, completed, failed
-    "workflow_state": "running",
-    // timestamp
-    "started_at": "2012-06-01T00:00:00-06:00",
-    // timestamp
-    "finished_at": "2012-06-01T00:00:00-06:00",
-    // file uploading data, see {file:file_uploads.html File Upload Documentation}
-    // for file upload workflow This works a little differently in that all the file
-    // data is in the pre_attachment hash if there is no upload_url then there was
-    // an attachment pre-processing error, the error message will be in the message
-    // key This data will only be here after a create or update call
-    "pre_attachment": {
-        upload_url: '',
-        "message": "file exceeded quota",
-        "upload_params": {}
-    }
-}