%KiSCJImPPNECdvHLTaftQTie0HnRrCIx9KzQndgrD5c=.sha256scuttle-book
ok I've started designing a helper module following this idea : %TZxzMKH...
This one is a helper module which does all the things you'd want to do (sensibly) with books. The main motivation is to make an easy module that is client-agnostic
Here's the repo : %TZxzMKH...
Comments? cc @arj @matt @dominic @mikey
and here's the README sofar (I'm doing documentation-driven development). The repo has stubs of files in case that helps you see the idea.
//////////////////////////////////////////////////////////////////////////
Scuttle-book
A helper module which covers all your ssb book related needs from fetching book data, creating new book entries, and validating whether a message is of a standard form.
The parts of this modules are :
- queries/ getters
- publishing helpers
- schemas
Usage
const Book = require('scuttle-book')
const book = Book(client) // an ssb-client (sbot)
const newBook = {
title: 'The Dispossessed',
author: 'Ursula le Guin'
}
book.async.create(newBook, (err, bookMsg) => {
if (err) // handle error
book.isBook(bookMsg)
// => true
})
Constructor API
Book(client, opts)
client an ssb-client instance (sometimes called sbot in other docs).
opts (options) an Object with over-ride options for the scuttle-book instance:
{
// TODO: REVISE THIS
aboutWinner: function (sbot, attr, attrOpinions, cb) {
// In the event there are differing opinions about a given book attribute,
// this function determines which one 'wins'.
// By default, the fallback for attribute is :
// [ myOpinion, publishersOpinion, friendsOpinion, strangersOpinion ]
// 'friendsOpinion' is the most recent opinion by a friend
}
}
Instance API
book.async.create(book, cb)
book - an Object which must at least have title, author
book.async.update(id, attributes, cb)
book.async.comment(id, text, cb)
book.sync.isBook(bookMsg)
Checks if a given message is a valid book message.
This method doesn't need an sbot connection so can be accessed directly like:
const isBook = require('scuttle-book/isBook')
book.async.isBook(id, cb)
Looks up an id to see if it's a valid book message.
book.async.isBookUpdate(aboutMsg, cb)
Check if it's an about message, and directed at a valid book message.
book.isBookComment(postMsg, cb)
Check if it's a post message, and directed at a valid book message.
book.pull.books()
A stream of all books. These are just raw book messages.
book.pull.comments()
A stream of comments on books
book.pull.updates()
A stream of updates on books. You can filter this yourself to pull out just ratings, or description updates etc).
book.obs.get(id)
Returns an observeable which provides live updating data for a particular book.
var favBook = book.obs.book('%A4RPANAIiCtO9phwbL0tqk9ta4ltzzZwECZjsH25rqY=.sha256"')
favBook( function listener (newBookState) {
// this function is passed the newBookState whenever there's an update
})
favBook()
// => get the state right now
// {
// key: '%A4RPANAIiCtO9phwbL0tqk9ta4ltzzZwECZjsH25rqY=.sha256',
// value: { }, // the original message content
// attributes: { }, // contains the single 'winning' state for each attr
// comments: [ ], // the collection of replies in the order they were published
// latestAttributes: { } // the latest state of each attribute from each peer
// }
attributes:
{
title: String,
authors: String,
description: String,
image: Blob,
series: String,
seriesNo: Number,
review,
rating,
ratingMax,
ratingType,
shelve, // this one may not make any sense!
genre
}
book.async.get(id, cb)
Similar to book.obs.get but an asynchronous method for e.g. backend rendering.
book.obs.shelves()
book.obs.authors()
Schemas
A new book:
{
type: 'bookclub',
title: String,
authors: String,
description: String, (optional)
image: Blob, (optional)
series: String, (optional)
seriesNo: Number (optional)
}
Updating a book :
(note arj seperated this into amending vs subjective comments, I think this can be done by providing convenience methods)
{
type: 'about',
about: MessageId, // the original book id
title: String, (optional)
authors: String, (optional)
description: String, (optional)
image: Blob, (optional)
series: String, (optional)
seriesNo: Number, (optional)
review,
rating, // ??? type
ratingMax, // ??? < I think we should just have an opinion
ratingType, // do we need this?
shelve,
genre
}
Commenting on a book:
{
type: 'post',
root: MessageId, // the original book id
text: String,
branch: String | Array
}
