instant-api - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

index.js

@@ -22,5 +22,10 @@ var http = require('http')
     // allow any origin
-    credentials: true,
+    credentials: !!options.corsAllowedDomains,
     origin: function (origin, callback) {
-      callback(null, origin)
+      var originDomain = origin.replace(/^[^:]+:\/\//, '')
+      var corsOrigin = origin
+      if (options.corsAllowedDomains) {
+        corsOrigin = options.corsAllowedDomains.includes(originDomain) ? origin : null
+      }
+      callback(corsOrigin ? null : `Invalid origin found: ${originDomain}`, corsOrigin)
     }
@@ -27,0 +32,0 @@ })

package.json

 {
   "name": "instant-api",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Like instant soup but API. JSON-RPC2 flavor with Websockets and HTTP.",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/archilogic-com/instant-api",

README.md

@@ -20,18 +20,18 @@ # Instant API
 module.exports = function (rpc) {
-  
+
   // use parameters
   console.log(rpc.params)
-  
+
   // return result
   rpc.sendResult('Done. Enjoy!')
-  
+
   // return param error
   //rpc.sendParamsError('Missing parameter ...')
-  
+
   // return custom error
   //rpc.sendError('Splash')
-  
+
   // use in promise chains
   // rawQuery(query).then(rpc.sendResult).catch(rpc.sendError)
-  
+
 }
@@ -57,3 +57,3 @@ ```
 }).catch(console.error)
- 
+
 // ... from a browser using Websockets
@@ -83,2 +83,17 @@ var ws = new WebSocket('ws://localhost:3000')
 
+[**🚨 Cross origin settings**](example/index.js)
+
+By default, [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) is enabled but does not permit transmitting credentials.
+You can specify allowed CORS domains which will also be able to send credentials:
+
+```javascript
+var tasks = {
+  'makeSoup': require('./tasks/make-soup')
+}
+require('instant-api')(tasks ,{
+  port: process.env.PORT || 3000,
+  corsAllowedDomains: [ 'example.org', 'test.example.org' ]
+})
+```
+
 [**🕹 Run example**](example/index.js)
@@ -85,0 +100,0 @@ ```

No alert changes

Improved metrics

Total package byte prevSize

20454

increased by4.06%

Lines of code

469

increased by1.08%

Number of lines in readme file

102

increased by17.24%

No dependency changes