adapt-authoring-errors 0.0.1 → 1.0.0

package/.eslintignore

@@ -1 +1 @@
-node_modules
+node_modules

package/.eslintrc

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

package/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,55 +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
+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/feature_request.yml

@@ -1,22 +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
+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

@@ -1,11 +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"
+# 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

@@ -1,25 +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)
-
-
+[//]: # (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

@@ -1,16 +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 }}
+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

@@ -1,19 +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 }}
+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/.github/workflows/releases.yml

@@ -0,0 +1,25 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 'lts/*'
+      - name: Install dependencies
+        run: npm ci
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.AAT_NPM_TOKEN }}
+        run: npx semantic-release

package/README.md

@@ -1,2 +1,2 @@
-# adapt-authoring-errors
+# adapt-authoring-errors
 Error handling for the Adapt authoring tool.

package/adapt-authoring.json

@@ -1,13 +1,13 @@
-{
-  "essentialType": "errors",
-  "documentation": {
-    "enable": true,
-    "manualPages": {
-      "error-handling.md": "basics",
-      "errorsref.md": "reference"
-    },
-    "manualPlugins": [
-      "docs/plugins/errors.js"
-    ]
-  } 
-}
+{
+  "essentialType": "errors",
+  "documentation": {
+    "enable": true,
+    "manualPages": {
+      "error-handling.md": "basics",
+      "errorsref.md": "reference"
+    },
+    "manualPlugins": [
+      "docs/plugins/errors.js"
+    ]
+  } 
+}

package/docs/error-handling.md

@@ -1,50 +1,50 @@
-# Error handling
-Handling errors correctly is a key aspect of writing stable software. This guide will give some tips on how you should deal with errors, as well as the utilities available to make error handling simpler.
-
-Before going into specifics, it would be useful to discuss application errors in general terms. The errors you experience are likely to fall into one of the following broad groups:
-- **Initialisation errors**: i.e. problems during start-up
-- **General server errors**: errors which occur outside of user requests, possibly during automated tasks
-- **User errors**: errors which are a direct result of a user request
-
-You will need to deal with each category of error differently. Below are some general tips on handling each type of error.
-
-## Initialisation errors
-## Initialisation errors
-Any errors which occur during initialisation should be captured and logged as appropriate. Depending on the type of error, it may or may not be considered fatal to your code. 
-
-Some examples: 
-- For a database-handler module, failing to connect to the database would be considered a fatal error, as no further actions can be executed. In this case, the code should perform any clean-up and exit.
-- For a configuration module, failing to load the user configuration file may not be fatal if the application can run without it (e.g. with default settings). In this case the error should be logged, but the code can continue to initialise post-error.
-- For a module which attempts to load a specific file in each module connected to the core system, failing to load a single configuration file may not be an error as such, but rather an expected outcome if the configuration file in question is not something that's required to be defined for every module. In this case, the code can continue and it may not even be necessary to log a message.
-
-## General server errors
-'General server errors' is a broad category which covers other errors that don't take place at either initialisation or as a result of direct user action. Again, depending on the specific error, these may or may not be fatal.
-
-Some examples: 
-- For a database-handler module, disconnecting from the database is an expected error, and can be handled and rectified easily.
-
-## User errors errors
-User errors are any errors which are caused as a direct result of a user performing an action incorrectly. It is even *more* critical with user errors that the error is as specific and descriptive as possible, as the response needs to be informative and instructive to the user that caused the error. Failing to do so will result in an unpleasant user experience.
-
-Some examples:
-- A user uploads a file in an invalid format. This definitely isn't a fatal error, as the code can continue post-error. The returned error should inform the user of the issue, as well as how it can be rectified.
-
-## Defining errors
-Depending on the kinds of error that you're dealing with in your code, it may be useful to include a set of custom error definitions specific to your code.
-
-Defining useful errors is a critical part of any software system. The ErrorsModule makes it easy to define errors for your own modules, and make use of errors defined in other modules.
-
-## Catching errors
-
-## Throwing errors
-As mentioned above, it is preferable to catch errors internally in your code and re-throw these errors 
-
-The ErrorsModule acts as a central store for all errors defined in the system, and errors can be accessed and thrown from here. For convenience, the Errors module is made available directly as a property of the main App instance, or by referencing the module in the usual way: `App#waitForModule('errors)`
-
-```js
-try {
-  // do something here
-} catch(e) {
-  throw this.app.errors.MY_ERROR
-}
+# Error handling
+Handling errors correctly is a key aspect of writing stable software. This guide will give some tips on how you should deal with errors, as well as the utilities available to make error handling simpler.
+
+Before going into specifics, it would be useful to discuss application errors in general terms. The errors you experience are likely to fall into one of the following broad groups:
+- **Initialisation errors**: i.e. problems during start-up
+- **General server errors**: errors which occur outside of user requests, possibly during automated tasks
+- **User errors**: errors which are a direct result of a user request
+
+You will need to deal with each category of error differently. Below are some general tips on handling each type of error.
+
+## Initialisation errors
+## Initialisation errors
+Any errors which occur during initialisation should be captured and logged as appropriate. Depending on the type of error, it may or may not be considered fatal to your code. 
+
+Some examples: 
+- For a database-handler module, failing to connect to the database would be considered a fatal error, as no further actions can be executed. In this case, the code should perform any clean-up and exit.
+- For a configuration module, failing to load the user configuration file may not be fatal if the application can run without it (e.g. with default settings). In this case the error should be logged, but the code can continue to initialise post-error.
+- For a module which attempts to load a specific file in each module connected to the core system, failing to load a single configuration file may not be an error as such, but rather an expected outcome if the configuration file in question is not something that's required to be defined for every module. In this case, the code can continue and it may not even be necessary to log a message.
+
+## General server errors
+'General server errors' is a broad category which covers other errors that don't take place at either initialisation or as a result of direct user action. Again, depending on the specific error, these may or may not be fatal.
+
+Some examples: 
+- For a database-handler module, disconnecting from the database is an expected error, and can be handled and rectified easily.
+
+## User errors errors
+User errors are any errors which are caused as a direct result of a user performing an action incorrectly. It is even *more* critical with user errors that the error is as specific and descriptive as possible, as the response needs to be informative and instructive to the user that caused the error. Failing to do so will result in an unpleasant user experience.
+
+Some examples:
+- A user uploads a file in an invalid format. This definitely isn't a fatal error, as the code can continue post-error. The returned error should inform the user of the issue, as well as how it can be rectified.
+
+## Defining errors
+Depending on the kinds of error that you're dealing with in your code, it may be useful to include a set of custom error definitions specific to your code.
+
+Defining useful errors is a critical part of any software system. The ErrorsModule makes it easy to define errors for your own modules, and make use of errors defined in other modules.
+
+## Catching errors
+
+## Throwing errors
+As mentioned above, it is preferable to catch errors internally in your code and re-throw these errors 
+
+The ErrorsModule acts as a central store for all errors defined in the system, and errors can be accessed and thrown from here. For convenience, the Errors module is made available directly as a property of the main App instance, or by referencing the module in the usual way: `App#waitForModule('errors)`
+
+```js
+try {
+  // do something here
+} catch(e) {
+  throw this.app.errors.MY_ERROR
+}
 ```

package/docs/plugins/errors.js

@@ -1,19 +1,19 @@
-export default class Errors {
-  async run() {
-    this.manualFile = 'errorsref.md';
-    this.contents = Object.keys(this.app.errors);
-    this.replace = { ERRORS: this.generateMd() };
-  }
-  generateMd() {
-    return Object.keys(this.app.errors).reduce((md, k) => {
-      const e = this.app.errors[k];
-      return `${md}\n| \`${e.code}\` | ${e.meta.description} | ${e.statusCode} | <ul>${this.dataToMd(e.meta.data)}</ul> |`;
-    }, '| Error code | Description | HTTP status code | Supplemental data |\n| - | - | :-: | - |');
-  }
-  dataToMd(data, s = '') {
-    if(!data) return s;
-    return Object.entries(data).reduce((s, [k, v]) => {
-      return `${s}<li>\`${k}\`: ${typeof v === 'object' ? this.dataToMd(v, s) : v}</li>`;
-    }, s);
-  }
+export default class Errors {
+  async run() {
+    this.manualFile = 'errorsref.md';
+    this.contents = Object.keys(this.app.errors);
+    this.replace = { ERRORS: this.generateMd() };
+  }
+  generateMd() {
+    return Object.keys(this.app.errors).reduce((md, k) => {
+      const e = this.app.errors[k];
+      return `${md}\n| \`${e.code}\` | ${e.meta.description} | ${e.statusCode} | <ul>${this.dataToMd(e.meta.data)}</ul> |`;
+    }, '| Error code | Description | HTTP status code | Supplemental data |\n| - | - | :-: | - |');
+  }
+  dataToMd(data, s = '') {
+    if(!data) return s;
+    return Object.entries(data).reduce((s, [k, v]) => {
+      return `${s}<li>\`${k}\`: ${typeof v === 'object' ? this.dataToMd(v, s) : v}</li>`;
+    }, s);
+  }
 }

package/docs/plugins/errorsref.md

@@ -1,9 +1,9 @@
-# Errors Reference
-
-This page documents all errors which are likely to be thrown in the system, along with the appropriate HTTP status code and any supplemental data which is stored with the error. 
-
-Supplemental data can be used at the point that errors are translated to provide more context to a specific error. All data stored with an error can be assumed to be a primitive type for easy printing.
-
-{{{TABLE_OF_CONTENTS}}}
-
+# Errors Reference
+
+This page documents all errors which are likely to be thrown in the system, along with the appropriate HTTP status code and any supplemental data which is stored with the error. 
+
+Supplemental data can be used at the point that errors are translated to provide more context to a specific error. All data stored with an error can be assumed to be a primitive type for easy printing.
+
+{{{TABLE_OF_CONTENTS}}}
+
 {{{ERRORS}}}

package/errors/adapt-errors.json

@@ -1,38 +1,38 @@
-{
-  "FUNC_NOT_OVERRIDDEN": {
-    "data": {
-      "name": "The name of the function"
-    },
-    "description": "Function must be overridden in child class",
-    "statusCode": 500
-  },
-  "FUNC_DISABLED": {
-    "data": {
-      "name": "The name of the function"
-    },
-    "description": "Function has been disabled",
-    "statusCode": 500
-  },
-  "SERVER_ERROR": {
-    "description": "Generic server error",
-    "statusCode": 500, 
-    "data": {
-      "error": "The original error"
-    }
-  },
-  "INVALID_PARAMS": {
-    "data": {
-      "params": "The invalid params"
-    },
-    "description": "Invalid parameters have been provided",
-    "statusCode": 400
-  },
-  "NOT_FOUND": {
-    "data": {
-      "id": "An identifier for the missing item",
-      "type": "Type of the missing item"
-    },
-    "description": "Requested item could not be found",
-    "statusCode": 404
-  }
+{
+  "FUNC_NOT_OVERRIDDEN": {
+    "data": {
+      "name": "The name of the function"
+    },
+    "description": "Function must be overridden in child class",
+    "statusCode": 500
+  },
+  "FUNC_DISABLED": {
+    "data": {
+      "name": "The name of the function"
+    },
+    "description": "Function has been disabled",
+    "statusCode": 500
+  },
+  "SERVER_ERROR": {
+    "description": "Generic server error",
+    "statusCode": 500, 
+    "data": {
+      "error": "The original error"
+    }
+  },
+  "INVALID_PARAMS": {
+    "data": {
+      "params": "The invalid params"
+    },
+    "description": "Invalid parameters have been provided",
+    "statusCode": 400
+  },
+  "NOT_FOUND": {
+    "data": {
+      "id": "An identifier for the missing item",
+      "type": "Type of the missing item"
+    },
+    "description": "Requested item could not be found",
+    "statusCode": 404
+  }
 }

package/errors/node-core.json

@@ -1,39 +1,39 @@
-{
-  "EACCES": {
-    "description": "An attempt was made to access a file in a way forbidden by its file access permissions",
-    "statusCode": 500
-  },
-  "EADDRINUSE": {
-    "description": "An attempt to bind a server to a local address failed due to another server on the local system already occupying that address",
-    "statusCode": 500
-  },
-  "ECONNREFUSED": {
-    "description": "No connection could be made because the target machine actively refused it",
-    "statusCode": 500
-  },
-  "EEXIST": {
-    "description": "An existing file was the target of an operation that required that the target not exist",
-    "statusCode": 500,
-    "data": {
-      "path": "Path to target file or directory"
-    }
-  },
-  "ENOENT": {
-    "description": "No entity (file or directory) could be found by the given path",
-    "statusCode": 500,
-    "data": {
-      "path": "Path to target file or directory"
-    }
-  },
-  "ENOTEMPTY": {
-    "description": "A directory with entries was the target of an operation that requires an empty directory",
-    "statusCode": 500,
-    "data": {
-      "path": "Path to target file or directory"
-    }
-  },
-  "MODULE_NOT_FOUND": {
-    "description": "A module file could not be resolved while attempting a require() or import operation",
-    "statusCode": 500
-  }
+{
+  "EACCES": {
+    "description": "An attempt was made to access a file in a way forbidden by its file access permissions",
+    "statusCode": 500
+  },
+  "EADDRINUSE": {
+    "description": "An attempt to bind a server to a local address failed due to another server on the local system already occupying that address",
+    "statusCode": 500
+  },
+  "ECONNREFUSED": {
+    "description": "No connection could be made because the target machine actively refused it",
+    "statusCode": 500
+  },
+  "EEXIST": {
+    "description": "An existing file was the target of an operation that required that the target not exist",
+    "statusCode": 500,
+    "data": {
+      "path": "Path to target file or directory"
+    }
+  },
+  "ENOENT": {
+    "description": "No entity (file or directory) could be found by the given path",
+    "statusCode": 500,
+    "data": {
+      "path": "Path to target file or directory"
+    }
+  },
+  "ENOTEMPTY": {
+    "description": "A directory with entries was the target of an operation that requires an empty directory",
+    "statusCode": 500,
+    "data": {
+      "path": "Path to target file or directory"
+    }
+  },
+  "MODULE_NOT_FOUND": {
+    "description": "A module file could not be resolved while attempting a require() or import operation",
+    "statusCode": 500
+  }
 }

package/index.js

@@ -1,5 +1,5 @@
-/**
- * Error handling
- * @namespace errors
- */
-export { default } from './lib/ErrorsModule.js'
+/**
+ * Error handling
+ * @namespace errors
+ */
+export { default } from './lib/ErrorsModule.js'

package/lib/AdaptError.js

@@ -1,52 +1,52 @@
-/**
- * A generic error class for use in Adapt applications
- * @memberof errors
- */
-class AdaptError extends Error {
-  /**
-   * @constructor
-   * @param {string} code The human-readable error code
-   * @param {number} statusCode The HTTP status code
-   * @param {object} metadata Metadata describing the error
-   */
-  constructor (code, statusCode = 500, metadata = {}) {
-    super(code)
-    /**
-     * The error code
-     * @type {String}
-     */
-    this.code = code
-    /**
-     * The HTTP status code
-     * @type {String}
-     */
-    this.statusCode = statusCode
-    /**
-     * Metadata describing the error
-     * @type {Object}
-     */
-    this.meta = metadata
-  }
-
-  /**
-   * Chainable function to allow setting of data for use in user-friendly error messages later on.
-   * @param {object} data
-   * @returns {AdaptError}
-   * @example
-   * // note calling this function will also return
-   * // the error itself to allow for easy error throwing
-   * throw this.app.errors.MY_ERROR
-   *   .setData({ hello: 'world' })
-   */
-  setData (data) {
-    this.data = data
-    return this
-  }
-
-  /** @override */
-  toString () {
-    return `${this.constructor.name}: ${this.code} ${this.data ? JSON.stringify(this.data) : ''}`
-  }
-}
-
-export default AdaptError
+/**
+ * A generic error class for use in Adapt applications
+ * @memberof errors
+ */
+class AdaptError extends Error {
+  /**
+   * @constructor
+   * @param {string} code The human-readable error code
+   * @param {number} statusCode The HTTP status code
+   * @param {object} metadata Metadata describing the error
+   */
+  constructor (code, statusCode = 500, metadata = {}) {
+    super(code)
+    /**
+     * The error code
+     * @type {String}
+     */
+    this.code = code
+    /**
+     * The HTTP status code
+     * @type {String}
+     */
+    this.statusCode = statusCode
+    /**
+     * Metadata describing the error
+     * @type {Object}
+     */
+    this.meta = metadata
+  }
+
+  /**
+   * Chainable function to allow setting of data for use in user-friendly error messages later on.
+   * @param {object} data
+   * @returns {AdaptError}
+   * @example
+   * // note calling this function will also return
+   * // the error itself to allow for easy error throwing
+   * throw this.app.errors.MY_ERROR
+   *   .setData({ hello: 'world' })
+   */
+  setData (data) {
+    this.data = data
+    return this
+  }
+
+  /** @override */
+  toString () {
+    return `${this.constructor.name}: ${this.code} ${this.data ? JSON.stringify(this.data) : ''}`
+  }
+}
+
+export default AdaptError

package/lib/ErrorsModule.js

@@ -1,58 +1,58 @@
-import { AbstractModule } from 'adapt-authoring-core'
-import AdaptError from './AdaptError.js'
-import fs from 'fs/promises'
-import { glob } from 'glob'
-
-/**
- * Module to store a global reference to all errors defined in the system. Errors are accessed from here and thrown appropriately elsewhere.
- * @memberof errors
- * @extends {AbstractModule}
- */
-class ErrorModule extends AbstractModule {
-  /** @override */
-  async init () {
-    /**
-     * A key/value store of all errors defined in the system. Errors are accessed via the human-readable error code for better readability when thrown in code.
-     * @type {object}
-     * @see {AdaptError}
-     */
-    this.errors = await this.loadErrors()
-    this.app.errors = this.errors
-  }
-
-  /**
-   * Loads all errors defined in Adapt module dependencies
-   * @returns {Promise}
-   */
-  async loadErrors () {
-    const errorDefs = {}
-    await Promise.all(Object.values(this.app.dependencies).map(async d => {
-      const files = await glob('errors/*.json', { cwd: d.rootDir, absolute: true })
-      await Promise.all(files.map(async f => {
-        try {
-          const contents = JSON.parse(await fs.readFile(f))
-          Object.entries(contents).forEach(([k, v]) => {
-            if (errorDefs[k]) return this.log('warn', `error code '${k}' already defined`)
-            errorDefs[k] = v
-          })
-        } catch (e) {
-          this.log('error', e.message)
-        }
-      }))
-    }))
-    return Object.entries(errorDefs)
-      .sort()
-      .reduce((m, [k, { description, statusCode, data }]) => {
-        return Object.defineProperty(m, k, {
-          get: () => {
-            const metadata = { description }
-            if (data) metadata.data = data
-            return new AdaptError(k, statusCode, metadata)
-          },
-          enumerable: true
-        })
-      }, {})
-  }
-}
-
-export default ErrorModule
+import { AbstractModule } from 'adapt-authoring-core'
+import AdaptError from './AdaptError.js'
+import fs from 'fs/promises'
+import { glob } from 'glob'
+
+/**
+ * Module to store a global reference to all errors defined in the system. Errors are accessed from here and thrown appropriately elsewhere.
+ * @memberof errors
+ * @extends {AbstractModule}
+ */
+class ErrorModule extends AbstractModule {
+  /** @override */
+  async init () {
+    /**
+     * A key/value store of all errors defined in the system. Errors are accessed via the human-readable error code for better readability when thrown in code.
+     * @type {object}
+     * @see {AdaptError}
+     */
+    this.errors = await this.loadErrors()
+    this.app.errors = this.errors
+  }
+
+  /**
+   * Loads all errors defined in Adapt module dependencies
+   * @returns {Promise}
+   */
+  async loadErrors () {
+    const errorDefs = {}
+    await Promise.all(Object.values(this.app.dependencies).map(async d => {
+      const files = await glob('errors/*.json', { cwd: d.rootDir, absolute: true })
+      await Promise.all(files.map(async f => {
+        try {
+          const contents = JSON.parse(await fs.readFile(f))
+          Object.entries(contents).forEach(([k, v]) => {
+            if (errorDefs[k]) return this.log('warn', `error code '${k}' already defined`)
+            errorDefs[k] = v
+          })
+        } catch (e) {
+          this.log('error', e.message)
+        }
+      }))
+    }))
+    return Object.entries(errorDefs)
+      .sort()
+      .reduce((m, [k, { description, statusCode, data }]) => {
+        return Object.defineProperty(m, k, {
+          get: () => {
+            const metadata = { description }
+            if (data) metadata.data = data
+            return new AdaptError(k, statusCode, metadata)
+          },
+          enumerable: true
+        })
+      }, {})
+  }
+}
+
+export default ErrorModule

package/package.json

@@ -1,17 +1,52 @@
-{
-  "name": "adapt-authoring-errors",
-  "version": "0.0.1",
-  "description": "Error handling for the Adapt authoring tool",
-  "homepage": "https://github.com/adapt-security/adapt-authoring-errors",
-  "license": "GPL-3.0",
-  "type": "module",
-  "main": "index.js",
-  "repository": "github:adapt-security/adapt-authoring-errors",
-  "devDependencies": {
-    "eslint": "^9.9.1",
-    "standard": "^17.1.0"
-  },
-  "dependencies": {
-    "glob": "^11.0.0"
-  }
-}
+{
+  "name": "adapt-authoring-errors",
+  "version": "1.0.0",
+  "description": "Error handling for the Adapt authoring tool",
+  "homepage": "https://github.com/adapt-security/adapt-authoring-errors",
+  "license": "GPL-3.0",
+  "type": "module",
+  "main": "index.js",
+  "repository": "github:adapt-security/adapt-authoring-errors",
+  "devDependencies": {
+    "eslint": "^9.9.1",
+    "standard": "^17.1.0",
+    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^8.0.5",
+    "@semantic-release/npm": "^9.0.1",
+    "@semantic-release/release-notes-generator": "^10.0.3",
+    "conventional-changelog-eslint": "^3.0.9",
+    "semantic-release": "^21.0.1",
+    "semantic-release-replace-plugin": "^1.2.7"
+  },
+  "release": {
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "eslint"
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "eslint"
+        }
+      ],
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "package.json"
+          ],
+          "message": "Chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        }
+      ]
+    ]
+  },
+  "dependencies": {
+    "glob": "^11.0.0"
+  }
+}