adapt-authoring-jsonschema 0.0.1 → 1.1.0

package/lib/XSSDefaults.js

@@ -1,142 +1,142 @@
-export default {
-  a: ['class', 'href', 'target', 'title'],
-  abbr: ['title'],
-  address: [],
-  area: ['alt', 'coords', 'href', 'shape'],
-  article: [],
-  aside: ['aria-hidden', 'class', 'role'],
-  audio: [
-    'autoplay',
-    'controls',
-    'crossorigin',
-    'loop',
-    'muted',
-    'preload',
-    'src'
-  ],
-  b: [],
-  bdi: ['dir'],
-  bdo: ['dir'],
-  big: [],
-  blockquote: ['cite'],
-  br: [],
-  button: ['class'],
-  caption: [],
-  center: [],
-  cite: [],
-  code: [],
-  col: ['align', 'span', 'valign', 'width'],
-  colgroup: ['align', 'span', 'valign', 'width'],
-  data: [],
-  dd: [],
-  del: ['datetime'],
-  dfn: [],
-  details: ['open'],
-  div: [
-    'aria-describedby',
-    'aria-description',
-    'aria-label',
-    'aria-hidden',
-    'class',
-    'role',
-    'tabindex'
-  ],
-  dl: [],
-  dt: [],
-  em: [],
-  figcaption: [],
-  figure: ['class'],
-  font: ['color', 'face', 'size'],
-  footer: [],
-  h1: ['class'],
-  h2: ['class'],
-  h3: ['class'],
-  h4: ['class'],
-  h5: ['class'],
-  h6: ['class'],
-  header: [],
-  hr: [],
-  i: [],
-  img: [
-    'alt',
-    'aria-hidden',
-    'aria-label',
-    'class',
-    'height',
-    'loading',
-    'src',
-    'title',
-    'width'
-  ],
-  ins: ['datetime'],
-  kbd: [],
-  li: ['class'],
-  mark: [],
-  math: [],
-  mfrac: [],
-  mi: [],
-  mn: [],
-  mo: [],
-  mover: [],
-  mrow: [],
-  ms: [],
-  mspace: [],
-  msub: [],
-  msubsup: [],
-  msup: [],
-  mtext: [],
-  munder: [],
-  munderover: [],
-  nav: [],
-  ol: ['class'],
-  p: ['lang'],
-  pre: [],
-  q: [],
-  rp: [],
-  rt: [],
-  ruby: [],
-  s: [],
-  samp: [],
-  section: [],
-  small: [],
-  span: [
-    'aria-describedby',
-    'aria-description',
-    'aria-label',
-    'aria-hidden',
-    'class',
-    'role',
-    'tabindex'
-  ],
-  sub: [],
-  summary: [],
-  sup: [],
-  strong: [],
-  strike: [],
-  table: ['align', 'border', 'width', 'valign'],
-  tbody: ['align', 'valign'],
-  td: ['align', 'colspan', 'rowspan', 'valign', 'width'],
-  tfoot: ['align', 'valign'],
-  th: ['align', 'colspan', 'rowspan', 'valign', 'width'],
-  thead: ['align', 'valign'],
-  time: [],
-  tr: ['align', 'rowspan', 'valign'],
-  tt: [],
-  u: [],
-  ul: ['class'],
-  var: [],
-  video: [
-    'autoplay',
-    'controls',
-    'crossorigin',
-    'loop',
-    'muted',
-    'playsinline',
-    'poster',
-    'preload',
-    'src',
-    'height',
-    'width'
-  ],
-  wbr: []
-}
+export default {
+  a: ['class', 'href', 'target', 'title'],
+  abbr: ['title'],
+  address: [],
+  area: ['alt', 'coords', 'href', 'shape'],
+  article: [],
+  aside: ['aria-hidden', 'class', 'role'],
+  audio: [
+    'autoplay',
+    'controls',
+    'crossorigin',
+    'loop',
+    'muted',
+    'preload',
+    'src'
+  ],
+  b: [],
+  bdi: ['dir'],
+  bdo: ['dir'],
+  big: [],
+  blockquote: ['cite'],
+  br: [],
+  button: ['class'],
+  caption: [],
+  center: [],
+  cite: [],
+  code: [],
+  col: ['align', 'span', 'valign', 'width'],
+  colgroup: ['align', 'span', 'valign', 'width'],
+  data: [],
+  dd: [],
+  del: ['datetime'],
+  dfn: [],
+  details: ['open'],
+  div: [
+    'aria-describedby',
+    'aria-description',
+    'aria-label',
+    'aria-hidden',
+    'class',
+    'role',
+    'tabindex'
+  ],
+  dl: [],
+  dt: [],
+  em: [],
+  figcaption: [],
+  figure: ['class'],
+  font: ['color', 'face', 'size'],
+  footer: [],
+  h1: ['class'],
+  h2: ['class'],
+  h3: ['class'],
+  h4: ['class'],
+  h5: ['class'],
+  h6: ['class'],
+  header: [],
+  hr: [],
+  i: [],
+  img: [
+    'alt',
+    'aria-hidden',
+    'aria-label',
+    'class',
+    'height',
+    'loading',
+    'src',
+    'title',
+    'width'
+  ],
+  ins: ['datetime'],
+  kbd: [],
+  li: ['class'],
+  mark: [],
+  math: [],
+  mfrac: [],
+  mi: [],
+  mn: [],
+  mo: [],
+  mover: [],
+  mrow: [],
+  ms: [],
+  mspace: [],
+  msub: [],
+  msubsup: [],
+  msup: [],
+  mtext: [],
+  munder: [],
+  munderover: [],
+  nav: [],
+  ol: ['class'],
+  p: ['lang'],
+  pre: [],
+  q: [],
+  rp: [],
+  rt: [],
+  ruby: [],
+  s: [],
+  samp: [],
+  section: [],
+  small: [],
+  span: [
+    'aria-describedby',
+    'aria-description',
+    'aria-label',
+    'aria-hidden',
+    'class',
+    'role',
+    'tabindex'
+  ],
+  sub: [],
+  summary: [],
+  sup: [],
+  strong: [],
+  strike: [],
+  table: ['align', 'border', 'width', 'valign'],
+  tbody: ['align', 'valign'],
+  td: ['align', 'colspan', 'rowspan', 'valign', 'width'],
+  tfoot: ['align', 'valign'],
+  th: ['align', 'colspan', 'rowspan', 'valign', 'width'],
+  thead: ['align', 'valign'],
+  time: [],
+  tr: ['align', 'rowspan', 'valign'],
+  tt: [],
+  u: [],
+  ul: ['class'],
+  var: [],
+  video: [
+    'autoplay',
+    'controls',
+    'crossorigin',
+    'loop',
+    'muted',
+    'playsinline',
+    'poster',
+    'preload',
+    'src',
+    'height',
+    'width'
+  ],
+  wbr: []
+}

package/lib/typedefs.js

@@ -1,48 +1,48 @@
-/**
- * This file exists to define the below types for documentation purposes.
- */
-/**
- * Ajv JSON Schema validator
- * @memberof jsonschema
- * @external Ajv
- * @see {@link https://ajv.js.org/api.html#ajv-constructor-and-methods}
- */
-/**
- * Ajv custom keyword definition
- * @memberof jsonschema
- * @external AjvKeyword
- * @see {@link https://ajv.js.org/keywords.html}
- */
-/**
- * @memberof jsonschema
- * @typedef {Object} ApplyPatchProperties
- * @property {Object} extendAnnotations Whether annotation properties should be overwitten by the patch
- * @property {Object} strict Restricts patches to only merge/patch schemas
- * @property {Object} overwriteProperties Whether existing properties should be overwritten by the patch schema
-*/
-/**
-* @memberof jsonschema
-* @typedef {Object} LoadSchemaOptions
-* @property {Boolean} applyExtensions Whether extension schemas are applied
-* @property {function} extensionFilter Function to selectively apply schema extensions. Function should return a boolean to signify whether the extension should be applied
-* @property {Boolean} useCache Whether cached should be returned
-*/
-/**
-* @memberof jsonschema
-* @typedef {Object} RegisterSchemaOptions
-* @property {Boolean} replace Will replace the existing schema if one exists
-*/
-/**
-* @memberof jsonschema
-* @typedef {Object} SanitiseOptions
-* @property {Boolean} isInternal Whether internal attributes should be filtered
-* @property {Boolean} isReadOnly Whether read-only attributes should be filtered
-* @property {Boolean} sanitiseHtml Whether HTML text should be filtered
-* @property {Boolean} strict Whether to throw errors
-*/
-/**
-* @memberof jsonschema
-* @typedef {Object} ValidateOptions
-* @property {Boolean} useDefaults Whether to apply defaults
-* @property {Boolean} ignoreRequired Whether to ignore missing required fields
+/**
+ * This file exists to define the below types for documentation purposes.
+ */
+/**
+ * Ajv JSON Schema validator
+ * @memberof jsonschema
+ * @external Ajv
+ * @see {@link https://ajv.js.org/api.html#ajv-constructor-and-methods}
+ */
+/**
+ * Ajv custom keyword definition
+ * @memberof jsonschema
+ * @external AjvKeyword
+ * @see {@link https://ajv.js.org/keywords.html}
+ */
+/**
+ * @memberof jsonschema
+ * @typedef {Object} ApplyPatchProperties
+ * @property {Object} extendAnnotations Whether annotation properties should be overwitten by the patch
+ * @property {Object} strict Restricts patches to only merge/patch schemas
+ * @property {Object} overwriteProperties Whether existing properties should be overwritten by the patch schema
+*/
+/**
+* @memberof jsonschema
+* @typedef {Object} LoadSchemaOptions
+* @property {Boolean} applyExtensions Whether extension schemas are applied
+* @property {function} extensionFilter Function to selectively apply schema extensions. Function should return a boolean to signify whether the extension should be applied
+* @property {Boolean} useCache Whether cached should be returned
+*/
+/**
+* @memberof jsonschema
+* @typedef {Object} RegisterSchemaOptions
+* @property {Boolean} replace Will replace the existing schema if one exists
+*/
+/**
+* @memberof jsonschema
+* @typedef {Object} SanitiseOptions
+* @property {Boolean} isInternal Whether internal attributes should be filtered
+* @property {Boolean} isReadOnly Whether read-only attributes should be filtered
+* @property {Boolean} sanitiseHtml Whether HTML text should be filtered
+* @property {Boolean} strict Whether to throw errors
+*/
+/**
+* @memberof jsonschema
+* @typedef {Object} ValidateOptions
+* @property {Boolean} useDefaults Whether to apply defaults
+* @property {Boolean} ignoreRequired Whether to ignore missing required fields
 */

package/package.json

@@ -1,29 +1,64 @@
-{
-  "name": "adapt-authoring-jsonschema",
-  "version": "0.0.1",
-  "description": "Module to add support for the JSON schema specification",
-  "homepage": "https://github.com/adapt-security/adapt-authoring-jsonschema",
-  "license": "GPL-3.0",
-  "type": "module",
-  "main": "index.js",
-  "bin": {
-    "at-schemacheck": "./bin/check.js"
-  },
-  "repository": "github:adapt-security/adapt-authoring-jsonschema",
-  "dependencies": {
-    "ajv": "^8.12.0",
-    "bytes": "^3.1.2",
-    "glob": "^11.0.0",
-    "lodash": "^4.17.21",
-    "ms": "^2.1.3",
-    "safe-regex": "2.1.1",
-    "xss": "^1.0.14"
-  },
-  "peerDependencies": {
-    "adapt-authoring-core": "github:adapt-security/adapt-authoring-core"
-  },
-  "devDependencies": {
-    "eslint": "^9.12.0",
-    "standard": "^17.1.0"
-  }
-}
+{
+  "name": "adapt-authoring-jsonschema",
+  "version": "1.1.0",
+  "description": "Module to add support for the JSON schema specification",
+  "homepage": "https://github.com/adapt-security/adapt-authoring-jsonschema",
+  "license": "GPL-3.0",
+  "type": "module",
+  "main": "index.js",
+  "bin": {
+    "at-schemacheck": "./bin/check.js"
+  },
+  "repository": "github:adapt-security/adapt-authoring-jsonschema",
+  "dependencies": {
+    "ajv": "^8.12.0",
+    "bytes": "^3.1.2",
+    "glob": "^11.0.0",
+    "lodash": "^4.17.21",
+    "ms": "^2.1.3",
+    "safe-regex": "2.1.1",
+    "xss": "^1.0.14"
+  },
+  "peerDependencies": {
+    "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/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}"
+        }
+      ]
+    ]
+  }
+}

package/schema/base.schema.json

@@ -1,13 +1,13 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$anchor": "base",
-  "description": "The base schema inherited by all other schemas",
-  "type": "object",
-  "properties": {
-    "_id": {
-      "description": "Unique identifier",
-      "type": "string",
-      "isObjectId": true
-    }
-  }
-}
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$anchor": "base",
+  "description": "The base schema inherited by all other schemas",
+  "type": "object",
+  "properties": {
+    "_id": {
+      "description": "Unique identifier",
+      "type": "string",
+      "isObjectId": true
+    }
+  }
+}