adapt-authoring-adaptframework 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,29 @@
+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 }}
+          
+  handle_precommit_pr:
+    if: contains(github.event.pull_request.title, '[pre-commit.ci]')
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Label pull request with "_bot"
+        run: gh pr edit ${{ github.event.pull_request.number }} -R ${{ github.repository }} --add-label "_bot"
+        env:
+          GH_TOKEN: ${{ secrets.PROJECTS_SECRET }}

package/adapt-authoring.json

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

package/conf/config.schema.json

@@ -0,0 +1,44 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "buildDir": {
+      "description": "Path to the folder where framework builds will be generated",
+      "type": "string",
+      "isDirectory": true,
+      "default": "$TEMP/framework-builds"
+    },
+    "buildLifespan": {
+      "description": "How long a build should remain valid for. Expects an amount followed by a space and then the unit (e.g. 5 hours)",
+      "type": "string",
+      "isTimeMs": true,
+      "default": "7d"
+    },
+    "enableUpdateApi": {
+      "description": "Whether the Adapt framework can be updated via the REST API",
+      "type": "boolean",
+      "default": true,
+      "_adapt": {
+        "isPublic": true
+      }
+    },
+    "frameworkDir": {
+      "description": "Path to the adapt_framework source folder",
+      "type": "string",
+      "isDirectory": true,
+      "default": "$TEMP/adapt_framework"
+    },
+    "frameworkRepository": {
+      "description": "URL of the Adapt framework git repository to install",
+      "type": "string"
+    },
+    "importMaxFileSize": {
+      "description": "Maximum file upload size for course imports",
+      "type": "string",
+      "isBytes": true,
+      "isMutable": true,
+      "isPublic": true,
+      "default": "1gb"
+    }
+  }
+}

package/errors/errors.json

@@ -0,0 +1,100 @@
+{
+  "FW_BUILD_NOT_FOUND": {
+    "data": {
+      "_id": "Database document _id value for the missing course build"
+    },
+    "description": "Framework build could not be found in the database",
+    "statusCode": 404
+  },
+  "FW_CLI_BUILD_FAILED": {
+    "data": {
+      "cmd": "The command that caused the error",
+      "raw": "The raw error output"
+    },
+    "description": "Framework build using the adapt-cli failed",
+    "statusCode": 500
+  },
+  "FW_CLI_UNKNOWN_CMD": {
+    "data": {
+      "command": "The command"
+    },
+    "description": "Framework build using the adapt-cli failed",
+    "statusCode": 500
+  },
+  "FW_IMPORT_CONTENT_FAILED": {
+    "data": {
+      "errors": "Accompanying errors"
+    },
+    "description": "Import of framework content failed",
+    "statusCode": 400
+  },
+  "FW_IMPORT_FAILED": {
+    "data": {
+      "error": "The error"
+    },
+    "description": "Import of framework course failed",
+    "statusCode": 400
+  },
+  "FW_IMPORT_INCOMPAT": {
+    "data": {
+      "import": "Framework version used in import course",
+      "installed": "Framework version currently installed on the server"
+    },
+    "description": "Course for import uses a framework version incompatible with that installed",
+    "statusCode": 400
+  },
+  "FW_IMPORT_INVALID": {
+    "description": "An invalid import zip has been provided",
+    "statusCode": 400
+  },
+  "FW_IMPORT_INVALID_COURSE": {
+    "description": "An invalid course has been provided",
+    "statusCode": 400
+  },
+  "FW_IMPORT_INVALID_CONTENT": {
+    "description": "An invalid content item has been found in import data",
+    "statusCode": 400,
+    "data": {
+      "item": "The invalid content item"
+    }
+  },
+  "FW_IMPORT_MISSING_PLUGINS": {
+    "description": "Course for import uses plugins which are missing from the server",
+    "statusCode": 400
+  },
+  "FW_IMPORT_PLUGINS_FAILED": {
+    "description": "Import of framework plugins failed",
+    "statusCode": 500
+  },
+  "FW_IMPORT_UNEXPECTED_STRUCTURE": {
+    "description": "Unable to generate valid course structure from input JSON data",
+    "statusCode": 500
+  },
+  "FW_INCOMPAT_PLUGIN_DEP": {
+    "data": {
+      "name": "Incompatible plugin name",
+      "version": "Incompatible plugin version"
+    },
+    "description": "Plugin is incompatible",
+    "statusCode": 500
+  },
+  "FW_INSTALL_FAILED": {
+    "description": "Installation of the framework failed",
+    "statusCode": 500
+  },
+  "FW_INVALID_VERSION": {
+    "data": {
+      "name": "Incompatible plugin name",
+      "version": "Incompatible plugin version"
+    },
+    "description": "Invalid version specified",
+    "statusCode": 400
+  },
+  "FW_MISSING_PLUGIN_DEP": {
+    "data": {
+      "name": "Missing plugin name"
+    },
+    "description": "Plugin is missing a dependency",
+    "statusCode": 500
+  }
+}

package/index.js

@@ -0,0 +1,8 @@
+/**
+ * Adapt framework integration
+ * @namespace adaptframework
+ */
+export { default } from './lib/AdaptFrameworkModule.js'
+export { default as AdaptFrameworkBuild } from './lib/AdaptFrameworkBuild.js'
+export { default as AdaptFrameworkImport } from './lib/AdaptFrameworkImport.js'
+export { default as AdaptFrameworkUtils } from './lib/AdaptFrameworkUtils.js'