@hmcts/opal-frontend-common-node 0.0.6 → 0.0.8

package/README.md

@@ -13,6 +13,7 @@ This is a shared Node.js library containing common middleware, configurations, a
 - [Linting and Formatting](#linting-and-formatting)
 - [Exports](#exports)
 - [Using This Library in a Node.js Application](#using-this-library-in-a-nodejs-application)
+- [Switching Between Local and Published Versions](#switching-between-local-and-published-versions)
 
 ## Getting Started
 
@@ -29,34 +30,70 @@ Ensure you have the following installed:
 yarn
 ```
 
-## Scripts
+## Build Process
 
-The following commands are available in the `package.json`:
+Run the following to build the project:
 
-- `yarn build`  
-  Cleans the `dist/` folder, compiles TypeScript, and copies relevant files to `dist/`.
+```bash
+yarn build
+```
 
-- `yarn clean`  
-  Removes the `dist/` directory.
+The compiled output will be available in the `dist/` folder. It includes `index.js`, type declarations, and any exported modules listed in the `exports` field.
 
-- `yarn lint`  
-  Runs ESLint across the `src/` directory and checks formatting using Prettier.
+## Switching Between Local and Published Versions
 
-- `yarn prettier`  
-  Checks if files are formatted correctly.
+See [opal-frontend](https://github.com/hmcts/opal-frontend) for how this library is consumed in practice.
 
-- `yarn prettier:fix`  
-  Automatically formats the codebase.
+Use the `yarn import:local:common-node-lib` and `yarn import:published:common-node-lib` scripts in your consuming project (`opal-frontend`) to switch between local development and the published npm version of the library.
 
-## Build Process
+To use a published version of this library during development in another project:
+1. In the consuming project, run:
+    ```bash
+    yarn import:published:common-node-lib
+    ```
 
-Run the following to build the project:
+To use a local version of this library during development in another project:
 
-```bash
-yarn build
-```
+1. Build this library:
+    ```bash
+    yarn build
+    ```
 
-The compiled output will be available in the `dist/` folder. It includes `index.js`, type declarations, and any exported modules listed in the `exports` field.
+2. In your consuming project (e.g. `opal-frontend`), ensure you have set an environment variable pointing to the local build:
+
+    ```bash
+    # In your shell config file (.zshrc, .bash_profile, or .bashrc)
+    export COMMON_NODE_LIB_PATH="[INSERT PATH TO COMMON NODE LIB DIST FOLDER]"
+    ```
+
+3. In the consuming project (e.g. `opal-frontend`), run:
+    ```bash
+    yarn import:local:common-node-lib
+    ```
+
+    This will remove the published version and install the local build using the path provided.
+
+4. To switch back to the published version:
+    ```bash
+    yarn import:published:common-node-lib
+    ```
+
+This setup makes it easy to switch between development and production versions of the shared library.
+
+## Publish the library
+
+Once any changes have been approved and merged into the main branch, you'll need to publish a new version of the library so that it can be consumed by other projects. To do this:
+
+1. Increment the version number in both the library's root `package.json`.
+2. Commit and push those changes to the main branch.
+3. On GitHub, create a new [release](https://github.com/hmcts/opal-frontend-common-node-lib/releases) and use the updated version number as a tag.
+4. When the release workflow completes, the library will be published.
+
+After this new version of the library is published, any consuming application should remove the local or outdated version of the library and then install the published version by running:
+
+    ```bash
+    yarn import:published:common-node-lib
+    ```
 
 ## Linting and Formatting
 
@@ -91,19 +128,21 @@ import {
 
 Refer to the `exports` block in `package.json` for the full list of available modules.
 
-## Using This Library in a Node.js Application
+## Commonly Used Commands
 
-Install the published package using:
+The following commands are available in the `package.json`:
 
-```bash
-yarn add @hmcts/opal-frontend-common-node
-```
+- `yarn build`  
+  Cleans the `dist/` folder, compiles TypeScript, and copies relevant files to `dist/`.
 
-If consuming from a local build:
+- `yarn clean`  
+  Removes the `dist/` directory.
 
-```bash
-yarn remove @hmcts/opal-frontend-common-node
-yarn add @hmcts/opal-frontend-common-node@file:../opal-frontend-common-node-lib/dist
-```
+- `yarn lint`  
+  Runs ESLint across the `src/` directory and checks formatting using Prettier.
 
-Ensure paths reflect your actual local setup when using the `file:` specifier.
+- `yarn prettier`  
+  Checks if files are formatted correctly.
+
+- `yarn prettier:fix`  
+  Automatically formats the codebase.

package/csrf-token/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/csrf-token/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAW,MAAM,SAAS,CAAC;AAE/C,qBAAa,SAAS;IACb,SAAS,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,GAAG,IAAI;CA+BjH"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/csrf-token/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAEtC,qBAAa,SAAS;IACb,SAAS,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,GAAG,IAAI;CA8BjH"}

package/csrf-token/index.js

@@ -10,9 +10,8 @@ export class CSRFToken {
                 secure: secure,
                 path: '/',
             },
-            getTokenFromRequest: (req) => {
-                return req.cookies[cookieName].split('|')[0] ?? null;
-            },
+            getSessionIdentifier: (req) => req.session.id,
+            getCsrfTokenFromRequest: (req) => req.cookies[cookieName].split('|')[0] ?? null,
         });
         app.use((req, res, next) => {
             if (ignore.includes(req.url)) {
@@ -24,7 +23,7 @@ export class CSRFToken {
         });
         app.use((req, res, next) => {
             if (req.csrfToken) {
-                req.csrfToken(true);
+                req.csrfToken({ overwrite: true, validateOnReuse: true });
             }
             next();
         });

package/csrf-token/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/csrf-token/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAGvC,MAAM,OAAO,SAAS;IACb,SAAS,CAAC,GAAgB,EAAE,MAAc,EAAE,UAAkB,EAAE,QAAiB,EAAE,MAAe;QACvG,MAAM,MAAM,GAAG,CAAC,qBAAqB,CAAC,CAAC;QAEvC,MAAM,EAAE,oBAAoB,EAAE,GAAG,UAAU,CAAC;YAC1C,SAAS,EAAE,GAAG,EAAE,CAAC,MAAM;YACvB,UAAU,EAAE,UAAU;YACtB,aAAa,EAAE;gBACb,QAAQ,EAAE,QAAQ;gBAClB,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,GAAG;aACV;YACD,mBAAmB,EAAE,CAAC,GAAG,EAAE,EAAE;gBAC3B,OAAO,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;YACvD,CAAC;SACF,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YACzB,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7B,IAAI,EAAE,CAAC;YACT,CAAC;iBAAM,CAAC;gBACN,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YACvC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,CAAC,CAAC,GAAY,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YAClC,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;gBAClB,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;YACD,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/csrf-token/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAGvC,MAAM,OAAO,SAAS;IACb,SAAS,CAAC,GAAgB,EAAE,MAAc,EAAE,UAAkB,EAAE,QAAiB,EAAE,MAAe;QACvG,MAAM,MAAM,GAAG,CAAC,qBAAqB,CAAC,CAAC;QAEvC,MAAM,EAAE,oBAAoB,EAAE,GAAG,UAAU,CAAC;YAC1C,SAAS,EAAE,GAAG,EAAE,CAAC,MAAM;YACvB,UAAU,EAAE,UAAU;YACtB,aAAa,EAAE;gBACb,QAAQ,EAAE,QAAQ;gBAClB,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,GAAG;aACV;YACD,oBAAoB,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;YAC7C,uBAAuB,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI;SAChF,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YACzB,IAAI,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7B,IAAI,EAAE,CAAC;YACT,CAAC;iBAAM,CAAC;gBACN,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;YACvC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;YACzB,IAAI,GAAG,CAAC,SAAS,EAAE,CAAC;gBAClB,GAAG,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5D,CAAC;YACD,IAAI,EAAE,CAAC;QACT,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@hmcts/opal-frontend-common-node",
   "type": "module",
-  "version": "0.0.6",
+  "version": "0.0.8",
+  "license": "MIT",
   "description": "Common nodejs library components for opal",
   "main": "dist/index",
   "types": "dist/index.d.ts",
@@ -23,14 +24,14 @@
     "config": "^3.3.9",
     "connect-redis": "^8.0.0",
     "cookie-parser": "^1.4.6",
-    "csrf-csrf": "^3.0.6",
-    "express": "^4.15.2",
+    "csrf-csrf": "^4.0.0",
+    "express": "^5.0.0",
     "express-session": "^1.17.3",
     "helmet": "^8.0.0",
     "http-proxy-middleware": "^3.0.0",
     "luxon": "^3.4.3",
     "prettier": "^3.0.3",
-    "redis": "^4.6.11",
+    "redis": "^5.0.0",
     "session-file-store": "^1.5.0",
     "xml2js": "^0.6.2"
   },
@@ -41,8 +42,8 @@
     "@types/luxon": "^3.4.2",
     "@types/node": "^22.0.0",
     "@types/session-file-store": "^1.2.5",
-    "@typescript-eslint/eslint-plugin": "8.29.1",
-    "@typescript-eslint/parser": "8.29.1",
+    "@typescript-eslint/eslint-plugin": "8.32.0",
+    "@typescript-eslint/parser": "8.32.0",
     "eslint": "^9.0.0",
     "eslint-plugin-prettier": "^5.2.6",
     "typescript": "~5.8.0",

package/type.d.ts

@@ -1,7 +0,0 @@
-import 'express';
-
-declare module 'express' {
-  export interface Request {
-    csrfToken?: (arg?: boolean) => string;
-  }
-}