adapt-authoring-jsonschema 0.0.1 → 1.1.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/adapt-authoring.json

@@ -1,13 +1,13 @@
-{
-  "essentialType": "schema",
-  "documentation": {
-    "enable": true,
-    "manualPlugins": ["docs/plugins/schemas-reference.js"],
-    "manualPages": {
-      "schema-examples.md": "reference",
-      "schemas-introduction.md": "basics",
-      "schemas-reference.md": "reference",
-      "writing-a-schema.md": "basics"
-    }
-  }
-}
+{
+  "essentialType": "schema",
+  "documentation": {
+    "enable": true,
+    "manualPlugins": ["docs/plugins/schemas-reference.js"],
+    "manualPages": {
+      "schema-examples.md": "reference",
+      "schemas-introduction.md": "basics",
+      "schemas-reference.md": "reference",
+      "writing-a-schema.md": "basics"
+    }
+  }
+}

package/bin/check.js

@@ -1,43 +1,43 @@
-#!/usr/bin/env node
-/**
- * Checks for duplicate schema properties
-*/
-import { App } from 'adapt-authoring-core'
-
-process.env.NODE_ENV = 'production'
-process.env.ADAPT_AUTHORING_LOGGER__mute = 'true'
-
-let app
-
-async function check () {
-  console.log('Checking for duplicate schema definitions.\n')
-  app = await App.instance.onReady()
-  const schema = await app.waitForModule('jsonschema')
-
-  await Promise.allSettled(Object.keys(schema.schemaPaths).map(async s => {
-    const usedKeys = {}
-    const hierarchy = await schema.loadSchemaHierarchy(s)
-    await Promise.all(hierarchy.map(s => checkSchema(s, usedKeys)))
-    const duplicates = Object.entries(usedKeys).filter(([key, uses]) => uses.length > 1)
-
-    if (duplicates.length) {
-      console.log(`Schema '${s}' contains duplicate definitions for the following properties:`)
-      duplicates.forEach(([prop, schemas]) => console.log(` - ${prop}: ${schemas}`))
-      console.log('')
-      process.exitCode = 1
-    }
-  }))
-  if (process.exitCode !== 1) console.log('No duplicates found.')
-  process.exit()
-}
-
-async function checkSchema (schema, usedKeys) {
-  const props = schema.properties ?? schema?.$patch?.with?.properties ?? schema?.$merge?.with?.properties
-  Object.keys(props).forEach(p => {
-    if (p === '_globals') return
-    if (!usedKeys[p]) usedKeys[p] = []
-    usedKeys[p].push(schema.$anchor)
-  })
-}
-
-check()
+#!/usr/bin/env node
+/**
+ * Checks for duplicate schema properties
+*/
+import { App } from 'adapt-authoring-core'
+
+process.env.NODE_ENV = 'production'
+process.env.ADAPT_AUTHORING_LOGGER__mute = 'true'
+
+let app
+
+async function check () {
+  console.log('Checking for duplicate schema definitions.\n')
+  app = await App.instance.onReady()
+  const schema = await app.waitForModule('jsonschema')
+
+  await Promise.allSettled(Object.keys(schema.schemaPaths).map(async s => {
+    const usedKeys = {}
+    const hierarchy = await schema.loadSchemaHierarchy(s)
+    await Promise.all(hierarchy.map(s => checkSchema(s, usedKeys)))
+    const duplicates = Object.entries(usedKeys).filter(([key, uses]) => uses.length > 1)
+
+    if (duplicates.length) {
+      console.log(`Schema '${s}' contains duplicate definitions for the following properties:`)
+      duplicates.forEach(([prop, schemas]) => console.log(` - ${prop}: ${schemas}`))
+      console.log('')
+      process.exitCode = 1
+    }
+  }))
+  if (process.exitCode !== 1) console.log('No duplicates found.')
+  process.exit()
+}
+
+async function checkSchema (schema, usedKeys) {
+  const props = schema.properties ?? schema?.$patch?.with?.properties ?? schema?.$merge?.with?.properties
+  Object.keys(props).forEach(p => {
+    if (p === '_globals') return
+    if (!usedKeys[p]) usedKeys[p] = []
+    usedKeys[p].push(schema.$anchor)
+  })
+}
+
+check()

package/conf/config.schema.json

@@ -1,26 +1,26 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "type": "object",
-  "properties": {
-    "enableCache": {
-      "description": "Whether schema data should be cached",
-      "type": "boolean",
-      "default": true
-    },
-    "formatOverrides": {
-      "description": "Custom RegExp overrides for Ajv string formats",
-      "type": "object",
-      "default": {}
-    },
-    "xssWhitelist": {
-      "description": "Attributes which should be whitelisted when run through the XSS sanitiser.",
-      "type": "object",
-      "default": {}
-    },
-    "xssWhitelistOverride": {
-      "description": "If set to false, the xssWhitelist value will EXTEND the default XSS whitelist. If set to true, it will REPLACE it.",
-      "type": "boolean",
-      "default": false
-    }
-  }
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "enableCache": {
+      "description": "Whether schema data should be cached",
+      "type": "boolean",
+      "default": true
+    },
+    "formatOverrides": {
+      "description": "Custom RegExp overrides for Ajv string formats",
+      "type": "object",
+      "default": {}
+    },
+    "xssWhitelist": {
+      "description": "Attributes which should be whitelisted when run through the XSS sanitiser.",
+      "type": "object",
+      "default": {}
+    },
+    "xssWhitelistOverride": {
+      "description": "If set to false, the xssWhitelist value will EXTEND the default XSS whitelist. If set to true, it will REPLACE it.",
+      "type": "boolean",
+      "default": false
+    }
+  }
 }