govuk_tech_docs 3.5.0 → 4.1.0

data/node_modules/govuk-frontend/govuk/i18n.js

@@ -1,397 +0,0 @@
-(function (global, factory) {
-  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
-  typeof define === 'function' && define.amd ? define('GOVUKFrontend', ['exports'], factory) :
-  (factory((global.GOVUKFrontend = {})));
-}(this, (function (exports) { 'use strict';
-
-  /**
-   * Internal support for selecting messages to render, with placeholder
-   * interpolation and locale-aware number formatting and pluralisation
-   *
-   * @class
-   * @private
-   * @param {Object<string, unknown>} translations - Key-value pairs of the translation strings to use.
-   * @param {object} [config] - Configuration options for the function.
-   * @param {string} [config.locale] - An overriding locale for the PluralRules functionality.
-   */
-  function I18n (translations, config) {
-    // Make list of translations available throughout function
-    this.translations = translations || {};
-
-    // The locale to use for PluralRules and NumberFormat
-    this.locale = (config && config.locale) || document.documentElement.lang || 'en';
-  }
-
-  /**
-   * The most used function - takes the key for a given piece of UI text and
-   * returns the appropriate string.
-   *
-   * @param {string} lookupKey - The lookup key of the string to use.
-   * @param {Object<string, unknown>} [options] - Any options passed with the translation string, e.g: for string interpolation.
-   * @returns {string} The appropriate translation string.
-   * @throws {Error} Lookup key required
-   * @throws {Error} Options required for `${}` placeholders
-   */
-  I18n.prototype.t = function (lookupKey, options) {
-    if (!lookupKey) {
-      // Print a console error if no lookup key has been provided
-      throw new Error('i18n: lookup key missing')
-    }
-
-    // If the `count` option is set, determine which plural suffix is needed and
-    // change the lookupKey to match. We check to see if it's numeric instead of
-    // falsy, as this could legitimately be 0.
-    if (options && typeof options.count === 'number') {
-      // Get the plural suffix
-      lookupKey = lookupKey + '.' + this.getPluralSuffix(lookupKey, options.count);
-    }
-
-    // Fetch the translation string for that lookup key
-    var translationString = this.translations[lookupKey];
-
-    if (typeof translationString === 'string') {
-      // Check for ${} placeholders in the translation string
-      if (translationString.match(/%{(.\S+)}/)) {
-        if (!options) {
-          throw new Error('i18n: cannot replace placeholders in string if no option data provided')
-        }
-
-        return this.replacePlaceholders(translationString, options)
-      } else {
-        return translationString
-      }
-    } else {
-      // If the key wasn't found in our translations object,
-      // return the lookup key itself as the fallback
-      return lookupKey
-    }
-  };
-
-  /**
-   * Takes a translation string with placeholders, and replaces the placeholders
-   * with the provided data
-   *
-   * @param {string} translationString - The translation string
-   * @param {Object<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
-   */
-  I18n.prototype.replacePlaceholders = function (translationString, options) {
-    /** @type {Intl.NumberFormat | undefined} */
-    var formatter;
-
-    if (this.hasIntlNumberFormatSupport()) {
-      formatter = new Intl.NumberFormat(this.locale);
-    }
-
-    return translationString.replace(
-      /%{(.\S+)}/g,
-
-      /**
-       * Replace translation string placeholders
-       *
-       * @param {string} placeholderWithBraces - Placeholder with braces
-       * @param {string} placeholderKey - Placeholder key
-       * @returns {string} Placeholder value
-       */
-      function (placeholderWithBraces, placeholderKey) {
-        if (Object.prototype.hasOwnProperty.call(options, placeholderKey)) {
-          var placeholderValue = options[placeholderKey];
-
-          // If a user has passed `false` as the value for the placeholder
-          // treat it as though the value should not be displayed
-          if (placeholderValue === false || (
-            typeof placeholderValue !== 'number' &&
-            typeof placeholderValue !== 'string')
-          ) {
-            return ''
-          }
-
-          // If the placeholder's value is a number, localise the number formatting
-          if (typeof placeholderValue === 'number') {
-            return formatter ? formatter.format(placeholderValue) : placeholderValue.toString()
-          }
-
-          return placeholderValue
-        } else {
-          throw new Error('i18n: no data found to replace ' + placeholderWithBraces + ' placeholder in string')
-        }
-      })
-  };
-
-  /**
-   * Check to see if the browser supports Intl and Intl.PluralRules.
-   *
-   * It requires all conditions to be met in order to be supported:
-   * - The browser supports the Intl class (true in IE11)
-   * - The implementation of Intl supports PluralRules (NOT true in IE11)
-   * - The browser/OS has plural rules for the current locale (browser dependent)
-   *
-   * @returns {boolean} Returns true if all conditions are met. Returns false otherwise.
-   */
-  I18n.prototype.hasIntlPluralRulesSupport = function () {
-    return Boolean(window.Intl && ('PluralRules' in window.Intl && Intl.PluralRules.supportedLocalesOf(this.locale).length))
-  };
-
-  /**
-   * Check to see if the browser supports Intl and Intl.NumberFormat.
-   *
-   * It requires all conditions to be met in order to be supported:
-   * - The browser supports the Intl class (true in IE11)
-   * - The implementation of Intl supports NumberFormat (also true in IE11)
-   * - The browser/OS has number formatting rules for the current locale (browser dependent)
-   *
-   * @returns {boolean} Returns true if all conditions are met. Returns false otherwise.
-   */
-  I18n.prototype.hasIntlNumberFormatSupport = function () {
-    return Boolean(window.Intl && ('NumberFormat' in window.Intl && Intl.NumberFormat.supportedLocalesOf(this.locale).length))
-  };
-
-  /**
-   * Get the appropriate suffix for the plural form.
-   *
-   * Uses Intl.PluralRules (or our own fallback implementation) to get the
-   * 'preferred' form to use for the given count.
-   *
-   * Checks that a translation has been provided for that plural form – if it
-   * hasn't, it'll fall back to the 'other' plural form (unless that doesn't exist
-   * either, in which case an error will be thrown)
-   *
-   * @param {string} lookupKey - The lookup key of the string to use.
-   * @param {number} count - Number used to determine which pluralisation to use.
-   * @returns {PluralRule} The suffix associated with the correct pluralisation for this locale.
-   * @throws {Error} Plural form `.other` required when preferred plural form is missing
-   */
-  I18n.prototype.getPluralSuffix = function (lookupKey, count) {
-    // Validate that the number is actually a number.
-    //
-    // Number(count) will turn anything that can't be converted to a Number type
-    // into 'NaN'. isFinite filters out NaN, as it isn't a finite number.
-    count = Number(count);
-    if (!isFinite(count)) { return 'other' }
-
-    var preferredForm;
-
-    // Check to verify that all the requirements for Intl.PluralRules are met.
-    // If so, we can use that instead of our custom implementation. Otherwise,
-    // use the hardcoded fallback.
-    if (this.hasIntlPluralRulesSupport()) {
-      preferredForm = new Intl.PluralRules(this.locale).select(count);
-    } else {
-      preferredForm = this.selectPluralFormUsingFallbackRules(count);
-    }
-
-    // Use the correct plural form if provided
-    if (lookupKey + '.' + preferredForm in this.translations) {
-      return preferredForm
-    // Fall back to `other` if the plural form is missing, but log a warning
-    // to the console
-    } else if (lookupKey + '.other' in this.translations) {
-      if (console && 'warn' in console) {
-        console.warn('i18n: Missing plural form ".' + preferredForm + '" for "' +
-          this.locale + '" locale. Falling back to ".other".');
-      }
-
-      return 'other'
-    // If the required `other` plural form is missing, all we can do is error
-    } else {
-      throw new Error(
-        'i18n: Plural form ".other" is required for "' + this.locale + '" locale'
-      )
-    }
-  };
-
-  /**
-   * Get the plural form using our fallback implementation
-   *
-   * This is split out into a separate function to make it easier to test the
-   * fallback behaviour in an environment where Intl.PluralRules exists.
-   *
-   * @param {number} count - Number used to determine which pluralisation to use.
-   * @returns {PluralRule} The pluralisation form for count in this locale.
-   */
-  I18n.prototype.selectPluralFormUsingFallbackRules = function (count) {
-    // Currently our custom code can only handle positive integers, so let's
-    // make sure our number is one of those.
-    count = Math.abs(Math.floor(count));
-
-    var ruleset = this.getPluralRulesForLocale();
-
-    if (ruleset) {
-      return I18n.pluralRules[ruleset](count)
-    }
-
-    return 'other'
-  };
-
-  /**
-   * Work out which pluralisation rules to use for the current locale
-   *
-   * The locale may include a regional indicator (such as en-GB), but we don't
-   * usually care about this part, as pluralisation rules are usually the same
-   * regardless of region. There are exceptions, however, (e.g. Portuguese) so
-   * this searches by both the full and shortened locale codes, just to be sure.
-   *
-   * @returns {string | undefined} The name of the pluralisation rule to use (a key for one
-   *   of the functions in this.pluralRules)
-   */
-  I18n.prototype.getPluralRulesForLocale = function () {
-    var locale = this.locale;
-    var localeShort = locale.split('-')[0];
-
-    // Look through the plural rules map to find which `pluralRule` is
-    // appropriate for our current `locale`.
-    for (var pluralRule in I18n.pluralRulesMap) {
-      if (Object.prototype.hasOwnProperty.call(I18n.pluralRulesMap, pluralRule)) {
-        var languages = I18n.pluralRulesMap[pluralRule];
-        for (var i = 0; i < languages.length; i++) {
-          if (languages[i] === locale || languages[i] === localeShort) {
-            return pluralRule
-          }
-        }
-      }
-    }
-  };
-
-  /**
-   * Map of plural rules to languages where those rules apply.
-   *
-   * Note: These groups are named for the most dominant or recognisable language
-   * that uses each system. The groupings do not imply that the languages are
-   * related to one another. Many languages have evolved the same systems
-   * independently of one another.
-   *
-   * Code to support more languages can be found in the i18n spike:
-   * {@link https://github.com/alphagov/govuk-frontend/blob/spike-i18n-support/src/govuk/i18n.mjs}
-   *
-   * Languages currently supported:
-   *
-   * Arabic: Arabic (ar)
-   * Chinese: Burmese (my), Chinese (zh), Indonesian (id), Japanese (ja),
-   *   Javanese (jv), Korean (ko), Malay (ms), Thai (th), Vietnamese (vi)
-   * French: Armenian (hy), Bangla (bn), French (fr), Gujarati (gu), Hindi (hi),
-   *   Persian Farsi (fa), Punjabi (pa), Zulu (zu)
-   * German: Afrikaans (af), Albanian (sq), Azerbaijani (az), Basque (eu),
-   *   Bulgarian (bg), Catalan (ca), Danish (da), Dutch (nl), English (en),
-   *   Estonian (et), Finnish (fi), Georgian (ka), German (de), Greek (el),
-   *   Hungarian (hu), Luxembourgish (lb), Norwegian (no), Somali (so),
-   *   Swahili (sw), Swedish (sv), Tamil (ta), Telugu (te), Turkish (tr),
-   *   Urdu (ur)
-   * Irish: Irish Gaelic (ga)
-   * Russian: Russian (ru), Ukrainian (uk)
-   * Scottish: Scottish Gaelic (gd)
-   * Spanish: European Portuguese (pt-PT), Italian (it), Spanish (es)
-   * Welsh: Welsh (cy)
-   *
-   * @type {Object<string, string[]>}
-   */
-  I18n.pluralRulesMap = {
-    arabic: ['ar'],
-    chinese: ['my', 'zh', 'id', 'ja', 'jv', 'ko', 'ms', 'th', 'vi'],
-    french: ['hy', 'bn', 'fr', 'gu', 'hi', 'fa', 'pa', 'zu'],
-    german: [
-      'af', 'sq', 'az', 'eu', 'bg', 'ca', 'da', 'nl', 'en', 'et', 'fi', 'ka',
-      'de', 'el', 'hu', 'lb', 'no', 'so', 'sw', 'sv', 'ta', 'te', 'tr', 'ur'
-    ],
-    irish: ['ga'],
-    russian: ['ru', 'uk'],
-    scottish: ['gd'],
-    spanish: ['pt-PT', 'it', 'es'],
-    welsh: ['cy']
-  };
-
-  /**
-   * Different pluralisation rule sets
-   *
-   * Returns the appropriate suffix for the plural form associated with `n`.
-   * Possible suffixes: 'zero', 'one', 'two', 'few', 'many', 'other' (the actual
-   * meaning of each differs per locale). 'other' should always exist, even in
-   * languages without plurals, such as Chinese.
-   * {@link https://cldr.unicode.org/index/cldr-spec/plural-rules}
-   *
-   * The count must be a positive integer. Negative numbers and decimals aren't accounted for
-   *
-   * @type {Object<string, function(number): PluralRule>}
-   */
-  I18n.pluralRules = {
-    /* eslint-disable jsdoc/require-jsdoc */
-    arabic: function (n) {
-      if (n === 0) { return 'zero' }
-      if (n === 1) { return 'one' }
-      if (n === 2) { return 'two' }
-      if (n % 100 >= 3 && n % 100 <= 10) { return 'few' }
-      if (n % 100 >= 11 && n % 100 <= 99) { return 'many' }
-      return 'other'
-    },
-    chinese: function () {
-      return 'other'
-    },
-    french: function (n) {
-      return n === 0 || n === 1 ? 'one' : 'other'
-    },
-    german: function (n) {
-      return n === 1 ? 'one' : 'other'
-    },
-    irish: function (n) {
-      if (n === 1) { return 'one' }
-      if (n === 2) { return 'two' }
-      if (n >= 3 && n <= 6) { return 'few' }
-      if (n >= 7 && n <= 10) { return 'many' }
-      return 'other'
-    },
-    russian: function (n) {
-      var lastTwo = n % 100;
-      var last = lastTwo % 10;
-      if (last === 1 && lastTwo !== 11) { return 'one' }
-      if (last >= 2 && last <= 4 && !(lastTwo >= 12 && lastTwo <= 14)) { return 'few' }
-      if (last === 0 || (last >= 5 && last <= 9) || (lastTwo >= 11 && lastTwo <= 14)) { return 'many' }
-      // Note: The 'other' suffix is only used by decimal numbers in Russian.
-      // We don't anticipate it being used, but it's here for consistency.
-      return 'other'
-    },
-    scottish: function (n) {
-      if (n === 1 || n === 11) { return 'one' }
-      if (n === 2 || n === 12) { return 'two' }
-      if ((n >= 3 && n <= 10) || (n >= 13 && n <= 19)) { return 'few' }
-      return 'other'
-    },
-    spanish: function (n) {
-      if (n === 1) { return 'one' }
-      if (n % 1000000 === 0 && n !== 0) { return 'many' }
-      return 'other'
-    },
-    welsh: function (n) {
-      if (n === 0) { return 'zero' }
-      if (n === 1) { return 'one' }
-      if (n === 2) { return 'two' }
-      if (n === 3) { return 'few' }
-      if (n === 6) { return 'many' }
-      return 'other'
-    }
-    /* eslint-enable jsdoc/require-jsdoc */
-  };
-
-  /**
-   * Plural rule category mnemonic tags
-   *
-   * @typedef {'zero' | 'one' | 'two' | 'few' | 'many' | 'other'} PluralRule
-   */
-
-  /**
-   * Translated message by plural rule they correspond to.
-   *
-   * Allows to group pluralised messages under a single key when passing
-   * translations to a component's constructor
-   *
-   * @typedef {object} TranslationPluralForms
-   * @property {string} [other] - General plural form
-   * @property {string} [zero] - Plural form used with 0
-   * @property {string} [one] - Plural form used with 1
-   * @property {string} [two] - Plural form used with 2
-   * @property {string} [few] - Plural form used for a few
-   * @property {string} [many] - Plural form used for many
-   */
-
-  exports.I18n = I18n;
-
-})));
-//# sourceMappingURL=i18n.js.map

data/node_modules/govuk-frontend/govuk/overrides/_typography.scss

@@ -1,21 +0,0 @@
-@include govuk-exports("govuk/overrides/typography") {
-  // Font size and line height
-
-  // Generate typography override classes for each responsive font map in the
-  // typography scale eg .govuk-\!-font-size-80
-  @each $size in map-keys($govuk-typography-scale) {
-    .govuk-\!-font-size-#{$size} {
-      @include govuk-typography-responsive($size, $important: true);
-    }
-  }
-
-  // Weights
-
-  .govuk-\!-font-weight-regular {
-    @include govuk-typography-weight-regular($important: true);
-  }
-
-  .govuk-\!-font-weight-bold {
-    @include govuk-typography-weight-bold($important: true);
-  }
-}

data/node_modules/govuk-frontend/govuk/settings/_colours-organisations.scss

@@ -1,146 +0,0 @@
-////
-/// @group settings/colours
-////
-
-/// Organisation colours
-///
-/// @type Map
-///
-/// @prop $organisation.colour - Colour for the given `$organisation`
-/// @prop $organisation.colour-websafe - Websafe colour for the given
-///   `$organisation`. We use `websafe` to mean strong enough contrast against
-///   white to be used for copy and meet the AAA (large text) and AA (smaller
-///   copy) WCAG guidelines.
-///
-/// @access public
-
-$govuk-colours-organisations: (
-  "attorney-generals-office": (
-    colour: #9f1888,
-    colour-websafe: #a03a88
-  ),
-  "cabinet-office": (
-    colour: #005abb,
-    colour-websafe: #347da4
-  ),
-  "civil-service": (
-    colour: #af292e
-  ),
-  "department-for-business-innovation-skills": (
-    colour: #003479,
-    colour-websafe: #347da4
-  ),
-  "department-for-communities-and-local-government": (
-    colour: #009999,
-    colour-websafe: #37836e
-  ),
-  "department-for-culture-media-sport": (
-    colour: #d40072,
-    colour-websafe: #a03155
-  ),
-  "department-for-education": (
-    colour: #003a69,
-    colour-websafe: #347ca9
-  ),
-  "department-for-environment-food-rural-affairs": (
-    colour: #00a33b,
-    colour-websafe: #008938
-  ),
-  "department-for-international-development": (
-    colour: #002878,
-    colour-websafe: #405e9a
-  ),
-  "department-for-international-trade": (
-    colour: #cf102d,
-    colour-websafe: #005ea5
-  ),
-  "department-for-business-and-trade": (
-    colour: #cf102d,
-    colour-websafe: #005ea5
-  ),
-  "department-for-levelling-up-housing-and-communities": (
-    colour: #012169,
-  ),
-  "department-for-transport": (
-    colour: #006c56,
-    colour-websafe: #398373
-  ),
-  "department-for-work-pensions": (
-    colour: #00beb7,
-    colour-websafe: #37807b
-  ),
-  "department-of-energy-climate-change": (
-    colour: #009ddb,
-    colour-websafe: #2b7cac
-  ),
-  "department-of-health": (
-    colour: #00ad93,
-    colour-websafe: #39836e
-  ),
-  "foreign-commonwealth-development-office": (
-    colour: #012169
-  ),
-  "foreign-commonwealth-office": (
-    colour: #003e74,
-    colour-websafe: #406e97
-  ),
-  "government-equalities-office": (
-    colour:  #9325b2
-  ),
-  "hm-government": (
-    colour: #0076c0,
-    colour-websafe: #347da4
-  ),
-  "hm-revenue-customs": (
-    colour: #009390,
-    colour-websafe: #008670
-  ),
-  "hm-treasury": (
-    colour: #af292e,
-    colour-websafe: #832322
-  ),
-  "home-office": (
-    colour: #9325b2,
-    colour-websafe: #9440b2
-  ),
-  "ministry-of-defence": (
-    colour: #4d2942,
-    colour-websafe: #5a5c92
-  ),
-  "ministry-of-justice": (
-    colour: #231f20,
-    colour-websafe: #5a5c92
-  ),
-  "northern-ireland-office": (
-    colour: #002663,
-    colour-websafe: #3e598c
-  ),
-  "office-of-the-advocate-general-for-scotland": (
-    colour: #002663,
-    colour-websafe: #005ea5
-  ),
-  "office-of-the-leader-of-the-house-of-commons": (
-    colour: #317023,
-    colour-websafe: #005f8f
-  ),
-  "office-of-the-leader-of-the-house-of-lords": (
-    colour: #9c132e,
-    colour-websafe: #c2395d
-  ),
-  "scotland-office": (
-    colour: #002663,
-    colour-websafe: #405c8a
-  ),
-  "uk-export-finance": (
-    colour: #005747,
-    colour-websafe: #005ea5
-  ),
-  "uk-trade-investment": (
-    colour: #c80651,
-    colour-websafe: #005ea5
-  ),
-  "wales-office": (
-    colour: #a33038,
-    colour-websafe: #7a242a
-  )
-) !default;

data/node_modules/govuk-frontend/govuk/settings/_colours-palette.scss

@@ -1,120 +0,0 @@
-@import "compatibility";
-
-// stylelint-disable value-list-max-empty-lines -- allow empty lines in lists
-// in this file to allow grouping
-
-////
-/// @group settings/colours
-////
-
-/// Use 'legacy' colour palette
-///
-/// Whether or not to use the colour palette from GOV.UK Elements / Frontend
-/// Toolkit, for teams that are migrating to GOV.UK Frontend and may be using
-/// components from both places in a single application.
-///
-/// @type Boolean
-/// @access public
-/// @deprecated Will be removed in v5.0 with the rest of the compatibility mode
-/// suite of tools and settings
-
-$govuk-use-legacy-palette: if(
-  (
-    $govuk-compatibility-govukfrontendtoolkit or
-    $govuk-compatibility-govuktemplate or
-    $govuk-compatibility-govukelements
-  ),
-  true,
-  false
-) !default;
-
-// Only show the deprecation warning if user is setting $govuk-use-legacy-palette
-// manually instead of automatically via compatibility variables
-@if $govuk-use-legacy-palette == true and
-  $govuk-compatibility-govukfrontendtoolkit == false and
-  $govuk-compatibility-govuktemplate == false and
-  $govuk-compatibility-govukelements == false {
-  @include _warning(legacy-palette, "$govuk-use-legacy-palette is deprecated. " +
-  "Only the modern colour palette will be supported from v5.0.");
-}
-
-/// Modern colour palette
-///
-/// This exists only because you cannot easily set a !default variable
-/// conditionally (thanks to the way scope works in Sass) so we set
-/// `$govuk-colour-palette` using the `if` function.
-///
-/// @access private
-
-$_govuk-colour-palette-modern: (
-  "red": #d4351c,
-  "yellow": #ffdd00,
-  "green": #00703c,
-  "blue": #1d70b8,
-  "dark-blue": #003078,
-  "light-blue": #5694ca,
-  "purple": #4c2c92,
-
-  "black": #0b0c0c,
-  "dark-grey": #505a5f,
-  "mid-grey": #b1b4b6,
-  "light-grey": #f3f2f1,
-  "white": #ffffff,
-
-  "light-purple": #6f72af,
-  "bright-purple": #912b88,
-  "pink": #d53880,
-  "light-pink": #f499be,
-  "orange": #f47738,
-  "brown": #b58840,
-  "light-green": #85994b,
-  "turquoise": #28a197
-);
-
-/// Legacy colour palette
-///
-/// This exists only because you cannot easily set a !default variable
-/// conditionally (thanks to the way scope works in Sass) so we set
-/// `$govuk-colour-palette` using the `if` function.
-///
-/// @access private
-
-$_govuk-colour-palette-legacy: (
-  "purple": #2e358b,
-  "light-purple": #6f72af,
-  "bright-purple": #912b88,
-  "pink": #d53880,
-  "light-pink": #f499be,
-  "red": #b10e1e,
-  "bright-red": #df3034,
-  "orange": #f47738,
-  "brown": #b58840,
-  "yellow": #ffbf47,
-  "light-green": #85994b,
-  "green": #006435,
-  "turquoise": #28a197,
-  "light-blue": #2b8cc4,
-  "blue": #005ea5,
-
-  "black": #0b0c0c,
-  "grey-1": #6f777b,
-  "grey-2": #bfc1c3,
-  "grey-3": #dee0e2,
-  "grey-4": #f8f8f8,
-  "white": #ffffff
-);
-
-/// Colour palette
-///
-/// @type Map
-///
-/// @prop $colour - Representation for the given $colour, where $colour is the
-///   friendly name for the colour (e.g. "red": #ff0000);
-///
-/// @access public
-
-$govuk-colours: if(
-  $govuk-use-legacy-palette,
-  $_govuk-colour-palette-legacy,
-  $_govuk-colour-palette-modern
-) !default;