the Global Module provides a simple API to find objects from the global 2 | stores
For example, the syntax to find all objects from the global store 3 | looks like this:
hoodie.global.findAll().done( handleObjects )
4 | okay, might not be the best idea to do that with 1+ million objects, but 5 | you get the point
vanilla API syntax: 9 | hoodie.global.findAll()
extend Hoodie
one place to rule them all!
thrown when invalid keys are used to store an object
Sending emails. Not unicorns
TODO
6 | let's subscribe to general _email changes and provide
7 | an on interface, so devs can listen to events like:
sends an email and returns a promise
extend Hoodie
the User Module provides a simple API to find objects from other users public 2 | stores
For example, the syntax to find all objects from user "Joe" looks like this:
hoodie.user("Joe").findAll().done( handleObjects )
3 | extend hodie.store promise API
vanilla API syntax: 9 | hoodie.user('uuid1234').findAll()
hoodie.store decorations add custom methods to promises returned 17 | by hoodie.store methods like find, add or update. All methods return 18 | methods again that will be executed in the scope of the promise, but 19 | with access to the current hoodie instance
publish
20 | 21 |publish an object. If an array of properties passed, publish only these 22 | attributes and hide the remaining ones. If no properties passed, publish 23 | the entire object.
unpublish
unpublish
extend Hoodie
Central Config API
used as attribute name in localStorage
memory cache
adds a configuration
receives a configuration
clears cache and removes object from store
removes a configuration, is a simple alias for config.set(key, undefined)
11 |
12 | //
13 | // initialize your Hoodie App
14 | //
15 |
16 | whereTheMagicHappens = 'https://yourapp.hood.ie';
17 | hoodie = new Hoodie(whereTheMagicHappens);
18 |
19 | //
20 | // Account
21 | //
22 |
23 | // sign up
24 | hoodie.account.signUp('joe@example.com', 'secret')
25 |
26 | // sign in
27 | hoodie.account.signIn('joe@example.com', 'secret')
28 |
29 | // sign out
30 | hoodie.account.signOut()
31 |
32 | // change password
33 | hoodie.account.changePassword('currentpassword', 'newpassword')
34 |
35 | // change username
36 | hoodie.account.changeUsername('currentpassword', 'newusername')
37 |
38 | // reset password
39 | hoodie.account.resetPassword('joe@example.com')
40 |
41 | // destroy account and all its data
42 | hoodie.account.destroy()
43 |
44 | //
45 | // Store
46 | //
47 |
48 | // add a new object
49 | type = 'couch'
50 | attributes = {color: "red"}
51 | hoodie.store.add(type, attributes )
52 | .done ( function(newObject) { } )
53 |
54 | // save an object
55 | type = 'couch'
56 | id = 'abc4567'
57 | attributes = {color: "red", name: "relax"}
58 | hoodie.store.save( type, id, attributes )
59 | .done ( function(object) { } )
60 |
61 | // update an existing object
62 | type = 'couch'
63 | id = 'abc4567'
64 | update = {size: 2}
65 | hoodie.store.update( type, id, update )
66 | .done ( function(updatedObject) { } )
67 |
68 | // find one object
69 | type = 'couch'
70 | id = 'abc4567'
71 | hoodie.store.find( type, id )
72 | .done ( function(object) { } )
73 |
74 | // Load all objects
75 | hoodie.store.findAll()
76 | .done ( function(objects) { } )
77 |
78 | // Load all objects from one type
79 | type = 'couch'
80 | hoodie.store.findAll( type )
81 | .done ( function(objects) { } )
82 |
83 | // remove an existing object
84 | type = 'couch'
85 | id = 'abc4567'
86 | hoodie.store.remove( type, id )
87 | .done ( function(removedObject) { } )
88 |
89 | // listen to store events
90 | hoodie.store.on( 'add', function( newObject) { } )
91 |
92 | // new doc created
93 | hoodie.store.on( 'add', function( newObject) { } )
94 |
95 | // existing doc updated
96 | hoodie.store.on( 'update', function( updatedObject) { } )
97 |
98 | // doc removed
99 | hoodie.store.on( 'remove', function( removedObject) { } )
100 |
101 | // any of the events above
102 | hoodie.store.on( 'change', function( event, changedObject) { } )
103 |
104 | // all listeners can be filtered by type
105 | hoodie.store.on( "add:couch", function( newObject) { } )
106 | hoodie.store.on( "update:couch", function( updatedObject) { } )
107 | hoodie.store.on( "remove:couch", function( removedObject) { } )
108 | hoodie.store.on( "change:couch", function( event, changedObject) { } )
109 |
110 | // ... and by type and id
111 | hoodie.store.on( "add:couch:uuid123", function( newObject) { } )
112 | hoodie.store.on( "update:couch:uuid123", function( updatedObject) { } )
113 | hoodie.store.on( "remove:couch:uuid123", function( removedObject) { } )
114 | hoodie.store.on( "change:couch:uuid123", function( event, changedObject) { } )
115 |
116 |
117 | //
118 | // Synchronization
119 | //
120 | // When signed in, local changes do get synched automatically.
121 | // You can subscribe to remote updates
122 | //
123 |
124 | // new doc created
125 | hoodie.remote.on( 'add', function( newObject) { } )
126 |
127 | // existing doc updated
128 | hoodie.remote.on( 'update', function( updatedObject) { } )
129 |
130 | // doc removed
131 | hoodie.remote.on( 'remove', function( removedObject) { } )
132 |
133 | // any of the events above
134 | hoodie.remote.on( 'change', function( event, changedObject) { } )
135 |
136 | // all listeners can be filtered by type
137 | hoodie.remote.on( "add:couch", function( newObject) { } )
138 | hoodie.remote.on( "update:couch", function( updatedObject) { } )
139 | hoodie.remote.on( "remove:couch", function( removedObject) { } )
140 | hoodie.remote.on( "change:couch", function( event, changedObject) { } )
141 |
142 | // ... and by type and id
143 | hoodie.remote.on( "add:couch:uuid123", function( newObject) { } )
144 | hoodie.remote.on( "update:couch:uuid123", function( updatedObject) { } )
145 | hoodie.remote.on( "remove:couch:uuid123", function( removedObject) { } )
146 | hoodie.remote.on( "change:couch:uuid123", function( event, changedObject) { } )
147 |
148 |
149 | //
150 | // Public Shares (Public User Stores)
151 | //
152 | // Select data you want to share with others and control exactly what will
153 | // be shared
154 | //
155 |
156 | // make couch object with id "abc4567" public
157 | hoodie.store.find("couch","abc4567").publish()
158 |
159 | // make couch with id "abc4567" public, but do only show the color, hide
160 | // all other attributes
161 | hoodie.store.find("couch","abc4567").publish(['color'])
162 |
163 | // make couch with id "abc4567" private again
164 | hoodie.store.find("couch","abc4567").unpublish()
165 |
166 | // find all couch objects from user "joe"
167 | hoodie.user("joe").findAll("couch").done( function(couches) { ... })
168 |
169 |
170 | //
171 | // Global Public Store
172 | //
173 | // When enabled, all publicly shared objects by all users will be
174 | // available through the hoodie.global API
175 | //
176 |
177 | // find all public songs from all users
178 | hoodie.global.findAll("song").done( function(songs) { ... })
179 |
180 |
181 | //
182 | // Sharing
183 | //
184 | // The hoodie.share module allows to share objects with other users. A share
185 | // can be public, which means everybody knowing its id can access it. Or the
186 | // access can be limited to specific users. Optionally, a password can be set
187 | // for additional security. Access can be differenciated between read and write.
188 | //
189 |
190 | // add a new share
191 | hoodie.share.add().done( function(share) {} )
192 |
193 | // grant / revoke access
194 | share.grantReadAccess()
195 | share.grantWriteAccess()
196 | share.revokeReadAccess()
197 | share.revokeWriteAccess()
198 | share.grantReadAccess('joe@example.com')
199 | share.revomeWriteAccess(['joe@example.com','lisa@example.com'])
200 |
201 | // add all todo objects to the share
202 | hoodie.store.findAll('todo').shareAt(share.id)
203 |
204 | // remove a specific todo from the share
205 | hoodie.store.find('todo', '123').unshareAt(share.id)
206 |
207 | // add a new share and add some of my objects to it in one step
208 | hoodie.store.findAll('todo').share()
209 | .done( function(todos, share) { alert('shared at ' + share.id) } )
210 |
211 | // remove objects from all shares
212 | hoodie.store.findAll('todo').unshare()
213 |
214 | // remove share
215 | hoodie.share.remove(share.id)
216 |
217 | // open a share and load all its objects
218 | hoodie.share('shareIdHere').findAll()
219 | .done( function(objects) { } )
220 |
221 | // subscribe / unsubscribe
222 | hoodie.share('shareId').subscribe()
223 | hoodie.share('shareId').unsubscribe()
224 |
225 |
226 | //
227 | // Send emails
228 | //
229 | email = {
230 | to : ['you@roundthewor.ld'],
231 | cc : ['rest@roundthewor.ld'],
232 | subject : 'rule the wolrd',
233 | body : "we can do it!\nSigned, Joe"
234 | }
235 |
236 | hoodie.email.send( email )
237 |
238 | // synched to server
239 | .progress ( function(email) { } )
240 |
241 | // email sent successfully
242 | .done ( function(email) { } )
243 |
244 | // something went wrong
245 | .fail ( function(err) { } )
246 |
247 | //
248 | // hoodie.js API docs
249 | // http://hoodiehq.github.com/hoodie.js/doc/hoodie.html
250 | //
251 | extend any Class with support for
object.bind('event', cb)object.unbind('event', cb)object.trigger('event', args...)object.one('ev', cb)based on Events implementations from Spine
bind a callback to an event triggerd by the object
object.bind 'cheat', blame
9 | alias
same as bind, but does get executed only once
object.one 'groundTouch', gameOver
22 | trigger an event and pass optional parameters for binding.
object.trigger 'win', score: 1230
26 | unbind to from all bindings, from all bindings of a specific event 35 | or from a specific binding.
object.unbind()
36 | object.unbind 'move'
37 | object.unbind 'move', follow
38 | just some loose thoughts on a hoodie.open method.
open a "store"
shortcuts
I can open any kind of named store, like a sharing or a users public 12 | store. An "opened" store does always provide the same API whereat 13 | some might require special privileges. They all return a promise
instantiate
store / find objects
sync
event binding
password
Connection / Socket to our couch
AccountRemote is using CouchDB's _changes feed to
2 | listen to changes and _bulk_docs to push local changes
When hoodie.remote is continuously syncing (default), 3 | it will continuously synchronize with local store, 4 | otherwise sync, pull or push can be called manually
connect by default
set name to user's DB name
we're always connected to our own db
do not prefix files for my own remote
do not start to connect immediately, but authenticate beforehand
we store the last since number from the current user's store 22 | in his config
if no objects passed to be pushed, we default to 26 | changed objects in user's local store
namespaced alias for hoodie.on
namespaced alias for hoodie.trigger
Global