@types/govuk-frontend 5.7.0 → 5.9.0

govuk-frontend/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for govuk-frontend (https://github.com/al
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/govuk-frontend.
 
 ### Additional Details
- * Last updated: Mon, 14 Oct 2024 16:41:00 GMT
+ * Last updated: Thu, 03 Apr 2025 22:35:25 GMT
  * Dependencies: none
 
 # Credits

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

@@ -1,11 +1,14 @@
+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";
@@ -13,5 +16,4 @@ 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";

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

@@ -1,11 +1,14 @@
+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";
@@ -13,7 +16,6 @@ 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 {
@@ -30,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;
@@ -38,6 +41,7 @@ declare const GOVUKFrontend: {
     SkipLink: typeof SkipLink;
     Tabs: typeof Tabs;
     Component: typeof Component;
+    ConfigurableComponent: typeof ConfigurableComponent;
     createAll: typeof createAll;
     initAll: typeof initAll;
 };

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;

govuk-frontend/dist/govuk/common/configuration.d.mts

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

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

@@ -0,0 +1,207 @@
+import { Component } from "../component.js";
+
+/**
+ * Normalise string
+ *
+ * 'If it looks like a duck, and it quacks like a duck…' 🦆
+ *
+ * If the passed value looks like a boolean or a number, convert it to a boolean
+ * or number.
+ *
+ * Designed to be used to convert config passed via data attributes (which are
+ * always strings) into something sensible.
+ *
+ * @internal
+ * @param {DOMStringMap[string]} value - The value to normalise
+ * @param {SchemaProperty} [property] - Component schema property
+ * @returns {string | boolean | number | undefined} Normalised data
+ */
+export function normaliseString(
+    value: DOMStringMap[string],
+    property?: SchemaProperty,
+): string | boolean | number | undefined;
+
+/**
+ * Normalise dataset
+ *
+ * Loop over an object and normalise each value using {@link normaliseString},
+ * optionally expanding nested `i18n.field`
+ *
+ * @internal
+ * @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<
+    ConfigurationType extends Partial<Record<keyof ConfigurationType, unknown>>,
+>(
+    Component: {
+        schema?: Schema<ConfigurationType>;
+        moduleName: string;
+    },
+    dataset: DOMStringMap,
+): ObjectNested;
+
+/**
+ * Config merging function
+ *
+ * Takes any number of objects and combines them together, with
+ * greatest priority on the LAST item passed in.
+ *
+ * @internal
+ * @param {...{ [key: string]: unknown }} configObjects - Config objects to merge
+ * @returns {{ [key: string]: unknown }} A merged config object
+ */
+export function mergeConfigs(
+    ...configObjects: {
+        [key: string]: unknown;
+    }[]
+): {
+    [key: string]: unknown;
+};
+
+/**
+ * Validate component config by schema
+ *
+ * Follows limited examples in JSON schema for wider support in future
+ *
+ * {@link https://ajv.js.org/json-schema.html#compound-keywords}
+ * {@link https://ajv.js.org/packages/ajv-errors.html#single-message}
+ *
+ * @internal
+ * @template {Partial<Record<keyof ConfigurationType, unknown>>} ConfigurationType
+ * @param {Schema<ConfigurationType>} schema - The schema of a component
+ * @param {ConfigurationType} config - Component config
+ * @returns {string[]} List of validation errors
+ */
+export function validateConfig<
+    ConfigurationType extends Partial<Record<keyof ConfigurationType, unknown>>,
+>(schema: Schema<ConfigurationType>, config: ConfigurationType): string[];
+
+/**
+ * Extracts keys starting with a particular namespace from dataset ('data-*')
+ * object, removing the namespace in the process, normalising all values
+ *
+ * @internal
+ * @template {Partial<Record<keyof ConfigurationType, unknown>>} ConfigurationType
+ * @param {Schema<ConfigurationType>} schema - The schema of a component
+ * @param {DOMStringMap} dataset - The object to extract key-value pairs from
+ * @param {keyof ConfigurationType} namespace - The namespace to filter keys with
+ * @returns {ObjectNested | undefined} Nested object with dot-separated key namespace removed
+ */
+export function extractConfigByNamespace<
+    ConfigurationType extends Partial<Record<keyof ConfigurationType, unknown>>,
+>(
+    schema: Schema<ConfigurationType>,
+    dataset: DOMStringMap,
+    namespace: keyof ConfigurationType,
+): ObjectNested | undefined;
+
+export const configOverride: unique symbol;
+
+/**
+ * Base Component class
+ *
+ * Centralises the behaviours shared by our components
+ *
+ * @template {Partial<Record<keyof ConfigurationType, unknown>>} ConfigurationType
+ * @template {Element & { dataset: DOMStringMap }} RootElementType
+ */
+export abstract class ConfigurableComponent<
+    ConfigurationType extends Partial<
+        Record<keyof ConfigurationType, unknown>
+    > = ObjectNested,
+    RootElementType extends Element & {
+        dataset: DOMStringMap;
+    } = HTMLElement,
+> extends Component<RootElementType> {
+    /**
+     * Constructs a new component, validating that GOV.UK Frontend is supported
+     *
+     * @internal
+     * @param {Element | null} [$root] - HTML element to use for component
+     * @param {ConfigurationType} [config] - HTML element to use for component
+     */
+    constructor($root?: Element | null, config?: ConfigurationType);
+
+    /**
+     * Returns the root element of the component
+     *
+     * @returns {ConfigurationType} - the root element of component
+     */
+    protected get config(): ConfigurationType;
+
+    /** */
+    _config: ConfigurationType;
+
+    /**
+     * configOverride
+     *
+     * Function which defines configuration overrides to prioritize
+     * properties from the root element's dataset.
+     *
+     * It should take a subset of configuration as input and return
+     * a new configuration object with properties that should be
+     * overridden based on the root element's dataset. A Symbol
+     * is used for indexing to prevent conflicts.
+     *
+     * @internal
+     * @param {Partial<ConfigurationType>} [param] - Configuration object
+     * @returns {Partial<ConfigurationType>} return - Configuration object
+     */
+    [configOverride](
+        param?: Partial<ConfigurationType>,
+    ): Partial<ConfigurationType>;
+}
+
+export type NestedKey = keyof ObjectNested;
+
+export interface ObjectNested {
+    [key: string]: string | boolean | number | ObjectNested | undefined;
+}
+
+/**
+ * Schema for component config
+ */
+export interface Schema<
+    ConfigurationType extends Partial<Record<keyof ConfigurationType, unknown>>,
+> {
+    /**
+     * - Schema properties
+     */
+    properties: Record<keyof ConfigurationType, SchemaProperty | undefined>;
+
+    /**
+     * - List of schema conditions
+     */
+    anyOf?: SchemaCondition<ConfigurationType>[] | undefined;
+}
+
+/**
+ * Schema property for component config
+ */
+export interface SchemaProperty {
+    /**
+     * - Property type
+     */
+    type: "string" | "boolean" | "number" | "object";
+}
+
+/**
+ * Schema condition for component config
+ */
+export interface SchemaCondition<
+    ConfigurationType extends Partial<Record<keyof ConfigurationType, unknown>>,
+> {
+    /**
+     * - List of required config fields
+     */
+    required: (keyof ConfigurationType)[];
+
+    /**
+     * - Error message when required config fields not provided
+     */
+    errorMessage: string;
+}

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

@@ -1,3 +1,5 @@
+import { type ObjectNested } from "./configuration.js";
+
 /**
  * Common helpers which do not require polyfill.
  *
@@ -5,41 +7,6 @@
  * so that the polyfill can be properly tree-shaken and does not burden
  * the components that do not need that helper
  */
-/**
- * Config merging function
- *
- * Takes any number of objects and combines them together, with
- * greatest priority on the LAST item passed in.
- *
- * @internal
- * @param {...{ [key: string]: unknown }} configObjects - Config objects to merge
- * @returns {{ [key: string]: unknown }} A merged config object
- */
-export function mergeConfigs(
-    ...configObjects: Array<{
-        [key: string]: unknown;
-    }>
-): {
-    [key: string]: unknown;
-};
-
-/**
- * Extracts keys starting with a particular namespace from dataset ('data-*')
- * object, removing the namespace in the process, normalising all values
- *
- * @internal
- * @param {{ schema: Schema }} Component - Component class
- * @param {DOMStringMap} dataset - The object to extract key-value pairs from
- * @param {string} namespace - The namespace to filter keys with
- * @returns {ObjectNested | undefined} Nested object with dot-separated key namespace removed
- */
-export function extractConfigByNamespace(
-    Component: {
-        schema: Schema;
-    },
-    dataset: DOMStringMap,
-    namespace: string,
-): ObjectNested | undefined;
 
 /**
  * Get hash fragment from URL
@@ -105,21 +72,16 @@ export function isInitialised($root: Element, moduleName: string): boolean;
 export function isSupported($scope?: HTMLElement | null): boolean;
 
 /**
- * Validate component config by schema
- *
- * Follows limited examples in JSON schema for wider support in future
- *
- * {@link https://ajv.js.org/json-schema.html#compound-keywords}
- * {@link https://ajv.js.org/packages/ajv-errors.html#single-message}
+ * Check for an object
  *
  * @internal
- * @param {Schema} schema - Config schema
- * @param {{ [key: string]: unknown }} config - Component config
- * @returns {string[]} List of validation errors
+ * @template {Partial<Record<keyof ObjectType, unknown>>} [ObjectType=ObjectNested]
+ * @param {unknown | ObjectType} option - Option to check
+ * @returns {option is ObjectType} Whether the option is an object
  */
-export function validateConfig(schema: Schema, config: {
-    [key: string]: unknown;
-}): string[];
+export function isObject<
+    ObjectType extends Partial<Record<keyof ObjectType, unknown>> = ObjectNested,
+>(option: unknown | ObjectType): option is ObjectType;
 
 /**
  * Format error message
@@ -129,55 +91,10 @@ export function validateConfig(schema: Schema, config: {
  * @param {string} message - Error message
  * @returns {string} - Formatted error message
  */
-export function formatErrorMessage(Component: ComponentWithModuleName, message: string): string;
-
-/**
- * Schema for component config
- */
-export interface Schema {
-    /**
-     * - Schema properties
-     */
-    properties: {
-        [field: string]: SchemaProperty | undefined;
-    };
-
-    /**
-     * - List of schema conditions
-     */
-    anyOf?: SchemaCondition[] | undefined;
-}
-
-/**
- * Schema property for component config
- */
-export interface SchemaProperty {
-    /**
-     * - Property type
-     */
-    type: "string" | "boolean" | "number" | "object";
-}
-
-/**
- * Schema condition for component config
- */
-export interface SchemaCondition {
-    /**
-     * - List of required config fields
-     */
-    required: string[];
-
-    /**
-     * - Error message when required config fields not provided
-     */
-    errorMessage: string;
-}
-
-export type NestedKey = keyof ObjectNested;
-
-export interface ObjectNested {
-    [key: string]: string | boolean | number | ObjectNested | undefined;
-}
+export function formatErrorMessage(
+    Component: ComponentWithModuleName,
+    message: string,
+): string;
 
 export interface ComponentWithModuleName {
     /**

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

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

govuk-frontend/dist/govuk/{govuk-frontend-component.d.ts → 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;
 
     /**

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

@@ -1,4 +1,4 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { ConfigurableComponent } from "../../common/configuration.js";
 
 /**
  * Accordion component
@@ -12,7 +12,10 @@ import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
  * The state of each section is saved to the DOM via the `aria-expanded`
  * attribute, which also provides accessibility.
  */
-export class Accordion extends GOVUKFrontendComponent<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 GOVUKFrontendComponent<HTMLElement> {
      * Accordion default config
      *
      * @see {@link AccordionConfig}
+     * @constant
      */
     static defaults: AccordionConfig;
 
     /**
      * Accordion config schema
      *
-     * @satisfies {Schema}
+     * @constant
+     * @satisfies {Schema<AccordionConfig>}
      */
     static schema: Readonly<{
         properties: {

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

@@ -1,9 +1,9 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { ConfigurableComponent } from "../../common/configuration.js";
 
 /**
  * JavaScript enhancements for the Button component
  */
-export class Button extends GOVUKFrontendComponent<HTMLElement> {
+export class Button extends ConfigurableComponent<ButtonConfig, HTMLElement> {
     /**
      * Name for the component used when initialising using data-module attributes.
      */
@@ -13,13 +13,15 @@ export class Button extends GOVUKFrontendComponent<HTMLElement> {
      * Button default config
      *
      * @see {@link ButtonConfig}
+     * @constant
      */
     static defaults: ButtonConfig;
 
     /**
      * Button config schema
      *
-     * @satisfies {Schema}
+     * @constant
+     * @satisfies {Schema<ButtonConfig>}
      */
     static schema: Readonly<{
         properties: {

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

@@ -1,4 +1,4 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { configOverride, ConfigurableComponent } from "../../common/configuration.js";
 import { type TranslationPluralForms } from "../../i18n.js";
 
 /**
@@ -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 GOVUKFrontendComponent<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 GOVUKFrontendComponent<HTMLElement> {
      * 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 GOVUKFrontendComponent<HTMLElement> {
                 type: "number";
             };
         };
-        anyOf: Array<{
-            required: string[];
-            errorMessage: string;
-        }>;
+        anyOf: (
+            | {
+                required: "maxwords"[];
+                errorMessage: string;
+            }
+            | {
+                required: "maxlength"[];
+                errorMessage: string;
+            }
+        )[];
     }>;
 
     /**
@@ -55,6 +66,19 @@ export class CharacterCount extends GOVUKFrontendComponent<HTMLElement> {
      * @param {CharacterCountConfig} [config] - Character count config
      */
     constructor($root: Element | null, config?: CharacterCountConfig);
+
+    /**
+     * Character count config override
+     *
+     * To ensure data-attributes take complete precedence, even if they change
+     * the type of count, we need to reset the `maxlength` and `maxwords` from
+     * the JavaScript config.
+     *
+     * @internal
+     * @param {CharacterCountConfig} datasetConfig - configuration specified by dataset
+     * @returns {CharacterCountConfig} - configuration to override by dataset
+     */
+    [configOverride](datasetConfig: CharacterCountConfig): CharacterCountConfig;
 }
 
 /**

govuk-frontend/dist/govuk/components/checkboxes/checkboxes.d.ts

@@ -1,9 +1,9 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { Component } from "../../component.js";
 
 /**
  * Checkboxes component
  */
-export class Checkboxes extends GOVUKFrontendComponent<HTMLElement> {
+export class Checkboxes extends Component<HTMLElement> {
     /**
      * Name for the component used when initialising using data-module attributes.
      */

govuk-frontend/dist/govuk/components/error-summary/error-summary.d.ts

@@ -1,4 +1,4 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { ConfigurableComponent } from "../../common/configuration.js";
 
 /**
  * Error summary component
@@ -6,7 +6,10 @@ import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
  * Takes focus on initialisation for accessible announcement, unless disabled in
  * configuration.
  */
-export class ErrorSummary extends GOVUKFrontendComponent<HTMLElement> {
+export class ErrorSummary extends ConfigurableComponent<
+    ErrorSummaryConfig,
+    HTMLElement
+> {
     /**
      * Name for the component used when initialising using data-module attributes.
      */
@@ -16,13 +19,15 @@ export class ErrorSummary extends GOVUKFrontendComponent<HTMLElement> {
      * Error summary default config
      *
      * @see {@link ErrorSummaryConfig}
+     * @constant
      */
     static defaults: ErrorSummaryConfig;
 
     /**
      * Error summary config schema
      *
-     * @satisfies {Schema}
+     * @constant
+     * @satisfies {Schema<ErrorSummaryConfig>}
      */
     static schema: Readonly<{
         properties: {
@@ -47,5 +52,5 @@ export interface ErrorSummaryConfig {
      * - If set to `true` the error
      * summary will not be focussed when the page loads.
      */
-    disableAutoFocus?: boolean;
+    disableAutoFocus?: boolean | undefined;
 }

govuk-frontend/dist/govuk/components/exit-this-page/exit-this-page.d.ts

@@ -1,9 +1,12 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { ConfigurableComponent } from "../../common/configuration.js";
 
 /**
  * Exit this page component
  */
-export class ExitThisPage extends GOVUKFrontendComponent<HTMLElement> {
+export class ExitThisPage extends ConfigurableComponent<
+    ExitThisPageConfig,
+    HTMLElement
+> {
     /**
      * Name for the component used when initialising using data-module attributes.
      */
@@ -13,13 +16,15 @@ export class ExitThisPage extends GOVUKFrontendComponent<HTMLElement> {
      * Exit this page default config
      *
      * @see {@link ExitThisPageConfig}
+     * @constant
      */
     static defaults: ExitThisPageConfig;
 
     /**
      * Exit this page config schema
      *
-     * @satisfies {Schema}
+     * @constant
+     * @satisfies {Schema<ExitThisPageConfig>}
      */
     static schema: Readonly<{
         properties: {

govuk-frontend/dist/govuk/components/file-upload/file-upload.d.mts

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

govuk-frontend/dist/govuk/components/file-upload/file-upload.d.ts

@@ -0,0 +1,95 @@
+import { ConfigurableComponent } from "../../common/configuration.js";
+import { type TranslationPluralForms } from "../../i18n.js";
+
+/**
+ * File upload component
+ */
+export class FileUpload extends ConfigurableComponent<
+    FileUploadConfig,
+    HTMLElement
+> {
+    /**
+     * Name for the component used when initialising using data-module attributes.
+     */
+    static moduleName: string;
+
+    /**
+     * File upload default config
+     *
+     * @see {@link FileUploadConfig}
+     * @constant
+     */
+    static defaults: FileUploadConfig;
+
+    /**
+     * File upload config schema
+     *
+     * @constant
+     * @satisfies {Schema<FileUploadConfig>}
+     */
+    static schema: Readonly<{
+        properties: {
+            i18n: {
+                type: "object";
+            };
+        };
+    }>;
+
+    /**
+     * @param {Element | null} $root - File input element
+     * @param {FileUploadConfig} [config] - File Upload config
+     */
+    constructor($root: Element | null, config?: FileUploadConfig);
+}
+
+export type HTMLFileInputElement = HTMLInputElement & {
+    files: FileList;
+};
+
+/**
+ * File upload config
+ */
+export interface FileUploadConfig {
+    /**
+     * - File upload translations
+     */
+    i18n?: FileUploadTranslations | undefined;
+}
+
+/**
+ * Messages used by the component
+ */
+export interface FileUploadTranslations {
+    /**
+     * - The text of the button that opens the file picker
+     */
+    chooseFile?: string | undefined;
+
+    /**
+     * - The text informing users they can drop files
+     */
+    dropInstruction?: string | undefined;
+
+    /**
+     * - The text displayed when multiple files
+     * have been chosen by the user
+     */
+    multipleFilesChosen?: TranslationPluralForms | undefined;
+
+    /**
+     * - The text to displayed when no file has been chosen by the user
+     */
+    noFileChosen?: string | undefined;
+
+    /**
+     * - The text announced by assistive technology
+     * when user drags files and enters the drop zone
+     */
+    enteredDropZone?: string | undefined;
+
+    /**
+     * - The text announced by assistive technology
+     * when user drags files and leaves the drop zone without dropping
+     */
+    leftDropZone?: string | undefined;
+}

govuk-frontend/dist/govuk/components/header/header.d.ts

@@ -1,9 +1,9 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { Component } from "../../component.js";
 
 /**
  * Header component
  */
-export class Header extends GOVUKFrontendComponent<HTMLElement> {
+export class Header extends Component<HTMLElement> {
     /**
      * Name for the component used when initialising using data-module attributes.
      */

govuk-frontend/dist/govuk/components/notification-banner/notification-banner.d.ts

@@ -1,9 +1,12 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { ConfigurableComponent } from "../../common/configuration.js";
 
 /**
  * Notification Banner component
  */
-export class NotificationBanner extends GOVUKFrontendComponent<HTMLElement> {
+export class NotificationBanner extends ConfigurableComponent<
+    NotificationBannerConfig,
+    HTMLElement
+> {
     /**
      * Name for the component used when initialising using data-module attributes.
      */
@@ -13,13 +16,15 @@ export class NotificationBanner extends GOVUKFrontendComponent<HTMLElement> {
      * Notification banner default config
      *
      * @see {@link NotificationBannerConfig}
+     * @constant
      */
     static defaults: NotificationBannerConfig;
 
     /**
      * Notification banner config schema
      *
-     * @satisfies {Schema}
+     * @constant
+     * @satisfies {Schema<NotificationBannerConfig>}
      */
     static schema: Readonly<{
         properties: {

govuk-frontend/dist/govuk/components/password-input/password-input.d.ts

@@ -1,9 +1,12 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { ConfigurableComponent } from "../../common/configuration.js";
 
 /**
  * Password input component
  */
-export class PasswordInput extends GOVUKFrontendComponent<HTMLElement> {
+export class PasswordInput extends ConfigurableComponent<
+    PasswordInputConfig,
+    HTMLElement
+> {
     /**
      * Name for the component used when initialising using data-module attributes.
      */
@@ -13,13 +16,16 @@ export class PasswordInput extends GOVUKFrontendComponent<HTMLElement> {
      * Password input default config
      *
      * @see {@link PasswordInputConfig}
+     * @constant
+     * @default
      */
     static defaults: PasswordInputConfig;
 
     /**
      * Password input config schema
      *
-     * @satisfies {Schema}
+     * @constant
+     * @satisfies {Schema<PasswordInputConfig>}
      */
     static schema: Readonly<{
         properties: {

govuk-frontend/dist/govuk/components/radios/radios.d.ts

@@ -1,9 +1,9 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { Component } from "../../component.js";
 
 /**
  * Radios component
  */
-export class Radios extends GOVUKFrontendComponent<HTMLElement> {
+export class Radios extends Component<HTMLElement> {
     /**
      * Name for the component used when initialising using data-module attributes.
      */

govuk-frontend/dist/govuk/components/service-navigation/service-navigation.d.ts

@@ -1,9 +1,9 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { Component } from "../../component.js";
 
 /**
  * Service Navigation component
  */
-export class ServiceNavigation extends GOVUKFrontendComponent<HTMLElement> {
+export class ServiceNavigation extends Component<HTMLElement> {
     /**
      * Name for the component used when initialising using data-module attributes.
      */

govuk-frontend/dist/govuk/components/skip-link/skip-link.d.ts

@@ -1,9 +1,9 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { Component } from "../../component.js";
 
 /**
  * Skip link component
  */
-export class SkipLink extends GOVUKFrontendComponent<HTMLAnchorElement> {
+export class SkipLink extends Component<HTMLAnchorElement> {
     static elementType: {
         new(): HTMLAnchorElement;
         prototype: HTMLAnchorElement;

govuk-frontend/dist/govuk/components/tabs/tabs.d.ts

@@ -1,9 +1,9 @@
-import { GOVUKFrontendComponent } from "../../govuk-frontend-component.js";
+import { Component } from "../../component.js";
 
 /**
  * Tabs component
  */
-export class Tabs extends GOVUKFrontendComponent<HTMLElement> {
+export class Tabs extends Component<HTMLElement> {
     /**
      * Name for the component used when initialising using data-module attributes.
      */

govuk-frontend/dist/govuk/errors/index.d.ts

@@ -19,8 +19,7 @@ import { type ComponentWithModuleName } from "../common/index.js";
  * }
  * ```
  */
-export abstract class GOVUKFrontendError extends Error {
-}
+export abstract class GOVUKFrontendError extends Error {}
 
 /**
  * Indicates that GOV.UK Frontend is not supported
@@ -37,8 +36,7 @@ export class SupportError extends GOVUKFrontendError {
 /**
  * Indicates that a component has received an illegal configuration
  */
-export class ConfigError extends GOVUKFrontendError {
-}
+export class ConfigError extends GOVUKFrontendError {}
 
 /**
  * Indicates an issue with an element (possibly `null` or `undefined`)

govuk-frontend/dist/govuk/i18n.d.ts

@@ -104,9 +104,12 @@ export class I18n {
      * @param {{ [key: string]: unknown }} options - Any options passed with the translation string, e.g: for string interpolation.
      * @returns {string} The translation string to output, with $\{\} placeholders replaced
      */
-    replacePlaceholders(translationString: string, options: {
-        [key: string]: unknown;
-    }): string;
+    replacePlaceholders(
+        translationString: string,
+        options: {
+            [key: string]: unknown;
+        },
+    ): string;
 
     /**
      * Check to see if the browser supports Intl.PluralRules

govuk-frontend/dist/govuk/init.d.ts

@@ -3,12 +3,12 @@ import { type ButtonConfig } from "./components/button/button.js";
 import { type CharacterCountConfig } from "./components/character-count/character-count.js";
 import { type ErrorSummaryConfig } from "./components/error-summary/error-summary.js";
 import { type ExitThisPageConfig } from "./components/exit-this-page/exit-this-page.js";
+import { type FileUploadConfig } from "./components/file-upload/file-upload.js";
 import { type NotificationBannerConfig } from "./components/notification-banner/notification-banner.js";
 import { type PasswordInputConfig } from "./components/password-input/password-input.js";
 
 export interface CompatibleClass {
     new(...args: any[]): any;
-    defaults?: object;
     moduleName: string;
 }
 
@@ -41,6 +41,11 @@ export interface Config {
      */
     exitThisPage?: ExitThisPageConfig | undefined;
 
+    /**
+     * - File Upload config
+     */
+    fileUpload?: FileUploadConfig | undefined;
+
     /**
      * - Notification Banner config
      */
@@ -57,7 +62,9 @@ export interface Config {
  */
 export type ConfigKey = keyof Config;
 
-export interface ErrorContext<T extends CompatibleClass> {
+export type ComponentConfig<ComponentClass extends CompatibleClass> = ConstructorParameters<ComponentClass>[1];
+
+export interface ErrorContext<ComponentClass extends CompatibleClass> {
     /**
      * - Element used for component module initialisation
      */
@@ -66,17 +73,20 @@ export interface ErrorContext<T extends CompatibleClass> {
     /**
      * - Class of component
      */
-    component?: T | undefined;
+    component?: ComponentClass | undefined;
 
     /**
      * - Config supplied to component
      */
-    config: T["defaults"];
+    config: ComponentConfig<ComponentClass>;
 }
 
-export type OnErrorCallback<T extends CompatibleClass> = (error: unknown, context: ErrorContext<T>) => any;
+export type OnErrorCallback<ComponentClass extends CompatibleClass> = (
+    error: unknown,
+    context: ErrorContext<ComponentClass>,
+) => any;
 
-export interface CreateAllOptions<T extends CompatibleClass> {
+export interface CreateAllOptions<ComponentClass extends CompatibleClass> {
     /**
      * - scope of the document to search within
      */
@@ -85,7 +95,7 @@ export interface CreateAllOptions<T extends CompatibleClass> {
     /**
      * - callback function if error throw by component on init
      */
-    onError?: OnErrorCallback<T> | undefined;
+    onError?: OnErrorCallback<ComponentClass> | undefined;
 }
 
 /**
@@ -112,14 +122,18 @@ export function initAll(
  *
  * Any component errors will be caught and logged to the console.
  *
- * @template {CompatibleClass} T
- * @param {T} Component - class of the component to create
- * @param {T["defaults"]} [config] - Config supplied to component
- * @param {OnErrorCallback<T> | Element | Document | CreateAllOptions<T> } [createAllOptions] - options for createAll including scope of the document to search within and callback function if error throw by component on init
- * @returns {Array<InstanceType<T>>} - array of instantiated components
+ * @template {CompatibleClass} ComponentClass
+ * @param {ComponentClass} Component - class of the component to create
+ * @param {ComponentConfig<ComponentClass>} [config] - Config supplied to component
+ * @param {OnErrorCallback<ComponentClass> | Element | Document | CreateAllOptions<ComponentClass> } [createAllOptions] - options for createAll including scope of the document to search within and callback function if error throw by component on init
+ * @returns {Array<InstanceType<ComponentClass>>} - array of instantiated components
  */
-export function createAll<T extends CompatibleClass>(
-    Component: T,
-    config?: T["defaults"],
-    createAllOptions?: Document | Element | OnErrorCallback<T> | CreateAllOptions<T>,
-): Array<InstanceType<T>>;
+export function createAll<ComponentClass extends CompatibleClass>(
+    Component: ComponentClass,
+    config?: ComponentConfig<ComponentClass>,
+    createAllOptions?:
+        | OnErrorCallback<ComponentClass>
+        | Element
+        | Document
+        | CreateAllOptions<ComponentClass>,
+): Array<InstanceType<ComponentClass>>;

govuk-frontend/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/govuk-frontend",
-    "version": "5.7.0",
+    "version": "5.9.0",
     "description": "TypeScript definitions for govuk-frontend",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/govuk-frontend",
     "license": "MIT",
@@ -32,6 +32,7 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "08d1cc6a671dadd0e0e9c1113ea085b28a6b2510f52991c817bfb8d71bc308ae",
-    "typeScriptVersion": "4.8"
+    "peerDependencies": {},
+    "typesPublisherContentHash": "0c6bf1e47e944f9d230c1eed825ea255eb3d43f5684e51a3c8c070c2a8ec9177",
+    "typeScriptVersion": "5.1"
 }

govuk-frontend/dist/govuk/common/normalise-dataset.d.mts

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

govuk-frontend/dist/govuk/common/normalise-dataset.d.ts

@@ -1,16 +0,0 @@
-import { type ObjectNested, type Schema } from "./index.js";
-
-/**
- * Normalise dataset
- *
- * Loop over an object and normalise each value using {@link normaliseString},
- * optionally expanding nested `i18n.field`
- *
- * @internal
- * @param {{ schema: Schema }} Component - Component class
- * @param {DOMStringMap} dataset - HTML element dataset
- * @returns {ObjectNested} Normalised dataset
- */
-export function normaliseDataset(Component: {
-    schema: Schema;
-}, dataset: DOMStringMap): ObjectNested;

govuk-frontend/dist/govuk/common/normalise-string.d.mts

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

govuk-frontend/dist/govuk/common/normalise-string.d.ts

@@ -1,22 +0,0 @@
-import { type SchemaProperty } from "./index.js";
-
-/**
- * Normalise string
- *
- * 'If it looks like a duck, and it quacks like a duck…' 🦆
- *
- * If the passed value looks like a boolean or a number, convert it to a boolean
- * or number.
- *
- * Designed to be used to convert config passed via data attributes (which are
- * always strings) into something sensible.
- *
- * @internal
- * @param {DOMStringMap[string]} value - The value to normalise
- * @param {SchemaProperty} [property] - Component schema property
- * @returns {string | boolean | number | undefined} Normalised data
- */
-export function normaliseString(
-    value: DOMStringMap[string],
-    property?: SchemaProperty,
-): string | boolean | number | undefined;

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

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