@openlearning/imscc-packager/dist/imscc/types.d.ts

Package JSON course structure into an IMSCC package

export type ResourceType = "webcontent" | "weblink" | "discussion" | "assessment";
export type ImsResourceType = "webcontent" | "imswl_xmlv1p1" | "imsdt_xmlv1p1" | "imsqti_xmlv1p2/imscc_xmlv1p1/assessment" | "associatedcontent/imscc_xmlv1p1/learning-application-resource";
export type LmsType = "canvas" | "moodle";
export type MattexType = "text/html" | "text/plain";
export type QtiQuestionType = "multiple_choice_question" | "matching_question" | "numerical_question" | "multiple_answers_question" | "short_answer_question" | "text_only_question";
export declare const IMS_RESOURCE_TYPES: {
    [ResourceType: string]: ImsResourceType;
};
export interface Answer {
    text: string;
    id?: string;
    feedback?: string;
}
export interface Choice extends Answer {
    isCorrect?: boolean;
}
export interface Match {
    pair: [Answer, Answer];
}
export interface Section {
    title: string;
    type: QtiQuestionType;
    question: string;
    point?: number;
    answers?: Answer[];
    choices?: Choice[];
    matches?: Match[];
}
export interface Attachment {
    blob?: Blob;
    base64?: string;
    placeholder: string;
    filename: string;
}
export interface Page {
    title: string;
    type: ResourceType;
    content: string | Section[];
    attachments?: Attachment[];
    description?: string;
}
export interface Module {
    title: string;
    pages: Page[];
}
export interface Course {
    title: string;
    description: string;
    language?: string;
    modules: Module[];
}
export interface Config {
    classes: {
        [className: string]: string;
    };
    cssMode: "inline-replace" | "inline-preserve" | "stylesheet-tag" | "stylesheet-link";
}
export interface ResourceAttachment extends Attachment {
    filePath: string;
}
export interface ResourcePage extends Page {
    id: string;
    filePath: string;
    content: string;
    dependencies?: string[];
    attachments?: ResourceAttachment[];
}
export interface ResourceModule extends Module {
    pages: ResourcePage[];
}