refc!: Updates for v0.2

.gitattributes

@@ -0,0 +1,4 @@
+# /.gitattributes
+# Makes sure all line endings are LF
+
+*	text=auto eol=lf

.github/workflows/ci.yaml

@@ -0,0 +1,101 @@
+# /.github/workflows/ci.yaml
+# GitHub actions workflow
+
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    name: Lint
+    strategy:
+      matrix:
+        node-version: [lts/*]
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+      - name: Use Node ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Lint code
+        run: |
+          npm ci
+          npm run lint
+  test-library:
+    name: Test (Library)
+    strategy:
+      matrix:
+        node-version: [lts/gallium, lts/*, latest]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+      - name: Use Node ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Run tests
+        run: |
+          npm ci
+          npm run test:lib
+  test-examples:
+    name: Test (Examples)
+    strategy:
+      matrix:
+        node-version: [lts/*]
+        deno-version: [v1.x]
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+      - name: Use Node ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - name: Use Deno ${{ matrix.deno-version }}
+        uses: denoland/setup-deno@v1
+        with:
+          deno-version: ${{ matrix.deno-version }}
+      - name: Run tests
+        run: |
+          npm ci
+          cd examples/
+          npm ci
+          npm test
+  publish:
+    name: Publish
+    needs: [lint, test-library, test-examples]
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: lts/*
+          registry-url: https://registry.npmjs.org/
+      - name: Install dependencies
+        run: npm ci
+      - name: Publish to npm
+        run: npm publish --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Build package to upload to GitHub releases
+        run: |
+          npm pack
+          mv ratelimit-header-parser-*.tgz ratelimit-header-parser.tgz
+      - name: Create a Github release
+        uses: softprops/action-gh-release@v1
+        with:
+          files: ratelimit-header-parser.tgz
+          body:
+            You can view the changelog
+            [here](https://github.com/express-rate-limit/ratelimit-header-parser/blob/main/changelog.md).

.npmrc

@@ -0,0 +1,6 @@
+# .npmrc
+# Configuration for npm and pnpm
+
+# Uses the exact version instead of any within-patch-range version of an
+# installed package
+save-exact=true

.prettierignore

@@ -1,3 +1,6 @@
+# /.prettierignore
+# Tells Prettier to ignore certain files
+
 package.json
 package-lock.json
 

config/husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run pre-commit

examples/.npmrc

@@ -0,0 +1,6 @@
+# .npmrc
+# Configuration for npm and pnpm
+
+# Uses the exact version instead of any within-patch-range version of an
+# installed package
+save-exact=true

examples/deno/fetch.ts

@@ -0,0 +1,10 @@
+// /examples/deno/fetch.ts
+// Uses `fetch` to hit the Imgur API.
+
+import { getRateLimit } from '../../dist/index.mjs'
+
+// Make a GET request to the Imgur API.
+const response = await fetch('https://api.imgur.com/post/v1/posts/t/aww')
+console.log('imgur ratelimit:', getRateLimit(response))
+
+// > imgur ratelimit: { limit: 500, used: 1, remaining: 499, reset: 2023-08-25T04:16:48.000Z }

examples/node/axios.ts

@@ -0,0 +1,11 @@
+// /examples/node/axios.ts
+// Uses `axios` to hit the GitHub API.
+
+import axios from 'axios'
+import { getRateLimit } from 'ratelimit-header-parser'
+
+// Make a GET request to the GitHub API.
+const response = await axios('https://api.github.com/orgs/express-rate-limit')
+console.log('github ratelimit:', getRateLimit(response))
+
+// > github ratelimit: { limit: 60, used: 1, remaining: 59, reset: 2023-08-25T04:16:48.000Z }

examples/node/draft-7-fetch.ts

@@ -0,0 +1,48 @@
+// /examples/node/draft-7-fetch.ts
+// Use `fetch`, and parse the `RateLimit` header from the IETF spec's 7th draft.
+
+// Note that example has a server and client together - normally they'd be in
+// separate files, likely on separate devices.
+
+// ---
+// `server.ts`
+// ----
+
+import { default as express } from 'express'
+import { rateLimit } from 'express-rate-limit'
+
+// Create a rate-limited server.
+const app = express()
+app.use(
+	rateLimit({
+		max: 5,
+		windowMs: 60 * 1000, // 1 minute windows.
+		legacyHeader: false, // Disable the `X-RateLimit-*` headers.
+		standardHeaders: 'draft-7', // Use the combined `RateLimit` header.
+	}),
+)
+
+// Register routes, and start the server.
+app.get('/', (req, res) => res.send('Hallo there!'))
+const { port, server } = await new Promise((resolve) => {
+	const server = app.listen(0, () =>
+		resolve({ port: server.address().port, server }),
+	)
+})
+
+// ---
+// `client.ts`
+// ---
+
+import { getRateLimit } from 'ratelimit-header-parser'
+
+// Fetch a response from the server.
+const response = await fetch(`http://localhost:${port}`)
+
+console.log('`RateLimit` header content:', response.headers.get('RateLimit'))
+// > `RateLimit` header content: limit=5, remaining=4, reset=60
+console.log('parsed rate limit info:', getRateLimit(response))
+// > parsed rate limit info: { limit: 5, used: 1, remaining: 4, reset: 2023-08-25T04:41:31.546Z }
+
+// Cleanup the server.
+server.close()

examples/node/http-get.ts

@@ -0,0 +1,14 @@
+// /examples/node/http-get.ts
+// Uses `http.get` to hit the Imgur API.
+
+import https from 'node:https'
+import { getRateLimits } from 'ratelimit-header-parser'
+
+// Make a GET request to the Imgur API.
+https.get('https://api.imgur.com/post/v1/posts/t/aww', (response) => {
+	console.log('imgur ratelimit:', getRateLimits(response))
+	return response.resume()
+})
+
+// > imgur ratelimit: { limit: 500, used: 1, remaining: 499, reset: 2023-09-19T14:19:30.297Z }
+// >                  { limit: 12500, used: 1, remaining: 12499, reset: 2023-09-19T14:19:30.297Z }