harcon-radiation - npm Package Compare versions

Comparing version 0.8.0 to 1.0.0

lib/harcon-radiation.js

@@ -6,3 +6,3 @@ var ES6 = require('./ES6Fixer');
 
-var VERSION = exports.VERSION = '0.8.0';
+var VERSION = exports.VERSION = '1.0.0';
 function extend(obj, extension){
@@ -9,0 +9,0 @@ for(var key in extension){

package.json

 {
   "name": "harcon-radiation",
-  "version": "0.8.0",
+  "version": "1.0.0",
   "description": "REST and Websocket plugin for harcon",
@@ -33,3 +33,3 @@ "keywords": [
     "connect-rest": "~1",
-    "harcon": "~1",
+    "harcon": "~2",
     "socket.io": "~1"
@@ -55,3 +55,3 @@ },
   },
-  "_id": "harcon-radiation@0.8.0"
+  "_id": "harcon-radiation@1.0.0"
 }

README.md

@@ -1,2 +0,2 @@
-Harcon-Radiation - An extension to the [harcon](https://github.com/imrefazekas/harcon) library to automatically expose entities through REST and Websocket.
+Harcon-Radiation - An extension to the [harcon](https://github.com/imrefazekas/harcon) library to automatically expose selected entities through REST and/or Websocket.
 
@@ -9,3 +9,3 @@ [![NPM](https://nodei.co/npm/harcon-radiation.png)](https://nodei.co/npm/harcon-radiation/)
 
-Every time you publish or revoke an object-based entity, the [harcon-radiation](https://github.com/imrefazekas/harcon-radiation) will maintain the interfaces transparently.
+Every time you publish or revoke an object-based entity, the [harcon-radiation](https://github.com/imrefazekas/harcon-radiation) reacts to the changes and maintain the interfaces transparently.
 
@@ -18,8 +18,10 @@ ## Installation
 ```javascript
-var inflicter = new Inflicter( { ... } );
-var radiation = new Radiation( inflicter );
-
+var harcon = new Harcon( { ... } );
+var radiation = new Radiation( harcon );
+var rest = require('connect-rest');
+var connect = require('connect');
+...
 var app = connect();
 ...
-app.use( radiation.rester( options ) ); // Activates the REST services
+app.use( radiation.rester( rest, options ) ); // Activates the REST services
 ...
@@ -29,3 +31,3 @@ server = http.createServer(app);
 ...
-inflicter.addicts( {
+harcon.addicts( {
 	name: 'julie',
@@ -40,7 +42,30 @@ context: 'book',
 ```
-The example shows how you can attach the __radiation__ to a connect/express instance. You can activate the REST and Websocket interfaces or both as you wish.
+The example shows how you can attach the __radiation__ to a connect/express instance and link to your _harcon_ instance. You can activate the REST and Websocket interfaces only or both as you wish.
 Any object-based entities published to [harcon](https://github.com/imrefazekas/harcon) possessing attributes __'rest'__ and __'websocket'__ will be exposed through those interfaces automatically.
 
-## Access service functions
 
+## Regulate publishing process
+
+The default behavior is to publish all services. However, one can define rules to make exceptions. By setting the option _hideInnerServices_, [harcon-radiation](https://github.com/imrefazekas/harcon-radiation) will hide inner services and won't publish them
+
+```javascript
+var radiation = new Radiation( harcon, { hideInnerServices: true } );
+```
+
+[harcon-radiation](https://github.com/imrefazekas/harcon-radiation) ignores a service in 2 cases:
+
+- its name starts with a given prefix
+```javascript
+	var radiation = new Radiation( harcon, { hideInnerServices: true, innerServicesPrefix: '_' } );
+```
+
+- its name matches to a given pattern
+```javascript
+	var radiation = new Radiation( harcon, { hideInnerServices: true, innerServicesFn: function(name){
+		return name.startsWith('inner') || name.startsWith('sys');
+	} } );
+```
+
+## Call in from remote
+
 REST interface means a POST service using the same addressing logic as was implemented in harcon.
@@ -94,2 +119,5 @@ An division-aware URI composed by name or context and a service function's name
 
+- 1.0.0 : moving to harcon v2
+- 0.8.0 : addressing via names added
+- 0.5.0 : refactoring and moving to harcon v1
 - 0.1.0 : initial release

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

31103

increased by3.69%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

119

increased by30.77%

Dependency changes

• + Addedharcon@2.10.2(transitive)

• + Addedisa.js@1.9.1(transitive)

• - Removedharcon@1.5.1(transitive)

• Updatedharcon@~2