@types/govuk-frontend 5.9.0 → 5.11.0

govuk-frontend/README.md

@@ -8,8 +8,8 @@ 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: Thu, 03 Apr 2025 22:35:25 GMT
+ * Last updated: Fri, 12 Sep 2025 19:02:26 GMT
  * Dependencies: none
 
 # Credits
-These definitions were written by [Colin Rotherham](https://github.com/colinrotherham), and [Romaric Pascal](https://github.com/romaricpascal).
+These definitions were written by [Colin Rotherham](https://github.com/colinrotherham), [Paul Robert Lloyd](https://github.com/paulrobertlloyd), and [Romaric Pascal](https://github.com/romaricpascal).

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

@@ -1,4 +1,5 @@
 import { Component } from "../component.js";
+import { type CompatibleClass, type Config, type CreateAllOptions, type OnErrorCallback } from "../init.js";
 
 /**
  * Normalise string
@@ -44,6 +45,25 @@ export function normaliseDataset<
     dataset: DOMStringMap,
 ): ObjectNested;
 
+/**
+ * Normalise options passed to `initAll` or `createAll`
+ *
+ * @internal
+ * @template {CompatibleClass} ComponentClass
+ * @param {Config | CreateAllOptions<ComponentClass> | OnErrorCallback<ComponentClass> | Element | Document | null} [scopeOrOptions] - Scope of the document to search within, initialisation options or error callback function
+ * @returns {CreateAllOptions<ComponentClass>} Normalised options
+ */
+export function normaliseOptions<
+    ComponentClass extends CompatibleClass,
+>(
+    scopeOrOptions?:
+        | Config
+        | CreateAllOptions<ComponentClass>
+        | OnErrorCallback<ComponentClass>
+        | Element
+        | Document
+        | null,
+): CreateAllOptions<ComponentClass>;
 /**
  * Config merging function
  *

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

@@ -1,5 +1,3 @@
-import { type ObjectNested } from "./configuration.js";
-
 /**
  * Common helpers which do not require polyfill.
  *
@@ -7,18 +5,6 @@ import { type ObjectNested } from "./configuration.js";
  * so that the polyfill can be properly tree-shaken and does not burden
  * the components that do not need that helper
  */
-
-/**
- * Get hash fragment from URL
- *
- * Extract the hash fragment (everything after the hash) from a URL,
- * but not including the hash symbol
- *
- * @param {string} url - URL
- * @returns {string | undefined} Fragment from URL, without the hash
- */
-export function getFragmentFromUrl(url: string): string | undefined;
-
 /**
  * Get GOV.UK Frontend breakpoint value from CSS custom property
  *
@@ -75,14 +61,26 @@ export function isSupported($scope?: HTMLElement | null): boolean;
  * Check for an object
  *
  * @internal
- * @template {Partial<Record<keyof ObjectType, unknown>>} [ObjectType=ObjectNested]
+ * @template {Partial<Record<keyof ObjectType, unknown>>} ObjectType
  * @param {unknown | ObjectType} option - Option to check
  * @returns {option is ObjectType} Whether the option is an object
  */
 export function isObject<
-    ObjectType extends Partial<Record<keyof ObjectType, unknown>> = ObjectNested,
+    ObjectType extends Partial<Record<keyof ObjectType, unknown>>,
 >(option: unknown | ObjectType): option is ObjectType;
 
+/**
+ * Check for valid scope
+ *
+ * @internal
+ * @template {Element | Document} ScopeType
+ * @param {unknown | ScopeType} $scope - Scope of the document to search within
+ * @returns {$scope is ScopeType} Whether the scope can be queried
+ */
+export function isScope<ScopeType extends Element | Document>(
+    $scope: unknown | ScopeType,
+): $scope is ScopeType;
+
 /**
  * Format error message
  *

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

@@ -73,22 +73,22 @@ export class InitError extends GOVUKFrontendError {
  */
 export interface ElementErrorOptions {
     /**
-     * - An identifier that'll let the user understand which element has an error. This is whatever makes the most sense
+     * - The element in error (optional)
      */
-    identifier: string;
+    element?: Document | Element | null | undefined;
 
     /**
-     * - The element in error
+     * - Component throwing the error (optional)
      */
-    element?: Element | null | undefined;
+    component?: ComponentWithModuleName | undefined;
 
     /**
-     * - The type that was expected for the identifier
+     * - An identifier that'll let the user understand which element has an error. This is whatever makes the most sense
      */
-    expectedType?: string | undefined;
+    identifier: string;
 
     /**
-     * - Component throwing the error
+     * - The type that was expected for the identifier (optional)
      */
-    component: ComponentWithModuleName;
+    expectedType?: string | undefined;
 }

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

@@ -1,11 +1,14 @@
-import { type AccordionConfig } from "./components/accordion/accordion.js";
-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";
+import { Accordion, type AccordionConfig } from "./components/accordion/accordion.js";
+import { Button, type ButtonConfig } from "./components/button/button.js";
+import { CharacterCount, type CharacterCountConfig } from "./components/character-count/character-count.js";
+import { ErrorSummary, type ErrorSummaryConfig } from "./components/error-summary/error-summary.js";
+import { ExitThisPage, type ExitThisPageConfig } from "./components/exit-this-page/exit-this-page.js";
+import { FileUpload, type FileUploadConfig } from "./components/file-upload/file-upload.js";
+import {
+    NotificationBanner,
+    type NotificationBannerConfig,
+} from "./components/notification-banner/notification-banner.js";
+import { PasswordInput, type PasswordInputConfig } from "./components/password-input/password-input.js";
 
 export interface CompatibleClass {
     new(...args: any[]): any;
@@ -16,6 +19,28 @@ export interface CompatibleClass {
  * Config for all components via `initAll()`
  */
 export interface Config {
+    /**
+     * - Scope of the document to search within
+     */
+    scope?: Document | Element | null | undefined;
+
+    /**
+     * - Initialisation error callback
+     */
+    onError?:
+        | OnErrorCallback<
+            | typeof Accordion
+            | typeof Button
+            | typeof CharacterCount
+            | typeof ErrorSummary
+            | typeof ExitThisPage
+            | typeof FileUpload
+            | typeof NotificationBanner
+            | typeof PasswordInput
+            | undefined
+        >
+        | undefined;
+
     /**
      * - Accordion config
      */
@@ -60,15 +85,18 @@ export interface Config {
 /**
  * Component config keys, e.g. `accordion` and `characterCount`
  */
-export type ConfigKey = keyof Config;
+export type ConfigKey = keyof Omit<Config, "scope" | "onError">;
 
 export type ComponentConfig<ComponentClass extends CompatibleClass> = ConstructorParameters<ComponentClass>[1];
 
-export interface ErrorContext<ComponentClass extends CompatibleClass> {
+export interface ErrorContext<
+    ComponentClass extends CompatibleClass | undefined = undefined,
+> {
     /**
      * - Element used for component module initialisation
      */
-    element?: Element | undefined;
+    element?: ComponentClass extends CompatibleClass ? Element
+        : undefined;
 
     /**
      * - Class of component
@@ -76,12 +104,15 @@ export interface ErrorContext<ComponentClass extends CompatibleClass> {
     component?: ComponentClass | undefined;
 
     /**
-     * - Config supplied to component
+     * - Config supplied to components
      */
-    config: ComponentConfig<ComponentClass>;
+    config?: ComponentClass extends CompatibleClass ? ComponentConfig<ComponentClass>
+        : Config;
 }
 
-export type OnErrorCallback<ComponentClass extends CompatibleClass> = (
+export type OnErrorCallback<
+    ComponentClass extends CompatibleClass | undefined = undefined,
+> = (
     error: unknown,
     context: ErrorContext<ComponentClass>,
 ) => any;
@@ -90,7 +121,7 @@ export interface CreateAllOptions<ComponentClass extends CompatibleClass> {
     /**
      * - scope of the document to search within
      */
-    scope?: Document | Element | undefined;
+    scope?: Document | Element | null | undefined;
 
     /**
      * - callback function if error throw by component on init
@@ -104,13 +135,10 @@ export interface CreateAllOptions<ComponentClass extends CompatibleClass> {
  * Use the `data-module` attributes to find, instantiate and init all of the
  * components provided as part of GOV.UK Frontend.
  *
- * @param {Config & { scope?: Element, onError?: OnErrorCallback<CompatibleClass> }} [config] - Config for all components (with optional scope)
+ * @param {Config | Element | Document | null} [scopeOrConfig] - Scope of the document to search within or config for all components (with optional scope)
  */
 export function initAll(
-    config?: Config & {
-        scope?: Element;
-        onError?: OnErrorCallback<CompatibleClass>;
-    },
+    scopeOrConfig?: Config | Element | Document | null,
 ): void;
 
 /**
@@ -125,15 +153,16 @@ export function initAll(
  * @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
+ * @param {OnErrorCallback<ComponentClass> | Element | Document | null | CreateAllOptions<ComponentClass>} [scopeOrOptions] - 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<ComponentClass extends CompatibleClass>(
     Component: ComponentClass,
     config?: ComponentConfig<ComponentClass>,
-    createAllOptions?:
+    scopeOrOptions?:
         | OnErrorCallback<ComponentClass>
         | Element
         | Document
+        | null
         | CreateAllOptions<ComponentClass>,
 ): Array<InstanceType<ComponentClass>>;

govuk-frontend/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/govuk-frontend",
-    "version": "5.9.0",
+    "version": "5.11.0",
     "description": "TypeScript definitions for govuk-frontend",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/govuk-frontend",
     "license": "MIT",
@@ -10,6 +10,11 @@
             "githubUsername": "colinrotherham",
             "url": "https://github.com/colinrotherham"
         },
+        {
+            "name": "Paul Robert Lloyd",
+            "githubUsername": "paulrobertlloyd",
+            "url": "https://github.com/paulrobertlloyd"
+        },
         {
             "name": "Romaric Pascal",
             "githubUsername": "romaricpascal",
@@ -33,6 +38,6 @@
     "scripts": {},
     "dependencies": {},
     "peerDependencies": {},
-    "typesPublisherContentHash": "0c6bf1e47e944f9d230c1eed825ea255eb3d43f5684e51a3c8c070c2a8ec9177",
-    "typeScriptVersion": "5.1"
+    "typesPublisherContentHash": "33f390f9de3c3dfe7ef78c5fee7171a541a00aeecaedc5460d56c20acb614a45",
+    "typeScriptVersion": "5.2"
 }