adapt-authoring-adaptframework 1.4.0 → 1.5.0

package/lib/AdaptFrameworkBuild.js

@@ -198,7 +198,6 @@ class AdaptFrameworkBuild {
       this.copySource()
     ])
     await this.preBuildHook.invoke(this)
-    await framework.preBuildHook.invoke(this)
 
     await this.writeContentJson()
 
@@ -227,7 +226,6 @@ class AdaptFrameworkBuild {
       this.location = this.isPreview ? path.join(this.dir, 'build') : this.dir
     }
     await this.postBuildHook.invoke(this)
-    await framework.postBuildHook.invoke(this)
 
     this.buildData = await this.recordBuildAttempt()
   }

package/lib/AdaptFrameworkImport.js

@@ -1,4 +1,4 @@
-import { App } from 'adapt-authoring-core'
+import { App, Hook } from 'adapt-authoring-core'
 import fs from 'fs/promises'
 import { glob } from 'glob'
 import octopus from 'adapt-octopus'
@@ -70,7 +70,7 @@ class AdaptFrameworkImport {
    * @constructor
    * @param {AdaptFrameworkImportOptions} options
    */
-  constructor ({ unzipPath, userId, assetFolders, tags, isDryRun, importContent = true, importPlugins = true, migrateContent = true, updatePlugins = false }) {
+  constructor ({ unzipPath, userId, assetFolders, tags, isDryRun, importContent = true, importPlugins = true, migrateContent = true, updatePlugins = false, removeSource = true }) {
     try {
       if (!unzipPath || !userId) throw new Error()
       /**
@@ -163,8 +163,17 @@ class AdaptFrameworkImport {
         importContent,
         importPlugins,
         migrateContent,
-        updatePlugins
+        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
@@ -231,6 +240,7 @@ class AdaptFrameworkImport {
         [this.prepare],
         [this.loadAssetData],
         [this.loadPluginData],
+        [() => this.preImportHook.invoke(this), true],
         [this.importTags, importContent],
         [this.importCourseAssets, importContent],
         [this.importCoursePlugins, isDryRun && importPlugins],
@@ -243,6 +253,7 @@ class AdaptFrameworkImport {
       for (const [func, test] of tasks) {
         if (test === true || test === undefined) await func.call(this)
       }
+      await this.postImportHook.invoke(this)
     } catch (e) {
       error = e
     }
@@ -764,7 +775,7 @@ class AdaptFrameworkImport {
         data[key].forEach(d => this.extractAssets(val.items.properties, d))
       } else if (val?._backboneForms?.type === 'Asset' || val?._backboneForms === 'Asset') {
         data[key] !== ''
-          ? data[key] = this.assetMap[data[key]]
+          ? data[key] = this.assetMap[data[key]] ?? data[key]
           : delete data[key]
       }
     })
@@ -776,6 +787,9 @@ class AdaptFrameworkImport {
    * @return {Promise}
    */
   async cleanUp (error) {
+    if (!this.settings.removeSource) {
+      return
+    }
     try {
       const tasks = [
         fs.rm(this.unzipPath, { recursive: true })

package/lib/AdaptFrameworkModule.js

@@ -32,6 +32,16 @@ class AdaptFrameworkModule extends AbstractModule {
      */
     this.postUpdateHook = new Hook()
 
+    /**
+     * Invoked prior to a course being imported. The AdaptFrameworkImport instance is passed to any observers.
+     * @type {Hook}
+     */
+    this.preImportHook = new Hook({ mutable: true })
+    /**
+     * Invoked after a course has been imported. The AdaptFrameworkImport instance is passed to any observers.
+     * @type {Hook}
+     */
+    this.postImportHook = new Hook()
     /**
      * Invoked prior to a course being built. The AdaptFrameworkBuild instance is passed to any observers.
      * @type {Hook}
@@ -299,22 +309,25 @@ class AdaptFrameworkModule extends AbstractModule {
    * @return {AdaptFrameworkBuild}
    */
   async buildCourse (options) {
-    return AdaptFrameworkBuild.run(options)
+    const builder = AdaptFrameworkBuild.run(options)
+    builder.preBuildHook.tap(() => this.preBuildHook.invoke(builder))
+    builder.postBuildHook.tap(() => this.postBuildHook.invoke(builder))
   }
 
   /**
    * Imports a single Adapt framework course
-   * @param {String} importPath Path to the course import
-   * @param {String} userId _id of the new owner of the imported course
+   * @param {AdaptFrameworkImportOptions} options
    * @return {AdaptFrameworkImportSummary}
    */
-  async importCourse (importPath, userId) {
-    let unzipPath = importPath
-    if (importPath.endsWith('.zip')) {
-      unzipPath = `${importPath}_unzip`
-      await unzip(importPath, unzipPath, { removeSource: true })
+  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({ unzipPath, userId })
+    const importer = await AdaptFrameworkImport.run(options)
+    importer.preImportHook.tap(() => this.preImportHook.invoke(importer))
+    importer.postImportHook.tap(() => this.postImportHook.invoke(importer))
     return await FWUtils.getImportSummary(importer)
   }
 }

package/package.json

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