@govuk-pay/pay-js-commons 3.11.2 → 4.0.2

package/README.md

@@ -1,6 +1,3 @@
-[![Build Status](https://travis-ci.org/alphagov/pay-js-commons.svg?branch=master)](https://travis-ci.org/alphagov/pay-js-commons)
-
-
 # GOV.UK Pay JS Commons
 Reusable js scripts for GOV.UK Pay Node.js projects
 
@@ -10,8 +7,8 @@ Reusable js scripts for GOV.UK Pay Node.js projects
 - [Releasing a new version](#releasing-a-new-version)
 
 ## Browsered scripts
-This is a colection of client side scripts we use throught the GOV.UK 
-Pay in the browser. We call it browsered because they are written in 
+This is a collection of client side scripts we use throughout GOV.UK 
+Pay in the browser. We call it `browsered` because they are written in 
 Node.js and _browsered_ by Browserify to make them safe for all our 
 browsers. We browserify [within the microservice when it’s compiled](https://github.com/alphagov/pay-selfservice/blob/master/Gruntfile.js#L128).
 
@@ -149,7 +146,7 @@ i.e. ``< > ; : ` ( ) " \' = | , ~ [ ]``
 
 These are small functions that power the nunjucks filters but can also be used for server side stuff too.
 
-## Nunjucks filters
+### Nunjucks filters
 
 These get loaded in to the Nunjucks environment and then can apply changes to variables in templates.
 
@@ -167,18 +164,13 @@ Or a pence value can be converted to GBP
     <dd>{{ amount | penceToPounds }}</dd>
   </dl>
 ```
-# Releasing a new version
 
-Versions are released to npm, to do so you need to be a member of https://www.npmjs.com/org/govuk-pay.
+## Releasing
 
-Once you are a member run the following commands
+After a pull request is merged, Concourse will automatically create a new release pull request that increments the package version.
 
-- make sure you are on the latest master version of `pay-js-commons`
-- `npm login` (if you’re not already logged in)
-- `npm version major|minor|patch` depending on which sort of release it is
-- `npm publish`
-- A new commit is created automatically to increment the version, create a PR and merge this
+This pull request must be reviewed and merged by a developer.
 
-Once you have done this it should be available instantly you can check by visiting https://www.npmjs.com/package/@govuk-pay/pay-js-commons and looking for your release, should say _published a few seconds ago_.
+Once the release pull request is merged, GitHub Actions will publish the new versioned package to NPM.
 
-Then you can go around our repos bumping the version in this [sort of fashion](https://github.com/alphagov/pay-frontend/pull/940).
+__IMPORTANT__: Other pull requests will be blocked from merging until the release pull request is merged or closed.

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@govuk-pay/pay-js-commons",
-  "version": "3.11.2",
+  "version": "4.0.2",
   "description": "Reusable js scripts for GOV.UK Pay Node.js projects",
   "engines": {
-    "node": "^16.20.1"
+    "node": "^18.17.1"
   },
   "main": "lib/index.js",
+  "files": [
+    "images",
+    "sass",
+    "lib"
+  ],
   "scripts": {
     "compile": "npm run transpile",
     "clean": "rm -rf lib",
@@ -16,12 +21,15 @@
     "test": "npm run jest-tests npm && npm run karma-tests",
     "karma-tests": "karma start",
     "jest-tests": "jest src/analytics",
-    "lint": "./node_modules/.bin/standard --fix"
+    "lint": "standard --fix"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/alphagov/pay-js-commons.git"
   },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
   "keywords": [
     "nodejs",
     "js",

package/.github/dependabot.yml

@@ -1,22 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "03:00"
-  open-pull-requests-limit: 0
-  labels:
-  - dependencies
-  - govuk-pay
-  - javascript
-- package-ecosystem: github-actions
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "03:00"
-  open-pull-requests-limit: 0
-  labels:
-  - dependencies
-  - govuk-pay
-  - github_actions

package/.github/workflows/run-tests.yml

@@ -1,48 +0,0 @@
-name: Github Actions Tests
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-
-permissions:
-  contents: read
-
-jobs:
-  detect-secrets:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Git checkout
-        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
-      - name: Detect secrets
-        uses: alphagov/pay-ci/actions/detect-secrets@master
-        
-  unit-tests:
-    runs-on: ubuntu-latest
-    name: Unit tests
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab
-      - name: Parse Node version
-        run: echo "NVMRC=$(cat .nvmrc)" >> $GITHUB_OUTPUT
-        id: parse-node-version        
-      - name: Setup
-        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c
-        with:
-          node-version: "${{ steps.parse-node-version.outputs.NVMRC }}"
-      - name: Cache NPM packages
-        uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: ${{ runner.os }}-node-
-      - name: Install dependencies
-        run: npm ci
-      - name: Compile
-        run: npm run compile
-      - name: Run lint
-        run: npm run lint
-      - name: Run unit tests
-        run: npm test -- --forbid-only --forbid-pending

package/.pre-commit-config.yaml

@@ -1,7 +0,0 @@
-repos:
-- repo: https://github.com/Yelp/detect-secrets
-  rev: v1.4.0
-  hooks:
-    - id: detect-secrets
-      args: [ '--baseline', '.secrets.baseline' ]
-      exclude: package-lock.json

package/.secrets.baseline

@@ -1,122 +0,0 @@
-{
-  "version": "1.4.0",
-  "plugins_used": [
-    {
-      "name": "ArtifactoryDetector"
-    },
-    {
-      "name": "AWSKeyDetector"
-    },
-    {
-      "name": "AzureStorageKeyDetector"
-    },
-    {
-      "name": "Base64HighEntropyString",
-      "limit": 4.5
-    },
-    {
-      "name": "BasicAuthDetector"
-    },
-    {
-      "name": "CloudantDetector"
-    },
-    {
-      "name": "DiscordBotTokenDetector"
-    },
-    {
-      "name": "GitHubTokenDetector"
-    },
-    {
-      "name": "HexHighEntropyString",
-      "limit": 3.0
-    },
-    {
-      "name": "IbmCloudIamDetector"
-    },
-    {
-      "name": "IbmCosHmacDetector"
-    },
-    {
-      "name": "JwtTokenDetector"
-    },
-    {
-      "name": "KeywordDetector",
-      "keyword_exclude": ""
-    },
-    {
-      "name": "MailchimpDetector"
-    },
-    {
-      "name": "NpmDetector"
-    },
-    {
-      "name": "PrivateKeyDetector"
-    },
-    {
-      "name": "SendGridDetector"
-    },
-    {
-      "name": "SlackDetector"
-    },
-    {
-      "name": "SoftlayerDetector"
-    },
-    {
-      "name": "SquareOAuthDetector"
-    },
-    {
-      "name": "StripeDetector"
-    },
-    {
-      "name": "TwilioKeyDetector"
-    }
-  ],
-  "filters_used": [
-    {
-      "path": "detect_secrets.filters.allowlist.is_line_allowlisted"
-    },
-    {
-      "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
-      "min_level": 2
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_indirect_reference"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_likely_id_string"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_lock_file"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_potential_uuid"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_sequential_string"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_swagger_file"
-    },
-    {
-      "path": "detect_secrets.filters.heuristic.is_templated_secret"
-    }
-  ],
-  "results": {
-    "src/utils/field-validation-checks.js": [
-      {
-        "type": "Secret Keyword",
-        "filename": "src/utils/field-validation-checks.js",
-        "hashed_secret": "5bb4b8e78cff9ca47061adfd961e2b26c46e7fa5",
-        "is_verified": false,
-        "line_number": 20
-      }
-    ]
-  },
-  "generated_at": "2022-11-09T09:40:45Z"
-}

package/ci/pipeline.yml

@@ -1,75 +0,0 @@
----
-resource_types:
-
-    - name: pull-request
-      type: docker-image
-      source: 
-        repository: teliaoss/github-pr-resource
-
-resources:
-
-    - name: pull-request
-      type: pull-request
-      icon: github
-      source:
-        disable_forks: true
-        repository: alphagov/pay-js-commons
-        access_token: ((github-access-token))
-
-    - name: pipeline
-      type: git
-      icon: github
-      source:
-        uri: https://github.com/alphagov/pay-js-commons
-        branch: master
-        paths:
-          - ci/pipeline.yml
-jobs:
-  - name: build-pr
-    serial: true
-    plan:
-      - get: pull-request
-        trigger: true
-      - put: pull-request
-        params:
-          path: pull-request
-          status: pending
-      - task: build
-        config:
-          platform: linux
-          image_resource:
-            type: docker-image
-            source:
-              repository: node
-              tag: alpine3.16
-          inputs:
-            - name: pull-request
-          caches:
-            - path: pull-request/vendor
-          run:
-            path: sh
-            dir: pull-request
-            args:
-              - -c
-              - |
-                apk add --no-cache chromium
-                export CHROMIUM_BIN="$(which chromium)"
-                npm ci
-                npm run test
-        on_failure:
-          put: pull-request
-          params:
-            description: "Build failed on PR"
-            path: pull-request
-            status: failure
-      - put: pull-request
-        params:
-          path: pull-request
-          status: success
-
-  - name: update-pipeline
-    plan:
-      - get: pipeline
-        trigger: true
-      - set_pipeline: pay-js-commons
-        file: pipeline/ci/pipeline.yml

package/jest.config.js

@@ -1,5 +0,0 @@
-module.exports = {
-  testEnvironmentOptions : {
-    url: 'http://www.example.org'
-  }
-}