di-ipv-cri-common-express contains Express libraries and utilities for use building GOV.UK One Login Credential Issuers
It provides functionality for use with an Express webserver, GOV.UK Design System and the HMPO Components library
This package contains:
The implementation of GA4 and the Crown Logo update are contained across multiple versions of common-express in various stages. See below for details:
Several environment variables are declared within the CRIs and then used within the shared code of this repository:
GA4_ENABLED
- Feature flag to enable GA4, defaulted to "false"
UA_ENABLED
- Feature flag to enable UA, defaulted to "false"
UA_CONTAINER_ID
- Container ID for Universal Analytics, required for UA to work correctly. Default value is GTM-TK92W68
GA4_CONTAINER_ID
- Container ID for GA4, required for analytics to work correctly. Default value is GTM-KD86CMZ
ANALYTICS_COOKIE_DOMAIN
- Cookie domain to persist values throughout the different sections of the OneLogin journey. Default value is localhost
ANALYTICS_DATA_SENSITIVE
- Redacts all form response data, defaulted to "true"
. Only to be set to "false"
if a journey section contains no PII in none text based form controlsGA4_PAGE_VIEW_ENABLED
- Feature flag to enable GA4 page view tracking, defaulted to "true"
GA4_FORM_RESPONSE_ENABLED
- Feature flag to enable GA4 form response tracking, defaulted to "true"
GA4_FORM_ERROR_ENABLED
- Feature flag to enable GA4 form error tracking, defaulted to "true"
GA4_FORM_CHANGE_ENABLED
- Feature flag to enable GA4 form change tracking, defaulted to "true"
GA4_NAVIGATION_ENABLED
- Feature flag to enable GA4 navigation tracking, defaulted to "true"
GA4_SELECT_CONTENT_ENABLED
- Feature flag to enable GA4 select content tracking, defaulted to "true"
Clone this repository and then run
npm install
mocha is used as the testing framework.
To run the tests:
npm run test
Linting and code formatting are applied using a combination of prettier, eslint.
These can be run manually using:
npm run lint
Linting and code formatting is enforced on commit using pre-commit.
Pre-commit hooks can be run manually using:
pre-commit run --all-files
Note: Husky was previously used, and will need to be de-configured using
git config --unset-all core.hooksPath
and re-configured usingpre-commit install
Releases are automatically published to npm at @govuk-one-login/di-ipv-cri-common-express using a GitHub action upon creation of an appropriate Git tag.
The previous usage of
"govuk-one-login/ipv-cri-common-express.git#v4.0.0"
should not be used as this has no support for package building, which will be a requirement with future improemetns
In order to prepare a new release
git checkout
a fresh copy of the main
branchchore/release/v1.2.3
npm version VERSION --no-git-tag-version
, changing VERSION
to be major
, minor
or patch
as required
package.json
and package-lock.json
files will be updated with the new version.v
to avoid Git reference collisions, e.g. v1.2.3
This repo has a CODEOWNERS
file in the root and is configured to require PRs to reviewed by Code Owners.
This node package includes the initialisation script from the GDS Analytics package (https://www.npmjs.com/package/@govuk-one-login/frontend-analytics).