docs(readme): replace dead ideal-postcodes.dev links

.github/workflows/ci.yml

@@ -9,24 +9,19 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [22.x, 24.x]
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v7
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v7
         with:
           node-version: ${{ matrix.node-version }}
-
-      - name: Cache node modules
-        uses: actions/cache@v1
-        with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}-${{ matrix.node-version }}
+          cache: npm
 
       - name: Install
-        run: npm install
+        run: npm ci
 
       - name: Build
         run: npm run build
@@ -39,5 +34,9 @@ jobs:
 
       - name: Coverage
         run: npm run coverage
-        env:
-          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v7
+        with:
+          files: coverage.lcov
+          token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/release.yml

@@ -11,21 +11,19 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v1
-
-      - name: Use Node.js 14.x
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v7
         with:
-          node-version: 14.x
+          fetch-depth: 0
+          persist-credentials: false
 
-      - name: Cache node modules
-        uses: actions/cache@v1
+      - name: Use Node.js 24.x
+        uses: actions/setup-node@v7
         with:
-          path: ~/.npm
-          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          node-version: 24.x
+          cache: npm
 
       - name: Install
-        run: npm install
+        run: npm ci
 
       - name: Test
         run: npm test

README.md

@@ -17,7 +17,7 @@ Our JavaScript client implements a common interface defined at [@ideal-postcodes
 
 High level client documentation can be found at [core-interface](https://github.com/ideal-postcodes/core-interface/blob/master/README.md).
 
-In depth client documentation can be found at [core-interface.ideal-postcodes.dev](https://core-interface.ideal-postcodes.dev).
+In depth client documentation can be found in the [core-interface README](https://github.com/ideal-postcodes/core-interface#documentation).
 
 `@ideal-postcodes/core-node` is tested against [all maintained, stable releases](https://nodejs.org/en/about/releases/).
 
@@ -26,7 +26,7 @@ In depth client documentation can be found at [core-interface.ideal-postcodes.de
 - [Configuration & Usage](#configuration--usage)
 - [Quickstart](#quickstart)
 - [Client Documentation](https://github.com/ideal-postcodes/core-interface/blob/master/README.md)
-- [In Depth Client Documentation](https://core-interface.ideal-postcodes.dev/#documentation)
+- [In Depth Client Documentation](https://github.com/ideal-postcodes/core-interface#documentation)
 - [npm Module](https://www.npmjs.com/package/@ideal-postcodes/core-node)
 - [GitHub Repository](https://github.com/ideal-postcodes/core-node)
 
@@ -63,7 +63,7 @@ import { Client } from "@ideal-postcodes/core-node"
 const client = new Client({ api_key: "iddqd" });
 ```
 
-[Configuration options](https://core-interface.ideal-postcodes.dev/interfaces/client.config)
+[Configuration options](https://github.com/ideal-postcodes/core-interface/blob/master/lib/client.ts)
 
 #### Use
 
@@ -133,7 +133,7 @@ The client exposes a number of simple methods to get at the most common tasks wh
 - [Search for an Address](#search-for-an-address)
 - [Search for an Address by UDPRN](#search-for-an-address-by-udprn)
 
-For a complete list of client methods, including low level resource methods, please see the [core-interface documentation](https://core-interface.ideal-postcodes.dev/#documentation)
+For a complete list of client methods, including low level resource methods, please see the [core-interface documentation](https://github.com/ideal-postcodes/core-interface#documentation)
 
 #### Lookup a Postcode
 
@@ -147,7 +147,7 @@ const postcode = "id11qd";
 const addresses = await lookupPostcode({ client, postcode });
 ```
 
-[Method options](https://core-interface.ideal-postcodes.dev/interfaces/helper_methods.lookuppostcodeoptions)
+[Method options](https://github.com/ideal-postcodes/core-interface/blob/master/lib/helpers.ts)
 
 #### Search for an Address
 
@@ -161,7 +161,7 @@ const query = "10 downing street sw1a";
 const addresses = await lookupAddress({ client, query });
 ```
 
-[Method options](https://core-interface.ideal-postcodes.dev/interfaces/helper_methods.lookupaddressoptions)
+[Method options](https://github.com/ideal-postcodes/core-interface/blob/master/lib/helpers.ts)
 
 #### Search for an Address by UDPRN
 
@@ -177,7 +177,7 @@ const udprn = 23747771;
 const address = await lookupUdprn({ client, udprn });
 ```
 
-[Method options](https://core-interface.ideal-postcodes.dev/interfaces/helper_methods.lookupudprnoptions)
+[Method options](https://github.com/ideal-postcodes/core-interface/blob/master/lib/helpers.ts)
 
 ## Test
 

eslint.config.js

@@ -0,0 +1,36 @@
+const tseslint = require("typescript-eslint");
+
+module.exports = tseslint.config({
+  files: ["lib/**/*.ts"],
+  languageOptions: {
+    parser: tseslint.parser,
+    parserOptions: { projectService: true },
+  },
+  plugins: { "@typescript-eslint": tseslint.plugin },
+  rules: {
+    "@typescript-eslint/await-thenable": "error",
+    "@typescript-eslint/no-empty-object-type": "error",
+    "@typescript-eslint/no-unsafe-function-type": "error",
+    "@typescript-eslint/no-wrapper-object-types": "error",
+    "@typescript-eslint/no-inferrable-types": "error",
+    "@typescript-eslint/no-namespace": "error",
+    "@typescript-eslint/no-require-imports": "error",
+    "@typescript-eslint/prefer-for-of": "error",
+    "@typescript-eslint/unified-signatures": "error",
+    "arrow-body-style": "error",
+    "constructor-super": "error",
+    "dot-notation": "error",
+    "guard-for-in": "error",
+    "no-bitwise": "error",
+    "no-console": [
+      "error",
+      { allow: ["debug", "info", "time", "timeEnd", "trace"] },
+    ],
+    "no-debugger": "error",
+    "no-invalid-this": "error",
+    "no-new-wrappers": "error",
+    "no-undef-init": "error",
+    "object-shorthand": "error",
+    "prefer-const": "error",
+  },
+});

lib/agent.ts

@@ -8,7 +8,7 @@ import {
 
 const {
   /**
-   * Ideal Postcodes base error class implemented in [core-interface](https://core-interface.ideal-postcodes.dev/classes/idealpostcodeserror.html)
+   * Ideal Postcodes base error class implemented in [core-interface](https://github.com/ideal-postcodes/core-interface/blob/master/lib/error.ts)
    */
   IdealPostcodesError,
 } = errors;