1
0

18 Commits

Author SHA1 Message Date
7faffa3dd9 3.3.0 2025-07-24 21:57:37 +02:00
a08adf3c03 add basic helper function 2025-07-24 21:56:26 +02:00
2e594d09f5 update bearer regex 2025-07-24 21:56:11 +02:00
d1c84cf6f6 3.2.10 2024-10-26 23:08:28 +02:00
ba67b34a0d update pipelines 2024-10-26 23:08:10 +02:00
2d5bdfe40e update readme 2024-10-26 23:07:54 +02:00
7bb935fa53 update publish pipeline 2024-10-26 21:55:21 +02:00
49d5806d89 3.2.9 2024-10-26 21:42:49 +02:00
73a0d4a4f9 update dependencies, build for esm 2024-10-26 21:42:35 +02:00
24a85e9814 3.2.8 2024-09-28 02:29:17 +02:00
dfdc50ba8a update dev dependencies 2024-09-28 02:29:04 +02:00
67bba2a339 3.2.7 2024-09-28 02:25:54 +02:00
c21e91bcb6 npm audit fix 2024-09-28 02:25:46 +02:00
fe2f8ec227 3.2.6 2024-09-28 02:19:32 +02:00
0e78ec4787 return cors headers for 404 response as well 2024-09-28 02:19:07 +02:00
fd7dce7256 3.2.5 2024-09-28 01:53:00 +02:00
1d72a15ca6 update readme 2024-09-28 01:51:05 +02:00
a740f1b103 audit fix 2024-07-15 22:14:32 +02:00
9 changed files with 589 additions and 757 deletions

View File

@@ -1,4 +1,5 @@
name: Publish name: Publish
run-name: Publish ${{ github.ref_name }}
on: on:
release: release:
@@ -13,19 +14,27 @@ jobs:
with: with:
node-version: latest node-version: latest
registry-url: https://registry.npmjs.org/ registry-url: https://registry.npmjs.org/
- name: Install dependencies - name: Install dependencies
run: npm ci run: npm ci
- name: Run tests
run: npm test
- name: Build - name: Build
run: npm run build run: npm run build
- name: Publish to npmjs - name: Publish to npmjs
env: env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
run: npm publish --tag latest --access public run: npm publish --tag ${{ contains(github.ref_name, '-') && 'pre' || 'latest' }} --access public
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: with:
node-version: latest node-version: latest
registry-url: https://npm.pkg.github.com/ registry-url: https://npm.pkg.github.com/
- name: Publish to GPR - name: Publish to GPR
env: env:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: npm publish --tag latest --access public run: npm publish --tag ${{ contains(github.ref_name, '-') && 'pre' || 'latest' }} --access public

31
.github/workflows/release.yml vendored Normal file
View File

@@ -0,0 +1,31 @@
name: Release
run-name: Release ${{ github.ref_name }}
on:
push:
tags:
- 'v*'
jobs:
release:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: latest
registry-url: https://registry.npmjs.org/
- name: Install dependencies
run: npm ci
- name: Run tests
run: npm test
- name: Build
run: npm run build
- name: Create release
run: gh release create ${{ github.ref_name }} --draft --generate-notes ${{ contains(github.ref_name, '-') && '--prerelease --latest=false' || '--latest' }}
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

View File

@@ -15,7 +15,12 @@ jobs:
with: with:
node-version: latest node-version: latest
registry-url: https://registry.npmjs.org/ registry-url: https://registry.npmjs.org/
- name: Install dependencies - name: Install dependencies
run: npm ci run: npm ci
- name: Run tests - name: Run tests
run: npm test run: npm test
- name: Build
run: npm run build

View File

@@ -18,8 +18,9 @@ When I was trying out Cloudflare Workers I almost immediately noticed how fast i
- ZERO dependencies - ZERO dependencies
- Lightweight (1.0K gzipped) - Lightweight (1.0K gzipped)
- Fully written in TypeScript - Fully written in TypeScript
- Integrated Debug-Mode & CORS helper
- Built specifically around Middlewares - Built specifically around Middlewares
- Debug-Mode, CORS and Bearer helpers
- Allows accessing request body multiple times
## Usage ## Usage
@@ -292,7 +293,7 @@ wrangler init <name>
Use of TypeScript is strongly encouraged :) Use of TypeScript is strongly encouraged :)
```bash ```bash
npm i -D @tsndr/cloudflare-worker-router npm i @tsndr/cloudflare-worker-router
``` ```

1210
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{ {
"name": "@tsndr/cloudflare-worker-router", "name": "@tsndr/cloudflare-worker-router",
"version": "3.2.4", "version": "3.3.0",
"description": "", "description": "",
"type": "module", "type": "module",
"exports": "./index.js", "exports": "./index.js",
@@ -32,9 +32,9 @@
}, },
"homepage": "https://github.com/tsndr/cloudflare-worker-router#readme", "homepage": "https://github.com/tsndr/cloudflare-worker-router#readme",
"devDependencies": { "devDependencies": {
"@cloudflare/workers-types": "^4.20240222.0", "@cloudflare/workers-types": "^4.20241022.0",
"@edge-runtime/vm": "^3.2.0", "@edge-runtime/vm": "^4.0.3",
"typescript": "^5.3.3", "typescript": "^5.6.3",
"vitest": "^1.3.1" "vitest": "^2.1.3"
} }
} }

View File

@@ -52,6 +52,7 @@ export type RouterRequest<ReqExt> = ReqExt & {
formData(): Promise<FormData> formData(): Promise<FormData>
blob(): Promise<Blob> blob(): Promise<Blob>
bearer(): string | undefined bearer(): string | undefined
basic(): [string, string]
cf?: IncomingRequestCfProperties cf?: IncomingRequestCfProperties
} }
@@ -395,7 +396,8 @@ export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
json: async <T>(): Promise<T> => buffer.json ? buffer.json : buffer.json = await request.clone().json<T>(), json: async <T>(): Promise<T> => buffer.json ? buffer.json : buffer.json = await request.clone().json<T>(),
formData: async (): Promise<FormData> => buffer.formData ? buffer.formData : buffer.formData = await request.clone().formData(), formData: async (): Promise<FormData> => buffer.formData ? buffer.formData : buffer.formData = await request.clone().formData(),
blob: async (): Promise<Blob> => buffer.blob ? buffer.blob : buffer.blob = await request.clone().blob(), blob: async (): Promise<Blob> => buffer.blob ? buffer.blob : buffer.blob = await request.clone().blob(),
bearer: () => request.headers.get('Authorization')?.replace(/^(B|b)earer /, '').trim() bearer: () => request.headers.get('Authorization')?.replace(/^[Bb]earer\s/, '').trim(),
basic: () => (atob(request.headers.get('Authorization')?.replace(/^[Bb]asic\s/, '').trim() ?? '') || undefined)?.split(':')
} as RouterRequest<ReqExt> } as RouterRequest<ReqExt>
if (this.corsEnabled && req.method === 'OPTIONS') { if (this.corsEnabled && req.method === 'OPTIONS') {
@@ -406,21 +408,23 @@ export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
} }
const route = this.getRoute(req) const route = this.getRoute(req)
let response: Response | undefined
if (!route) if (!route)
return new Response(this.debugMode ? 'Route not found!' : null, { status: 404 }) response = new Response(this.debugMode ? 'Route not found!' : null, { status: 404 })
const handlers = [...this.globalHandlers, ...route.handlers] if (!response) {
const dbg = this.debugMode const handlers = [
...this.globalHandlers,
let response: Response | undefined ...(route?.handlers ?? [])
]
for (const handler of handlers) { for (const handler of handlers) {
const context = { const context = {
...(ctxExt ?? {}), ...(ctxExt ?? {}),
env, env,
req, req,
dbg, dbg: this.debugMode,
ctx ctx
} as RouterContext<Env, CtxExt, ReqExt> } as RouterContext<Env, CtxExt, ReqExt>
@@ -431,9 +435,10 @@ export class Router<Env = any, CtxExt = {}, ReqExt = {}> {
break break
} }
} }
}
if (!response) if (!response)
return new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 }) response = new Response(this.debugMode ? 'Handler did not return a Response!' : null, { status: 404 })
if (this.corsEnabled) { if (this.corsEnabled) {
response = new Response(response.body, response) response = new Response(response.body, response)

View File

@@ -261,6 +261,21 @@ describe('Router', () => {
expect(await response.text()).toBe(testToken) expect(await response.text()).toBe(testToken)
}) })
test('basic', async () => {
const router = new Router()
const testCredentials = ['user', 'password']
const testBasicAuth = btoa(testCredentials.join(':'))
const testRequest = new Request('https://example.com/', { headers: { 'Authorization': `Basic ${testBasicAuth}` }})
router.get('/', ({ req }) => Response.json(req.basic()))
const response = await router.handle(testRequest, {})
expect(response.status).toEqual(200)
expect(await response.json()).toMatchObject(testCredentials)
})
}) })
describe('Middleware', () => { describe('Middleware', () => {

View File

@@ -1,7 +1,7 @@
{ {
"compilerOptions": { "compilerOptions": {
"outDir": ".", "outDir": ".",
"module": "commonjs", "module": "esnext",
"target": "esnext", "target": "esnext",
"lib": ["esnext"], "lib": ["esnext"],
"declaration": true, "declaration": true,