adapt-authoring-adaptframework 2.0.10 → 2.1.0

package/lib/AdaptFrameworkBuild.js

@@ -1,10 +1,10 @@
 import _ from 'lodash'
 import { App, Hook, ensureDir, writeJson } from 'adapt-authoring-core'
 import { parseObjectId } from 'adapt-authoring-mongodb'
-import { createWriteStream } from 'fs'
+import { createWriteStream } from 'node:fs'
 import AdaptCli from 'adapt-cli'
 import { log, logDir, logMemory, copyFrameworkSource } from './utils.js'
-import fs from 'fs/promises'
+import fs from 'node:fs/promises'
 import path from 'upath'
 import semver from 'semver'
 import zipper from 'zipper'

package/lib/AdaptFrameworkImport.js

@@ -1,6 +1,6 @@
 import { App, Hook, spawn, readJson, writeJson } from 'adapt-authoring-core'
 import { parseObjectId } from 'adapt-authoring-mongodb'
-import fs from 'fs/promises'
+import fs from 'node:fs/promises'
 import { glob } from 'glob'
 import octopus from 'adapt-octopus'
 import path from 'upath'
@@ -630,7 +630,8 @@ class AdaptFrameworkImport {
 
     let managedPluginUpdateBlocked = false
     Object.keys(this.usedContentPlugins).forEach(p => {
-      const installedP = this.installedPlugins[p]
+      const { name: pluginName } = this.usedContentPlugins[p]
+      const installedP = this.installedPlugins[pluginName]
       let { version: importVersion } = this.usedContentPlugins[p]
       if (!semver.valid(importVersion)) {
         if (!installedP) {
@@ -677,8 +678,9 @@ class AdaptFrameworkImport {
       // pre-process: store update metadata and fix missing targetAttributes
       for (const p of allPlugins) {
         const isUpdate = pluginsToUpdate.includes(p)
-        if (isUpdate && this.installedPlugins[p]) {
-          this.updatedContentPlugins[p] = this.installedPlugins[p]
+        const { name: pName } = this.usedContentPlugins[p]
+        if (isUpdate && this.installedPlugins[pName]) {
+          this.updatedContentPlugins[p] = this.installedPlugins[pName]
         }
         const pluginBowerPath = path.join(this.usedContentPlugins[p].path, 'bower.json')
         const bowerJson = await readJson(pluginBowerPath)

package/lib/AdaptFrameworkModule.js

@@ -1,11 +1,11 @@
 import { AbstractModule, Hook, readJson } from 'adapt-authoring-core'
 import AdaptFrameworkBuild from './AdaptFrameworkBuild.js'
 import AdaptFrameworkImport from './AdaptFrameworkImport.js'
-import ApiDefs from './apidefs.js'
-import fs from 'fs/promises'
+import fs from 'node:fs/promises'
 import { getHandler, postHandler, importHandler, postUpdateHandler, getUpdateHandler } from './handlers.js'
+import { loadRouteConfig } from 'adapt-authoring-server'
 import { runCliCommand } from './utils.js'
-import path from 'path'
+import path from 'node:path'
 import semver from 'semver'
 
 /**
@@ -229,44 +229,16 @@ class AdaptFrameworkModule extends AbstractModule {
      * Router for handling all API calls
      * @type {Router}
      */
-    this.apiRouter = server.api.createChildRouter('adapt')
-    this.apiRouter.addRoute(
-      {
-        route: '/preview/:id',
-        handlers: { post: postHandler },
-        meta: ApiDefs.preview
-      },
-      {
-        route: '/publish/:id',
-        handlers: { post: postHandler, get: getHandler },
-        meta: ApiDefs.publish
-      },
-      {
-        route: '/import',
-        handlers: { post: [importHandler] },
-        meta: ApiDefs.import
-      },
-      {
-        route: '/export/:id',
-        handlers: { post: postHandler, get: getHandler },
-        meta: ApiDefs.export
+    const config = await loadRouteConfig(this.rootDir, this, {
+      handlerAliases: { getHandler, postHandler, importHandler, postUpdateHandler, getUpdateHandler }
+    })
+    this.apiRouter = server.api.createChildRouter(config.root)
+    for (const r of config.routes) {
+      this.apiRouter.addRoute(r)
+      if (!r.permissions) continue
+      for (const [method, perms] of Object.entries(r.permissions)) {
+        auth.secureRoute(`${this.apiRouter.path}${r.route}`, method, perms)
       }
-    )
-    auth.secureRoute(`${this.apiRouter.path}/preview/:id`, 'post', ['preview:adapt'])
-    auth.secureRoute(`${this.apiRouter.path}/publish/:id`, 'get', ['publish:adapt'])
-    auth.secureRoute(`${this.apiRouter.path}/publish/:id`, 'post', ['publish:adapt'])
-    auth.secureRoute(`${this.apiRouter.path}/import`, 'post', ['import:adapt'])
-    auth.secureRoute(`${this.apiRouter.path}/export/:id`, 'get', ['export:adapt'])
-    auth.secureRoute(`${this.apiRouter.path}/export/:id`, 'post', ['export:adapt'])
-    auth.secureRoute(`${this.apiRouter.path}/update`, 'post', ['update:adapt'])
-
-    if (this.getConfig('enableUpdateApi')) {
-      this.apiRouter.addRoute({
-        route: '/update',
-        handlers: { post: postUpdateHandler, get: getUpdateHandler },
-        meta: ApiDefs.update
-      })
-      auth.secureRoute(`${this.apiRouter.path}/update`, 'get', ['update:adapt'])
     }
   }
 

package/lib/handlers.js

@@ -127,8 +127,11 @@ export async function importHandler (req, res, next) {
  */
 export async function postUpdateHandler (req, res, next) {
   try {
-    log('info', 'running framework update')
     const framework = await App.instance.waitForModule('adaptframework')
+    if (!framework.getConfig('enableUpdateApi')) {
+      return next(App.instance.errors.NOT_FOUND.setData({ type: 'route', id: req.originalUrl }))
+    }
+    log('info', 'running framework update')
     const previousVersion = framework.version
     await framework.updateFramework(req.body.version)
     const currentVersion = framework.version !== previousVersion ? framework.version : undefined
@@ -151,6 +154,9 @@ export async function postUpdateHandler (req, res, next) {
 export async function getUpdateHandler (req, res, next) {
   try {
     const framework = await App.instance.waitForModule('adaptframework')
+    if (!framework.getConfig('enableUpdateApi')) {
+      return next(App.instance.errors.NOT_FOUND.setData({ type: 'route', id: req.originalUrl }))
+    }
     const current = framework.version
     const latest = await framework.getLatestVersion()
     res.json({

package/lib/utils/copyFrameworkSource.js

@@ -1,5 +1,5 @@
 import { App } from 'adapt-authoring-core'
-import fs from 'fs/promises'
+import fs from 'node:fs/promises'
 import path from 'upath'
 
 /**

package/lib/utils/log.js

@@ -1,6 +1,6 @@
 import { App } from 'adapt-authoring-core'
 import bytes from 'bytes'
-import fsSync from 'fs'
+import fsSync from 'node:fs'
 import path from 'upath'
 
 let fw

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-adaptframework",
-  "version": "2.0.10",
+  "version": "2.1.0",
   "description": "Adapt framework integration for the Adapt authoring tool",
   "homepage": "https://github.com/adapt-security/adapt-authoring-adaptframework",
   "license": "GPL-3.0",
@@ -34,7 +34,7 @@
     "adapt-authoring-auth": "^2.0.0",
     "adapt-authoring-jsonschema": "^1.1.5",
     "adapt-authoring-middleware": "^1.0.1",
-    "adapt-authoring-server": "^2.0.0",
+    "adapt-authoring-server": "^2.1.0",
     "adapt-authoring-tags": "^1.0.1"
   },
   "devDependencies": {

package/routes.json

@@ -0,0 +1,216 @@
+{
+  "root": "adapt",
+  "routes": [
+    {
+      "route": "/preview/:id",
+      "handlers": { "post": "postHandler" },
+      "permissions": { "post": ["preview:adapt"] },
+      "meta": {
+        "post": {
+          "summary": "Build a preview of an Adapt course",
+          "responses": {
+            "200": {
+              "description": "The Adapt build data",
+              "content": {
+                "application/json": {
+                  "schema": { "$ref": "#components/schemas/adaptbuild" }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "route": "/publish/:id",
+      "handlers": { "post": "postHandler", "get": "getHandler" },
+      "permissions": { "post": ["publish:adapt"], "get": ["publish:adapt"] },
+      "meta": {
+        "post": {
+          "summary": "Create a publish zip of an Adapt course",
+          "responses": {
+            "200": {
+              "description": "The Adapt build data",
+              "content": {
+                "application/json": {
+                  "schema": { "$ref": "#components/schemas/adaptbuild" }
+                }
+              }
+            }
+          }
+        },
+        "get": {
+          "summary": "Retrieve an Adapt course publish zip",
+          "responses": {
+            "200": {
+              "description": "Course build zip file",
+              "content": { "application/zip": {} }
+            }
+          }
+        }
+      }
+    },
+    {
+      "route": "/import",
+      "handlers": { "post": "importHandler" },
+      "permissions": { "post": ["import:adapt"] },
+      "meta": {
+        "post": {
+          "summary": "Import an Adapt course",
+          "requestBody": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$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 },
+                    "updatePlugins": { "type": "Boolean", "default": false }
+                  }
+                }
+              }
+            }
+          },
+          "responses": {
+            "200": {
+              "description": "",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "properties": {
+                      "title": { "type": "string" },
+                      "courseId": { "type": "string" },
+                      "versions": { "type": "object" },
+                      "content": {
+                        "type": "object",
+                        "properties": {
+                          "course": { "type": "number" },
+                          "config": { "type": "number" },
+                          "menu": { "type": "number" },
+                          "page": { "type": "number" },
+                          "article": { "type": "number" },
+                          "block": { "type": "number" },
+                          "component": { "type": "number" }
+                        }
+                      },
+                      "statusReport": {
+                        "type": "object",
+                        "properties": {
+                          "error": {
+                            "type": "array",
+                            "items": {
+                              "type": "object",
+                              "properties": {
+                                "code": { "type": "string" },
+                                "data": { "type": "string" }
+                              }
+                            }
+                          },
+                          "warn": {
+                            "type": "array",
+                            "items": {
+                              "type": "object",
+                              "properties": {
+                                "code": { "type": "string" },
+                                "data": { "type": "string" }
+                              }
+                            }
+                          },
+                          "info": {
+                            "type": "array",
+                            "items": {
+                              "type": "object",
+                              "properties": {
+                                "code": { "type": "string" },
+                                "data": { "type": "string" }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "route": "/export/:id",
+      "handlers": { "post": "postHandler", "get": "getHandler" },
+      "permissions": { "post": ["export:adapt"], "get": ["export:adapt"] },
+      "meta": {
+        "post": {
+          "summary": "Create an export zip of an Adapt course",
+          "responses": {
+            "200": {
+              "description": "The Adapt build data",
+              "content": {
+                "application/json": {
+                  "schema": { "$ref": "#components/schemas/adaptbuild" }
+                }
+              }
+            }
+          }
+        },
+        "get": {
+          "summary": "Retrieve an Adapt course export zip",
+          "responses": {
+            "200": {
+              "description": "Course build zip file",
+              "content": { "application/zip": {} }
+            }
+          }
+        }
+      }
+    },
+    {
+      "route": "/update",
+      "handlers": { "post": "postUpdateHandler", "get": "getUpdateHandler" },
+      "permissions": { "post": ["update:adapt"], "get": ["update:adapt"] },
+      "meta": {
+        "post": {
+          "summary": "Updates the installed framework",
+          "responses": {
+            "200": {
+              "description": "Describes the upgraded elements",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "properties": {
+                      "from": { "type": "string" },
+                      "to": { "type": "string" }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "get": {
+          "summary": "Retrieve framework update data",
+          "responses": {
+            "200": {
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "properties": {
+                      "canBeUpdated": { "type": "boolean" },
+                      "currentVersion": { "type": "string" },
+                      "latestCompatibleVersion": { "type": "string" }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

package/tests/AdaptFrameworkImport.spec.js

@@ -337,7 +337,6 @@ describe('AdaptFrameworkImport', () => {
 
   describe('#cleanUp()', () => {
     const cleanUp = AdaptFrameworkImport.prototype.cleanUp
-    const rollback = AdaptFrameworkImport.prototype.rollback
 
     it('should call rollback when an error is passed', async () => {
       let rollbackCalled = false

package/lib/apidefs.js

@@ -1,153 +0,0 @@
-const responseDataMeta = {
-  200: {
-    description: 'The Adapt build data',
-    content: {
-      'application/json': {
-        schema: { $ref: '#components/schemas/adaptbuild' }
-      }
-    }
-  }
-}
-
-const responseZipMeta = {
-  200: {
-    description: 'Course build zip file',
-    content: { 'application/zip': {} }
-  }
-}
-
-const statusReportItemSchema = {
-  type: 'array',
-  items: {
-    type: 'object',
-    properties: {
-      code: { type: 'string' },
-      data: { type: 'string' }
-    }
-  }
-}
-
-export default {
-  preview: {
-    post: {
-      summary: 'Build a preview of an Adapt course',
-      responses: responseDataMeta
-    }
-  },
-  publish: {
-    post: {
-      summary: 'Create a publish zip of an Adapt course',
-      responses: responseDataMeta
-    },
-    get: {
-      summary: 'Retrieve an Adapt course publish zip',
-      responses: responseZipMeta
-    }
-  },
-  import: {
-    post: {
-      summary: 'Import an Adapt course',
-      requestBody: {
-        content: {
-          'application/json': {
-            schema: {
-              $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 },
-                updatePlugins: { type: 'Boolean', default: false }
-              }
-            }
-          }
-        }
-      },
-      responses: {
-        200: {
-          description: '',
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
-                  title: { type: 'string' },
-                  courseId: { type: 'string' },
-                  versions: { type: 'object' },
-                  content: {
-                    type: 'object',
-                    properties: {
-                      course: { type: 'number' },
-                      config: { type: 'number' },
-                      menu: { type: 'number' },
-                      page: { type: 'number' },
-                      article: { type: 'number' },
-                      block: { type: 'number' },
-                      component: { type: 'number' }
-                    }
-                  },
-                  statusReport: {
-                    type: 'object',
-                    properties: {
-                      error: statusReportItemSchema,
-                      warn: statusReportItemSchema,
-                      info: statusReportItemSchema
-                    }
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  },
-  export: {
-    post: {
-      summary: 'Create an export zip of an Adapt course',
-      responses: responseDataMeta
-    },
-    get: {
-      summary: 'Retrieve an Adapt course export zip',
-      responses: responseZipMeta
-    }
-  },
-  update: {
-    post: {
-      summary: 'Updates the installed framework',
-      responses: {
-        200: {
-          description: 'Describes the upgraded elements',
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
-                  from: { type: 'string' },
-                  to: { type: 'string' }
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    get: {
-      summary: 'Retrieve framework update data',
-      responses: {
-        200: {
-          content: {
-            'application/json': {
-              schema: {
-                properties: {
-                  canBeUpdated: { type: 'boolean' },
-                  currentVersion: { type: 'string' },
-                  latestCompatibleVersion: { type: 'string' }
-                }
-              }
-            }
-          }
-        }
-      }
-    }
-  }
-}