@vafast/cors 0.0.1 → 0.0.2

package/README.md

@@ -1,23 +1,39 @@
-# @huyooo/elysia-cors
-Plugin for [elysia](https://github.com/elysiajs/elysia) that for Cross Origin Requests (CORs)
+# @vafast/cors
+
+CORS middleware plugin for [Vafast](https://github.com/vafastjs/vafast) framework.
 
 ## Installation
+
 ```bash
-bun add @huyooo/elysia-cors
+bun add @vafast/cors
+# or
+npm install @vafast/cors
 ```
 
 ## Example
-```typescript
-import { Elysia } from '@huyooo/elysia'
-import { cors } from '@huyooo/elysia-cors'
 
-const app = new Elysia()
-    .use(cors())
-    .listen(8080)
+```typescript
+import { Server, createHandler } from 'vafast'
+import { cors } from '@vafast/cors'
+
+const server = new Server([
+  {
+    method: 'GET',
+    path: '/',
+    handler: createHandler(() => 'Hello World'),
+    middleware: [cors()]
+  }
+])
+
+export default {
+  fetch: (req: Request) => server.fetch(req)
+}
 ```
 
-## Config
+## Configuration
+
 ### origin
+
 @default `true`
 
 Assign the **Access-Control-Allow-Origin** header.
@@ -25,33 +41,34 @@ Assign the **Access-Control-Allow-Origin** header.
 Value can be one of the following:
 - `string` - String of origin which will directly assign to `Access-Control-Allow-Origin`
 
-- `boolean` - If set to true, `Access-Control-Allow-Origin` will be set to `*` (accept all origin)
+- `boolean` - If set to true, `Access-Control-Allow-Origin` will be set to the request origin (accept all origin)
 
 - `RegExp` - Pattern to use to test with request's url, will accept origin if matched.
 
 - `Function` - Custom logic to validate origin acceptance or not. will accept origin if `true` is returned.
-    - Function will accepts `Context` just like `Handler`
     ```typescript
     // Example usage
-    app.use(cors, {
-        origin: ({ request, headers }) => true
+    cors({
+        origin: (request: Request) => {
+            const origin = request.headers.get('Origin')
+            return origin === 'https://example.com'
+        }
     })
-
-    // Type Definition
-    type CORSOriginFn = (context: Context) => boolean | void
     ```
 
 - `Array<string | RegExp | Function>` - Will try to find truthy value of all options above. Will accept Request if one is `true`.
 
 ### methods
-@default `*`
+
+@default `true`
 
 Assign **Access-Control-Allow-Methods** header. 
 
 Value can be one of the following:
-Accept:
 - `undefined | null | ''` - Ignore all methods.
 
+- `true` - Mirror the request method.
+
 - `*` - Accept all methods.
 
 - `HTTPMethod` - Will be directly set to **Access-Control-Allow-Methods**.
@@ -61,34 +78,41 @@ Accept:
     - eg: ['GET', 'PUT', 'POST']
 
 ### allowedHeaders
-@default `*`
+
+@default `true`
 
 Assign **Access-Control-Allow-Headers** header. 
 
 Allow incoming request with the specified headers.
 
 Value can be one of the following:
+- `true` - Mirror the request headers.
+
 - `string`
-    - Expects either a single method or a comma-delimited string (eg: 'Content-Type, Authorization').
+    - Expects either a single header or a comma-delimited string (eg: 'Content-Type, Authorization').
 
-- `string[]` - Allow multiple HTTP methods.
+- `string[]` - Allow multiple headers.
     - eg: ['Content-Type', 'Authorization']
 
-### exposedHeaders
-@default `*`
+### exposeHeaders
+
+@default `true`
 
 Assign **Access-Control-Exposed-Headers** header. 
 
 Return the specified headers to request in CORS mode.
 
 Value can be one of the following:
+- `true` - Mirror the request headers.
+
 - `string`
-    - Expects either a single method or a comma-delimited string (eg: 'Content-Type, 'X-Powered-By').
+    - Expects either a single header or a comma-delimited string (eg: 'Content-Type, X-Powered-By').
 
-- `string[]` - Allow multiple HTTP methods.
+- `string[]` - Allow multiple headers.
     - eg: ['Content-Type', 'X-Powered-By']
 
 ### credentials
+
 @default `true`
 
 Assign **Access-Control-Allow-Credentials** header. 
@@ -98,17 +122,23 @@ Allow incoming requests to send `credentials` header.
 - `boolean` - Available if set to `true`.
 
 ### maxAge
+
 @default `5`
 
 Assign **Access-Control-Max-Age** header. 
 
-Allow incoming requests to send `credentials` header.
+Duration in seconds to indicates how long the results of a preflight request can be cached.
 
-- `number` - Duration in seconds to indicates how long the results of a preflight request can be cached.
+- `number` - Duration in seconds.
 
 ### preflight
+
 @default `true`
 
-Add `[OPTIONS] /*` handler to handle preflight request which response with `HTTP 204` and CORS hints.
+Automatically handle OPTIONS preflight requests which response with `HTTP 204` and CORS headers.
 
 - `boolean` - Available if set to `true`.
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@vafast/cors",
-	"version": "0.0.1",
+	"version": "0.0.2",
 	"description": "CORS middleware plugin for Vafast framework",
 	"type": "module",
 	"author": {
@@ -19,7 +19,6 @@
 		".": {
 			"types": "./dist/index.d.ts",
 			"import": "./dist/index.js",
-			"require": "./dist/index.js",
 			"default": "./dist/index.js"
 		}
 	},
@@ -31,19 +30,10 @@
 		"cors"
 	],
 	"scripts": {
-		"clean": "rimraf dist",
 		"build": "tsup",
-		"dev": "NODE_DEBUG=* bun run --hot example/index.ts",
-		"test": "bun test",
-		"test:types": "tsc --noEmit",
-		"lint": "eslint . --ext .ts",
-		"lint:fix": "eslint . --ext .ts --fix",
-		"type-check": "tsc --noEmit",
-		"prepublishOnly": "npm run build && npm run test",
-		"release": "npm run build && npm run test && npm publish --access=public",
-		"release:patch": "npm version patch && npm run release && git push && git push --tags",
-		"release:minor": "npm version minor && npm run release && git push && git push --tags",
-		"release:major": "npm version major && npm run release && git push && git push --tags"
+		"dev": "npx tsx watch example/index.ts",
+		"test": "npx vitest run",
+		"release": "npm run build && npm run test && npx bumpp && npm publish --access=public"
 	},
 	"license": "MIT",
 	"files": [