@jitar-plugins/http 0.0.2 → 0.0.3

package/README.md

@@ -3,10 +3,12 @@
 
 This package provides plugins for integrating the HTTP protocol in Jitar applications.
 
-It contains two middleware:
+It contains two types of middleware:
 
-* **CORS** for handling Cross-Origin Resource Sharing (CORS) requests.
-* **Origin** for ensuring the availability of the origin header.
+* **CORS** - configures cross-origin requests.
+* **Origin** - ensures the avaiability of the origin header.
+
+Both can be used indenpendently.
 
 ## Installation
 
@@ -16,16 +18,31 @@ npm install @jitar-plugins/http
 
 ## Usage
 
-Follow the following steps to configure and use the provided middleware.
+Follow the following steps to configure and use the middleware.
 
 ### Step 1 - Configure the middleware
 
+**CORS**
+
+```ts
+// src/middleware/corsMiddleware.ts
+
+import { CorsMiddleware } from '@jitar-plugins/http';
+
+const origin = '*'; // allowed orgins (optional, default: *)
+const headers = '*'; // allowed headers (optional, default: *)
+
+export default new CorsMiddleware(origin, headers);
+```
+
+**Origin**
+
 ```ts
 // src/middleware/originMiddleware.ts
 
-import OriginMiddleware from '@jitar-plugins/http';
+import { OriginMiddleware } from '@jitar-plugins/http';
 
-export default new OriginMiddleware();
+export default new OriginMiddleware(); // no configuration options
 ```
 
 ### Step 2 - Activate the middleware
@@ -37,6 +54,7 @@ With the health check in place, it needs to be activated by registering it to th
 {
     "url": "http://example.com:3000",
     "middleware": [ /* add middleware here */
+        "./middleware/corsMiddleware",
         "./middleware/originMiddleware"
     ],
     "proxy":

package/dist/index.d.ts

@@ -1,2 +1,2 @@
-export { default as CorsMiddleware } from './CorsMiddleware';
-export { default as OriginMiddleware } from './OriginMiddleware';
+export { default as CorsMiddleware } from './CorsMiddleware.js';
+export { default as OriginMiddleware } from './OriginMiddleware.js';

package/dist/index.js

@@ -1,2 +1,2 @@
-export { default as CorsMiddleware } from './CorsMiddleware';
-export { default as OriginMiddleware } from './OriginMiddleware';
+export { default as CorsMiddleware } from './CorsMiddleware.js';
+export { default as OriginMiddleware } from './OriginMiddleware.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jitar-plugins/http",
   "private": false,
-  "version": "0.0.2",
+  "version": "0.0.3",
   "type": "module",
   "scripts": {
     "build": "tsc",
@@ -17,7 +17,7 @@
   "types": "dist/index.d.ts",
   "exports": "./dist/index.js",
   "peerDependencies": {
-    "@theshelf/validation": "^0.0.2",
+    "@theshelf/validation": "^0.0.3",
     "jitar": "^0.10.3"
   }
 }