adapt-authoring-content 2.1.3 → 2.1.5

package/.github/workflows/standardjs.yml

@@ -1,4 +1,4 @@
-name: Standard.js formatting check
+name: Lint
 on: push
 jobs:
   default:
@@ -10,3 +10,4 @@ jobs:
           node-version: 'lts/*'
       - run: npm install
       - run: npx standard
+

package/lib/ContentModule.js

@@ -1,7 +1,6 @@
 import { AbstractApiModule } from 'adapt-authoring-api'
 import { getDescendants } from './utils.js'
 import { Hook, stringifyValues } from 'adapt-authoring-core'
-import apidefs from './apidefs.js'
 /**
  * Module which handles course content
  * @memberof content
@@ -10,19 +9,8 @@ import apidefs from './apidefs.js'
 class ContentModule extends AbstractApiModule {
   /** @override */
   async setValues () {
-    /** @ignore */ this.root = this.collectionName = this.schemaName = 'content'
-    this.useDefaultRouteConfig()
-    this.routes.push({
-      route: '/insertrecursive',
-      handlers: { post: this.handleInsertRecursive.bind(this) },
-      permissions: { post: ['write:content'] },
-      meta: apidefs.insertrecursive
-    }, {
-      route: '/clone',
-      handlers: { post: this.handleClone.bind(this) },
-      permissions: { post: ['write:content'] },
-      meta: apidefs.clone
-    })
+    await super.setValues()
+    /** @ignore */ this.collectionName = this.schemaName = 'content'
   }
 
   /** @override */
@@ -52,7 +40,7 @@ class ContentModule extends AbstractApiModule {
     await mongodb.setIndex(this.collectionName, { _courseId: 1, _parentId: 1, _type: 1 })
     await mongodb.setIndex(this.collectionName, { _courseId: 1, _friendlyId: 1 }, {
       unique: true,
-      partialFilterExpression: { _friendlyId: { $type: 'string' } }
+      partialFilterExpression: { _friendlyId: { $type: 'string', $gt: '' } }
     })
   }
 
@@ -266,7 +254,7 @@ class ContentModule extends AbstractApiModule {
         await this.clone(userId, config._id, undefined, { _courseId: newData._id.toString() })
         delete payload._id
         delete payload._courseId
-        await this.update({ _id: newData._id }, payload)
+        await this.update({ _id: newData._id }, payload, { validate: false })
       }
     }
     const children = await this.find({ _parentId: _id })
@@ -374,6 +362,7 @@ class ContentModule extends AbstractApiModule {
    */
   async handleClone (req, res, next) {
     try {
+      await this.requestHook.invoke(req)
       const { _id, _parentId } = req.body
       const source = await this.findOne({ _id: req.body._id })
       await this.checkAccess(req, source)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-content",
-  "version": "2.1.3",
+  "version": "2.1.5",
   "description": "Module for managing Adapt content",
   "homepage": "https://github.com/adapt-security/adapt-authoring-content",
   "license": "GPL-3.0",
@@ -11,7 +11,7 @@
     "test": "node --test 'tests/**/*.spec.js'"
   },
   "dependencies": {
-    "adapt-authoring-api": "^2.0.0",
+    "adapt-authoring-api": "^3.0.0",
     "adapt-authoring-core": "^2.0.0"
   },
   "peerDependencies": {
@@ -22,6 +22,7 @@
     "adapt-authoring-tags": "^1.0.2"
   },
   "devDependencies": {
+    "adapt-authoring-server": "^2.1.0",
     "@semantic-release/git": "^10.0.1",
     "conventional-changelog-eslint": "^6.0.0",
     "semantic-release": "^25.0.2",

package/routes.json

@@ -0,0 +1,63 @@
+{
+  "root": "content",
+  "routes": [
+    {
+      "route": "/insertrecursive",
+      "handlers": { "post": "handleInsertRecursive" },
+      "permissions": { "post": ["write:${scope}"] },
+      "meta": {
+        "post": {
+          "summary": "Insert hierarchical content data",
+          "description": "Recursively inserts content data",
+          "parameters": [{ "name": "rootId", "in": "path", "description": "The parent content item _id", "required": true }],
+          "requestBody": {
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#components/schemas/content" }
+              }
+            }
+          },
+          "responses": {
+            "201": {
+              "description": "The newly inserted data",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "$schema": "https://json-schema.org/draft/2020-12/schema",
+                    "type": "array",
+                    "items": { "$ref": "#components/schemas/content" }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "route": "/clone",
+      "handlers": { "post": "handleClone" },
+      "permissions": { "post": ["write:${scope}"] },
+      "meta": {
+        "post": {
+          "summary": "Clones a content item",
+          "description": "Duplicates a content item as well as all its children.",
+          "responses": {
+            "201": {
+              "description": "The newly cloned data",
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "$schema": "https://json-schema.org/draft/2020-12/schema",
+                    "type": "array",
+                    "items": { "$ref": "#components/schemas/content" }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

package/tests/ContentModule.spec.js

@@ -68,15 +68,14 @@ function createInstance (overrides = {}) {
     update: mock.fn(async (q, d) => ({ ...q, ...d })),
     delete: mock.fn(async () => ({})),
 
-    useDefaultRouteConfig: mock.fn(),
     setDefaultOptions: mock.fn((opts) => opts),
     checkAccess: mock.fn(async (req, data) => data),
     log: mock.fn(),
 
+    requestHook: createMockHook(),
     preCloneHook: createMockHook(),
     postCloneHook: createMockHook(),
 
-    // Methods that setValues tries to .bind(this)
     handleInsertRecursive: mock.fn(),
     handleClone: mock.fn(),
 
@@ -97,48 +96,14 @@ describe('ContentModule', () => {
   // setValues
   // -----------------------------------------------------------------------
   describe('setValues', () => {
-    it('should set root, collectionName and schemaName to "content"', async () => {
+    it('should set collectionName and schemaName to "content"', async () => {
       const inst = createInstance()
+      Object.getPrototypeOf(ContentModule.prototype).setValues = mock.fn(async function () {})
       await ContentModule.prototype.setValues.call(inst)
 
-      assert.equal(inst.root, 'content')
       assert.equal(inst.collectionName, 'content')
       assert.equal(inst.schemaName, 'content')
     })
-
-    it('should call useDefaultRouteConfig', async () => {
-      const inst = createInstance()
-      await ContentModule.prototype.setValues.call(inst)
-
-      assert.equal(inst.useDefaultRouteConfig.mock.callCount(), 1)
-    })
-
-    it('should push insertrecursive and clone routes', async () => {
-      const inst = createInstance()
-      await ContentModule.prototype.setValues.call(inst)
-
-      assert.equal(inst.routes.length, 2)
-      assert.equal(inst.routes[0].route, '/insertrecursive')
-      assert.equal(inst.routes[1].route, '/clone')
-    })
-
-    it('should assign correct HTTP methods for insertrecursive route', async () => {
-      const inst = createInstance()
-      await ContentModule.prototype.setValues.call(inst)
-
-      const route = inst.routes[0]
-      assert.ok(route.handlers.post)
-      assert.deepEqual(route.permissions, { post: ['write:content'] })
-    })
-
-    it('should assign correct HTTP methods for clone route', async () => {
-      const inst = createInstance()
-      await ContentModule.prototype.setValues.call(inst)
-
-      const route = inst.routes[1]
-      assert.ok(route.handlers.post)
-      assert.deepEqual(route.permissions, { post: ['write:content'] })
-    })
   })
 
   // -----------------------------------------------------------------------
@@ -906,9 +871,10 @@ describe('ContentModule', () => {
       assert.equal(next.mock.calls[0].arguments[0], error)
     })
 
-    it('should call checkAccess before cloning', async () => {
+    it('should call requestHook, checkAccess, then clone in order', async () => {
       const callOrder = []
       const inst = createInstance()
+      inst.requestHook = { invoke: mock.fn(async () => { callOrder.push('requestHook') }) }
       inst.findOne = mock.fn(async () => {
         callOrder.push('findOne')
         return { _id: 'orig' }
@@ -931,7 +897,7 @@ describe('ContentModule', () => {
 
       await ContentModule.prototype.handleClone.call(inst, req, res, mock.fn())
 
-      assert.deepEqual(callOrder, ['findOne', 'checkAccess', 'clone'])
+      assert.deepEqual(callOrder, ['requestHook', 'findOne', 'checkAccess', 'clone'])
     })
   })