adapt-authoring-adaptframework 1.2.0 → 1.3.0

package/.github/workflows/releases.yml

@@ -3,10 +3,16 @@ on:
   push:
     branches:
       - master
+
 jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for trusted publishing and npm provenance
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -16,10 +22,11 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 'lts/*'
+      - name: Update npm
+        run: npm install -g npm@latest
       - name: Install dependencies
         run: npm ci
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.AAT_NPM_TOKEN }}
         run: npx semantic-release

package/lib/AdaptFrameworkBuild.js

@@ -71,10 +71,10 @@ class AdaptFrameworkBuild {
      */
     this.isExport = action === 'export'
     /**
-     * Whether the final output directory should be compressed (only applies to publish and export)
+     * Whether the final output directory should be compressed
      * @type {Boolean}
      */
-    this.compress = compress !== false
+    this.compress = compress ?? !this.isPreview
     /**
      * The _id of the course being build
      * @type {String}
@@ -221,8 +221,11 @@ class AdaptFrameworkBuild {
           .setData(e)
       }
     }
-    this.isPreview ? await this.createPreview() : await this.createZip()
-
+    if (this.compress) {
+      this.location = await this.prepareZip()
+    } else {
+      this.location = this.isPreview ? path.join(this.dir, 'build') : this.dir
+    }
     await this.postBuildHook.invoke(this)
     await framework.postBuildHook.invoke(this)
 
@@ -235,11 +238,9 @@ class AdaptFrameworkBuild {
    */
   async loadCourseData () {
     const content = await App.instance.waitForModule('content')
-    const [course] = await content.find({ _id: this.courseId, _type: 'course' })
-    if (!course) {
-      throw App.instance.errors.NOT_FOUND.setData({ type: 'course', id: this.courseId })
-    }
-    const langDir = path.join(this.courseDir, 'en')
+    const course = await content.findOne({ _id: this.courseId, _type: 'course' })
+    const config = await content.findOne({ _courseId: this.courseId, _type: 'config' })
+    const langDir = path.join(this.courseDir, course._language ?? config._defaultLanguage ?? 'en')
     this.courseData = {
       course: { dir: langDir, fileName: 'course.json', data: undefined },
       config: { dir: this.courseDir, fileName: 'config.json', data: undefined },
@@ -460,37 +461,21 @@ class AdaptFrameworkBuild {
       await this.ensureDir(dir)
       const filepath = path.join(dir, fileName)
       const returnData = await FWUtils.writeJson(filepath, data)
-      FWUtils.log('debug', 'WRITE', filepath)
+      FWUtils.log('verbose', 'WRITE', filepath)
       return returnData
     }))
   }
-
-  /**
-   * Makes sure the output folder is structured to allow the files to be served statically for previewing
-   * @return {Promise}
-   */
-  async createPreview () {
-    const tempName = `${this.dir}_temp`
-    await fs.rename(path.join(this.dir, 'build'), tempName)
-    await fs.rm(this.dir, { recursive: true })
-    await fs.rename(tempName, this.dir)
-    this.location = this.dir
-  }
-
+  
   /**
    * Creates a zip file containing all files relevant to the type of build being performed
    * @return {Promise}
    */
-  async createZip () {
+  async prepareZip () {
     const zipPath = path.join(this.dir, this.isPublish ? 'build' : '')
-    if (this.compress === false) {
-      this.location = zipPath
-      return
-    }
     const outputPath = `${this.dir}.zip`
     await zipper.zip(zipPath, outputPath, { removeSource: true })
     await fs.rm(this.dir, { recursive: true })
-    this.location = outputPath
+    return outputPath
   }
 
   /**

package/lib/AdaptFrameworkModule.js

@@ -2,7 +2,7 @@ import { AbstractModule, Hook } from 'adapt-authoring-core'
 import AdaptFrameworkBuild from './AdaptFrameworkBuild.js'
 import AdaptFrameworkImport from './AdaptFrameworkImport.js'
 import ApiDefs from './apidefs.js'
-import fs from 'fs-extra'
+import fs from 'fs/promises'
 import FWUtils from './AdaptFrameworkUtils.js'
 import path from 'path'
 import semver from 'semver'

package/lib/AdaptFrameworkUtils.js

@@ -65,23 +65,11 @@ class AdaptFrameworkUtils {
   static async readJson (filepath) {
     return JSON.parse(await fs.readFile(filepath))
   }
-
+  
   static writeJson (filepath, data) {
     return fs.writeFile(filepath, (JSON.stringify(data, null, 2)))
   }
-
-  static async exists (filepath) {
-    try {
-      await fs.stat(filepath)
-      return true
-    } catch (e) {
-      if (e.code === 'ENOENT') {
-        return false
-      }
-      throw e
-    }
-  }
-
+  
   /**
    * Infers the framework action to be executed from a given request URL
    * @param {external:ExpressRequest} req
@@ -229,24 +217,17 @@ class AdaptFrameworkUtils {
     }
     if (action === 'publish' || action === 'export') {
       res.set('content-disposition', `attachment; filename="${await AdaptFrameworkUtils.slugifyTitle(buildData)}.zip"`)
-      try {
-        return res.sendFile(path.resolve(buildData.location))
-      } catch (e) {
-        return next(e)
-      }
+      return res.sendFile(path.resolve(buildData.location), next)
     }
     if (action === 'preview') {
       if (!req.auth.user) {
         return res.status(App.instance.errors.MISSING_AUTH_HEADER.statusCode).end()
       }
       const filePath = path.resolve(buildData.location, req.path.slice(req.path.indexOf(id) + id.length + 1) || 'index.html')
-      try {
-        await AdaptFrameworkUtils.exists(filePath)
-          ? res.sendFile(filePath)
-          : next(App.instance.errors.NOT_FOUND.setData({ type: 'file', id: filePath }))
-      } catch (e) {
-        if (e.code === 'ENOENT') return next(e)
-      }
+      await res.sendFile(filePath, e => {
+        if (e.code === 'ENOENT') e = App.instance.errors.NOT_FOUND.setData({ type: 'file', id: filePath })
+        next(e)
+      })
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-adaptframework",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Adapt framework integration for the Adapt authoring tool",
   "homepage": "https://github.com/adapt-security/adapt-authoring-adaptframework",
   "license": "GPL-3.0",
@@ -25,15 +25,15 @@
     "zipper": "github:adapt-security/zipper#v1.0.0"
   },
   "devDependencies": {
-    "standard": "^17.1.0",
-    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/commit-analyzer": "^13.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^8.0.5",
-    "@semantic-release/npm": "^9.0.1",
-    "@semantic-release/release-notes-generator": "^10.0.3",
-    "conventional-changelog-eslint": "^3.0.9",
-    "semantic-release": "^21.0.1",
-    "semantic-release-replace-plugin": "^1.2.7"
+    "@semantic-release/github": "^12.0.2",
+    "@semantic-release/npm": "^13.1.2",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "conventional-changelog-eslint": "^6.0.0",
+    "semantic-release": "^25.0.2",
+    "semantic-release-replace-plugin": "^1.2.7",
+    "standard": "^17.1.0"
   },
   "release": {
     "plugins": [