🤖 Merge PR DefinitelyTyped#72124 [@types/govuk-frontend] Update for GOV.UK Frontend v5.9.0 by @colinrotherham

Author: colinrotherham

types/govuk-frontend/dist/govuk/all.bundle.d.mts

@@ -1,18 +1,19 @@
 export { ConfigurableComponent } from "./common/configuration.mjs";
 export { version } from "./common/govuk-frontend-version.mjs";
 export { isSupported } from "./common/index.mjs";
+export { Component } from "./component.mjs";
 export { Accordion } from "./components/accordion/accordion.mjs";
 export { Button } from "./components/button/button.mjs";
 export { CharacterCount } from "./components/character-count/character-count.mjs";
 export { Checkboxes } from "./components/checkboxes/checkboxes.mjs";
 export { ErrorSummary } from "./components/error-summary/error-summary.mjs";
 export { ExitThisPage } from "./components/exit-this-page/exit-this-page.mjs";
+export { FileUpload } from "./components/file-upload/file-upload.mjs";
 export { Header } from "./components/header/header.mjs";
 export { NotificationBanner } from "./components/notification-banner/notification-banner.mjs";
 export { PasswordInput } from "./components/password-input/password-input.mjs";
 export { Radios } from "./components/radios/radios.mjs";
 export { ServiceNavigation } from "./components/service-navigation/service-navigation.mjs";
 export { SkipLink } from "./components/skip-link/skip-link.mjs";
 export { Tabs } from "./components/tabs/tabs.mjs";
-export { GOVUKFrontendComponent as Component } from "./govuk-frontend-component.mjs";
 export { type Config, type ConfigKey, createAll, initAll } from "./init.mjs";

types/govuk-frontend/dist/govuk/all.bundle.d.ts

@@ -1,20 +1,21 @@
 import { ConfigurableComponent } from "./common/configuration.js";
 import { version } from "./common/govuk-frontend-version.js";
 import { isSupported } from "./common/index.js";
+import { Component } from "./component.js";
 import { Accordion } from "./components/accordion/accordion.js";
 import { Button } from "./components/button/button.js";
 import { CharacterCount } from "./components/character-count/character-count.js";
 import { Checkboxes } from "./components/checkboxes/checkboxes.js";
 import { ErrorSummary } from "./components/error-summary/error-summary.js";
 import { ExitThisPage } from "./components/exit-this-page/exit-this-page.js";
+import { FileUpload } from "./components/file-upload/file-upload.js";
 import { Header } from "./components/header/header.js";
 import { NotificationBanner } from "./components/notification-banner/notification-banner.js";
 import { PasswordInput } from "./components/password-input/password-input.js";
 import { Radios } from "./components/radios/radios.js";
 import { ServiceNavigation } from "./components/service-navigation/service-navigation.js";
 import { SkipLink } from "./components/skip-link/skip-link.js";
 import { Tabs } from "./components/tabs/tabs.js";
-import { GOVUKFrontendComponent as Component } from "./govuk-frontend-component.js";
 import { type Config as ConfigImport, type ConfigKey as ConfigKeyImport, createAll, initAll } from "./init.js";
 
 declare namespace GOVUKFrontend {
@@ -31,6 +32,7 @@ declare const GOVUKFrontend: {
     Checkboxes: typeof Checkboxes;
     ErrorSummary: typeof ErrorSummary;
     ExitThisPage: typeof ExitThisPage;
+    FileUpload: typeof FileUpload;
     Header: typeof Header;
     NotificationBanner: typeof NotificationBanner;
     PasswordInput: typeof PasswordInput;

types/govuk-frontend/dist/govuk/common/closest-attribute-value.d.ts

@@ -6,4 +6,7 @@
  * @param {string} attributeName - The name of the attribute
  * @returns {string | null} Attribute value
  */
-export function closestAttributeValue($element: Element, attributeName: string): string | null;
+export function closestAttributeValue(
+    $element: Element,
+    attributeName: string,
+): string | null;

types/govuk-frontend/dist/govuk/common/configuration.d.ts

@@ -1,4 +1,4 @@
-import { GOVUKFrontendComponent } from "../govuk-frontend-component.js";
+import { Component } from "../component.js";
 
 /**
  * Normalise string
@@ -28,13 +28,17 @@ export function normaliseString(
  * optionally expanding nested `i18n.field`
  *
  * @internal
- * @param {{ schema?: Schema<ObjectNested>, moduleName: string }} Component - Component class
+ * @template {Partial<Record<keyof ConfigurationType, unknown>>} ConfigurationType
+ * @template {[keyof ConfigurationType, SchemaProperty | undefined][]} SchemaEntryType
+ * @param {{ schema?: Schema<ConfigurationType>, moduleName: string }} Component - Component class
  * @param {DOMStringMap} dataset - HTML element dataset
  * @returns {ObjectNested} Normalised dataset
  */
-export function normaliseDataset(
+export function normaliseDataset<
+    ConfigurationType extends Partial<Record<keyof ConfigurationType, unknown>>,
+>(
     Component: {
-        schema?: Schema<ObjectNested>;
+        schema?: Schema<ConfigurationType>;
         moduleName: string;
     },
     dataset: DOMStringMap,
@@ -51,9 +55,9 @@ export function normaliseDataset(
  * @returns {{ [key: string]: unknown }} A merged config object
  */
 export function mergeConfigs(
-    ...configObjects: Array<{
+    ...configObjects: {
         [key: string]: unknown;
-    }>
+    }[]
 ): {
     [key: string]: unknown;
 };
@@ -73,13 +77,8 @@ export function mergeConfigs(
  * @returns {string[]} List of validation errors
  */
 export function validateConfig<
-    ConfigurationType extends Partial<
-        Record<keyof ConfigurationType, unknown>
-    >,
->(
-    schema: Schema<ConfigurationType>,
-    config: ConfigurationType,
-): string[];
+    ConfigurationType extends Partial<Record<keyof ConfigurationType, unknown>>,
+>(schema: Schema<ConfigurationType>, config: ConfigurationType): string[];
 
 /**
  * Extracts keys starting with a particular namespace from dataset ('data-*')
@@ -93,9 +92,7 @@ export function validateConfig<
  * @returns {ObjectNested | undefined} Nested object with dot-separated key namespace removed
  */
 export function extractConfigByNamespace<
-    ConfigurationType extends Partial<
-        Record<keyof ConfigurationType, unknown>
-    >,
+    ConfigurationType extends Partial<Record<keyof ConfigurationType, unknown>>,
 >(
     schema: Schema<ConfigurationType>,
     dataset: DOMStringMap,
@@ -109,8 +106,8 @@ export const configOverride: unique symbol;
  *
  * Centralises the behaviours shared by our components
  *
- * @template {Partial<Record<keyof ConfigurationType, unknown>>} [ConfigurationType=ObjectNested]
- * @template {Element & { dataset: DOMStringMap }} [RootElementType=HTMLElement]
+ * @template {Partial<Record<keyof ConfigurationType, unknown>>} ConfigurationType
+ * @template {Element & { dataset: DOMStringMap }} RootElementType
  */
 export abstract class ConfigurableComponent<
     ConfigurationType extends Partial<
@@ -119,7 +116,7 @@ export abstract class ConfigurableComponent<
     RootElementType extends Element & {
         dataset: DOMStringMap;
     } = HTMLElement,
-> extends GOVUKFrontendComponent<RootElementType> {
+> extends Component<RootElementType> {
     /**
      * Constructs a new component, validating that GOV.UK Frontend is supported
      *
@@ -154,7 +151,9 @@ export abstract class ConfigurableComponent<
      * @param {Partial<ConfigurationType>} [param] - Configuration object
      * @returns {Partial<ConfigurationType>} return - Configuration object
      */
-    [configOverride](param?: Partial<ConfigurationType>): Partial<ConfigurationType>;
+    [configOverride](
+        param?: Partial<ConfigurationType>,
+    ): Partial<ConfigurationType>;
 }
 
 export type NestedKey = keyof ObjectNested;
@@ -167,9 +166,7 @@ export interface ObjectNested {
  * Schema for component config
  */
 export interface Schema<
-    ConfigurationType extends Partial<
-        Record<keyof ConfigurationType, unknown>
-    >,
+    ConfigurationType extends Partial<Record<keyof ConfigurationType, unknown>>,
 > {
     /**
      * - Schema properties
@@ -179,7 +176,7 @@ export interface Schema<
     /**
      * - List of schema conditions
      */
-    anyOf?: SchemaCondition[] | undefined;
+    anyOf?: SchemaCondition<ConfigurationType>[] | undefined;
 }
 
 /**
@@ -195,11 +192,13 @@ export interface SchemaProperty {
 /**
  * Schema condition for component config
  */
-export interface SchemaCondition {
+export interface SchemaCondition<
+    ConfigurationType extends Partial<Record<keyof ConfigurationType, unknown>>,
+> {
     /**
      * - List of required config fields
      */
-    required: string[];
+    required: (keyof ConfigurationType)[];
 
     /**
      * - Error message when required config fields not provided

types/govuk-frontend/dist/govuk/common/index.d.ts

@@ -81,9 +81,7 @@ export function isSupported($scope?: HTMLElement | null): boolean;
  */
 export function isObject<
     ObjectType extends Partial<Record<keyof ObjectType, unknown>> = ObjectNested,
->(
-    option: unknown,
-): option is ObjectType;
+>(option: unknown | ObjectType): option is ObjectType;
 
 /**
  * Format error message
@@ -93,7 +91,10 @@ export function isObject<
  * @param {string} message - Error message
  * @returns {string} - Formatted error message
  */
-export function formatErrorMessage(Component: ComponentWithModuleName, message: string): string;
+export function formatErrorMessage(
+    Component: ComponentWithModuleName,
+    message: string,
+): string;
 
 export interface ComponentWithModuleName {
     /**

types/govuk-frontend/dist/govuk/component.d.mts

@@ -0,0 +1 @@
+export * from "./component.js";

…dist/govuk/govuk-frontend-component.d.ts …govuk-frontend/dist/govuk/component.d.tstypes/govuk-frontend/dist/govuk/govuk-frontend-component.d.ts renamed to types/govuk-frontend/dist/govuk/component.d.ts types/govuk-frontend/dist/govuk/govuk-frontend-component.d.ts renamed to types/govuk-frontend/dist/govuk/component.d.ts

@@ -2,8 +2,10 @@
  * Base Component class
  *
  * Centralises the behaviours shared by our components
+ *
+ * @template {Element} [RootElementType=HTMLElement]
  */
-export abstract class GOVUKFrontendComponent<RootElementType extends Element = HTMLElement> {
+export abstract class Component<RootElementType extends Element = HTMLElement> {
     static elementType: typeof Element;
 
     /**

types/govuk-frontend/dist/govuk/components/accordion/accordion.d.ts

@@ -12,7 +12,10 @@ import { ConfigurableComponent } from "../../common/configuration.js";
  * The state of each section is saved to the DOM via the `aria-expanded`
  * attribute, which also provides accessibility.
  */
-export class Accordion extends ConfigurableComponent<AccordionConfig, HTMLElement> {
+export class Accordion extends ConfigurableComponent<
+    AccordionConfig,
+    HTMLElement
+> {
     /**
      * Name for the component used when initialising using data-module attributes.
      */
@@ -22,13 +25,15 @@ export class Accordion extends ConfigurableComponent<AccordionConfig, HTMLElemen
      * Accordion default config
      *
      * @see {@link AccordionConfig}
+     * @constant
      */
     static defaults: AccordionConfig;
 
     /**
      * Accordion config schema
      *
-     * @satisfies {Schema}
+     * @constant
+     * @satisfies {Schema<AccordionConfig>}
      */
     static schema: Readonly<{
         properties: {

types/govuk-frontend/dist/govuk/components/button/button.d.ts

@@ -13,13 +13,15 @@ export class Button extends ConfigurableComponent<ButtonConfig, HTMLElement> {
      * Button default config
      *
      * @see {@link ButtonConfig}
+     * @constant
      */
     static defaults: ButtonConfig;
 
     /**
      * Button config schema
      *
-     * @satisfies {Schema}
+     * @constant
+     * @satisfies {Schema<ButtonConfig>}
      */
     static schema: Readonly<{
         properties: {

types/govuk-frontend/dist/govuk/components/character-count/character-count.d.ts

@@ -11,7 +11,10 @@ import { type TranslationPluralForms } from "../../i18n.js";
  * You can configure the message to only appear after a certain percentage
  * of the available characters/words has been entered.
  */
-export class CharacterCount extends ConfigurableComponent<CharacterCountConfig, HTMLElement> {
+export class CharacterCount extends ConfigurableComponent<
+    CharacterCountConfig,
+    HTMLElement
+> {
     /**
      * Name for the component used when initialising using data-module attributes.
      */
@@ -21,13 +24,15 @@ export class CharacterCount extends ConfigurableComponent<CharacterCountConfig,
      * Character count default config
      *
      * @see {@link CharacterCountConfig}
+     * @constant
      */
     static defaults: CharacterCountConfig;
 
     /**
      * Character count config schema
      *
-     * @satisfies {Schema}
+     * @constant
+     * @satisfies {Schema<CharacterCountConfig>}
      */
     static schema: Readonly<{
         properties: {
@@ -44,10 +49,16 @@ export class CharacterCount extends ConfigurableComponent<CharacterCountConfig,
                 type: "number";
             };
         };
-        anyOf: Array<{
-            required: string[];
-            errorMessage: string;
-        }>;
+        anyOf: (
+            | {
+                required: "maxwords"[];
+                errorMessage: string;
+            }
+            | {
+                required: "maxlength"[];
+                errorMessage: string;
+            }
+        )[];
     }>;
 
     /**