RubyGems - defra_ruby_template - Versions diffs - 5.4.0 → 5.11.0 - Mend

defra_ruby_template 5.4.0 → 5.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (428) hide show

data/node_modules/govuk-frontend/dist/govuk/components/exit-this-page/exit-this-page.bundle.mjs CHANGED Viewed

@@ -1,3 +1,173 @@
+function isInitialised($root, moduleName) {
+  return $root instanceof HTMLElement && $root.hasAttribute(`data-${moduleName}-init`);
+}
+/**
+ * Checks if GOV.UK Frontend is supported on this page
+ *
+ * Some browsers will load and run our JavaScript but GOV.UK Frontend
+ * won't be supported.
+ *
+ * @param {HTMLElement | null} [$scope] - (internal) `<body>` HTML element checked for browser support
+ * @returns {boolean} Whether GOV.UK Frontend is supported on this page
+ */
+function isSupported($scope = document.body) {
+  if (!$scope) {
+    return false;
+  }
+  return $scope.classList.contains('govuk-frontend-supported');
+}
+function isArray(option) {
+  return Array.isArray(option);
+}
+function isObject(option) {
+  return !!option && typeof option === 'object' && !isArray(option);
+}
+function formatErrorMessage(Component, message) {
+  return `${Component.moduleName}: ${message}`;
+}
+/**
+ * @typedef ComponentWithModuleName
+ * @property {string} moduleName - Name of the component
+ */
+/**
+ * @import { ObjectNested } from './configuration.mjs'
+ */
+class GOVUKFrontendError extends Error {
+  constructor(...args) {
+    super(...args);
+    this.name = 'GOVUKFrontendError';
+  }
+}
+class SupportError extends GOVUKFrontendError {
+  /**
+   * Checks if GOV.UK Frontend is supported on this page
+   *
+   * @param {HTMLElement | null} [$scope] - HTML element `<body>` checked for browser support
+   */
+  constructor($scope = document.body) {
+    const supportMessage = 'noModule' in HTMLScriptElement.prototype ? 'GOV.UK Frontend initialised without `<body class="govuk-frontend-supported">` from template `<script>` snippet' : 'GOV.UK Frontend is not supported in this browser';
+    super($scope ? supportMessage : 'GOV.UK Frontend initialised without `<script type="module">`');
+    this.name = 'SupportError';
+  }
+}
+class ConfigError extends GOVUKFrontendError {
+  constructor(...args) {
+    super(...args);
+    this.name = 'ConfigError';
+  }
+}
+class ElementError extends GOVUKFrontendError {
+  constructor(messageOrOptions) {
+    let message = typeof messageOrOptions === 'string' ? messageOrOptions : '';
+    if (typeof messageOrOptions === 'object') {
+      const {
+        component,
+        identifier,
+        element,
+        expectedType
+      } = messageOrOptions;
+      message = identifier;
+      message += element ? ` is not of type ${expectedType != null ? expectedType : 'HTMLElement'}` : ' not found';
+      message = formatErrorMessage(component, message);
+    }
+    super(message);
+    this.name = 'ElementError';
+  }
+}
+class InitError extends GOVUKFrontendError {
+  constructor(componentOrMessage) {
+    const message = typeof componentOrMessage === 'string' ? componentOrMessage : formatErrorMessage(componentOrMessage, `Root element (\`$root\`) already initialised`);
+    super(message);
+    this.name = 'InitError';
+  }
+}
+/**
+ * @import { ComponentWithModuleName } from '../common/index.mjs'
+ */
+class Component {
+  /**
+   * Returns the root element of the component
+   *
+   * @protected
+   * @returns {RootElementType} - the root element of component
+   */
+  get $root() {
+    return this._$root;
+  }
+  constructor($root) {
+    this._$root = void 0;
+    const childConstructor = this.constructor;
+    if (typeof childConstructor.moduleName !== 'string') {
+      throw new InitError(`\`moduleName\` not defined in component`);
+    }
+    if (!($root instanceof childConstructor.elementType)) {
+      throw new ElementError({
+        element: $root,
+        component: childConstructor,
+        identifier: 'Root element (`$root`)',
+        expectedType: childConstructor.elementType.name
+      });
+    } else {
+      this._$root = $root;
+    }
+    childConstructor.checkSupport();
+    this.checkInitialised();
+    const moduleName = childConstructor.moduleName;
+    this.$root.setAttribute(`data-${moduleName}-init`, '');
+  }
+  checkInitialised() {
+    const constructor = this.constructor;
+    const moduleName = constructor.moduleName;
+    if (moduleName && isInitialised(this.$root, moduleName)) {
+      throw new InitError(constructor);
+    }
+  }
+  static checkSupport() {
+    if (!isSupported()) {
+      throw new SupportError();
+    }
+  }
+}
+/**
+ * @typedef ChildClass
+ * @property {string} moduleName - The module name that'll be looked for in the DOM when initialising the component
+ */
+/**
+ * @typedef {typeof Component & ChildClass} ChildClassConstructor
+ */
+Component.elementType = HTMLElement;
+const configOverride = Symbol.for('configOverride');
+class ConfigurableComponent extends Component {
+  [configOverride](param) {
+    return {};
+  }
+  /**
+   * Returns the root element of the component
+   *
+   * @protected
+   * @returns {ConfigurationType} - the root element of component
+   */
+  get config() {
+    return this._config;
+  }
+  constructor($root, config) {
+    super($root);
+    this._config = void 0;
+    const childConstructor = this.constructor;
+    if (!isObject(childConstructor.defaults)) {
+      throw new ConfigError(formatErrorMessage(childConstructor, 'Config passed as parameter into constructor but no defaults defined'));
+    }
+    const datasetConfig = normaliseDataset(childConstructor, this._$root.dataset);
+    this._config = mergeConfigs(childConstructor.defaults, config != null ? config : {}, this[configOverride](datasetConfig), datasetConfig);
+  }
+}
 function normaliseString(value, property) {
   const trimmedValue = value ? value.trim() : '';
   let output;
@@ -22,11 +192,24 @@ function normaliseString(value, property) {
   }
   return output;
 }
-/**
- * @typedef {import('./index.mjs').SchemaProperty} SchemaProperty
- */
+function normaliseDataset(Component, dataset) {
+  if (!isObject(Component.schema)) {
+    throw new ConfigError(formatErrorMessage(Component, 'Config passed as parameter into constructor but no schema defined'));
+  }
+  const out = {};
+  const entries = Object.entries(Component.schema.properties);
+  for (const entry of entries) {
+    const [namespace, property] = entry;
+    const field = namespace.toString();
+    if (field in dataset) {
+      out[field] = normaliseString(dataset[field], property);
+    }
+    if ((property == null ? void 0 : property.type) === 'object') {
+      out[field] = extractConfigByNamespace(Component.schema, dataset, namespace);
+    }
+  }
+  return out;
+}
 function mergeConfigs(...configObjects) {
   const formattedConfigObject = {};
   for (const configObject of configObjects) {
@@ -42,19 +225,19 @@ function mergeConfigs(...configObjects) {
   }
   return formattedConfigObject;
 }
-function extractConfigByNamespace(Component, dataset, namespace) {
-  const property = Component.schema.properties[namespace];
+function extractConfigByNamespace(schema, dataset, namespace) {
+  const property = schema.properties[namespace];
   if ((property == null ? void 0 : property.type) !== 'object') {
     return;
   }
   const newObject = {
-    [namespace]: ({})
+    [namespace]: {}
   };
   for (const [key, value] of Object.entries(dataset)) {
     let current = newObject;
     const keyParts = key.split('.');
     for (const [index, name] of keyParts.entries()) {
-      if (typeof current === 'object') {
+      if (isObject(current)) {
         if (index < keyParts.length - 1) {
           if (!isObject(current[name])) {
             current[name] = {};
@@ -68,101 +251,39 @@ function extractConfigByNamespace(Component, dataset, namespace) {
   }
   return newObject[namespace];
 }
-function isSupported($scope = document.body) {
-  if (!$scope) {
-    return false;
-  }
-  return $scope.classList.contains('govuk-frontend-supported');
-}
-function isArray(option) {
-  return Array.isArray(option);
-}
-function isObject(option) {
-  return !!option && typeof option === 'object' && !isArray(option);
-}
 /**
  * Schema for component config
  *
+ * @template {Partial<Record<keyof ConfigurationType, unknown>>} ConfigurationType
  * @typedef {object} Schema
- * @property {{ [field: string]: SchemaProperty | undefined }} properties - Schema properties
- * @property {SchemaCondition[]} [anyOf] - List of schema conditions
+ * @property {Record<keyof ConfigurationType, SchemaProperty | undefined>} properties - Schema properties
+ * @property {SchemaCondition<ConfigurationType>[]} [anyOf] - List of schema conditions
  */
 /**
  * Schema property for component config
  *
  * @typedef {object} SchemaProperty
  * @property {'string' | 'boolean' | 'number' | 'object'} type - Property type
  */
 /**
  * Schema condition for component config
  *
+ * @template {Partial<Record<keyof ConfigurationType, unknown>>} ConfigurationType
  * @typedef {object} SchemaCondition
- * @property {string[]} required - List of required config fields
+ * @property {(keyof ConfigurationType)[]} required - List of required config fields
  * @property {string} errorMessage - Error message when required config fields not provided
  */
-function normaliseDataset(Component, dataset) {
-  const out = {};
-  for (const [field, property] of Object.entries(Component.schema.properties)) {
-    if (field in dataset) {
-      out[field] = normaliseString(dataset[field], property);
-    }
-    if ((property == null ? void 0 : property.type) === 'object') {
-      out[field] = extractConfigByNamespace(Component, dataset, field);
-    }
-  }
-  return out;
-}
-class GOVUKFrontendError extends Error {
-  constructor(...args) {
-    super(...args);
-    this.name = 'GOVUKFrontendError';
-  }
-}
-class SupportError extends GOVUKFrontendError {
-  /**
-   * Checks if GOV.UK Frontend is supported on this page
-   *
-   * @param {HTMLElement | null} [$scope] - HTML element `<body>` checked for browser support
-   */
-  constructor($scope = document.body) {
-    const supportMessage = 'noModule' in HTMLScriptElement.prototype ? 'GOV.UK Frontend initialised without `<body class="govuk-frontend-supported">` from template `<script>` snippet' : 'GOV.UK Frontend is not supported in this browser';
-    super($scope ? supportMessage : 'GOV.UK Frontend initialised without `<script type="module">`');
-    this.name = 'SupportError';
-  }
-}
-class ElementError extends GOVUKFrontendError {
-  constructor(messageOrOptions) {
-    let message = typeof messageOrOptions === 'string' ? messageOrOptions : '';
-    if (typeof messageOrOptions === 'object') {
-      const {
-        componentName,
-        identifier,
-        element,
-        expectedType
-      } = messageOrOptions;
-      message = `${componentName}: ${identifier}`;
-      message += element ? ` is not of type ${expectedType != null ? expectedType : 'HTMLElement'}` : ' not found';
-    }
-    super(message);
-    this.name = 'ElementError';
-  }
-}
-class GOVUKFrontendComponent {
-  constructor() {
-    this.checkSupport();
-  }
-  checkSupport() {
-    if (!isSupported()) {
-      throw new SupportError();
-    }
-  }
-}
+/**
+ * @template {Partial<Record<keyof ConfigurationType, unknown>>} [ConfigurationType=ObjectNested]
+ * @typedef ChildClass
+ * @property {string} moduleName - The module name that'll be looked for in the DOM when initialising the component
+ * @property {Schema<ConfigurationType>} [schema] - The schema of the component configuration
+ * @property {ConfigurationType} [defaults] - The default values of the configuration of the component
+ */
+/**
+ * @template {Partial<Record<keyof ConfigurationType, unknown>>} [ConfigurationType=ObjectNested]
+ * @typedef {typeof Component & ChildClass<ConfigurationType>} ChildClassConstructor<ConfigurationType>
+ */
 class I18n {
   constructor(translations = {}, config = {}) {
@@ -361,16 +482,15 @@ I18n.pluralRules = {
  * Exit this page component
  *
  * @preserve
+ * @augments ConfigurableComponent<ExitThisPageConfig>
  */
-class ExitThisPage extends GOVUKFrontendComponent {
+class ExitThisPage extends ConfigurableComponent {
   /**
-   * @param {Element | null} $module - HTML element that wraps the Exit This Page button
+   * @param {Element | null} $root - HTML element that wraps the Exit This Page button
    * @param {ExitThisPageConfig} [config] - Exit This Page config
    */
-  constructor($module, config = {}) {
-    super();
-    this.$module = void 0;
-    this.config = void 0;
+  constructor($root, config = {}) {
+    super($root, config);
     this.i18n = void 0;
     this.$button = void 0;
     this.$skiplinkButton = null;
@@ -382,25 +502,16 @@ class ExitThisPage extends GOVUKFrontendComponent {
     this.timeoutTime = 5000;
     this.keypressTimeoutId = null;
     this.timeoutMessageId = null;
-    if (!($module instanceof HTMLElement)) {
-      throw new ElementError({
-        componentName: 'Exit this page',
-        element: $module,
-        identifier: 'Root element (`$module`)'
-      });
-    }
-    const $button = $module.querySelector('.govuk-exit-this-page__button');
+    const $button = this.$root.querySelector('.govuk-exit-this-page__button');
     if (!($button instanceof HTMLAnchorElement)) {
       throw new ElementError({
-        componentName: 'Exit this page',
+        component: ExitThisPage,
         element: $button,
         expectedType: 'HTMLAnchorElement',
         identifier: 'Button (`.govuk-exit-this-page__button`)'
       });
     }
-    this.config = mergeConfigs(ExitThisPage.defaults, config, normaliseDataset(ExitThisPage, $module.dataset));
     this.i18n = new I18n(this.config.i18n);
-    this.$module = $module;
     this.$button = $button;
     const $skiplinkButton = document.querySelector('.govuk-js-exit-this-page-skiplink');
     if ($skiplinkButton instanceof HTMLAnchorElement) {
@@ -419,7 +530,7 @@ class ExitThisPage extends GOVUKFrontendComponent {
     this.$updateSpan = document.createElement('span');
     this.$updateSpan.setAttribute('role', 'status');
     this.$updateSpan.className = 'govuk-visually-hidden';
-    this.$module.appendChild(this.$updateSpan);
+    this.$root.appendChild(this.$updateSpan);
   }
   initButtonClickHandler() {
     this.$button.addEventListener('click', this.handleClick.bind(this));
@@ -565,7 +676,7 @@ class ExitThisPage extends GOVUKFrontendComponent {
  */
 /**
- * @typedef {import('../../common/index.mjs').Schema} Schema
+ * @import { Schema } from '../../common/configuration.mjs'
  */
 ExitThisPage.moduleName = 'govuk-exit-this-page';
 ExitThisPage.defaults = Object.freeze({