UNPKG

@openlearning/imscc-packager

Version:

Package JSON course structure into an IMSCC package

26 lines (25 loc) 1.56 kB
import { Config, Course, Page } from './types'; import { Version } from './coursePackager/versions'; export { packageCourse } from './coursePackager/packager'; export { packageQuizContent } from './contentPackager/packager'; export { packageMoodleQuizContent } from './contentPackager/moodle/packager'; export { packageCanvasQuizContent } from './contentPackager/canvas/packager'; /** * Generates an IMS Common Cartridge (IMSCC) package for the given course. * * @param {Course} course - The course object containing the content to be packaged. * @param {string} [generatorComment] - An optional comment to include in the package metadata. * @param {Version} [version] - An optional version of the IMSCC to generate. * @param {Config} [options] - Optional configuration settings for the packaging process. * @returns {Promise<Blob>} - A promise that resolves to a Blob representing the packaged course content. */ export declare const generateImscc: (course: Course, generatorComment?: string, version?: Version, options?: Config) => Promise<Blob>; /** * Generates an IMS Content Package (IMSCP) for the given page and description. * * @param {Page} page - The page object containing the content to be packaged. * @param {string} packageTitle - The title for the content being packaged. * @returns {Promise<Blob>} - A promise that resolves to a Blob representing the packaged content. * @throws {Error} - Throws an error if the page type is unsupported. */ export declare const generateImscp: (page: Page, packageTitle: string) => Promise<Blob>;