qus-canvas/src/enrollment-terms/factories/enrollment-terms.factory.ts

client api for canvas

/*
 * MIT License
 * 
 * Copyright (c) 2024 Quantum Unit Solutions
 * Author: David Meikle
 * 
 * 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.
 */
import {CanvasHttpConnector} from "../../http/connections/canvas-http.connector";
import {EnrollmentTermInterface} from "../dtos/enrollment-term.interface";
import {Endpoints} from "../config/endpoints";
import {HttpResponse} from "node-http-connector";
import {toCamelCase} from "../../utils/case.converter";
import {CanvasObjectNotFoundError} from "../../exceptions/canvas-object-not-found.error";
import {AssignmentInterface} from "../../assignments/dtos/assignment.interface";

export class EnrollmentTermsFactory {

    constructor(protected readonly connector: CanvasHttpConnector,
                protected version: string,
                protected accountId: string) {
    }

    /**
     * List enrollment terms
     *
     * @param page
     * @param size
     */
    async listEnrollmentTerms(page: number, size: number): Promise<EnrollmentTermInterface[]> {
        const endpoint: string = new Endpoints().LIST_ENROLLMENT_TERMS
            .replace(':version', this.version)
            .replace(':account_id', this.accountId)
            .replace(':page', page.toString())
            .replace(':size', size.toString());

        const response: HttpResponse<any> | undefined = await this.connector.get(endpoint);
        if (response) {
            const enrollmentTerms: any = toCamelCase(response.data);

            // this endpoint is NOT an array, so we need to extract it into one;
            const termPromises = enrollmentTerms.enrollmentTerms.map(async (term: any) => ({
                ...term,
                id: '', // let the user generate their own local GUID
                enrollmentTermNumber: term.id // Map API id to termId
            }));

            return await Promise.all(termPromises);
        }
        return [];
    }

    /**
     * Get an enrollment term
     *
     * @param id
     */
    async getEnrollmentTerm(id: string): Promise<EnrollmentTermInterface> {
        const endpoint: string = new Endpoints().GET_ENROLLMENT_TERM
            .replace(':version', this.version)
            .replace(':account_id', this.accountId)
            .replace(':id', id);

        const response: HttpResponse<any> | undefined = await this.connector.get(endpoint);
        if (response) {
            const enrollmentTerm: any = toCamelCase(response.data);
            return {
                ...enrollmentTerm,
                id:'', // Let user generate local GUID
                enrollmentTermNumber: enrollmentTerm.id // Map API id to EnrollmentTerm
            };
        }

        throw new CanvasObjectNotFoundError(id);
    }

}