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

@@ -1,8 +1,8 @@
-{
-  "documentation": {
-    "enable": true,
-    "manualPages": {
-      "server-requests.md": "advanced"      
-    }
-  }
-}
+{
+  "documentation": {
+    "enable": true,
+    "manualPages": {
+      "server-requests.md": "advanced"      
+    }
+  }
+}

package/conf/config.schema.json

@@ -1,38 +1,38 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "host": {
-      "description": "Name of the host machine the server is running from",
-      "type": "string"
-    },
-    "port": {
-      "description": "Port to be used for listening to incoming connections",
-      "type": ["number", "string"]
-    },
-    "url": {
-      "description": "URL the server can be accessed from",
-      "type": "string",
-      "format": "uri",
-      "_adapt": {
-        "isPublic": true
-      }
-    },
-    "trustProxy": {
-      "description": "Whether to trust the client's x-Forwarded-For header for the request IP address. Only enable if using your own trusted reverse proxy",
-      "type": ["number", "boolean"],
-      "default": 0
-    },
-    "debugRequestTime": {
-      "description": "Will log the execution time of each request",
-      "type": "boolean",
-      "default": false
-    },
-    "verboseErrorLogging": {
-      "description": "Whether to log errors in their entirety",
-      "type": "boolean",
-      "default": false
-    }
-  },
-  "required": ["host", "port", "url"]
-}
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "host": {
+      "description": "Name of the host machine the server is running from",
+      "type": "string"
+    },
+    "port": {
+      "description": "Port to be used for listening to incoming connections",
+      "type": ["number", "string"]
+    },
+    "url": {
+      "description": "URL the server can be accessed from",
+      "type": "string",
+      "format": "uri",
+      "_adapt": {
+        "isPublic": true
+      }
+    },
+    "trustProxy": {
+      "description": "Whether to trust the client's x-Forwarded-For header for the request IP address. Only enable if using your own trusted reverse proxy",
+      "type": ["number", "boolean"],
+      "default": 0
+    },
+    "debugRequestTime": {
+      "description": "Will log the execution time of each request",
+      "type": "boolean",
+      "default": false
+    },
+    "verboseErrorLogging": {
+      "description": "Whether to log errors in their entirety",
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "required": ["host", "port", "url"]
+}

package/docs/server-requests.md

@@ -1,29 +1,29 @@
-# Handling server requests
-This page gives you some pointers on how to handle incoming requests in a way that will reduce the work needed by you as a developer, and create consistent and easy-to-process responses. 
-
-## Extend the `AbstractApiModule` class
-If you're building a non-trivial API (particularly one that uses the database), we highly recommend that you use `AbstractApiModule` as a base, as this includes a lot of boilerplate code and helper functions to make handling HTTP requests much easier. See [this page](writing-an-api) for more info on using the `AbstractApiModule` class. 
-
-## Use HTTP status codes
-This may go without saying, but please stick to standardised HTTP response codes; they state your intentions and make it nice and easy for other devs to work with and react to.
-
-See the [Mozilla Developer Network docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) for a full list of HTTP response status codes and what they mean.
-
-## Use the built-in error handler
-The Server module adds a `sendError` utility function to the ServerResponse object that's passed to every route handler in the stack. Making use of this in your own code will ensure errors are formatted in a consistent way.
-
-Using the helper function is as simple as:
-
-```js
-async myHandler(req, res, next) {
-  try {
-    // do some stuff
-  } catch() {
-    res.sendError(e);
-  }
-}
-```
-
-See the Express.js documentation for information on the extra functions available:
-- [Request](https://expressjs.com/en/4x/api.html#req)
+# Handling server requests
+This page gives you some pointers on how to handle incoming requests in a way that will reduce the work needed by you as a developer, and create consistent and easy-to-process responses. 
+
+## Extend the `AbstractApiModule` class
+If you're building a non-trivial API (particularly one that uses the database), we highly recommend that you use `AbstractApiModule` as a base, as this includes a lot of boilerplate code and helper functions to make handling HTTP requests much easier. See [this page](writing-an-api) for more info on using the `AbstractApiModule` class. 
+
+## Use HTTP status codes
+This may go without saying, but please stick to standardised HTTP response codes; they state your intentions and make it nice and easy for other devs to work with and react to.
+
+See the [Mozilla Developer Network docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status) for a full list of HTTP response status codes and what they mean.
+
+## Use the built-in error handler
+The Server module adds a `sendError` utility function to the ServerResponse object that's passed to every route handler in the stack. Making use of this in your own code will ensure errors are formatted in a consistent way.
+
+Using the helper function is as simple as:
+
+```js
+async myHandler(req, res, next) {
+  try {
+    // do some stuff
+  } catch() {
+    res.sendError(e);
+  }
+}
+```
+
+See the Express.js documentation for information on the extra functions available:
+- [Request](https://expressjs.com/en/4x/api.html#req)
 - [Response](https://expressjs.com/en/4x/api.html#res)

package/errors/errors.json

@@ -1,24 +1,24 @@
-{
-  "ENDPOINT_NOT_FOUND": {
-    "data": {
-      "endpoint": "The missing endpoint",
-      "method": "The HTTP method"
-    },
-    "description": "API endpoint does not exist",
-    "statusCode": 404
-  },
-  "NO_NET_CONN": {
-    "data": {
-      "hostname": "The hostname we were trying to reach"
-    },
-    "description": "No network connection",
-    "statusCode": 400
-  },
-  "SERVER_START": {
-    "data": {
-      "error": "The error"
-    },
-    "description": "Failed to start server",
-    "statusCode": 500
-  }
+{
+  "ENDPOINT_NOT_FOUND": {
+    "data": {
+      "endpoint": "The missing endpoint",
+      "method": "The HTTP method"
+    },
+    "description": "API endpoint does not exist",
+    "statusCode": 404
+  },
+  "NO_NET_CONN": {
+    "data": {
+      "hostname": "The hostname we were trying to reach"
+    },
+    "description": "No network connection",
+    "statusCode": 400
+  },
+  "SERVER_START": {
+    "data": {
+      "error": "The error"
+    },
+    "description": "Failed to start server",
+    "statusCode": 500
+  }
 }

package/index.js

@@ -1,5 +1,5 @@
-/**
- * HTTP server functionality using Express.js
- * @namespace server
- */
-export { default } from './lib/ServerModule.js'
+/**
+ * HTTP server functionality using Express.js
+ * @namespace server
+ */
+export { default } from './lib/ServerModule.js'