@defra/forms-engine-plugin 4.14.0 → 4.14.2-beta

package/.server/client/javascripts/debounce-click.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Attaches {@link handleButtonClick} to every button that carries the
+ * `prevent-multiple-clicks` CSS class so that double-submissions are blocked
+ * across the page.
+ *
+ * Safe to call multiple times — adding the same listener twice on a given
+ * element has no effect (the browser deduplicates identical listener/options
+ * pairs).
+ */
+export function initDebounceClick(): void;

package/.server/client/javascripts/debounce-click.js

@@ -0,0 +1,58 @@
+/** How long (ms) a button stays locked after the first click. */
+const DEBOUNCE_TIMEOUT_MS = 10_000;
+
+/**
+ * Shared debounce logic used by both the click and keydown handlers.
+ * @param {Event} event
+ */
+function handleActivation(event) {
+  const button = /** @type {HTMLButtonElement} */event.currentTarget;
+  if (button.dataset.debouncing === 'true') {
+    event.preventDefault();
+    event.stopImmediatePropagation();
+    return;
+  }
+  button.dataset.debouncing = 'true';
+  setTimeout(() => {
+    delete button.dataset.debouncing;
+  }, DEBOUNCE_TIMEOUT_MS);
+}
+
+/**
+ * Click handler that prevents a button from being activated more than once
+ * within {@link DEBOUNCE_TIMEOUT_MS}.
+ * @param {MouseEvent} event
+ */
+function handleButtonClick(event) {
+  handleActivation(event);
+}
+
+/**
+ * Keydown handler that prevents a button from being activated more than once
+ * within {@link DEBOUNCE_TIMEOUT_MS} when submitted via Enter or Space.
+ * @param {KeyboardEvent} event
+ */
+function handleButtonKeydown(event) {
+  if (event.key === 'Enter' || event.key === ' ') {
+    handleActivation(event);
+  }
+}
+
+/**
+ * Attaches {@link handleButtonClick} to every button that carries the
+ * `prevent-multiple-clicks` CSS class so that double-submissions are blocked
+ * across the page.
+ *
+ * Safe to call multiple times — adding the same listener twice on a given
+ * element has no effect (the browser deduplicates identical listener/options
+ * pairs).
+ */
+export function initDebounceClick() {
+  const buttons = /** @type {NodeListOf<HTMLButtonElement>} */
+  document.querySelectorAll('.prevent-multiple-clicks');
+  for (const button of buttons) {
+    button.addEventListener('click', handleButtonClick);
+    button.addEventListener('keydown', handleButtonKeydown);
+  }
+}
+//# sourceMappingURL=debounce-click.js.map

package/.server/client/javascripts/debounce-click.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce-click.js","names":["DEBOUNCE_TIMEOUT_MS","handleActivation","event","button","currentTarget","dataset","debouncing","preventDefault","stopImmediatePropagation","setTimeout","handleButtonClick","handleButtonKeydown","key","initDebounceClick","buttons","document","querySelectorAll","addEventListener"],"sources":["../../../src/client/javascripts/debounce-click.js"],"sourcesContent":["/** How long (ms) a button stays locked after the first click. */\nconst DEBOUNCE_TIMEOUT_MS = 10_000\n\n/**\n * Shared debounce logic used by both the click and keydown handlers.\n * @param {Event} event\n */\nfunction handleActivation(event) {\n  const button = /** @type {HTMLButtonElement} */ (event.currentTarget)\n\n  if (button.dataset.debouncing === 'true') {\n    event.preventDefault()\n    event.stopImmediatePropagation()\n    return\n  }\n\n  button.dataset.debouncing = 'true'\n\n  setTimeout(() => {\n    delete button.dataset.debouncing\n  }, DEBOUNCE_TIMEOUT_MS)\n}\n\n/**\n * Click handler that prevents a button from being activated more than once\n * within {@link DEBOUNCE_TIMEOUT_MS}.\n * @param {MouseEvent} event\n */\nfunction handleButtonClick(event) {\n  handleActivation(event)\n}\n\n/**\n * Keydown handler that prevents a button from being activated more than once\n * within {@link DEBOUNCE_TIMEOUT_MS} when submitted via Enter or Space.\n * @param {KeyboardEvent} event\n */\nfunction handleButtonKeydown(event) {\n  if (event.key === 'Enter' || event.key === ' ') {\n    handleActivation(event)\n  }\n}\n\n/**\n * Attaches {@link handleButtonClick} to every button that carries the\n * `prevent-multiple-clicks` CSS class so that double-submissions are blocked\n * across the page.\n *\n * Safe to call multiple times — adding the same listener twice on a given\n * element has no effect (the browser deduplicates identical listener/options\n * pairs).\n */\nexport function initDebounceClick() {\n  const buttons = /** @type {NodeListOf<HTMLButtonElement>} */ (\n    document.querySelectorAll('.prevent-multiple-clicks')\n  )\n\n  for (const button of buttons) {\n    button.addEventListener('click', handleButtonClick)\n    button.addEventListener('keydown', handleButtonKeydown)\n  }\n}\n"],"mappings":"AAAA;AACA,MAAMA,mBAAmB,GAAG,MAAM;;AAElC;AACA;AACA;AACA;AACA,SAASC,gBAAgBA,CAACC,KAAK,EAAE;EAC/B,MAAMC,MAAM,GAAG,gCAAkCD,KAAK,CAACE,aAAc;EAErE,IAAID,MAAM,CAACE,OAAO,CAACC,UAAU,KAAK,MAAM,EAAE;IACxCJ,KAAK,CAACK,cAAc,CAAC,CAAC;IACtBL,KAAK,CAACM,wBAAwB,CAAC,CAAC;IAChC;EACF;EAEAL,MAAM,CAACE,OAAO,CAACC,UAAU,GAAG,MAAM;EAElCG,UAAU,CAAC,MAAM;IACf,OAAON,MAAM,CAACE,OAAO,CAACC,UAAU;EAClC,CAAC,EAAEN,mBAAmB,CAAC;AACzB;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASU,iBAAiBA,CAACR,KAAK,EAAE;EAChCD,gBAAgB,CAACC,KAAK,CAAC;AACzB;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASS,mBAAmBA,CAACT,KAAK,EAAE;EAClC,IAAIA,KAAK,CAACU,GAAG,KAAK,OAAO,IAAIV,KAAK,CAACU,GAAG,KAAK,GAAG,EAAE;IAC9CX,gBAAgB,CAACC,KAAK,CAAC;EACzB;AACF;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASW,iBAAiBA,CAAA,EAAG;EAClC,MAAMC,OAAO,GAAG;EACdC,QAAQ,CAACC,gBAAgB,CAAC,0BAA0B,CACrD;EAED,KAAK,MAAMb,MAAM,IAAIW,OAAO,EAAE;IAC5BX,MAAM,CAACc,gBAAgB,CAAC,OAAO,EAAEP,iBAAiB,CAAC;IACnDP,MAAM,CAACc,gBAAgB,CAAC,SAAS,EAAEN,mBAAmB,CAAC;EACzD;AACF","ignoreList":[]}

package/.server/client/javascripts/debounce-click.test.js

@@ -0,0 +1,191 @@
+import { initDebounceClick } from "./debounce-click.js";
+const DEBOUNCE_TIMEOUT_MS = 10_000;
+
+/**
+ * @param {string} [extraClasses]
+ * @returns {HTMLButtonElement}
+ */
+function makeButton(extraClasses = '') {
+  const button = document.createElement('button');
+  button.className = `prevent-multiple-clicks ${extraClasses}`.trim();
+  document.body.appendChild(button);
+  return button;
+}
+
+/**
+ * @param {HTMLButtonElement} button
+ * @returns {MouseEvent}
+ */
+function click(button) {
+  const event = new MouseEvent('click', {
+    bubbles: true,
+    cancelable: true
+  });
+  button.dispatchEvent(event);
+  return event;
+}
+
+/**
+ * @param {HTMLButtonElement} button
+ * @param {string} key
+ * @returns {KeyboardEvent}
+ */
+function keydown(button, key) {
+  const event = new KeyboardEvent('keydown', {
+    key,
+    bubbles: true,
+    cancelable: true
+  });
+  button.dispatchEvent(event);
+  return event;
+}
+afterEach(() => {
+  document.body.innerHTML = '';
+});
+describe('initDebounceClick', () => {
+  it('attaches a click listener to every .prevent-multiple-clicks button', () => {
+    const b1 = makeButton();
+    const b2 = makeButton();
+    const spy1 = jest.fn();
+    const spy2 = jest.fn();
+    b1.addEventListener('click', spy1);
+    b2.addEventListener('click', spy2);
+    initDebounceClick();
+    click(b1);
+    click(b2);
+    expect(spy1).toHaveBeenCalledTimes(1);
+    expect(spy2).toHaveBeenCalledTimes(1);
+  });
+  it('does not attach to buttons that lack the class', () => {
+    const plain = document.createElement('button');
+    document.body.appendChild(plain);
+    const spy = jest.fn();
+    plain.addEventListener('click', spy);
+    initDebounceClick();
+    click(plain);
+
+    // Listener still runs — debounce was never applied
+    expect(plain.dataset.debouncing).toBeUndefined();
+  });
+});
+describe('handleButtonClick (via initDebounceClick)', () => {
+  beforeEach(() => {
+    jest.useFakeTimers();
+  });
+  afterEach(() => {
+    jest.useRealTimers();
+  });
+  it('sets data-debouncing="true" on the first click', () => {
+    const button = makeButton();
+    initDebounceClick();
+    click(button);
+    expect(button.dataset.debouncing).toBe('true');
+  });
+  it('allows a second click after the debounce timeout expires', () => {
+    const button = makeButton();
+    const spy = jest.fn();
+    button.addEventListener('click', spy);
+    initDebounceClick();
+    click(button);
+    jest.advanceTimersByTime(DEBOUNCE_TIMEOUT_MS);
+    click(button);
+    expect(button.dataset.debouncing).toBe('true');
+    expect(spy).toHaveBeenCalledTimes(2);
+  });
+  it('removes data-debouncing after the timeout', () => {
+    const button = makeButton();
+    initDebounceClick();
+    click(button);
+    expect(button.dataset.debouncing).toBe('true');
+    jest.advanceTimersByTime(DEBOUNCE_TIMEOUT_MS);
+    expect(button.dataset.debouncing).toBeUndefined();
+  });
+  it('prevents the default action on a duplicate click', () => {
+    const button = makeButton();
+    initDebounceClick();
+    click(button);
+    const duplicate = new MouseEvent('click', {
+      bubbles: true,
+      cancelable: true
+    });
+    button.dispatchEvent(duplicate);
+    expect(duplicate.defaultPrevented).toBe(true);
+  });
+  it('stops immediate propagation on a duplicate click', () => {
+    const button = makeButton();
+    initDebounceClick();
+    click(button);
+    const subsequent = jest.fn();
+    button.addEventListener('click', subsequent);
+    click(button);
+    expect(subsequent).not.toHaveBeenCalled();
+  });
+  it('does not fire listeners registered after the handler for a click within the timeout window', () => {
+    const button = makeButton();
+    initDebounceClick();
+    // Registered after initDebounceClick so the debounce handler runs first and
+    // can call stopImmediatePropagation before this listener is reached.
+    const spy = jest.fn();
+    button.addEventListener('click', spy);
+    click(button);
+    jest.advanceTimersByTime(DEBOUNCE_TIMEOUT_MS - 1);
+    click(button);
+
+    // First click let through, second is still within the window — spy blocked
+    expect(spy).toHaveBeenCalledTimes(1);
+  });
+});
+describe('handleButtonKeydown (via initDebounceClick)', () => {
+  beforeEach(() => {
+    jest.useFakeTimers();
+  });
+  afterEach(() => {
+    jest.useRealTimers();
+  });
+  it('sets data-debouncing="true" on Enter', () => {
+    const button = makeButton();
+    initDebounceClick();
+    keydown(button, 'Enter');
+    expect(button.dataset.debouncing).toBe('true');
+  });
+  it('sets data-debouncing="true" on Space', () => {
+    const button = makeButton();
+    initDebounceClick();
+    keydown(button, ' ');
+    expect(button.dataset.debouncing).toBe('true');
+  });
+  it('ignores keys other than Enter and Space', () => {
+    const button = makeButton();
+    initDebounceClick();
+    keydown(button, 'Tab');
+    expect(button.dataset.debouncing).toBeUndefined();
+  });
+  it('prevents default on a duplicate Enter keydown', () => {
+    const button = makeButton();
+    initDebounceClick();
+    keydown(button, 'Enter');
+    const duplicate = keydown(button, 'Enter');
+    expect(duplicate.defaultPrevented).toBe(true);
+  });
+  it('stops immediate propagation on a duplicate keydown within the timeout window', () => {
+    const button = makeButton();
+    initDebounceClick();
+    keydown(button, 'Enter');
+    const spy = jest.fn();
+    button.addEventListener('keydown', spy);
+    keydown(button, 'Enter');
+    expect(spy).not.toHaveBeenCalled();
+  });
+  it('allows a second keydown after the debounce timeout expires', () => {
+    const button = makeButton();
+    const spy = jest.fn();
+    button.addEventListener('keydown', spy);
+    initDebounceClick();
+    keydown(button, 'Enter');
+    jest.advanceTimersByTime(DEBOUNCE_TIMEOUT_MS);
+    keydown(button, 'Enter');
+    expect(button.dataset.debouncing).toBe('true');
+    expect(spy).toHaveBeenCalledTimes(2);
+  });
+});
+//# sourceMappingURL=debounce-click.test.js.map

package/.server/client/javascripts/debounce-click.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce-click.test.js","names":["initDebounceClick","DEBOUNCE_TIMEOUT_MS","makeButton","extraClasses","button","document","createElement","className","trim","body","appendChild","click","event","MouseEvent","bubbles","cancelable","dispatchEvent","keydown","key","KeyboardEvent","afterEach","innerHTML","describe","it","b1","b2","spy1","jest","fn","spy2","addEventListener","expect","toHaveBeenCalledTimes","plain","spy","dataset","debouncing","toBeUndefined","beforeEach","useFakeTimers","useRealTimers","toBe","advanceTimersByTime","duplicate","defaultPrevented","subsequent","not","toHaveBeenCalled"],"sources":["../../../src/client/javascripts/debounce-click.test.js"],"sourcesContent":["import { initDebounceClick } from '~/src/client/javascripts/debounce-click.js'\n\nconst DEBOUNCE_TIMEOUT_MS = 10_000\n\n/**\n * @param {string} [extraClasses]\n * @returns {HTMLButtonElement}\n */\nfunction makeButton(extraClasses = '') {\n  const button = document.createElement('button')\n  button.className = `prevent-multiple-clicks ${extraClasses}`.trim()\n  document.body.appendChild(button)\n  return button\n}\n\n/**\n * @param {HTMLButtonElement} button\n * @returns {MouseEvent}\n */\nfunction click(button) {\n  const event = new MouseEvent('click', { bubbles: true, cancelable: true })\n  button.dispatchEvent(event)\n  return event\n}\n\n/**\n * @param {HTMLButtonElement} button\n * @param {string} key\n * @returns {KeyboardEvent}\n */\nfunction keydown(button, key) {\n  const event = new KeyboardEvent('keydown', {\n    key,\n    bubbles: true,\n    cancelable: true\n  })\n  button.dispatchEvent(event)\n  return event\n}\n\nafterEach(() => {\n  document.body.innerHTML = ''\n})\n\ndescribe('initDebounceClick', () => {\n  it('attaches a click listener to every .prevent-multiple-clicks button', () => {\n    const b1 = makeButton()\n    const b2 = makeButton()\n    const spy1 = jest.fn()\n    const spy2 = jest.fn()\n    b1.addEventListener('click', spy1)\n    b2.addEventListener('click', spy2)\n\n    initDebounceClick()\n\n    click(b1)\n    click(b2)\n\n    expect(spy1).toHaveBeenCalledTimes(1)\n    expect(spy2).toHaveBeenCalledTimes(1)\n  })\n\n  it('does not attach to buttons that lack the class', () => {\n    const plain = document.createElement('button')\n    document.body.appendChild(plain)\n    const spy = jest.fn()\n    plain.addEventListener('click', spy)\n\n    initDebounceClick()\n    click(plain)\n\n    // Listener still runs — debounce was never applied\n    expect(plain.dataset.debouncing).toBeUndefined()\n  })\n})\n\ndescribe('handleButtonClick (via initDebounceClick)', () => {\n  beforeEach(() => {\n    jest.useFakeTimers()\n  })\n\n  afterEach(() => {\n    jest.useRealTimers()\n  })\n\n  it('sets data-debouncing=\"true\" on the first click', () => {\n    const button = makeButton()\n    initDebounceClick()\n\n    click(button)\n\n    expect(button.dataset.debouncing).toBe('true')\n  })\n\n  it('allows a second click after the debounce timeout expires', () => {\n    const button = makeButton()\n    const spy = jest.fn()\n    button.addEventListener('click', spy)\n    initDebounceClick()\n\n    click(button)\n    jest.advanceTimersByTime(DEBOUNCE_TIMEOUT_MS)\n    click(button)\n\n    expect(button.dataset.debouncing).toBe('true')\n    expect(spy).toHaveBeenCalledTimes(2)\n  })\n\n  it('removes data-debouncing after the timeout', () => {\n    const button = makeButton()\n    initDebounceClick()\n\n    click(button)\n    expect(button.dataset.debouncing).toBe('true')\n\n    jest.advanceTimersByTime(DEBOUNCE_TIMEOUT_MS)\n    expect(button.dataset.debouncing).toBeUndefined()\n  })\n\n  it('prevents the default action on a duplicate click', () => {\n    const button = makeButton()\n    initDebounceClick()\n    click(button)\n\n    const duplicate = new MouseEvent('click', {\n      bubbles: true,\n      cancelable: true\n    })\n    button.dispatchEvent(duplicate)\n\n    expect(duplicate.defaultPrevented).toBe(true)\n  })\n\n  it('stops immediate propagation on a duplicate click', () => {\n    const button = makeButton()\n    initDebounceClick()\n    click(button)\n\n    const subsequent = jest.fn()\n    button.addEventListener('click', subsequent)\n\n    click(button)\n\n    expect(subsequent).not.toHaveBeenCalled()\n  })\n\n  it('does not fire listeners registered after the handler for a click within the timeout window', () => {\n    const button = makeButton()\n    initDebounceClick()\n    // Registered after initDebounceClick so the debounce handler runs first and\n    // can call stopImmediatePropagation before this listener is reached.\n    const spy = jest.fn()\n    button.addEventListener('click', spy)\n\n    click(button)\n    jest.advanceTimersByTime(DEBOUNCE_TIMEOUT_MS - 1)\n    click(button)\n\n    // First click let through, second is still within the window — spy blocked\n    expect(spy).toHaveBeenCalledTimes(1)\n  })\n})\n\ndescribe('handleButtonKeydown (via initDebounceClick)', () => {\n  beforeEach(() => {\n    jest.useFakeTimers()\n  })\n\n  afterEach(() => {\n    jest.useRealTimers()\n  })\n\n  it('sets data-debouncing=\"true\" on Enter', () => {\n    const button = makeButton()\n    initDebounceClick()\n\n    keydown(button, 'Enter')\n\n    expect(button.dataset.debouncing).toBe('true')\n  })\n\n  it('sets data-debouncing=\"true\" on Space', () => {\n    const button = makeButton()\n    initDebounceClick()\n\n    keydown(button, ' ')\n\n    expect(button.dataset.debouncing).toBe('true')\n  })\n\n  it('ignores keys other than Enter and Space', () => {\n    const button = makeButton()\n    initDebounceClick()\n\n    keydown(button, 'Tab')\n\n    expect(button.dataset.debouncing).toBeUndefined()\n  })\n\n  it('prevents default on a duplicate Enter keydown', () => {\n    const button = makeButton()\n    initDebounceClick()\n    keydown(button, 'Enter')\n\n    const duplicate = keydown(button, 'Enter')\n\n    expect(duplicate.defaultPrevented).toBe(true)\n  })\n\n  it('stops immediate propagation on a duplicate keydown within the timeout window', () => {\n    const button = makeButton()\n    initDebounceClick()\n    keydown(button, 'Enter')\n\n    const spy = jest.fn()\n    button.addEventListener('keydown', spy)\n    keydown(button, 'Enter')\n\n    expect(spy).not.toHaveBeenCalled()\n  })\n\n  it('allows a second keydown after the debounce timeout expires', () => {\n    const button = makeButton()\n    const spy = jest.fn()\n    button.addEventListener('keydown', spy)\n    initDebounceClick()\n\n    keydown(button, 'Enter')\n    jest.advanceTimersByTime(DEBOUNCE_TIMEOUT_MS)\n    keydown(button, 'Enter')\n\n    expect(button.dataset.debouncing).toBe('true')\n    expect(spy).toHaveBeenCalledTimes(2)\n  })\n})\n"],"mappings":"AAAA,SAASA,iBAAiB;AAE1B,MAAMC,mBAAmB,GAAG,MAAM;;AAElC;AACA;AACA;AACA;AACA,SAASC,UAAUA,CAACC,YAAY,GAAG,EAAE,EAAE;EACrC,MAAMC,MAAM,GAAGC,QAAQ,CAACC,aAAa,CAAC,QAAQ,CAAC;EAC/CF,MAAM,CAACG,SAAS,GAAG,2BAA2BJ,YAAY,EAAE,CAACK,IAAI,CAAC,CAAC;EACnEH,QAAQ,CAACI,IAAI,CAACC,WAAW,CAACN,MAAM,CAAC;EACjC,OAAOA,MAAM;AACf;;AAEA;AACA;AACA;AACA;AACA,SAASO,KAAKA,CAACP,MAAM,EAAE;EACrB,MAAMQ,KAAK,GAAG,IAAIC,UAAU,CAAC,OAAO,EAAE;IAAEC,OAAO,EAAE,IAAI;IAAEC,UAAU,EAAE;EAAK,CAAC,CAAC;EAC1EX,MAAM,CAACY,aAAa,CAACJ,KAAK,CAAC;EAC3B,OAAOA,KAAK;AACd;;AAEA;AACA;AACA;AACA;AACA;AACA,SAASK,OAAOA,CAACb,MAAM,EAAEc,GAAG,EAAE;EAC5B,MAAMN,KAAK,GAAG,IAAIO,aAAa,CAAC,SAAS,EAAE;IACzCD,GAAG;IACHJ,OAAO,EAAE,IAAI;IACbC,UAAU,EAAE;EACd,CAAC,CAAC;EACFX,MAAM,CAACY,aAAa,CAACJ,KAAK,CAAC;EAC3B,OAAOA,KAAK;AACd;AAEAQ,SAAS,CAAC,MAAM;EACdf,QAAQ,CAACI,IAAI,CAACY,SAAS,GAAG,EAAE;AAC9B,CAAC,CAAC;AAEFC,QAAQ,CAAC,mBAAmB,EAAE,MAAM;EAClCC,EAAE,CAAC,oEAAoE,EAAE,MAAM;IAC7E,MAAMC,EAAE,GAAGtB,UAAU,CAAC,CAAC;IACvB,MAAMuB,EAAE,GAAGvB,UAAU,CAAC,CAAC;IACvB,MAAMwB,IAAI,GAAGC,IAAI,CAACC,EAAE,CAAC,CAAC;IACtB,MAAMC,IAAI,GAAGF,IAAI,CAACC,EAAE,CAAC,CAAC;IACtBJ,EAAE,CAACM,gBAAgB,CAAC,OAAO,EAAEJ,IAAI,CAAC;IAClCD,EAAE,CAACK,gBAAgB,CAAC,OAAO,EAAED,IAAI,CAAC;IAElC7B,iBAAiB,CAAC,CAAC;IAEnBW,KAAK,CAACa,EAAE,CAAC;IACTb,KAAK,CAACc,EAAE,CAAC;IAETM,MAAM,CAACL,IAAI,CAAC,CAACM,qBAAqB,CAAC,CAAC,CAAC;IACrCD,MAAM,CAACF,IAAI,CAAC,CAACG,qBAAqB,CAAC,CAAC,CAAC;EACvC,CAAC,CAAC;EAEFT,EAAE,CAAC,gDAAgD,EAAE,MAAM;IACzD,MAAMU,KAAK,GAAG5B,QAAQ,CAACC,aAAa,CAAC,QAAQ,CAAC;IAC9CD,QAAQ,CAACI,IAAI,CAACC,WAAW,CAACuB,KAAK,CAAC;IAChC,MAAMC,GAAG,GAAGP,IAAI,CAACC,EAAE,CAAC,CAAC;IACrBK,KAAK,CAACH,gBAAgB,CAAC,OAAO,EAAEI,GAAG,CAAC;IAEpClC,iBAAiB,CAAC,CAAC;IACnBW,KAAK,CAACsB,KAAK,CAAC;;IAEZ;IACAF,MAAM,CAACE,KAAK,CAACE,OAAO,CAACC,UAAU,CAAC,CAACC,aAAa,CAAC,CAAC;EAClD,CAAC,CAAC;AACJ,CAAC,CAAC;AAEFf,QAAQ,CAAC,2CAA2C,EAAE,MAAM;EAC1DgB,UAAU,CAAC,MAAM;IACfX,IAAI,CAACY,aAAa,CAAC,CAAC;EACtB,CAAC,CAAC;EAEFnB,SAAS,CAAC,MAAM;IACdO,IAAI,CAACa,aAAa,CAAC,CAAC;EACtB,CAAC,CAAC;EAEFjB,EAAE,CAAC,gDAAgD,EAAE,MAAM;IACzD,MAAMnB,MAAM,GAAGF,UAAU,CAAC,CAAC;IAC3BF,iBAAiB,CAAC,CAAC;IAEnBW,KAAK,CAACP,MAAM,CAAC;IAEb2B,MAAM,CAAC3B,MAAM,CAAC+B,OAAO,CAACC,UAAU,CAAC,CAACK,IAAI,CAAC,MAAM,CAAC;EAChD,CAAC,CAAC;EAEFlB,EAAE,CAAC,0DAA0D,EAAE,MAAM;IACnE,MAAMnB,MAAM,GAAGF,UAAU,CAAC,CAAC;IAC3B,MAAMgC,GAAG,GAAGP,IAAI,CAACC,EAAE,CAAC,CAAC;IACrBxB,MAAM,CAAC0B,gBAAgB,CAAC,OAAO,EAAEI,GAAG,CAAC;IACrClC,iBAAiB,CAAC,CAAC;IAEnBW,KAAK,CAACP,MAAM,CAAC;IACbuB,IAAI,CAACe,mBAAmB,CAACzC,mBAAmB,CAAC;IAC7CU,KAAK,CAACP,MAAM,CAAC;IAEb2B,MAAM,CAAC3B,MAAM,CAAC+B,OAAO,CAACC,UAAU,CAAC,CAACK,IAAI,CAAC,MAAM,CAAC;IAC9CV,MAAM,CAACG,GAAG,CAAC,CAACF,qBAAqB,CAAC,CAAC,CAAC;EACtC,CAAC,CAAC;EAEFT,EAAE,CAAC,2CAA2C,EAAE,MAAM;IACpD,MAAMnB,MAAM,GAAGF,UAAU,CAAC,CAAC;IAC3BF,iBAAiB,CAAC,CAAC;IAEnBW,KAAK,CAACP,MAAM,CAAC;IACb2B,MAAM,CAAC3B,MAAM,CAAC+B,OAAO,CAACC,UAAU,CAAC,CAACK,IAAI,CAAC,MAAM,CAAC;IAE9Cd,IAAI,CAACe,mBAAmB,CAACzC,mBAAmB,CAAC;IAC7C8B,MAAM,CAAC3B,MAAM,CAAC+B,OAAO,CAACC,UAAU,CAAC,CAACC,aAAa,CAAC,CAAC;EACnD,CAAC,CAAC;EAEFd,EAAE,CAAC,kDAAkD,EAAE,MAAM;IAC3D,MAAMnB,MAAM,GAAGF,UAAU,CAAC,CAAC;IAC3BF,iBAAiB,CAAC,CAAC;IACnBW,KAAK,CAACP,MAAM,CAAC;IAEb,MAAMuC,SAAS,GAAG,IAAI9B,UAAU,CAAC,OAAO,EAAE;MACxCC,OAAO,EAAE,IAAI;MACbC,UAAU,EAAE;IACd,CAAC,CAAC;IACFX,MAAM,CAACY,aAAa,CAAC2B,SAAS,CAAC;IAE/BZ,MAAM,CAACY,SAAS,CAACC,gBAAgB,CAAC,CAACH,IAAI,CAAC,IAAI,CAAC;EAC/C,CAAC,CAAC;EAEFlB,EAAE,CAAC,kDAAkD,EAAE,MAAM;IAC3D,MAAMnB,MAAM,GAAGF,UAAU,CAAC,CAAC;IAC3BF,iBAAiB,CAAC,CAAC;IACnBW,KAAK,CAACP,MAAM,CAAC;IAEb,MAAMyC,UAAU,GAAGlB,IAAI,CAACC,EAAE,CAAC,CAAC;IAC5BxB,MAAM,CAAC0B,gBAAgB,CAAC,OAAO,EAAEe,UAAU,CAAC;IAE5ClC,KAAK,CAACP,MAAM,CAAC;IAEb2B,MAAM,CAACc,UAAU,CAAC,CAACC,GAAG,CAACC,gBAAgB,CAAC,CAAC;EAC3C,CAAC,CAAC;EAEFxB,EAAE,CAAC,4FAA4F,EAAE,MAAM;IACrG,MAAMnB,MAAM,GAAGF,UAAU,CAAC,CAAC;IAC3BF,iBAAiB,CAAC,CAAC;IACnB;IACA;IACA,MAAMkC,GAAG,GAAGP,IAAI,CAACC,EAAE,CAAC,CAAC;IACrBxB,MAAM,CAAC0B,gBAAgB,CAAC,OAAO,EAAEI,GAAG,CAAC;IAErCvB,KAAK,CAACP,MAAM,CAAC;IACbuB,IAAI,CAACe,mBAAmB,CAACzC,mBAAmB,GAAG,CAAC,CAAC;IACjDU,KAAK,CAACP,MAAM,CAAC;;IAEb;IACA2B,MAAM,CAACG,GAAG,CAAC,CAACF,qBAAqB,CAAC,CAAC,CAAC;EACtC,CAAC,CAAC;AACJ,CAAC,CAAC;AAEFV,QAAQ,CAAC,6CAA6C,EAAE,MAAM;EAC5DgB,UAAU,CAAC,MAAM;IACfX,IAAI,CAACY,aAAa,CAAC,CAAC;EACtB,CAAC,CAAC;EAEFnB,SAAS,CAAC,MAAM;IACdO,IAAI,CAACa,aAAa,CAAC,CAAC;EACtB,CAAC,CAAC;EAEFjB,EAAE,CAAC,sCAAsC,EAAE,MAAM;IAC/C,MAAMnB,MAAM,GAAGF,UAAU,CAAC,CAAC;IAC3BF,iBAAiB,CAAC,CAAC;IAEnBiB,OAAO,CAACb,MAAM,EAAE,OAAO,CAAC;IAExB2B,MAAM,CAAC3B,MAAM,CAAC+B,OAAO,CAACC,UAAU,CAAC,CAACK,IAAI,CAAC,MAAM,CAAC;EAChD,CAAC,CAAC;EAEFlB,EAAE,CAAC,sCAAsC,EAAE,MAAM;IAC/C,MAAMnB,MAAM,GAAGF,UAAU,CAAC,CAAC;IAC3BF,iBAAiB,CAAC,CAAC;IAEnBiB,OAAO,CAACb,MAAM,EAAE,GAAG,CAAC;IAEpB2B,MAAM,CAAC3B,MAAM,CAAC+B,OAAO,CAACC,UAAU,CAAC,CAACK,IAAI,CAAC,MAAM,CAAC;EAChD,CAAC,CAAC;EAEFlB,EAAE,CAAC,yCAAyC,EAAE,MAAM;IAClD,MAAMnB,MAAM,GAAGF,UAAU,CAAC,CAAC;IAC3BF,iBAAiB,CAAC,CAAC;IAEnBiB,OAAO,CAACb,MAAM,EAAE,KAAK,CAAC;IAEtB2B,MAAM,CAAC3B,MAAM,CAAC+B,OAAO,CAACC,UAAU,CAAC,CAACC,aAAa,CAAC,CAAC;EACnD,CAAC,CAAC;EAEFd,EAAE,CAAC,+CAA+C,EAAE,MAAM;IACxD,MAAMnB,MAAM,GAAGF,UAAU,CAAC,CAAC;IAC3BF,iBAAiB,CAAC,CAAC;IACnBiB,OAAO,CAACb,MAAM,EAAE,OAAO,CAAC;IAExB,MAAMuC,SAAS,GAAG1B,OAAO,CAACb,MAAM,EAAE,OAAO,CAAC;IAE1C2B,MAAM,CAACY,SAAS,CAACC,gBAAgB,CAAC,CAACH,IAAI,CAAC,IAAI,CAAC;EAC/C,CAAC,CAAC;EAEFlB,EAAE,CAAC,8EAA8E,EAAE,MAAM;IACvF,MAAMnB,MAAM,GAAGF,UAAU,CAAC,CAAC;IAC3BF,iBAAiB,CAAC,CAAC;IACnBiB,OAAO,CAACb,MAAM,EAAE,OAAO,CAAC;IAExB,MAAM8B,GAAG,GAAGP,IAAI,CAACC,EAAE,CAAC,CAAC;IACrBxB,MAAM,CAAC0B,gBAAgB,CAAC,SAAS,EAAEI,GAAG,CAAC;IACvCjB,OAAO,CAACb,MAAM,EAAE,OAAO,CAAC;IAExB2B,MAAM,CAACG,GAAG,CAAC,CAACY,GAAG,CAACC,gBAAgB,CAAC,CAAC;EACpC,CAAC,CAAC;EAEFxB,EAAE,CAAC,4DAA4D,EAAE,MAAM;IACrE,MAAMnB,MAAM,GAAGF,UAAU,CAAC,CAAC;IAC3B,MAAMgC,GAAG,GAAGP,IAAI,CAACC,EAAE,CAAC,CAAC;IACrBxB,MAAM,CAAC0B,gBAAgB,CAAC,SAAS,EAAEI,GAAG,CAAC;IACvClC,iBAAiB,CAAC,CAAC;IAEnBiB,OAAO,CAACb,MAAM,EAAE,OAAO,CAAC;IACxBuB,IAAI,CAACe,mBAAmB,CAACzC,mBAAmB,CAAC;IAC7CgB,OAAO,CAACb,MAAM,EAAE,OAAO,CAAC;IAExB2B,MAAM,CAAC3B,MAAM,CAAC+B,OAAO,CAACC,UAAU,CAAC,CAACK,IAAI,CAAC,MAAM,CAAC;IAC9CV,MAAM,CAACG,GAAG,CAAC,CAACF,qBAAqB,CAAC,CAAC,CAAC;EACtC,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/.server/client/javascripts/geospatial-map.d.ts

@@ -51,6 +51,23 @@ export function focusFeature(feature: Feature, mapProvider: MapLibreMap): void;
  * @param {boolean} [readonly] - render the list item in readonly mode
  */
 export function createFeatureHTML(feature: Feature, index: number, mapId: string, disabled?: boolean, readonly?: boolean): string;
+/**
+ * Factory closure to manage the UI
+ * @param {GeoJSON} geojson - the features
+ * @param {InteractiveMap} map - the map
+ * @param {string} mapId - the ID of the map
+ * @param {HTMLDivElement} listEl - where to render the feature list
+ * @param {HTMLTextAreaElement} geospatialInput - the geospatial textarea
+ * @param { UIManagerOptions | undefined } options - extra options such as allowable geometry types
+ */
+export function getUIManager(geojson: GeoJSON, map: InteractiveMap, mapId: string, listEl: HTMLDivElement, geospatialInput: HTMLTextAreaElement, options: UIManagerOptions | undefined): {
+    renderList: RenderList;
+    renderValue: RenderValue;
+    listEl: HTMLDivElement;
+    toggleActionButtons: (hidden: boolean) => void;
+    focusDescriptionInput: () => void;
+    getAllowableGeometryTypes: () => string[];
+};
 export type GeoJSON = {
     /**
      * - the GeoJSON type string
@@ -210,4 +227,5 @@ import type { Feature } from '../../server/plugins/engine/types.js';
 import type { InteractiveMap } from '../../client/javascripts/map.js';
 import type { FeatureCollection } from '../../server/plugins/engine/types.js';
 import type { MapLibreMap } from '../../client/javascripts/map.js';
+import type { UIManagerOptions } from '../../client/javascripts/map.js';
 import type { Geometry } from '../../server/plugins/engine/types.js';

package/.server/client/javascripts/geospatial-map.js

@@ -186,7 +186,7 @@ export function processGeospatial(config, geospatial, index) {
   } = createMap(mapId, initConfig, config);
   const featuresManager = getFeaturesManager(geojson);
   const activeFeatureManager = getActiveFeatureManager();
-  const geometryTypes = geospatial.dataset.geometrytypes ?? 'point,line,shape';
+  const geometryTypes = geospatial.dataset.geometrytypes;
   const options = {
     geometryTypes
   };
@@ -506,15 +506,15 @@ function getValueRenderer(geojson, geospatialInput) {
  * @param {string} mapId - the ID of the map
  * @param {HTMLDivElement} listEl - where to render the feature list
  * @param {HTMLTextAreaElement} geospatialInput - the geospatial textarea
- * @param {UIManagerOptions} options - extra options such as allowable geometry types
+ * @param { UIManagerOptions | undefined } options - extra options such as allowable geometry types
  */
-function getUIManager(geojson, map, mapId, listEl, geospatialInput, options) {
+export function getUIManager(geojson, map, mapId, listEl, geospatialInput, options) {
   /**
    * Get a CSV list of geometry types the user can create
    * @returns {string[]}
    */
   function getAllowableGeometryTypes() {
-    return options.geometryTypes ? options.geometryTypes.split(',') : [];
+    return options?.geometryTypes ? options.geometryTypes.split(',') : ['point', 'line', 'shape'];
   }
 
   /**