adapt-authoring-adaptframework 1.6.0 → 1.7.0

package/lib/AdaptFrameworkBuild.js

@@ -40,6 +40,7 @@ class AdaptFrameworkBuild {
    * @property {String} courseId The course  to build
    * @property {String} userId The user executing the build
    * @property {String} expiresAt When the build expires
+   * @property {Boolean} compress Whether output files should be compressed into an archive file
    *
    * @constructor
    * @param {AdaptFrameworkBuildOptions} options

package/lib/AdaptFrameworkImport.js

@@ -4,6 +4,7 @@ import { glob } from 'glob'
 import octopus from 'adapt-octopus'
 import path from 'upath'
 import semver from 'semver'
+import { unzip } from 'zipper'
 
 import FWUtils from './AdaptFrameworkUtils.js'
 
@@ -61,7 +62,7 @@ class AdaptFrameworkImport {
   /**
    * Options to be passed to AdaptFrameworkBuild
    * @typedef {Object} AdaptFrameworkImportOptions
-   * @property {String} unzipPath Path to unzipped import
+   * @property {String} importPath Path to the import package
    * @property {String} userId Owner of the imported course
    * @property {String} language Language of course files to be imported (if not specified, _defaultLanguage will be used)
    * @property {Array<String>} assetFolders List of non-standard asset directories
@@ -75,124 +76,122 @@ class AdaptFrameworkImport {
    * @constructor
    * @param {AdaptFrameworkImportOptions} options
    */
-  constructor ({ unzipPath, userId, language, assetFolders, tags, isDryRun, importContent = true, importPlugins = true, migrateContent = true, updatePlugins = false, removeSource = true }) {
-    try {
-      if (!unzipPath || !userId) throw new Error()
-      /**
-       * Reference to the package.json data
-       * @type {Object}
-       */
-      this.pkg = undefined
-      /**
-       * Path that the import will be unzipped to
-       * @type {String}
-       */
-      this.unzipPath = unzipPath.replaceAll('\\', '/')
-      /**
-       * Language code for the langauge to import. Used for locating course content.
-       * @type {String}
-       */
-      this.language = language
-      /**
-       * List of asset folders to check
-       * @type {Array<String>}
-       */
-      this.assetFolders = assetFolders ?? ['assets']
-      /**
-       * List of asset metadata
-       * @type {Array}
-       */
-      this.assetData = []
-      /**
-       * List of tags to apply to the course
-       * @type {Array<String>}
-       */
-      this.tags = tags
-      /**
-       * Path to the import course folder
-       * @type {String}
-       */
-      this.coursePath = undefined
-      /**
-       * Path to the import course language folder
-       * @type {String}
-       */
-      this.langPath = undefined
-      /**
-       * A cache of the import's content JSON file data (note this is not the DB data used by the application)
-       * @type {Object}
-       */
-      this.contentJson = {
-        course: {},
-        contentObjects: []
-      }
-      /**
-       * Key/value store of the installed content plugins
-       * @type {Object}
-       */
-      this.usedContentPlugins = {}
-      /**
-       * All plugins installed during the import as a name -> metadata map
-       * @type {Object}
-       */
-      this.newContentPlugins = {}
-      /**
-       * Key/value store mapping old component keys to component names
-       * @type {Object}
-       */
-      this.componentNameMap = {}
-      /**
-       * A key/value map of asset file names to new asset ids
-       * @type {Object}
-       */
-      this.assetMap = {}
-      /**
-       * A key/value map of old ids to new ids
-       * @type {Object}
-       */
-      this.idMap = {}
-      /**
-       * The _id of the user initiating the import
-       * @type {String}
-       */
-      this.userId = userId
-      /**
-       * Contains non-fatal infomation messages regarding import status which can be return as response data. Fatal errors are thrown in the usual way.
-       * @type {Object}
-       */
-      this.statusReport = {
-        info: [],
-        warn: []
-      }
-      /**
-       * User-defined settings related to what is included with the import
-       * @type {Object}
-       */
-      this.settings = {
-        isDryRun,
-        importContent,
-        importPlugins,
-        migrateContent,
-        updatePlugins,
-        removeSource
-      }
-      /**
-       * Invoked before the import process has started
-       */
-      this.preImportHook = new Hook()
-      /**
-       * Invoked once the import process has completed
-       */
-      this.postImportHook = new Hook()
-
-      /**
-       * plugins on import that are of a lower version than the installed version
-       * @type {Array}
-       */
-      this.pluginsToMigrate = ['core']
-    } catch (e) {
-      throw App.instance.errors.FW_IMPORT_INVALID_COURSE
+  constructor ({ importPath, userId, language, assetFolders, tags, isDryRun, importContent = true, importPlugins = true, migrateContent = true, updatePlugins = false, removeSource = true }) {
+    const e = App.instance.errors.INVALID_PARAMS
+    if (!importPath) throw e.setData({ params: ['importPath'] })
+    if (!userId) throw e.INVALID_PARAMS.setData({ params: ['userId'] })
+    /**
+     * Reference to the package.json data
+     * @type {Object}
+     */
+    this.pkg = undefined
+    /**
+     * Path of the import package
+     * @type {String}
+     */
+    this.path = importPath.replaceAll('\\', '/')
+    /**
+     * Language code for the langauge to import. Used for locating course content.
+     * @type {String}
+     */
+    this.language = language
+    /**
+     * List of asset folders to check
+     * @type {Array<String>}
+     */
+    this.assetFolders = assetFolders ?? ['assets']
+    /**
+     * List of asset metadata
+     * @type {Array}
+     */
+    this.assetData = []
+    /**
+     * List of tags to apply to the course
+     * @type {Array<String>}
+     */
+    this.tags = tags
+    /**
+     * Path to the import course folder
+     * @type {String}
+     */
+    this.coursePath = undefined
+    /**
+     * Path to the import course language folder
+     * @type {String}
+     */
+    this.langPath = undefined
+    /**
+     * A cache of the import's content JSON file data (note this is not the DB data used by the application)
+     * @type {Object}
+     */
+    this.contentJson = {
+      course: {},
+      contentObjects: []
+    }
+    /**
+     * Key/value store of the installed content plugins
+     * @type {Object}
+     */
+    this.usedContentPlugins = {}
+    /**
+     * All plugins installed during the import as a name -> metadata map
+     * @type {Object}
+     */
+    this.newContentPlugins = {}
+    /**
+     * Key/value store mapping old component keys to component names
+     * @type {Object}
+     */
+    this.componentNameMap = {}
+    /**
+     * A key/value map of asset file names to new asset ids
+     * @type {Object}
+     */
+    this.assetMap = {}
+    /**
+     * A key/value map of old ids to new ids
+     * @type {Object}
+     */
+    this.idMap = {}
+    /**
+     * The _id of the user initiating the import
+     * @type {String}
+     */
+    this.userId = userId
+    /**
+     * Contains non-fatal infomation messages regarding import status which can be return as response data. Fatal errors are thrown in the usual way.
+     * @type {Object}
+     */
+    this.statusReport = {
+      info: [],
+      warn: []
     }
+    /**
+     * User-defined settings related to what is included with the import
+     * @type {Object}
+     */
+    this.settings = {
+      isDryRun,
+      importContent,
+      importPlugins,
+      migrateContent,
+      updatePlugins,
+      removeSource
+    }
+    /**
+     * Invoked before the import process has started
+     */
+    this.preImportHook = new Hook()
+    /**
+     * Invoked once the import process has completed
+     */
+    this.postImportHook = new Hook()
+
+    /**
+     * plugins on import that are of a lower version than the installed version
+     * @type {Array}
+     */
+    this.pluginsToMigrate = ['core']
   }
 
   /**
@@ -277,21 +276,24 @@ class AdaptFrameworkImport {
    * @return {Promise}
    */
   async prepare () {
+    if (this.path.endsWith('.zip')) {
+      this.path = await unzip(this.path, `${this.path}_unzip`, { removeSource: true })
+    }
     try { // if it's a nested zip, move everything up a level
-      const files = await fs.readdir(this.unzipPath)
+      const files = await fs.readdir(this.path)
       if (files.length === 1) {
-        const nestDir = `${this.unzipPath}/${files[0]}`
+        const nestDir = `${this.path}/${files[0]}`
         await fs.stat(`${nestDir}/package.json`)
-        const newDir = path.join(`${this.unzipPath}_2`)
+        const newDir = path.join(`${this.path}_2`)
         await fs.rename(nestDir, newDir)
-        await fs.rm(this.unzipPath, { recursive: true })
-        this.unzipPath = newDir
+        await fs.rm(this.path, { recursive: true })
+        this.path = newDir
       }
     } catch (e) {
       // nothing to do
     }
     // find and store the course data path
-    const courseDirs = await glob(`${this.unzipPath}/*/course`)
+    const courseDirs = await glob(`${this.path}/*/course`)
     if (courseDirs.length > 1) {
       this.framework.log('error', 'MULTIPLE_COURSE_DIRS', courseDirs)
       throw App.instance.errors.FW_IMPORT_INVALID_COURSE
@@ -305,16 +307,16 @@ class AdaptFrameworkImport {
       this.framework.log('error', e)
       throw App.instance.errors.FW_IMPORT_INVALID_COURSE
     }
-    FWUtils.logDir('unzipPath', this.unzipPath)
+    FWUtils.logDir('unzipPath', this.path)
     FWUtils.logDir('coursePath', this.coursePath)
 
     try {
-      /** @ignore */this.pkg = await FWUtils.readJson(`${this.unzipPath}/package.json`)
+      /** @ignore */this.pkg = await FWUtils.readJson(`${this.path}/package.json`)
     } catch (e) {
       throw App.instance.errors.FW_IMPORT_INVALID
     }
     try {
-      await fs.rm(`${this.unzipPath}/package-lock.json`)
+      await fs.rm(`${this.path}/package-lock.json`)
     } catch (e) {}
 
     if (!semver.satisfies(this.pkg.version, semver.major(this.framework.version).toString())) {
@@ -335,7 +337,7 @@ class AdaptFrameworkImport {
    */
   async convertSchemas () {
     return octopus.runRecursive({
-      cwd: this.unzipPath,
+      cwd: this.path,
       logger: { log: (...args) => FWUtils.log('debug', ...args) }
     })
   }
@@ -344,7 +346,7 @@ class AdaptFrameworkImport {
    * Writes the contents of 2-customStyles.less to course.json file. Unfortunately it's necessary to do it this way to ensure it's included in migrations.
    */
   async patchCustomStyle () {
-    const [customStylePath] = await glob('**/2-customStyles.less', { cwd: this.unzipPath, absolute: true })
+    const [customStylePath] = await glob('**/2-customStyles.less', { cwd: this.path, absolute: true })
     const courseJsonPath = `${this.langPath}/course.json`
     if (!customStylePath) {
       return
@@ -406,7 +408,7 @@ class AdaptFrameworkImport {
    * @return {Promise}
    */
   async loadPluginData () {
-    const usedPluginPaths = await glob(`${this.unzipPath}/src/+(components|extensions|menu|theme)/*`, { absolute: true })
+    const usedPluginPaths = await glob(`${this.path}/src/+(components|extensions|menu|theme)/*`, { absolute: true })
     const getPluginType = pluginData => {
       for (const type of ['component', 'extension', 'menu', 'theme']) {
         if (pluginData[type] !== undefined) return type
@@ -802,7 +804,7 @@ class AdaptFrameworkImport {
     }
     try {
       const tasks = [
-        fs.rm(this.unzipPath, { recursive: true })
+        fs.rm(this.path, { recursive: true })
       ]
       if (error) {
         tasks.push(

package/lib/AdaptFrameworkModule.js

@@ -6,7 +6,6 @@ import fs from 'fs/promises'
 import FWUtils from './AdaptFrameworkUtils.js'
 import path from 'path'
 import semver from 'semver'
-import { unzip } from 'zipper'
 
 /**
  * Module to handle the interface with the Adapt framework
@@ -320,11 +319,6 @@ class AdaptFrameworkModule extends AbstractModule {
    * @return {AdaptFrameworkImportSummary}
    */
   async importCourse (options) {
-    let unzipPath = options.importPath
-    if (options.importPath.endsWith('.zip')) {
-      unzipPath = `${options.importPath}_unzip`
-      await unzip(options.importPath, unzipPath, { removeSource: true })
-    }
     const importer = await AdaptFrameworkImport.run(options)
     importer.preImportHook.tap(() => this.preImportHook.invoke(importer))
     importer.postImportHook.tap(() => this.postImportHook.invoke(importer))

package/lib/AdaptFrameworkUtils.js

@@ -270,14 +270,14 @@ class AdaptFrameworkUtils {
    */
   static async importHandler (req, res, next) {
     try {
-      let unzipPath = req.body.unzipPath
+      let importPath = req.body.importPath
       if (req.get('Content-Type').indexOf('multipart/form-data') === 0) {
         await AdaptFrameworkUtils.handleImportFile(req, res)
         const [course] = req.fileUpload.files.course
-        unzipPath = course.filepath
+        importPath = course.filepath
       }
       const importer = await FrameworkImport.run({
-        unzipPath,
+        importPath,
         userId: req.auth.user._id.toString(),
         isDryRun: AdaptFrameworkUtils.toBoolean(req.body.dryRun),
         assetFolders: req.body.formAssetFolders,

package/lib/apidefs.js

@@ -54,6 +54,7 @@ export default {
               $schema: 'https://json-schema.org/draft/2020-12/schema',
               type: 'object',
               properties: {
+                path: { type: 'String' },
                 isDryRun: { type: 'Boolean', default: false },
                 importContent: { type: 'Boolean', default: true },
                 importPlugins: { type: 'Boolean', default: true },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-adaptframework",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Adapt framework integration for the Adapt authoring tool",
   "homepage": "https://github.com/adapt-security/adapt-authoring-adaptframework",
   "license": "GPL-3.0",