adapt-authoring-tags 1.2.1 → 1.3.1

package/lib/TagsModule.js

@@ -14,7 +14,7 @@ class TagsModule extends AbstractApiModule {
 
   /** @override */
   async setValues () {
-    /** @ignore */ this.root = 'tags'
+    await super.setValues()
     /** @ignore */ this.schemaName = 'tag'
     /** @ignore */ this.schemaExtensionName = 'tags'
     /** @ignore */ this.collectionName = 'tags'
@@ -23,51 +23,6 @@ class TagsModule extends AbstractApiModule {
      * @type {Array<AbstractApiModule>}
      */
     this.modules = []
-
-    this.useDefaultRouteConfig()
-
-    this.routes = [{
-      route: '/autocomplete',
-      handlers: { get: this.autocompleteHandler.bind(this) },
-      permissions: { get: ['read:content'] },
-      meta: {
-        get: {
-          summary: 'Retrieve tags for UI autocomplete',
-          description: 'A streamlined query API to allow searching of tag data.',
-          parameters: [{ name: 'term', in: 'query', description: 'Search term', required: true }],
-          responses: {
-            200: {
-              content: {
-                'application/json': {
-                  schema: {
-                    type: 'array',
-                    items: {
-                      type: 'object',
-                      properties: {
-                        _id: { type: 'string' },
-                        title: { type: 'string' },
-                        value: { type: 'string' }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    }, {
-      route: '/transfer/:_id',
-      handlers: { post: this.transferHandler.bind(this) },
-      permissions: { post: ['write:content'] },
-      modifying: false,
-      meta: {
-        post: {
-          summary: 'Transfer tag',
-          description: 'Transfers all items using one tag for another.'
-        }
-      }
-    }, ...this.routes]
     // make title unique
     const mongodb = await this.app.waitForModule('mongodb')
     return mongodb.setIndex(this.collectionName, 'title', { unique: true })

package/package.json

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

package/routes.json

@@ -0,0 +1,48 @@
+{
+  "root": "tags",
+  "routes": [
+    {
+      "route": "/autocomplete",
+      "handlers": { "get": "autocompleteHandler" },
+      "permissions": { "get": ["read:content"] },
+      "meta": {
+        "get": {
+          "summary": "Retrieve tags for UI autocomplete",
+          "description": "A streamlined query API to allow searching of tag data.",
+          "parameters": [{ "name": "term", "in": "query", "description": "Search term", "required": true }],
+          "responses": {
+            "200": {
+              "content": {
+                "application/json": {
+                  "schema": {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "_id": { "type": "string" },
+                        "title": { "type": "string" },
+                        "value": { "type": "string" }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    {
+      "route": "/transfer/:_id",
+      "modifying": false,
+      "handlers": { "post": "transferHandler" },
+      "permissions": { "post": ["write:content"] },
+      "meta": {
+        "post": {
+          "summary": "Transfer tag",
+          "description": "Transfers all items using one tag for another."
+        }
+      }
+    }
+  ]
+}

package/tests/TagsModule.spec.js

@@ -55,25 +55,10 @@ function createInstance (overrides = {}) {
 
 describe('TagsModule', () => {
   describe('#setValues()', () => {
-    it('should set root to "tags"', async () => {
-      const { instance } = createInstance()
-      instance.root = undefined
-      instance.schemaName = undefined
-      instance.schemaExtensionName = undefined
-      instance.collectionName = undefined
-      instance.modules = undefined
-      instance.routes = undefined
-      // useDefaultRouteConfig normally sets this.routes; mock must do the same
-      instance.useDefaultRouteConfig = mock.fn(function () { this.routes = [] })
-      await instance.setValues()
-      assert.equal(instance.root, 'tags')
-    })
-
     it('should set schemaName to "tag"', async () => {
       const { instance } = createInstance()
-      instance.root = undefined
       instance.schemaName = undefined
-      instance.useDefaultRouteConfig = mock.fn(function () { this.routes = [] })
+      Object.getPrototypeOf(TagsModule.prototype).setValues = mock.fn(async function () {})
       await instance.setValues()
       assert.equal(instance.schemaName, 'tag')
     })
@@ -81,7 +66,7 @@ describe('TagsModule', () => {
     it('should set schemaExtensionName to "tags"', async () => {
       const { instance } = createInstance()
       instance.schemaExtensionName = undefined
-      instance.useDefaultRouteConfig = mock.fn(function () { this.routes = [] })
+      Object.getPrototypeOf(TagsModule.prototype).setValues = mock.fn(async function () {})
       await instance.setValues()
       assert.equal(instance.schemaExtensionName, 'tags')
     })
@@ -89,7 +74,7 @@ describe('TagsModule', () => {
     it('should set collectionName to "tags"', async () => {
       const { instance } = createInstance()
       instance.collectionName = undefined
-      instance.useDefaultRouteConfig = mock.fn(function () { this.routes = [] })
+      Object.getPrototypeOf(TagsModule.prototype).setValues = mock.fn(async function () {})
       await instance.setValues()
       assert.equal(instance.collectionName, 'tags')
     })
@@ -97,38 +82,14 @@ describe('TagsModule', () => {
     it('should initialise modules as an empty array', async () => {
       const { instance } = createInstance()
       instance.modules = undefined
-      instance.useDefaultRouteConfig = mock.fn(function () { this.routes = [] })
+      Object.getPrototypeOf(TagsModule.prototype).setValues = mock.fn(async function () {})
       await instance.setValues()
       assert.deepEqual(instance.modules, [])
     })
 
-    it('should call useDefaultRouteConfig', async () => {
-      const { instance } = createInstance()
-      instance.useDefaultRouteConfig = mock.fn(function () { this.routes = [] })
-      await instance.setValues()
-      assert.equal(instance.useDefaultRouteConfig.mock.calls.length, 1)
-    })
-
-    it('should add autocomplete and transfer routes', async () => {
-      const { instance } = createInstance()
-      instance.useDefaultRouteConfig = mock.fn(function () { this.routes = [] })
-      await instance.setValues()
-
-      const autocompleteRoute = instance.routes.find(r => r.route === '/autocomplete')
-      assert.ok(autocompleteRoute, 'autocomplete route should exist')
-      assert.ok(autocompleteRoute.handlers.get, 'autocomplete should have GET handler')
-      assert.deepEqual(autocompleteRoute.permissions.get, ['read:content'])
-
-      const transferRoute = instance.routes.find(r => r.route === '/transfer/:_id')
-      assert.ok(transferRoute, 'transfer route should exist')
-      assert.ok(transferRoute.handlers.post, 'transfer should have POST handler')
-      assert.deepEqual(transferRoute.permissions.post, ['write:content'])
-      assert.equal(transferRoute.modifying, false)
-    })
-
     it('should call mongodb.setIndex for unique title', async () => {
       const { instance, mockMongodb } = createInstance()
-      instance.useDefaultRouteConfig = mock.fn(function () { this.routes = [] })
+      Object.getPrototypeOf(TagsModule.prototype).setValues = mock.fn(async function () {})
       await instance.setValues()
       assert.equal(mockMongodb.setIndex.mock.calls.length, 1)
       const call = mockMongodb.setIndex.mock.calls[0]