adapt-authoring-ui 1.9.1 → 2.0.0

package/lib/JavaScriptTask.js

@@ -1,3 +1,4 @@
+import { escapeRegExp } from 'adapt-authoring-core'
 import CacheManager from './CacheManager.js'
 import path from 'upath'
 import fs from 'fs-extra'
@@ -71,10 +72,6 @@ export default class JavaScriptTask {
     if (this.isDisableCache) this.log('info', 'Cache disabled')
   }
 
-  escapeRegExp (string) {
-    return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&') // $& means the whole matched string
-  }
-
   async restoreCache (cachePath, basePath) {
     if (this.isFirstRun || this.isDisableCache || this.cache || !fs.existsSync(cachePath)) return
     await new Promise((resolve, reject) => {
@@ -131,7 +128,7 @@ export default class JavaScriptTask {
     await new Promise((resolve, reject) => {
       let str = JSON.stringify(bundleCache)
       // Make cache location agnostic by stripping current basePath
-      str = str.replace(new RegExp(this.escapeRegExp(basePath), 'g'), '%%basePath%%')
+      str = str.replace(new RegExp(escapeRegExp(basePath), 'g'), '%%basePath%%')
       deflate(str, { level: constants.Z_BEST_SPEED }, (err, buffer) => {
         if (err) {
           this.log('error', 'An error occurred saving rollup cache:', err)

package/lib/UiBuild.js

@@ -7,6 +7,7 @@ import less from 'less'
 import { Gaze } from 'gaze'
 import chalk from 'chalk'
 import JavaScriptTask from './JavaScriptTask.js'
+import { collate } from './utils/collate.js'
 
 class UiBuild {
   constructor ({ app, log, isDev, buildDir, enableWatch, uiPlugins }) {
@@ -63,16 +64,6 @@ class UiBuild {
     this.jsTask = new JavaScriptTask(this.Paths.Output, this.log, this.uiPlugins, path.join(this.app.getConfig('tempDir'), 'ui-build-cache'))
   }
 
-  collate (collateAtFolderName, destFolder, srcFileName) {
-    // ignore if the srcFileName ends with the collateAtFolderName
-    const nameParts = srcFileName.split('/')
-    if (nameParts[nameParts.length - 1] === collateAtFolderName) {
-      return destFolder
-    }
-    const startOfCollatePath = srcFileName.indexOf(collateAtFolderName) + collateAtFolderName.length + 1
-    return path.join(destFolder, srcFileName.substr(startOfCollatePath))
-  }
-
   logCopy (event, dest, src) {
     this.log('verbose', `file ${event} ${chalk.cyan(src)} => ${chalk.green(dest)}`)
   }
@@ -226,7 +217,7 @@ class UiBuild {
       }
       try {
         const src = path.normalize(filepath)
-        const dest = this.collate(type, dir, src)
+        const dest = collate(type, dir, src)
         await fs.cp(src, dest)
         this.logCopy(event, dest, src)
       } catch (e) {

package/lib/utils/collate.js

@@ -0,0 +1,21 @@
+import path from 'upath'
+
+/**
+ * Determines the output file path when collating files by folder name.
+ * Returns destFolder if srcFileName ends with collateAtFolderName,
+ * otherwise joins destFolder with the portion of srcFileName after the folder name.
+ * @param {string} collateAtFolderName The folder name to collate at
+ * @param {string} destFolder The destination folder path
+ * @param {string} srcFileName The source file path
+ * @returns {string} The resolved output path
+ * @memberof ui
+ */
+export function collate (collateAtFolderName, destFolder, srcFileName) {
+  // ignore if the srcFileName ends with the collateAtFolderName
+  const nameParts = srcFileName.split('/')
+  if (nameParts[nameParts.length - 1] === collateAtFolderName) {
+    return destFolder
+  }
+  const startOfCollatePath = srcFileName.indexOf(collateAtFolderName) + collateAtFolderName.length + 1
+  return path.join(destFolder, srcFileName.substr(startOfCollatePath))
+}

package/lib/utils.js

@@ -0,0 +1 @@
+export { collate } from './utils/collate.js'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-ui",
-  "version": "1.9.1",
+  "version": "2.0.0",
   "description": "Front-end application for the Adapt authoring tool",
   "homepage": "https://github.com/adapt-security/adapt-authoring-ui",
   "license": "GPL-3.0",
@@ -21,7 +21,7 @@
     "@rollup/plugin-commonjs": "^29.0.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^0.4.0",
-    "adapt-authoring-core": "^1.7.0",
+    "adapt-authoring-core": "^2.0.0",
     "babel-plugin-transform-amd-to-es6": "^1.0.2",
     "cpy": "^13.0.0",
     "fs-extra": "^11.2.0",
@@ -37,8 +37,8 @@
     "upath": "^2.0.1"
   },
   "peerDependencies": {
-    "adapt-authoring-adaptframework": "^1.9.4",
-    "adapt-authoring-server": "^1.2.1"
+    "adapt-authoring-adaptframework": "^2.0.0",
+    "adapt-authoring-server": "^2.0.0"
   },
   "peerDependenciesMeta": {
     "adapt-authoring-adaptframework": {

package/tests/utils-collate.spec.js

@@ -0,0 +1,53 @@
+import { describe, it } from 'node:test'
+import assert from 'node:assert/strict'
+import { collate } from '../lib/utils/collate.js'
+
+describe('collate()', () => {
+  it('should return destFolder when srcFileName ends with collateAtFolderName', () => {
+    const result = collate('assets', '/output/css/assets', 'some/path/assets')
+    assert.equal(result, '/output/css/assets')
+  })
+
+  it('should join destFolder with path after collateAtFolderName', () => {
+    const result = collate('assets', '/output/css/assets', 'node_modules/plugin/assets/image.png')
+    assert.equal(result, '/output/css/assets/image.png')
+  })
+
+  it('should handle nested paths after collateAtFolderName', () => {
+    const result = collate('assets', '/output/css/assets', 'node_modules/plugin/assets/fonts/bold.woff')
+    assert.equal(result, '/output/css/assets/fonts/bold.woff')
+  })
+
+  it('should handle libraries folder type', () => {
+    const result = collate('libraries', '/output/libraries', 'node_modules/adapt-authoring-ui/app/libraries/jquery.js')
+    assert.equal(result, '/output/libraries/jquery.js')
+  })
+
+  it('should handle required folder type', () => {
+    const result = collate('required', '/output', 'node_modules/adapt-authoring-ui/app/core/required/config.json')
+    assert.equal(result, '/output/config.json')
+  })
+
+  it('should handle srcFileName that exactly matches collateAtFolderName', () => {
+    const result = collate('assets', '/dest', 'assets')
+    assert.equal(result, '/dest')
+  })
+
+  it('should handle multiple occurrences of collateAtFolderName (uses first)', () => {
+    const result = collate('assets', '/dest', 'path/assets/sub/assets/file.png')
+    assert.equal(result, '/dest/sub/assets/file.png')
+  })
+
+  it('should handle paths with no content after collateAtFolderName marker', () => {
+    const result = collate('assets', '/dest', 'some/path/assets/')
+    // srcFileName ends with '/' not 'assets', so it enters the path calculation
+    // indexOf('assets') + 'assets'.length + 1 = past the slash, substr returns empty string
+    const expected = '/dest'
+    assert.equal(result, expected)
+  })
+
+  it('should return a string', () => {
+    const result = collate('assets', '/output', 'some/assets/file.txt')
+    assert.equal(typeof result, 'string')
+  })
+})