DefinitelyTyped · typescript-bot · Jul 25, 2024 · Jul 24, 2024 · Jul 24, 2024 · Jul 24, 2024
diff --git a/types/govuk-frontend/.npmignore b/types/govuk-frontend/.npmignore
@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts
diff --git a/types/govuk-frontend/dist/govuk/all.bundle.d.mts b/types/govuk-frontend/dist/govuk/all.bundle.d.mts
@@ -0,0 +1,14 @@
+export { version } from "./common/govuk-frontend-version.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 { 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 { SkipLink } from "./components/skip-link/skip-link.mjs";
+export { Tabs } from "./components/tabs/tabs.mjs";
+export { type Config, type ConfigKey, createAll, initAll } from "./init.mjs";
diff --git a/types/govuk-frontend/dist/govuk/all.bundle.d.ts b/types/govuk-frontend/dist/govuk/all.bundle.d.ts
@@ -0,0 +1,39 @@
+import { version } from "./common/govuk-frontend-version.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 { 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 { SkipLink } from "./components/skip-link/skip-link.js";
+import { Tabs } from "./components/tabs/tabs.js";
+import { type Config as ConfigImport, type ConfigKey as ConfigKeyImport, createAll, initAll } from "./init.js";
+
+declare namespace GOVUKFrontend {
+    type Config = ConfigImport;
+    type ConfigKey = ConfigKeyImport;
+}
+
+declare const GOVUKFrontend: {
+    version: typeof version;
+    Accordion: typeof Accordion;
+    Button: typeof Button;
+    CharacterCount: typeof CharacterCount;
+    Checkboxes: typeof Checkboxes;
+    ErrorSummary: typeof ErrorSummary;
+    ExitThisPage: typeof ExitThisPage;
+    Header: typeof Header;
+    NotificationBanner: typeof NotificationBanner;
+    PasswordInput: typeof PasswordInput;
+    Radios: typeof Radios;
+    SkipLink: typeof SkipLink;
+    Tabs: typeof Tabs;
+    createAll: typeof createAll;
+    initAll: typeof initAll;
+};
+
+export = GOVUKFrontend;
diff --git a/types/govuk-frontend/dist/govuk/all.d.mts b/types/govuk-frontend/dist/govuk/all.d.mts
@@ -0,0 +1 @@
+export * from "./all.bundle.mjs";
diff --git a/types/govuk-frontend/dist/govuk/common/closest-attribute-value.d.mts b/types/govuk-frontend/dist/govuk/common/closest-attribute-value.d.mts
@@ -0,0 +1 @@
+export * from "./closest-attribute-value.js";
diff --git a/types/govuk-frontend/dist/govuk/common/closest-attribute-value.d.ts b/types/govuk-frontend/dist/govuk/common/closest-attribute-value.d.ts
@@ -0,0 +1,9 @@
+/**
+ * Returns the value of the given attribute closest to the given element (including itself)
+ *
+ * @internal
+ * @param {Element} $element - The element to start walking the DOM tree up
+ * @param {string} attributeName - The name of the attribute
+ * @returns {string | null} Attribute value
+ */
+export function closestAttributeValue($element: Element, attributeName: string): string | null;
diff --git a/types/govuk-frontend/dist/govuk/common/govuk-frontend-version.d.mts b/types/govuk-frontend/dist/govuk/common/govuk-frontend-version.d.mts
@@ -0,0 +1 @@
+export * from "./govuk-frontend-version.js";
diff --git a/types/govuk-frontend/dist/govuk/common/govuk-frontend-version.d.ts b/types/govuk-frontend/dist/govuk/common/govuk-frontend-version.d.ts
@@ -0,0 +1,6 @@
+/**
+ * GOV.UK Frontend release version
+ *
+ * {@link https://github.com/alphagov/govuk-frontend/releases}
+ */
+export const version: "development";
diff --git a/types/govuk-frontend/dist/govuk/common/index.d.mts b/types/govuk-frontend/dist/govuk/common/index.d.mts
@@ -0,0 +1 @@
+export * from "./index.js";
diff --git a/types/govuk-frontend/dist/govuk/common/index.d.ts b/types/govuk-frontend/dist/govuk/common/index.d.ts
@@ -0,0 +1,159 @@
+/**
+ * Common helpers which do not require polyfill.
+ *
+ * IMPORTANT: If a helper require a polyfill, please isolate it in its own module
+ * 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
+ *
+ * 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
+ *
+ * @param {string} name - Breakpoint name
+ * @returns {{ property: string, value?: string }} Breakpoint object
+ */
+export function getBreakpoint(name: string): {
+    property: string;
+    value?: string;
+};
+
+/**
+ * Move focus to element
+ *
+ * Sets tabindex to -1 to make the element programmatically focusable,
+ * but removes it on blur as the element doesn't need to be focused again.
+ *
+ * @template {HTMLElement} FocusElement
+ * @param {FocusElement} $element - HTML element
+ * @param {object} [options] - Handler options
+ * @param {function(this: FocusElement): void} [options.onBeforeFocus] - Callback before focus
+ * @param {function(this: FocusElement): void} [options.onBlur] - Callback on blur
+ */
+export function setFocus<FocusElement extends HTMLElement>(
+    $element: FocusElement,
+    options?: {
+        onBeforeFocus?: ((this: FocusElement) => void) | undefined;
+        onBlur?: ((this: FocusElement) => void) | undefined;
+    },
+): void;
+
+/**
+ * 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.
+ *
+ * @internal
+ * @param {HTMLElement | null} [$scope] - HTML element `<body>` checked for browser support
+ * @returns {boolean} Whether GOV.UK Frontend is supported on this page
+ */
+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}
+ *
+ * @internal
+ * @param {Schema} schema - Config schema
+ * @param {{ [key: string]: unknown }} config - Component config
+ * @returns {string[]} List of validation errors
+ */
+export function validateConfig(schema: Schema, config: {
+    [key: string]: unknown;
+}): 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;
+}
diff --git a/types/govuk-frontend/dist/govuk/common/normalise-dataset.d.mts b/types/govuk-frontend/dist/govuk/common/normalise-dataset.d.mts
@@ -0,0 +1 @@
+export * from "./normalise-dataset.js";
diff --git a/types/govuk-frontend/dist/govuk/common/normalise-dataset.d.ts b/types/govuk-frontend/dist/govuk/common/normalise-dataset.d.ts
@@ -0,0 +1,16 @@
+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;
diff --git a/types/govuk-frontend/dist/govuk/common/normalise-string.d.mts b/types/govuk-frontend/dist/govuk/common/normalise-string.d.mts
@@ -0,0 +1 @@
+export * from "./normalise-string.js";
diff --git a/types/govuk-frontend/dist/govuk/common/normalise-string.d.ts b/types/govuk-frontend/dist/govuk/common/normalise-string.d.ts
@@ -0,0 +1,22 @@
+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;
diff --git a/types/govuk-frontend/dist/govuk/components/accordion/accordion.d.mts b/types/govuk-frontend/dist/govuk/components/accordion/accordion.d.mts
@@ -0,0 +1 @@
+export * from "./accordion.js";