nodenext compatiblity (#42)

* nodenext compatibility

* enable lint in wf

Author: Uzlopak

.github/workflows/ci.yml

@@ -15,3 +15,4 @@ jobs:
     uses: fastify/workflows/.github/workflows/plugins-ci.yml@v3
     with:
       license-check: true
+      lint: true

.npmrc

@@ -0,0 +1 @@
+package-lock=false

index.js

@@ -13,6 +13,8 @@
  */
 
 module.exports = proxyaddr
+module.exports.default = proxyaddr
+module.exports.proxyaddr = proxyaddr
 module.exports.all = alladdrs
 module.exports.compile = compile
 

package.json

@@ -2,6 +2,8 @@
   "name": "@fastify/proxy-addr",
   "description": "Determine address of proxied request",
   "version": "4.0.0",
+  "main": "index.js",
+  "types": "types/index.d.ts",
   "author": "Douglas Christopher Wilson <[email protected]>",
   "license": "MIT",
   "keywords": [
@@ -22,18 +24,18 @@
     "ipaddr.js": "^2.0.0"
   },
   "devDependencies": {
+    "@types/node": "^18.11.11",
     "beautify-benchmark": "0.2.4",
     "benchmark": "2.1.4",
     "standard": "^17.0.0",
-    "tap": "^16.0.0"
+    "tap": "^16.0.0",
+    "tsd": "^0.25.0"
   },
-  "files": [
-    "LICENSE",
-    "README.md",
-    "index.js"
-  ],
   "scripts": {
     "bench": "node benchmark/index.js",
-    "test": "standard && tap"
+    "lint": "standard",
+    "test": "npm run test:unit && npm run test:typescript",
+    "test:typescript": "tsd",
+    "test:unit": "tap"
   }
 }

types/index.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+
+import { IncomingMessage } from 'http';
+
+type FastifyProxyAddr = typeof proxyaddr
+
+declare function proxyaddr(req: IncomingMessage, trust: proxyaddr.Address | proxyaddr.Address[] | ((addr: string, i: number) => boolean)): string;
+
+declare namespace proxyaddr {
+  export function all(req: IncomingMessage, trust?: Address | Address[] | ((addr: string, i: number) => boolean)): string[];
+  export function compile(val: Address | Address[]): (addr: string, i: number) => boolean;
+
+  export type Address = 'loopback' | 'linklocal' | 'uniquelocal' | string;
+
+  export const proxyAddr: FastifyProxyAddr
+  export { proxyAddr as default }
+}
+export = proxyaddr;

types/index.test-d.ts

@@ -0,0 +1,27 @@
+import proxyaddr from '..';
+import { createServer } from 'http';
+
+createServer(req => {
+    // $ExpectType string
+    proxyaddr(req, addr => addr === '127.0.0.1');
+    proxyaddr(req, (addr, i) => i < 1);
+
+    proxyaddr(req, '127.0.0.1');
+    proxyaddr(req, ['127.0.0.0/8', '10.0.0.0/8']);
+    proxyaddr(req, ['127.0.0.0/255.0.0.0', '192.168.0.0/255.255.0.0']);
+
+    proxyaddr(req, '::1');
+    proxyaddr(req, ['::1/128', 'fe80::/10']);
+
+    proxyaddr(req, 'loopback');
+    proxyaddr(req, ['loopback', 'fc00:ac:1ab5:fff::1/64']);
+
+    // $ExpectType string[]
+    proxyaddr.all(req);
+    proxyaddr.all(req, 'loopback');
+
+    const trust = proxyaddr.compile('localhost');
+    proxyaddr.compile(['localhost']);
+    trust; // $ExpectType (addr: string, i: number) => boolean
+    proxyaddr(req, trust);
+});