adapt-authoring-courseassets 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/errors/errors.json

@@ -0,0 +1,10 @@
+{
+  "RESOURCE_IN_USE": {
+    "data": {
+      "type": "Type of resource",
+      "courses": "Courses using the resource"
+    },
+    "description": "Resource is currently being using in courses",
+    "statusCode": 400
+  }
+}

package/index.js

@@ -0,0 +1,5 @@
+/**
+ * Tracking of asset usage within courses
+ * @namespace courseassets
+ */
+export { default } from './lib/courseassetsModule.js'

package/lib/courseassetsModule.js

@@ -0,0 +1,123 @@
+import AbstractApiModule from 'adapt-authoring-api'
+/**
+ * Module which handles courseassets automatically using on content events
+ * @memberof courseassets
+ * @extends {AbstractApiModule}
+*/
+class CourseAssetsModule extends AbstractApiModule {
+  /** @override */
+  async setValues () {
+    /** @ignore */ this.root = 'courseassets'
+    /** @ignore */ this.schemaName = 'courseasset'
+    /** @ignore */ this.collectionName = 'courseassets'
+    /** @ignore */ this.routes = this.DEFAULT_ROUTES.filter(r => r.route === '/query')
+  }
+
+  /**
+  * Initialise the module
+  * @return {Promise}
+  */
+  async init () {
+    await super.init()
+
+    const [assets, content] = await this.app.waitForModule('assets', 'content')
+    /**
+     * Cached module instance for easy access
+     * @type {AssetsModule}
+     */
+    this.assets = assets
+    /**
+     * Cached module instance for easy access
+     * @type {ContentModule}
+     */
+    this.content = content
+
+    this.assets.preDeleteHook.tap(this.handleDeletedAsset.bind(this));
+
+    ['insert', 'update', 'delete'].forEach(action => { // note we just log any errors
+      const hookName = `post${action[0].toUpperCase()}${action.slice(1)}Hook`
+      this.content[hookName].tap(async (...args) => {
+        try {
+          await this.handleContentEvent(action, ...args).catch(e => this.log('error', e))
+        } catch (e) {
+          this.log('error', 'COURSEASSETS_UPDATE', e)
+        }
+      })
+    })
+  }
+
+  /**
+   * Search data object for asset types and retrieve _ids
+   * @param {Object} data
+   */
+  extractAssetIds (schema, data, assets = []) {
+    Object.entries(schema).forEach(([key, val]) => {
+      if (!Object.prototype.hasOwnProperty.call(data, key)) {
+        return
+      }
+      if (val.properties) {
+        this.extractAssetIds(val.properties, data[key], assets)
+      } else if (val?.items?.properties) {
+        data[key].forEach(d => this.extractAssetIds(val.items.properties, d, assets))
+      } else if (val?._backboneForms?.type === 'Asset' || val?._backboneForms === 'Asset') {
+        assets.push(data[key].toString())
+      }
+    })
+    return Array.from(new Set(assets))
+  };
+
+  /**
+   * Handler for content event
+   * @param {String} action The action performed
+   * @param {object} arg1 First argument passed by the event
+   * @param {object} arg2 Second argument passed by the event
+   */
+  async handleContentEvent (action, arg1, arg2) {
+    if (action === 'delete') {
+      return Promise.all((Array.isArray(arg1) ? arg1 : [arg1]).map(async c => {
+        const key = c._type === 'course' ? 'courseId' : 'contentId'
+        await this.deleteMany({ [key]: c._id })
+        this.log('debug', 'DELETE', c._courseId.toString(), c._id.toString())
+      }))
+    }
+    const type = arg1._type
+    const contentId = arg1._id.toString()
+    const courseId = arg1._courseId?.toString() ?? (type === 'course' ? contentId : undefined)
+    const isModify = action === 'update'
+
+    if (!contentId || !courseId) {
+      return
+    }
+    // delete any existing course assets for content
+    await this.deleteMany({ courseId, contentId })
+
+    const data = isModify ? arg2 : arg1
+    const schema = await this.content.getSchema(this.content.schemaName, data)
+    const ids = this.extractAssetIds(schema.built.properties, data)
+
+    if (!ids.length) {
+      return
+    }
+    await Promise.all(ids.map(async _id => {
+      const [asset] = await this.assets.find({ _id })
+      if (!asset) {
+        throw this.app.errors.NOT_FOUND.setData({ type: 'asset', id: _id })
+      }
+      await this.insert({ courseId, contentId, assetId: _id })
+    }))
+    this.log('debug', 'UPDATE', courseId, contentId)
+  }
+
+  async handleDeletedAsset (asset) {
+    const results = await this.find({ assetId: asset._id })
+    if (!results.length) {
+      return
+    }
+    const courses = (await this.content.find({ _id: { $in: results.map(r => r.courseId) } }))
+      .map(c => c.displayTitle || c.title)
+
+    throw this.app.errors.RESOURCE_IN_USE.setData({ type: 'asset', courses })
+  }
+}
+
+export default CourseAssetsModule

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "adapt-authoring-courseassets",
+  "version": "0.0.1",
+  "description": "Module for managing courseassets",
+  "homepage": "https://github.com/deltanetdan/adapt-authoring-courseassets",
+  "license": "GPL-3.0",
+  "type": "module",
+  "main": "index.js",
+  "repository": "github:adapt-security/adapt-authoring-courseassets",
+  "peerDependencies": {
+    "adapt-authoring-api": "github:adapt-security/adapt-authoring-api",
+    "adapt-authoring-content": "github:adapt-security/adapt-authoring-content",
+    "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/courseasset.schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$anchor": "courseasset",
+  "description": "Metadata related to where an asset is used in a course",
+  "type": "object",
+  "properties": {
+    "courseId": {
+      "description": "Course record unique ID",
+      "type": "string",
+      "isObjectId": true
+    },
+    "contentId": {
+      "description": "The ID for the content record that uses this asset",
+      "type": "string",
+      "isObjectId": true
+    },
+    "assetId": {
+      "description": "Asset record unique ID",
+      "type": "string",
+      "isObjectId": true
+    }
+  },
+  "required": ["courseId", "contentId", "assetId"]
+}