Various type fixes

Author: colinrotherham

jest.config.js

@@ -31,5 +31,5 @@ export default {
 }
 
 /**
- * @import { Config, ProjectConfig } from 'jest'
+ * @import { Config } from 'jest'
  */

manage_breast_screening/assets/js/check-in.js

@@ -1,18 +1,26 @@
 import setSubmit from './set-submit.js'
 
-/*
-Enhance an HTML form to intercept submit events and instead fetch the form action URL.
-If successful, show child elements with data-show-on-submit, and hide those with data-hide-on-submit.
-If unsuccessful, or the fetch times out, force a page refresh.
-*/
+/**
+ * Enhance an HTML form to intercept submit events and instead fetch the form action URL.
+ * If successful, show child elements with data-show-on-submit, and hide those with data-hide-on-submit.
+ * If unsuccessful, or the fetch times out, force a page refresh.
+ */
 class CheckIn {
+  /**
+   * @param {Element | null} [$root] - HTML element to use for component
+   */
   constructor($root) {
-    if (!$root) {
-      throw Error('CheckIn initialised without a root element')
+    if (!$root || !($root instanceof HTMLElement)) {
+      throw new Error('CheckIn initialised without a root element')
+    }
+
+    const $form = $root.querySelector('form')
+    if (!$form) {
+      throw new Error('CheckIn initialised without a form element')
     }
 
     this.$root = $root
-    this.$form = $root.querySelector('form')
+    this.$form = $form
     this.$showOnSubmit = $root.querySelectorAll('[data-show-on-submit]')
     this.$hideOnSubmit = $root.querySelectorAll('[data-hide-on-submit]')
 

manage_breast_screening/assets/js/set-submit.js

@@ -9,27 +9,30 @@ const TIMEOUT = 2000
  * @param {object} [options] - Handler options
  * @param {(this: HTMLFormElement) => void} [options.onBeforeSubmit] - Callback before submission
  * @param {(this: HTMLFormElement, response: Response) => void} [options.onSuccess] - Callback on successful response
- * @param {(this: HTMLFormElement, error: any) => void} [options.onError] - Callback on error
+ * @param {(this: HTMLFormElement, error: Error) => void} [options.onError] - Callback on error
  */
 export default ($form, options = {}) => {
   if (!$form || !($form instanceof HTMLFormElement)) {
-    throw Error('setSubmit must be called with an HTMLFormElement')
+    throw new Error('setSubmit must be called with an HTMLFormElement')
   }
 
   const method = $form.method
   const action = $form.action
 
   if (!method || !action) {
-    throw Error('Form method and action must be defined')
+    throw new Error('Form method and action must be defined')
   }
 
-  const doSubmit = async () => {
+  async function doSubmit() {
     if (options.onBeforeSubmit) {
       options.onBeforeSubmit.call($form)
     }
 
+    /** @type {RequestInit} */
     const fetchOptions = { method: method, body: new FormData($form) }
-    if (AbortSignal.timeout !== undefined) {
+
+    // Check for timeout support
+    if ('AbortSignal' in window && 'timeout' in AbortSignal) {
       fetchOptions.signal = AbortSignal.timeout(TIMEOUT)
     }
 
@@ -41,7 +44,7 @@ export default ($form, options = {}) => {
         throw new Error(`Response status: ${response.status}`)
       }
     } catch (e) {
-      if (options.onError) {
+      if (options.onError && e instanceof Error) {
         options.onError.apply($form, [e])
       }
       return

manage_breast_screening/assets/js/set-submit.test.js

@@ -18,6 +18,7 @@ describe('setSubmit', () => {
   /** @type {Response} */
   let successResponse
 
+  /** @type {Error} */
   let error
 
   beforeEach(() => {
@@ -58,7 +59,7 @@ describe('setSubmit', () => {
     await user.click(button)
 
     expect(beforeSubmit).toBe(true)
-    expect(successResponse.status).toEqual(200)
+    expect(successResponse).toHaveProperty('status', 200)
     expect(error).toBeUndefined()
   })
 

manage_breast_screening/templates/.eslintrc.js

@@ -12,7 +12,7 @@ export default {
       },
       parserOptions: {
         // Note: Allow ES2015 for import/export syntax
-        ecmaVersion: '2015'
+        ecmaVersion: 2015
       },
       plugins: ['es-x'],
       rules: {

rollup.config.js

@@ -1,8 +1,13 @@
 import commonjs from '@rollup/plugin-commonjs'
 import { nodeResolve } from '@rollup/plugin-node-resolve'
 import terser from '@rollup/plugin-terser'
-import { babel } from '@rollup/plugin-babel';
+import { babel } from '@rollup/plugin-babel'
 
+/**
+ * Rollup config
+ *
+ * @type {RollupOptions}
+ */
 export default {
   input: 'manage_breast_screening/assets/js/index.js',
 
@@ -40,3 +45,7 @@ export default {
     babel({ babelHelpers: 'bundled' }) // must come after commonjs
   ]
 }
+
+/**
+ * @import { RollupOptions } from 'rollup'
+ */