Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 32 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 11 additions & 13 deletions packages/basic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,37 +34,35 @@ The modules **body**, **cookie** and **query** have an individual
export path as shown in the following code snippet.

```typescript
import { createServer } from 'node:http';
import {
createNodeDispatcher,
coreHandler,
Router
defineCoreHandler,
Router,
serve,
} from 'routup';
import { basic } from '@routup/basic';
import { useRequestBody } from '@routup/basic/body';
import { readRequestBody } from '@routup/basic/body';
import { useRequestCookie, useRequestCookies } from '@routup/basic/cookie';
import { useRequetQuery } from '@routup/basic/query';
import { useRequestQuery } from '@routup/basic/query';

const router = new Router();

router.use(basic());

router.get('/', coreHandler((req, res) => {
const body = useRequestBody(req);
router.post('/', defineCoreHandler(async (event) => {
const body = await readRequestBody(event);
// { key: value, ... }

const cookies = useRequestCookies(req);
const cookies = useRequestCookies(event);
// { key: value, ... }

const cookie = useRequestCookie(req, 'key');
const cookie = useRequestCookie(event, 'key');
// value

const query = useRequetQuery(req);
const query = useRequestQuery(event);
// query
}));

const server = createServer(createNodeDispatcher(router));
server.listen(3000);
serve(router, { port: 3000 });
```

## Options
Expand Down
6 changes: 2 additions & 4 deletions packages/basic/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,15 @@
},
"homepage": "https://github.com/routup/plugins#readme",
"peerDependencies": {
"routup": "^4.0.1"
"routup": "^5.0.0-beta.3"
},
"dependencies": {
"@routup/body": "^2.4.3",
"@routup/cookie": "^2.4.3",
"@routup/query": "^2.4.3"
},
"devDependencies": {
"@types/supertest": "^7.2.0",
"routup": "^4.0.1",
"supertest": "^7.1.4"
"routup": "^5.0.0-beta.3"
},
"gitHead": "94d729e309c1eec0401afb4d8083f65ce3aa8e0b",
"publishConfig": {
Expand Down
94 changes: 46 additions & 48 deletions packages/basic/test/unit/module.spec.ts
Original file line number Diff line number Diff line change
@@ -1,87 +1,85 @@
import { describe, expect, it } from 'vitest';
import {
Router,
coreHandler,
createNodeDispatcher,
useRequestParam,
defineCoreHandler,
} from 'routup';
import supertest from 'supertest';
import { basic } from '../../src';
import { useRequestBody } from '@routup/body';
import { readRequestBody } from '@routup/body';
import { useRequestCookie, useRequestCookies } from '@routup/cookie';
import { useRequestQuery } from '@routup/query';

function createTestRequest(url: string, options?: RequestInit): Request {
const fullUrl = url.startsWith('http') ? url : `http://localhost${url}`;
return new Request(fullUrl, options);
}

describe('src/**', () => {
it('should use body plugin', async () => {
const router = new Router();

router.use(basic({ body: true }));

router.post('/:id', coreHandler((req, res) => useRequestBody(req, useRequestParam(req, 'id'))));
router.post('/', coreHandler((req, res) => useRequestBody(req)));

const server = supertest(createNodeDispatcher(router));

let response = await server
.post('/foo')
.send({ foo: 'bar' });

expect(response.statusCode).toEqual(200);
expect(response.text).toEqual('bar');

response = await server
.post('/')
.send({ foo: 'bar' });

expect(response.statusCode).toEqual(200);
expect(response.body).toEqual({ foo: 'bar' });
router.post('/:id', defineCoreHandler(async (event) => {
const body = await readRequestBody(event, event.params.id);
return body;
}));
router.post('/', defineCoreHandler(async (event) => await readRequestBody(event)));

let response = await router.fetch(createTestRequest('/foo', {
method: 'POST',
headers: { 'content-type': 'application/json' },
body: JSON.stringify({ foo: 'bar' }),
}));

expect(response.status).toEqual(200);
expect(await response.text()).toEqual('bar');

response = await router.fetch(createTestRequest('/', {
method: 'POST',
headers: { 'content-type': 'application/json' },
body: JSON.stringify({ foo: 'bar' }),
}));

expect(response.status).toEqual(200);
expect(await response.json()).toEqual({ foo: 'bar' });
});

it('should use cookie plugin', async () => {
const router = new Router();

router.use(basic({ cookie: true }));

router.get('/:id', coreHandler((req, res) => useRequestCookie(req, useRequestParam(req, 'id'))));
router.get('/', coreHandler((req, res) => useRequestCookies(req)));

const server = supertest(createNodeDispatcher(router));
router.get('/:id', defineCoreHandler((event) => useRequestCookie(event, event.params.id)));
router.get('/', defineCoreHandler((event) => useRequestCookies(event)));

let response = await server
.get('/foo')
.set('Cookie', ['foo=bar']);
let response = await router.fetch(createTestRequest('/foo', { headers: { 'cookie': 'foo=bar' } }));

expect(response.statusCode).toEqual(200);
expect(response.text).toEqual('bar');
expect(response.status).toEqual(200);
expect(await response.text()).toEqual('bar');

response = await server
.get('/')
.set('Cookie', ['foo=bar']);
response = await router.fetch(createTestRequest('/', { headers: { 'cookie': 'foo=bar' } }));

expect(response.statusCode).toEqual(200);
expect(response.body).toEqual({ foo: 'bar' });
expect(response.status).toEqual(200);
expect(await response.json()).toEqual({ foo: 'bar' });
});

it('should use query plugin', async () => {
const router = new Router();

router.use(basic({ query: true }));

router.get('/:id', coreHandler((req) => useRequestQuery(req, useRequestParam(req, 'id'))));
router.get('/', coreHandler((req, res) => useRequestQuery(req)));
router.get('/:id', defineCoreHandler((event) => useRequestQuery(event, event.params.id)));
router.get('/', defineCoreHandler((event) => useRequestQuery(event)));

const server = supertest(createNodeDispatcher(router));
let response = await server
.get('/sort?page[limit]=10&sort=-name');
let response = await router.fetch(createTestRequest('/sort?page[limit]=10&sort=-name'));

expect(response.statusCode).toEqual(200);
expect(response.text).toEqual('-name');
expect(response.status).toEqual(200);
expect(await response.text()).toEqual('-name');

response = await server
.get('/?page[limit]=10&sort=-name');
response = await router.fetch(createTestRequest('/?page[limit]=10&sort=-name'));

expect(response.statusCode).toEqual(200);
expect(response.body).toEqual({
expect(response.status).toEqual(200);
expect(await response.json()).toEqual({
page: { limit: '10' },
sort: '-name',
});
Expand Down
Loading