https://github.com/ken107/push-model
A JSON-RPC server with object synchronization based on JSON-Patch
https://github.com/ken107/push-model
firebase json-patch json-rpc json-rpc-server mvc mvvm pubsub
Last synced: 2 months ago
JSON representation
A JSON-RPC server with object synchronization based on JSON-Patch
- Host: GitHub
- URL: https://github.com/ken107/push-model
- Owner: ken107
- License: mit
- Created: 2015-07-31T03:27:39.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T03:58:06.000Z (over 2 years ago)
- Last Synced: 2024-04-14T22:16:08.590Z (about 1 year ago)
- Topics: firebase, json-patch, json-rpc, json-rpc-server, mvc, mvvm, pubsub
- Language: TypeScript
- Homepage:
- Size: 985 KB
- Stars: 8
- Watchers: 4
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/ken107/push-model)
## What's This?
This Node module implements a WebSocket JSON-RPC server with object synchronization capabilities based on the JSON-Pointer and JSON-Patch standards.
It is called a Push Model because it is intended to be used as part of a server-side MVC Model layer or MVVM ViewModel layer that requires the ability to push changes to clients.
The Model/ViewModel layer can handle JSON-RPC requests and return data directly to the requester, or it may choose to place data in a _model object_ that is published to interested clients. [Harmony Proxy](https://github.com/ken107/jsonpatch-observe) is used to detect subsequent changes to the data, which are published incrementally as JSON Patches.
## How To Use
```javascript
const pm = require("push-model");
const server = require("http").createServer();
const model = {
//properties that client can subscribe to
prop1: ...,
prop2: ...,
//RPC methods
method1: function(...args) {
...
return result; //or promise
},
method2: ...
};
pm.mount(server, "/path", model, acceptOrigins);
```
This creates an HTTP server and mounts `model` on the specified route. Clients can send RPC requests to this route over either HTTP or WebSocket, which invoke the corresponding methods on the model. Return values are automatically sent back as JSON-RPC responses.
### Special Methods
The PUB/SUB mechanism is only available to WebSocket clients.
##### SUB/UNSUB
Clients call SUB/UNSUB to start/stop observing changes to the model object. The `pointer` parameter, a JSON Pointer, indicates which part of the model to observe.
```
SUB(pointer)
UNSUB(pointer)
```
##### PUB
Server calls PUB to notify clients of changes to the model. The `patches` parameter holds an array of JSON Patches describing a series of changes that were made to the model.
```
SUB(patches)
```
### Special Return Values
##### ErrorResponse
A return value of type ErrorResponse will be translated into a JSON-RPC error message.
```
return new pm.ErrorResponse(code, message, data);
```
### A Example Model
An MVC chat server that uses object synchronization to push chat messages to clients.
```javascript
pm.mount(server, "/chat", {
//data
chatLog: [],
//actions
sendChat: function(name, message) {
this.chatLog.push(name + ": " + message);
}
});
```
## Examples
##### Running the Chat Example
Open a command prompt in the push-model directory and run:
```
npm install
node examples/chat/model.js
```
That will start the chat model on localhost:8080. Then open the file examples/chat/chat.html in two browser windows and start chatting!
##### Running the Shared TodoList Example
Open a command prompt in the push-model directory and run:
```
npm install
node examples/sharedtodolist/model.js
```
Then open the file examples/sharedtodolist/todo.html in two or more browser windows. If you use Chrome, you must run a local web server because Chrome does not allow AJAX over file:// URL.
##### Running the Messenger Example
```
npm install
node examples/messenger/model.js
```
Then open the file examples/messenger/messenger.html in two or more browser windows. Enter a user ID and name to login to the messenger app.
## Other Features
View the [wiki](http://github.com/ken107/push-model/wiki) for other features supported by the Push Model.