adapt-authoring-jsonschema 1.1.2 → 1.1.3

package/.github/workflows/releases.yml

@@ -3,10 +3,16 @@ on:
   push:
     branches:
       - master
+
 jobs:
   release:
     name: Release
     runs-on: ubuntu-latest
+    permissions:
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
+      id-token: write # to enable use of OIDC for trusted publishing and npm provenance
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -16,10 +22,11 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 'lts/*'
+      - name: Update npm
+        run: npm install -g npm@latest
       - name: Install dependencies
         run: npm ci
       - name: Release
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.AAT_NPM_TOKEN }}
-        run: npx semantic-release
+        run: npx semantic-release

package/.github/workflows/standardjs.yml

@@ -0,0 +1,13 @@
+name: Standard.js formatting check
+on: push
+jobs:
+  default:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-node@master
+        with:
+          node-version: 'lts/*'
+          cache: 'npm'
+      - run: npm ci
+      - run: npx standard

package/docs/plugins/schemas-reference.js

@@ -1,74 +1,80 @@
 export default class SchemasReference {
-  constructor(app, config, dir, utils) {
-    this.app = app;
-    this.utils = utils;
+  constructor (app, config, dir, utils) {
+    this.app = app
+    this.utils = utils
   }
-  async run() {
-    this.schemas = await this.loadSchemas();
-    this.manualFile = 'schemas-reference.md';
-    this.contents = Object.keys(this.schemas);
-    this.replace = { 'LIST': this.generateList() };
+
+  async run () {
+    this.schemas = await this.loadSchemas()
+    this.manualFile = 'schemas-reference.md'
+    this.contents = Object.keys(this.schemas)
+    this.replace = { LIST: this.generateList() }
   }
-  async loadSchemas() {
-    const schema = await this.app.waitForModule('jsonschema');
+
+  async loadSchemas () {
+    const schema = await this.app.waitForModule('jsonschema')
     return Object.keys(schema.schemas)
       .sort((a, b) => a.localeCompare(b))
-      .reduce((schemas, s) => Object.assign(schemas, { [s]: schema.schemas[s].raw }), {});
+      .reduce((schemas, s) => Object.assign(schemas, { [s]: schema.schemas[s].raw }), {})
   }
-  generateList() {
+
+  generateList () {
     return Object.entries(this.schemas).reduce((output, [dep, schema]) => {
       return `${output}<h3 id="${dep.toLowerCase()}" class="dep">${dep}</h3>
       
       ${this.schemaToMd(schema)}
       
-      `;
-    }, '');
+      `
+    }, '')
   }
-  schemaToMd(schema) {
-    let output = '';
-    if(schema.description) {
-      output += `<div class="desc">${schema.description}</div>\n\n`;
+
+  schemaToMd (schema) {
+    let output = ''
+    if (schema.description) {
+      output += `<div class="desc">${schema.description}</div>\n\n`
     }
-    let s;
-    if(schema.properties) {
-      s = schema;
-    } else if(schema.$patch) {
-      s = schema.$patch.with;
-      const ref = schema.$patch.source.$ref;
-      output += `<div class="extension">Patches <a href="#/schemas-reference?id=${ref}">${ref}</a></div>`;
-    } else if(schema.$merge) {
-      s = schema.$merge.with;
-      const ref = schema.$merge?.source?.$ref;
-      output += `<div class="extension">${ref ? `Merges with <a href="#/schemas-reference?id=${ref}">${ref}</a>` : 'This is a merge schema'}</div>\n\n`;
+    let s
+    if (schema.properties) {
+      s = schema
+    } else if (schema.$patch) {
+      s = schema.$patch.with
+      const ref = schema.$patch.source.$ref
+      output += `<div class="extension">Patches <a href="#/schemas-reference?id=${ref}">${ref}</a></div>`
+    } else if (schema.$merge) {
+      s = schema.$merge.with
+      const ref = schema.$merge?.source?.$ref
+      output += `<div class="extension">${ref ? `Merges with <a href="#/schemas-reference?id=${ref}">${ref}</a>` : 'This is a merge schema'}</div>\n\n`
     }
-    const { properties, required } = s;
+    const { properties, required } = s
 
-    if(!properties) {
-      return;
+    if (!properties) {
+      return
     }
-    if(required) {
-      output += `<div class="required">Fields in bold are required.</div>\n\n`;
+    if (required) {
+      output += '<div class="required">Fields in bold are required.</div>\n\n'
     }
-    const table = `<tr><th>Attribute</th><th>Type</th><th>Default</th><th>Description</th></tr>${this.tableRowsFromProps(properties, required)}`;
-    return `${output}<table class="schema">${table}</table>`;
+    const table = `<tr><th>Attribute</th><th>Type</th><th>Default</th><th>Description</th></tr>${this.tableRowsFromProps(properties, required)}`
+    return `${output}<table class="schema">${table}</table>`
   }
-  tableRowsFromProps(properties, required = [], parent) {
+
+  tableRowsFromProps (properties, required = [], parent) {
     return Object.entries(properties).reduce((output, [attr, config]) => {
-      const attrKey = (parent ? parent + '.' : '') + attr;
-      output +=  `<tr class="${config.default === undefined && required && required.includes(attr) ? 'required' : ''}">\n`;
-      output += `<td>${attrKey}</td>\n`;
-      output += `<td>${config.type}</td>\n`;
-      output += `<td>${config.default !== undefined ? this.defaultToMd(config.default) : ''}</td>\n`;
-      output += `<td>${config.description || ' '}</td>\n`;
-      output +=  `</tr>\n`;
-      if(config.properties) output += this.tableRowsFromProps(config.properties, config.required, attrKey);
-      return output;
-    }, '');
+      const attrKey = (parent ? parent + '.' : '') + attr
+      output += `<tr class="${config.default === undefined && required && required.includes(attr) ? 'required' : ''}">\n`
+      output += `<td>${attrKey}</td>\n`
+      output += `<td>${config.type}</td>\n`
+      output += `<td>${config.default !== undefined ? this.defaultToMd(config.default) : ''}</td>\n`
+      output += `<td>${config.description || ' '}</td>\n`
+      output += '</tr>\n'
+      if (config.properties) output += this.tableRowsFromProps(config.properties, config.required, attrKey)
+      return output
+    }, '')
   }
+
   /**
    * Returns a string formatted nicely for markdown
    */
-  defaultToMd(val) {
-    return `<pre>${JSON.stringify(val)}</pre>`;
+  defaultToMd (val) {
+    return `<pre>${JSON.stringify(val)}</pre>`
   }
 }

package/lib/JsonSchema.js

@@ -149,7 +149,7 @@ class JsonSchema {
       }))
     }
     this.built = built
-    if(options.compile !== false) { // don't compile when option present (e.g. when running build recursively)
+    if (options.compile !== false) { // don't compile when option present (e.g. when running build recursively)
       this.compiled = await this.validator.compileAsync(built)
     }
     this.isBuilding = false
@@ -203,7 +203,7 @@ class JsonSchema {
   validate (dataToValidate, options) {
     const opts = _.defaults(options, { useDefaults: true, ignoreRequired: false })
     const data = _.defaults(_.cloneDeep(dataToValidate), opts.useDefaults ? this.getObjectDefaults() : {})
-    if(!this.compiled) { // fallback in the case that the compiled function is missing
+    if (!this.compiled) { // fallback in the case that the compiled function is missing
       this.log('warn', 'NO_COMPILED_FUNC', this.name)
       this.validator.compile(this.built)
     }

package/lib/JsonSchemaModule.js

@@ -32,7 +32,7 @@ class JsonSchemaModule extends AbstractModule {
      * Invoked when schemas are registered
      * @type {Hook}
      */
-    this.registerSchemasHook = new Hook
+    this.registerSchemasHook = new Hook()
     /**
      * Tags and attributes to be whitelisted by the XSS filter
      * @type {Object}
@@ -53,9 +53,9 @@ class JsonSchemaModule extends AbstractModule {
       keywords: Keywords.all
     })
     this.addStringFormats({
-      'date-time': /[A-za-z0-9:+\(\)]+/,
+      'date-time': /[A-za-z0-9:+()]+/,
       time: /^(\d{2}):(\d{2}):(\d{2})\+(\d{2}):(\d{2})$/,
-      uri: /^(.+):\/\/(www\.)?[-a-zA-Z0-9@:%_\+.~#?&//=]{1,256}/
+      uri: /^(.+):\/\/(www\.)?[-a-zA-Z0-9@:%_+.~#?&//=]{1,256}/
     })
     await this.resetSchemaRegistry()
 
@@ -109,19 +109,21 @@ class JsonSchemaModule extends AbstractModule {
 
   /**
    * Searches all Adapt dependencies for any local JSON schemas and registers them for use in the app. Schemas must be located in in a `/schema` folder, and be named appropriately: `*.schema.json`.
+   * @param options {object}
+   * @param options.quiet {Boolean} Set to true to suppress logs
    * @return {Promise}
    */
-  async registerSchemas ({ quiet }) {
+  async registerSchemas (options = {}) {
     await this.resetSchemaRegistry()
     await Promise.all(Object.values(this.app.dependencies).map(async d => {
-      if(d.name === this.name) return
+      if (d.name === this.name) return
       const files = await glob('schema/*.schema.json', { cwd: d.rootDir, absolute: true })
       ;(await Promise.allSettled(files.map(f => this.registerSchema(f))))
         .filter(r => r.status === 'rejected')
         .forEach(r => this.log('warn', r.reason))
     }))
     await this.registerSchemasHook.invoke()
-    if(quiet !== true) this.logSchemas()
+    if (options.quiet !== true) this.logSchemas()
   }
 
   /**
@@ -215,7 +217,7 @@ class JsonSchemaModule extends AbstractModule {
   logSchemas () {
     this.log('debug', 'SCHEMAS', Object.keys(this.schemas))
     this.log('debug', 'SCHEMA_EXTENSIONS', Object.entries(this.schemas).reduce((m, [k, v]) => {
-      if(v.extensions.length) m[k] = v.extensions
+      if (v.extensions.length) m[k] = v.extensions
       return m
     }, {}))
   }

package/lib/typedefs.js

@@ -45,4 +45,4 @@
 * @typedef {Object} ValidateOptions
 * @property {Boolean} useDefaults Whether to apply defaults
 * @property {Boolean} ignoreRequired Whether to ignore missing required fields
-*/
+*/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "adapt-authoring-jsonschema",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Module to add support for the JSON schema specification",
   "homepage": "https://github.com/adapt-security/adapt-authoring-jsonschema",
   "license": "GPL-3.0",
@@ -23,16 +23,15 @@
     "adapt-authoring-core": "github:adapt-security/adapt-authoring-core"
   },
   "devDependencies": {
-    "eslint": "^9.12.0",
-    "standard": "^17.1.0",
-    "@semantic-release/commit-analyzer": "^9.0.2",
+    "@semantic-release/commit-analyzer": "^13.0.1",
     "@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"
+    "@semantic-release/github": "^12.0.2",
+    "@semantic-release/npm": "^13.1.2",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "conventional-changelog-eslint": "^6.0.0",
+    "semantic-release": "^25.0.2",
+    "semantic-release-replace-plugin": "^1.2.7",
+    "standard": "^17.1.0"
   },
   "release": {
     "plugins": [

package/.eslintignore

@@ -1 +0,0 @@
-node_modules

package/.eslintrc

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