{"_id":"wave","_rev":"4-95d62c53ad31c2a62c911c10e9d1d9ec","name":"wave","description":"Wave Gadget API implementation","dist-tags":{"latest":"0.2.3"},"versions":{"0.1.0":{"name":"wave","description":"Wave Gadget API implementation","keywords":["wave","websocket","google wave"],"author":{"name":"Scott Wilson","email":"scott.bradley.wilson@gmail.com"},"version":"0.1.0","engines":{"node":">=0.2.4"},"bugs":{"name":"http://github.com/scottbw/wave-node/issues"},"main":"./lib/wave","maintainers":[{"name":"Scott Wilson","email":"scott.bradley.wilson@gmail.com","url":"http://github.com/scottbw/wave-node"}],"licenses":[{"type":"Apache Software License 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}],"repositories":[{"type":"git","url":"git://github.com/scobbtw/wave-node.git"}],"dependencies":{"keys":">=0.1.2","socket.io":">=0.6.8","redis":">=0.5.2"},"_id":"wave@0.1.0","_engineSupported":true,"_npmVersion":"0.3.15","_nodeVersion":"v0.4.2","dist":{"shasum":"a35e83cd1dbbc1531a3d4b6d8e7dcefa1ed614a1","tarball":"https://registry.npmjs.org/wave/-/wave-0.1.0.tgz","integrity":"sha512-zVYywwAdd9WuDqA7n+p7ZHZLYtpWWuBwdKsvnBPax+XtNNQbrJJrMe8c8ZZIGirGJ05dkAjAU7OpR3tRkvUuIA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCtJ8mc93rR6JT8oO/m/bymIy59F3LeqpP1VnJFyJsBigIhANYWQ5osce4ZKV2uwJ4LDvwd3Q4ei3jdZVNNJO1Rzzbl"}]}},"0.2.0":{"name":"wave","description":"Wave Gadget API implementation","keywords":["wave","websocket","google wave"],"author":{"name":"Scott Wilson","email":"scott.bradley.wilson@gmail.com"},"version":"0.2.0","engines":{"node":">=0.2.4"},"bugs":{"name":"http://github.com/scottbw/wave-node/issues"},"main":"./lib/wave","maintainers":[{"name":"Scott Wilson","email":"scott.bradley.wilson@gmail.com","url":"http://github.com/scottbw/wave-node"}],"licenses":[{"type":"Apache Software License 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}],"repositories":[{"type":"git","url":"git://github.com/scobbtw/wave-node.git"}],"dependencies":{"keys":">=0.1.2","socket.io":">=0.6.8","redis":">=0.5.2"},"_id":"wave@0.2.0","_engineSupported":true,"_npmVersion":"0.3.15","_nodeVersion":"v0.4.2","directories":{"lib":"./lib"},"files":[""],"_defaultsLoaded":true,"dist":{"shasum":"d2adbc4626698b75de2b485aef414f43c760df80","tarball":"https://registry.npmjs.org/wave/-/wave-0.2.0.tgz","integrity":"sha512-p8vENhVlgvoXhf1pwlQYFyB1U6k2i9ezrcXwOdJ5d+4qOFRPedsbuVAHBQiG4RXDgGaQEZwRLpaHI8dmno4R3g==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCaR5rjZ/DGlczNU2PxTq7szMR4PGJ/JGdZE3f5qR64IAIgI4yMDl0GTGlvqt8wKKEGyhySWzTe1wTsQRn7rspMS1s="}]}},"0.2.2":{"name":"wave","description":"Wave Gadget API implementation","keywords":["wave","websocket","google wave"],"author":{"name":"Scott Wilson","email":"scott.bradley.wilson@gmail.com"},"version":"0.2.2","engines":{"node":">=0.4.0"},"bugs":{"name":"http://github.com/scottbw/wave-node/issues"},"main":"./lib/wave","maintainers":[{"name":"Scott Wilson","email":"scott.bradley.wilson@gmail.com","url":"http://github.com/scottbw/wave-node"}],"licenses":[{"type":"Apache Software License 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}],"repositories":[{"type":"git","url":"git://github.com/scobbtw/wave-node.git"}],"dependencies":{"keys":">=0.1.2","socket.io":">=0.7.0","redis":">=0.5.2"},"_id":"wave@0.2.2","_engineSupported":true,"_npmVersion":"0.3.15","_nodeVersion":"v0.4.2","directories":{"lib":"./lib"},"files":[""],"_defaultsLoaded":true,"dist":{"shasum":"8031e956eb360d4653063e703f3979a92f36f497","tarball":"https://registry.npmjs.org/wave/-/wave-0.2.2.tgz","integrity":"sha512-VIPLxerGY0iP9lpIhyhSNwsAQFni1qZc2iWwI2PZBWFiKADcGNl3Me5CSO/l/i5rs60vKIAMMjbibGVFqTN1pA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCH00NXAzHmRqOxWv4n/aVuTJhbuZlvx/aUvBGQvI1QB4CIQDW4Q+axrFbOeNw1rCXoEPOF4x7XEniMJM6Mbam3kNfQA=="}]}},"0.2.3":{"name":"wave","description":"Wave Gadget API implementation","keywords":["wave","websocket","google wave"],"author":{"name":"Scott Wilson","email":"scott.bradley.wilson@gmail.com"},"version":"0.2.3","engines":{"node":">=0.6.0"},"bugs":{"name":"http://github.com/scottbw/wave-node/issues"},"main":"./lib/wave","maintainers":[{"name":"scottbw","email":"scott.bradley.wilson@gmail.com"}],"licenses":[{"type":"Apache Software License 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}],"repositories":[{"type":"git","url":"git://github.com/scobbtw/wave-node.git"}],"dependencies":{"keys":">=0.1.2","socket.io":">=0.9.5","redis":">=0.7.0"},"_npmUser":{"name":"scottbw","email":"scott.bradley.wilson@gmail.com"},"_id":"wave@0.2.3","devDependencies":{},"optionalDependencies":{},"_engineSupported":true,"_npmVersion":"1.1.16","_nodeVersion":"v0.6.15","_defaultsLoaded":true,"dist":{"shasum":"067a6e324a3cc567f70d7ee4c13d18e3195831d2","tarball":"https://registry.npmjs.org/wave/-/wave-0.2.3.tgz","integrity":"sha512-0phjn2uXejtpEocClEDkyNWcIc8Fm/aSpQ2+2UWQNjtSddXNVfxwkw0VruJuparEQI+MlGK1ML1FIDTeqJgJVg==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDwMgCHp4Yg+wZTXORQlZgvjVZU8oCSnyq92x40/mB4UQIgeDs8nDushIxugy/+5xWBgy2MTClGIYvoc/PiFXjR0dw="}]}}},"maintainers":[{"name":"scottbw","email":"scott.bradley.wilson@gmail.com"}],"time":{"modified":"2022-06-28T22:11:25.440Z","created":"2011-03-10T12:17:21.386Z","0.1.0":"2011-03-10T12:17:21.831Z","0.2.0":"2011-03-11T10:38:25.905Z","0.2.2":"2011-07-22T21:03:02.527Z","0.2.3":"2012-04-12T13:05:57.790Z"},"author":{"name":"Scott Wilson","email":"scott.bradley.wilson@gmail.com"},"readme":"# Wave-Node\n\nThis is an implementation of the Google Wave Gadget API using Node.js, Socket.io, and Redis. \n\nIt uses diff-match-patch to synchronize states across multiple instances: clients send patches to the server, which then propagates the patches to other clients which\napply the patches to their local state model. So no matter how big the state model becomes, each update event is quite small.\n\n## Installation\n\nInstall Wave using NPM with:\n\n    $ npm install wave\n    \n## Creating a Wave server\n\nTo create a Wave server instance, attach it to a http server instance as follows:\n\n    var server = http.createServer(function(req, res){ \n      res.writeHead(200, {'Content-Type': 'text/html'}); \n      res.end('<h1>Wave Gadget API Server</h1>');   \n    });\n    var wave = require('wave').Server;\n    wave.attach(server);\n    server.listen(8000, \"127.0.0.1\");\n    \n    \nNote that you must have Redis running.\n\n## Setting Redis options\n\nYou can set various options for redis by passing a map of options to the attach() method, e.g.:\n\n    wave.attach(server, {\"host\":\"127.0.0.1\", \"port\":\"6379\", \"clear\":true});\n    \nThe \"clear\" option, when set true, clears out all existing states. Other valid options are \"host\", \"port\", and any standard Redis configuration options you can pass to node_redis using redis.createClient(). See [node-redis](http://github.com/mranney/node_redis) for more information.\n\n## Running the examples\n\nTo run the examples, you need to start your Redis server, and start a new Wave server using:\n\n    $ node examples/server/server.js\n    \nYou can then run the examples by opening examples/index.htm in a browser and following the instructions on the page.\n\t\n## Client API\n\nEach page or widget wanting to use the service needs to import the following JavaScript files:\n\n    diff_match_patch.js\n    json2.js\n    socket.io.js\n    wave.js\n    \nThese can all be found in the \"client\" folder; you can also load the current socket.io.js client from the server itself (e.g. http://localhost:8081/socket.io/socket.io.js)\n\nIn addition you need to call the following methods in your own scripts after importing the wave.js library:\n\n    wave.setSharedDataKey(key) : this is the \"context identifier\" for the pages/widgets that will share state.\n    wave.setViewer(id, name, icon src) : this is the current user's information\n\nFor example:\n\n    wave.setSharedDataKey(\"SPACE1\");\n    wave.setViewer(\"mindyourownbusiness\",\"alice\",\"smileys/rabbit.png\");\n\t\nWhen both have been set, your page/widget will handshake with the server.\n\nYou can then use the Wave Gadget API as described at: http://code.google.com/apis/wave/extensions/gadgets/guide.html\n\n## Notes\n\nNote that private states are not supported yet, nor are getHost() or state.clear().","readmeFilename":""}