adapt-authoring-tags 0.0.1

package/.eslintignore

@@ -0,0 +1 @@
+node_modules

package/.eslintrc

@@ -0,0 +1,14 @@
+{
+  "env": {
+      "browser": false,
+      "node": true,
+      "commonjs": false,
+      "es2020": true
+  },
+  "extends": [
+      "standard"
+  ],
+  "parserOptions": {
+      "ecmaVersion": 2020
+  }
+}

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,55 @@
+name: Bug Report
+description: File a bug report
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: textarea
+    id: description
+    attributes:
+      label: What happened?
+      description: Please describe the issue
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behaviour
+      description: Tell us what should have happened
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: Steps to reproduce
+      description: Tell us how to reproduce the issue
+    validations:
+      required: true
+  - type: input
+    id: aat-version
+    attributes:
+      label: Authoring tool version
+      description: What version of the Adapt authoring tool are you running?
+    validations:
+      required: true
+  - type: input
+    id: fw-version
+    attributes:
+      label: Framework version
+      description: What version of the Adapt framework are you running?
+  - type: dropdown
+    id: browsers
+    attributes:
+      label: What browsers are you seeing the problem on?
+      multiple: true
+      options:
+        - Firefox
+        - Chrome
+        - Safari
+        - Microsoft Edge
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: sh

package/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

package/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,22 @@
+name: Feature request
+description: Request a new feature
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to request a new feature in the Adapt authoring tool! The Adapt team will consider all new feature requests, but unfortunately cannot commit to every one.
+  - type: textarea
+    id: description
+    attributes:
+      label: Feature description
+      description: Please describe your feature request
+    validations:
+      required: true
+  - type: checkboxes
+    id: contribute
+    attributes:
+      label: Can you work on this feature?
+      description: If you are able to commit your own time to work on this feature, it will greatly increase the liklihood of it being implemented by the core dev team. Otherwise, it will be triaged and prioritised alongside the core team's current priorities.
+      options:
+        - label: I can contribute

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

package/.github/pull_request_template.md

@@ -0,0 +1,25 @@
+[//]: # (Please title your PR according to eslint commit conventions)
+[//]: # (See https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint#eslint-convention for details)
+
+[//]: # (Add a link to the original issue)
+
+[//]: # (Delete as appropriate)
+### Fix
+* A sentence describing each fix
+
+### Update
+* A sentence describing each udpate
+
+### New
+* A sentence describing each new feature
+
+### Breaking
+* A sentence describing each breaking change
+
+[//]: # (List appropriate steps for testing if needed)
+### Testing
+1. Steps for testing
+
+[//]: # (Mention any other dependencies)
+
+

package/.github/workflows/labelled_prs.yml

@@ -0,0 +1,16 @@
+name: Add labelled PRs to project
+
+on:
+  pull_request:
+    types: [ labeled ]
+
+jobs:
+  add-to-project:
+    if: ${{ github.event.label.name == 'dependencies' }}
+    name: Add to main project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v0.1.0
+        with:
+          project-url: https://github.com/orgs/adapt-security/projects/5
+          github-token: ${{ secrets.PROJECTS_SECRET }}

package/.github/workflows/new.yml

@@ -0,0 +1,19 @@
+name: Add to main project
+
+on:
+  issues:
+    types:
+      - opened
+  pull_request:
+    types:
+      - opened
+
+jobs:
+  add-to-project:
+    name: Add to main project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v0.1.0
+        with:
+          project-url: https://github.com/orgs/adapt-security/projects/5
+          github-token: ${{ secrets.PROJECTS_SECRET }}

package/adapt-authoring.json

@@ -0,0 +1,5 @@
+{
+  "documentation": {
+    "enable": true
+  }
+}

package/artillery.yml

@@ -0,0 +1,16 @@
+scenarios:
+  - flow:
+      - post:
+          url: "/tags"
+          json:
+              title: 'test tag title'
+          capture:
+              json: "$._id"
+              as: "id"
+      - put:
+          url: "/tags/{{id}}"
+          json:
+              title: 'UPDATED'
+              idTest: '{{id}}'
+      - get:
+          url: "/tags/{{id}}"

package/index.js

@@ -0,0 +1,5 @@
+/**
+ * Categorise data using tag labels
+ * @namespace tags
+ */
+export { default } from './lib/TagsModule.js'

package/lib/TagsModule.js

@@ -0,0 +1,166 @@
+import AbstractApiModule from 'adapt-authoring-api'
+/**
+ * Module which handles tagging
+ * @memberof tags
+ * @extends {AbstractApiModule}
+ */
+class TagsModule extends AbstractApiModule {
+  /** @override */
+  async init () {
+    await super.init()
+    const jsonschema = await this.app.waitForModule('jsonschema')
+    jsonschema.registerSchemasHook.tap(this.registerSchemas.bind(this))
+  }
+
+  /** @override */
+  async setValues () {
+    /** @ignore */ this.root = 'tags'
+    /** @ignore */ this.schemaName = 'tag'
+    /** @ignore */ this.schemaExtensionName = 'tags'
+    /** @ignore */ this.collectionName = 'tags'
+    /**
+     * Module registered for tags
+     * @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 })
+  }
+
+  /**
+   * Registers a module for use with this plugin
+   * @param {AbstractApiModule} mod
+   */
+  async registerModule (mod) {
+    if (!mod.schemaName) {
+      return this.log('warn', 'cannot register module, module doesn\'t define a schemaName')
+    }
+    await this.registerSchemas()
+   
+    this.log('debug', `registered ${mod.name} for use with tags`)
+    this.modules.push(mod)
+  }
+
+   /**
+   * Registers module schemas
+   */
+  async registerSchemas () {
+    const jsonschema = await this.app.waitForModule('jsonschema')
+    this.modules.forEach(mod => {
+      try {
+        jsonschema.extendSchema(mod.schemaName, this.schemaExtensionName)
+      } catch(e) {}
+    })
+  }
+
+  /**
+   * A handler for autocompletion of tags
+   * @param {external:ExpressRequest} req
+   * @param {external:ExpressResponse} res
+   * @param {Function} next
+   */
+  async autocompleteHandler (req, res, next) {
+    res.json((await this.find({ title: { $regex: `^${req.apiData.query.term}` } })).map(m => {
+      return {
+        _id: m._id,
+        title: m.title,
+        value: m.title
+      }
+    }))
+  }
+
+  /**
+   * Transfers items using a source tag to a different destination tag
+   * @param {external:ExpressRequest} req
+   * @param {external:ExpressResponse} res
+   * @param {Function} next
+   */
+  async transferHandler (req, res, next) {
+    const sourceId = req.apiData.query._id
+    const destId = req.apiData.data.destId
+    try {
+      await Promise.all(this.modules.map(async m => {
+        try {
+          await m.updateMany({ tags: sourceId }, { $push: { tags: destId } }, { rawUpdate: true })
+          if(req.apiData.query.deleteSourceTag !== 'true') await m.updateMany({ tags: sourceId }, { $pull: { tags: sourceId } }, { rawUpdate: true })
+        } catch (e) {
+          this.log('warn', `Failed to transfer tag, ${e}`)
+        }
+      }))
+      if(req.apiData.query.deleteSourceTag === 'true') {
+        await this.delete({ _id: sourceId })
+      }
+    } catch(e) {
+      next(e)
+    }
+  }
+
+  /** @override */
+  async insert (...args) {
+    // allow attempts to create tags that already exist
+    const [tag] = await this.find(...args)
+    if (tag) return tag
+    return super.insert(...args)
+  }
+
+  /** @override */
+  async delete (...args) {
+    const data = await super.delete(...args)
+    await Promise.all(this.modules.map(async m => {
+      try {
+        await m.updateMany({ tags: data._id }, { $pull: { tags: data._id } }, { rawUpdate: true })
+      } catch (e) {
+        this.log('warn', `Failed to remove tag, ${e}`)
+      }
+    }))
+    return data
+  }
+}
+
+export default TagsModule

package/package.json

@@ -0,0 +1,19 @@
+{
+  "name": "adapt-authoring-tags",
+  "version": "0.0.1",
+  "description": "Module for managing tags",
+  "homepage": "https://github.com/adapt-security/adapt-authoring-tags",
+  "license": "GPL-3.0",
+  "type": "module",
+  "main": "index.js",
+  "repository": "github:adapt-security/adapt-authoring-tags",
+  "peerDependencies": {
+    "adapt-authoring-api": "github:adapt-security/adapt-authoring-api",
+    "adapt-authoring-core": "github:adapt-security/adapt-authoring-core",
+    "adapt-authoring-mongodb": "github:adapt-security/adapt-authoring-mongodb"
+  },
+  "devDependencies": {
+    "eslint": "^9.12.0",
+    "standard": "^17.1.0"
+  }
+}

package/schema/tag.schema.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$anchor": "tag",
+  "description": "Tag metadata applied to other objects",
+  "type": "object",
+  "properties": {
+    "title": {
+      "description": "The tag title",
+      "type": "string"
+    }
+  },
+  "required": ["title"]
+}

package/schema/tags.schema.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$anchor": "tags",
+  "description": "Extra properties to define tags",
+  "$merge": {
+    "with": {
+      "properties": {
+        "tags": {
+          "title": "Tags",
+          "description": "Add tags by entering one or more words, separated with a comma (,)",
+          "type": "array",
+          "default": [],
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "isObjectId": true
+          },
+          "_backboneForms": "Tags"
+        }
+      }
+    }
+  }
+}