Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cerebrusinc/buncors
A tool that brings expressjs cors functionality to bun's bunrest package.
https://github.com/cerebrusinc/buncors
bunjs bunrest cors middleware
Last synced: 4 days ago
JSON representation
A tool that brings expressjs cors functionality to bun's bunrest package.
- Host: GitHub
- URL: https://github.com/cerebrusinc/buncors
- Owner: cerebrusinc
- Created: 2023-10-27T01:36:13.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-28T14:00:52.000Z (about 1 year ago)
- Last Synced: 2024-12-14T20:19:20.564Z (8 days ago)
- Topics: bunjs, bunrest, cors, middleware
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/buncors
- Size: 14.6 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# buncors
The cors middleware that enables a [bunrest](https://www.npmjs.com/package/bunrest) server to handle cors requests. It also handles preflight requests 😃.
## Default Response Headers
If no options are provided, the response headers will be as follows:
```txt
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET,HEAD,PUT,PATCH,POST,DELETE
Access-Control-Allow-Headers: Content-Type
Access-Control-Max-Age: 5
```
**NOTE:** The allow headers will always append `Content-Type` to your response headers so no need to add it to the list.
## Usage Examples
**Globally**
```ts
import server from "bunrest";
import cors from "buncors";
const app = server();
app.use(cors());
app.listen(Bun.env.PORT, () => {
console.log(`[startup]: Server running on port "${Bun.env.PORT}"`);
});
```
**Specific Route**
```ts
import server from "bunrest";
import cors from "buncors";
const app = server();
app.post("/auth", cors(), async (req, res) => {
// some processing code
res.status(200).json({ success: true });
});
app.listen(Bun.env.PORT, () => {
console.log(`[startup]: Server running on port "${Bun.env.PORT}"`);
});
```
## Preflight Example
Note that in most cases, you will not have to explicity handle a preflight request separately.
```ts
import server from "bunrest";
import cors from "buncors";
const app = server();
app.post("/auth", async (req, res) => {
// some processing code
res.status(200).json({ success: true });
});
app.options(
"/auth",
cors({
allowedHeaders: ["X-TOKEN"],
methods: ["POST"],
origins: ["www.cerebrus.dev"],
})
);
app.listen(Bun.env.PORT, () => {
console.log(`[startup]: Server running on port "${Bun.env.PORT}"`);
});
```
## CorsOptions Interface
```ts
origins?: string | string[];
methods?: string[];
allowedHeaders?: string[];
maxAge?: number;
allowCredentials?: boolean;
exposedHeaders?: string[];
```
| Param | Type | Default | Is Required? | Description |
| ---------------- | ----------------------------- | -------------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| origins | `string, string[], undefined` | `*` | No | Sets the `Access-Control-Allow-Origin` header; if set, it will dynamically return the correct origin or the first origin is not accetped. |
| methods | `string[], undefined` | `GET,HEAD,PUT,PATCH,POST,DELETE` | No | Sets the `Access-Control-Allow-Methods` header. |
| allowedHeaders | `string[], undefined` | `Content-Type` | No | Sets the `Access-Control-Allow-Headers` header; will always append `Content-Type` to the allowed headers. |
| maxAge | `number, undefined` | `5` | No | Sets the `Access-Control-Max-Age` header in **seconds**. |
| allowCredentials | `boolean, undefined` | `undefined` | No | Sets the `Access-Control-Allow-Credentials` header. |
| exposedHeaders | `string[], undefined` | `undefined` | No | Sets the `Access-Control-Expose-Headers` header. |
# Changelog
## v0.2.x
v0.2.3
- Added gloabl decleration compatibility
v0.2.2
- Better handling of wildcard origin
v0.2.1
- Removed console log statement
- Handling spaces in allowedHeaders request
v0.2.0
- Updated handler to manage allowedHeaders regardless of ordering or case
- Enabled non preflight requests returning headers EXCEPT allowedMethods
- Now you can send exposed headers back to the client
## v0.1.x
v0.1.2
- Removed console log statement
v0.1.1
- Added lib to NPM
v0.1.0
- Initial commit