feat: add auto-update of tlds list

.github/scripts/update-list.ts

@@ -0,0 +1,66 @@
+import { execFileSync } from 'node:child_process';
+import { writeFile } from 'node:fs/promises';
+import { createInterface } from 'node:readline';
+import * as Wreck from '@hapi/wreck';
+
+const ianaUri = 'https://data.iana.org/TLD/tlds-alpha-by-domain.txt';
+
+async function fetchTLDs() {
+    const request = await Wreck.get(ianaUri);
+    const rl = createInterface({
+        input: Wreck.toReadableStream(request.payload as string),
+        crlfDelay: Infinity,
+    });
+
+    let lineNumber = 0;
+
+    const data = {
+        version: '',
+        domains: [] as string[],
+    };
+
+    for await (const line of rl) {
+        if (lineNumber === 0) {
+            if (/^# Version \d{8}, Last Updated .+ UTC$/.test(line)) {
+                throw new Error('Unexpected version line');
+            }
+            data.version = line;
+        } else if (line.length > 0) {
+            data.domains.push(line);
+        }
+
+        lineNumber++;
+    }
+
+    const formattedFile = `// ${ianaUri}
+// ${data.version}
+
+export const TLDS: string[] = [
+${data.domains.map((d) => `    '${d}',`).join('\n')}
+];
+`;
+
+    try {
+        execFileSync(
+            'git',
+            [
+                'diff',
+                '--exit-code', // Fail if there are changes
+                '--no-index',
+                '-I',
+                '^// #', // Ignore version line, it changes every day
+                '--',
+                'src/tlds.ts',
+                '-', // Take stdin
+            ],
+            {
+                input: formattedFile,
+            },
+        );
+    } catch {
+        // An error means the file is probably different
+        await writeFile('./src/tlds.ts', formattedFile);
+    }
+}
+
+fetchTLDs();

.github/workflows/update-check.yml

@@ -0,0 +1,33 @@
+name: Update check
+
+on:
+  schedule:
+    - cron: '0 0 * * *'
+  workflow_dispatch:
+
+jobs:
+    update-check:
+        runs-on: ubuntu-latest
+
+        permissions:
+            contents: write
+            pull-requests: write
+
+        steps:
+        - uses: actions/checkout@v4
+        - uses: actions/setup-node@v4
+
+        - name: Install dependencies
+          run: npm install
+
+        - name: Run update list
+          run: npm run update-list
+
+        - name: Create Pull Request
+          uses: peter-evans/create-pull-request@v6
+          with:
+            title: Update TLDs
+            commit-message: 'fix: 🤖 Update TLDs'
+            branch: fix/auto-update-tlds
+            body: Automated update of TLDs
+            labels: bug

package.json

@@ -22,20 +22,23 @@
     "devDependencies": {
         "@hapi/code": "^9.0.3",
         "@hapi/lab": "^25.1.3",
-        "@types/node": "^16.18.50",
+        "@hapi/wreck": "^18.0.1",
+        "@types/node": "^20.11.30",
         "@typescript-eslint/eslint-plugin": "^6.7.0",
         "@typescript-eslint/parser": "^6.7.0",
         "eslint-config-prettier": "^9.0.0",
         "eslint-plugin-prettier": "^5.0.0",
         "prettier": "^3.0.3",
+        "ts-node": "^10.9.2",
         "typescript": "^5.2.2"
     },
     "scripts": {
         "test": "lab -t 100 -L",
         "test-cov-html": "lab -t 100 -L -r html -o coverage.html",
         "dist": "rm -rf dist esm && tsc --module commonjs --outdir dist && tsc --module es6 --outdir esm",
         "prepublishOnly": "npm run dist",
-        "format": "prettier --write '**/*.ts'"
+        "format": "prettier --write '**/*.ts'",
+        "update-list": "ts-node .github/scripts/update-list.ts"
     },
     "license": "BSD-3-Clause"
 }