absync - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

bower.json

 {
   "name": "absync",
   "main": "public/absync.js",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "homepage": "https://github.com/oliversalzburg/absync",
@@ -6,0 +6,0 @@ "authors": [

package.json

 {
   "name": "absync",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "absync",
@@ -5,0 +5,0 @@ "main": "index.js",

public/absync.js

@@ -24,3 +24,3 @@ var absync;
 		builder.assemble = function( then ) {
-			angular.module( "fmServices" )
+			angular.module( "absync" )
 				.factory(
@@ -27,0 +27,0 @@ collectionName,

README.md

@@ -8,2 +8,86 @@ absync is a highly opinionated framework to synchronize data pools in MEAN applications.
 
-One of the key concepts of absync is that model properties can be decorated with permission requirements that affect the data during transaction, which allows you to hide or change properties when the model is transferred between the server and the client (and vice versa).
+One of the key concepts of absync is that model properties can be decorated with permission requirements that affect the data during transaction, which allows you to hide or change properties when the model is transferred between the server and the client (and vice versa).
+
+## Usage
+1. Construct domain model and decorate it.
+
+	```js
+	var mongoose = require( "mongoose-q" )();
+	var Person = require( "./person.js" );
+	var Schema = mongoose.Schema;
+	var uuid = require( "node-uuid" );
+	var TypeDecorator = require( "absync" ).TypeDecorator;
+	var typeFactory = require( "absync" ).typeFactory;
+	var TypeInfo = require( "absync" ).TypeInfo;
+	
+	var typeDescription = {
+		__v   : { type : Number, select : false },
+		guid  : { type : String, default : uuid.v4 },
+		owner : { type : Schema.Types.ObjectId, ref : "Person" },
+		added : { type : Date, default : Date.now }
+	};
+	
+	new TypeDecorator( typeDescription )
+		.decorate( "__v", TypeInfo.USERCLASS_USER, TypeInfo.HIDDEN )
+		.decorate( "guid", TypeInfo.USERCLASS_USER, TypeInfo.READ_ONLY )
+		.decorate( "added", TypeInfo.USERCLASS_USER, TypeInfo.HIDDEN )
+	;
+	
+	var type = typeFactory.assemble( "Device", "devices", typeDescription );
+	
+	// Extend schema
+	type.schema.pre( "remove", function( next ) {
+		// …
+	} );
+	```
+	
+	absync support model inheritance, through [mongoose-schema-extend](https://github.com/briankircho/mongoose-schema-extend):
+	
+	```js
+	var extendedTypeDescription = {
+		identifierForVendor : { type : String },
+		deviceToken         : { type : String }
+	};
+	
+	new TypeDecorator( extendedTypeDescription )
+		.decorate( "identifierForVendor", TypeInfo.USERCLASS_USER, [ TypeInfo.HIDDEN, TypeInfo.READ_ONLY ] )
+		.decorate( "deviceToken", TypeInfo.USERCLASS_USER, [ TypeInfo.CONCEALED, TypeInfo.READ_ONLY ] )
+	;
+	
+	var extended = typeFactory.extend( "IosDevice", "Device", extendedTypeDescription );
+	```
+
+2. When data changes, use *typehelper* to sanitize inputs and *conductor* to synchronize updates with clients:
+
+	```js
+	module.exports.updateDevice = function( request, response ) {
+		var device = request.body.device;
+		var id = request.params.id;
+		return Device.model.findByIdQ( id )
+			.then( function( existingDevice ) {
+				// Update the model with the sent data and persist it to the database.
+				var updatedDeviceData = Device.typehelper.omitReadOnly( device, Device.typeinfo.USERCLASS_USER );
+				_.extend( existingDevice, updatedDeviceData );
+	
+				// Persist the device record.
+				return existingDevice.saveQ()
+					.then( function( updatedDevice, numberAffected ) {
+						// Send HTTP response
+						conductor.respondToUser( updatedDevice, Device, response );
+						// Push websocket update
+						conductor.sendToUsers( updatedDevice, Device );
+					} );
+			} );
+	};
+	```
+
+3. Construct caching services in Angular to hold the data:
+
+	```js
+	var deviceService = absync.CacheServiceFactory( "device", "device", "/api/devices", "/api/device", Device.fromJson );
+	deviceService.assemble();
+	```
+
+	`Device.fromJson` is supposed to be a function that transforms incoming entities before they are put into the cache. 
+
+	Services emit `entityNew` and `entityUpdated` events. The data is contained in their `entityCache` member.

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

53188

increased by6%

Number of lines in readme file

92

increased by1050%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes