@beaker/libfritter

Data definitions and methods for Fritter

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
471Jun 15, 2018Dec 6, 2017Minified + gzip package size for @beaker/libfritter in KB

Readme

Table of Contents generated with DocToc

libfritter

Data definitions and methods for Fritter, a Twitter clone built on top of Dat. Uses WebDB to read and write records on the Dat network.

See the Fritter app to see this library in use.

const LibFritter = require('@beaker/libfritter')
const fritter = new LibFritter()
await fritter.db.open()
await fritter.db.indexArchive('dat://bob.com')
await fritter.social.getProfile('dat://bob.com') // => ...

Schemas:

  • Profile. The schema for user profiles. A very simple "social media" profile: name, bio, profile pic, and a list of followed users.
  • Post. The schema for feed posts. Like in Twitter, posts are microblog posts, and can be in reply to other Fritter posts.
  • Vote. The schema for votes. In Fritter, only upvotes are used.

Usage

Getting started

LibFritter provides a set of methods to be used on top of a WebDB instance.

Setup will always include the following steps:

// create the libfritter instance
const fritter = new LibFritter()
// open the webdb
await fritter.db.open()

WebDB maintains an index which will determine who shows up in the feed, and whether any read method works for a given archive. (For instance, you can't call getProfile() on an archive that hasn't been indexed.) You can manage the index's membership using WebDB's methods:

// add a user
await fritter.db.indexArchive('dat://bob.com')
// remove a user
await fritter.db.unindexArchive('dat://bob.com')

You can also add individual files to the index, which is helpful when the user navigates to a thread:

// add an individual file
await fritter.db.indexFile('dat://bob.com/posts/1.json')

When you create a dat archive for the local user, you'll want to call prepareArchive() to setup the folder structure:

var alice = DatArchive.create({title: 'Alice', description: 'My Fritter profile'})
await fritter.prepareArchive(alice)

Profiles

User profiles include a name, bio, and an avatar image.

await fritter.social.setProfile(alice, {
  name: 'Alice',
  bio: 'A cool hacker'
})

await fritter.social.setAvatar(alice, 'iVBORw...rkJggg==', 'png')

await fritter.social.getProfile(alice) /* => {
  name: 'Alice',
  bio: 'A cool hacker',
  avatar: '/avatar.png'
} */

Social

Every user maintains a public list of other users they follow. You can modify and examine the social graph using these methods.

await fritter.social.follow(alice, bob)
await fritter.social.follow(alice, 'dat://bob.com') // (urls work too)
await fritter.social.listFollowers(bob) // => [{name: 'Alice', bio: 'A cool hacker', ...}]

Feed

The feed contains simple text-based posts.

// posting a new thread
await fritter.feed.post(alice, {
  text: 'Hello, world!',
})

// posting a reply
await fritter.feed.post(alice, {
  text: 'Hello, world!',
  threadParent: parent.getRecordURL(), // url of message replying to
  threadRoot: root.getRecordURL(), // url of topmost ancestor message
  createdAt: Date.parse('04 Dec 2017 00:12:00 GMT') // optional 
})

The list method will show any indexed posts.

await fritter.feed.listPosts({
  fetchAuthor: true,
  countVotes: true,
  reverse: true,
  rootPostsOnly: true,
  countReplies: true
})

You can view the posts of an individual user by adding the author filter, and also narrow down the feed to only include the followed users using the authors filter.

Like / Unlike

Users can like posts using the votes.

await fritter.feed.vote(alice, {vote: 1, subject: 'dat://bob.com/posts/1.json'})
await fritter.feed.listVotesFor('dat://bob.com/posts/1.json') /* => {
  up: 1,
  down: 0,
  value: 1,
  upVoters: ['dat://alice.com']
}

Notifications

You can view recent notifications (mentions, likes and replies on your posts) using the notifications api.

await fritter.notifications.listNotifications() /* => [
  { type: 'mention',
    url: 'dat://bob.com/posts/0jc7w0d5cd.json',
    createdAt: 15155171572345 },
  { type: 'reply',
    url: 'dat://alice.com/posts/0jc7w07be.json',
    createdAt: 1515517526289 },
  { type: 'vote',
    vote: 1,
    subject: 'dat://alice.com/posts/0jc7w079o.json',
    origin: 'dat://bob.com',
    createdAt: 1515517526308 }
]*/

API

new LibFritter([opts])

const fritter = new LibFritter()
  • opts Object.
    • mainIndex String. The name (in the browser) or path (in node) of the main indexes. Defaults to 'fritter'.
    • DatArchive Constructor. The class constructor for dat archive instances. If in node, you should specify node-dat-archive.

Create a new LibFritter instance. The mainIndex will control where the indexes are stored. You can specify different names to run multiple LibFritter instances at once.

fritter.db

The WebDB instance.

fritter.setUser(archive)

fritter.setUser(alice)
  • archive DatArchive. The archive which represents the local user.

Sets the local user. Used in notifications to know which posts should be indexed.

fritter.prepareArchive(archive)

await fritter.prepareArchive(alice)
  • archive DatArchive. The archive to prepare for use in fritter.

Create needed folders for writing to an archive. This should be called on any archive that represents the local user.

fritter.social.getProfile(archive)

await fritter.social.getProfile(alice) // => {name: 'Alice', bio: 'A cool hacker', avatar: '/avatar.png'}
  • archive DatArchive or String. The archive to read.

Get the profile data of the given archive.

fritter.social.setProfile(archive, profile)

await fritter.social.setProfile(alice, {name: 'Alice', bio: 'A cool hacker'})
  • archive DatArchive or String. The archive to modify.
  • profile Object.
    • name String.
    • bio String.

Set the profile data of the given archive.

fritter.social.setAvatar(archive, imgDataBuffer, extension)

await fritter.social.setAvatar(alice, myPngData, 'png')
  • archive DatArchive or String. The archive to modify.
  • imgDataBuffer String, ArrayBuffer, or Buffer. The image data to store. If a string, must be base64-encoded.
  • extensions String. The file-extension of the avatar.

Set the avatar image of the given archive.

fritter.social.follow(archive, targetUser[, targetUserName])

await fritter.social.follow(alice, bob, 'Bob')
  • archive DatArchive or String. The archive to modify.
  • targetUser DatArchive or String. The archive to follow.
  • targetUserName String. The name of the archive being followed.

Add to the follow-list of the given archive.

fritter.social.unfollow(archive, targetUser)

await fritter.social.unfollow(alice, bob)
  • archive DatArchive or String. The archive to modify.
  • targetUser DatArchive or String. The archive to unfollow.

Remove from the follow-list of the given archive.

fritter.social.listFollowers(archive)

await fritter.social.listFollowers(alice)
  • archive DatArchive or String. The archive to find followers of.

List users in db that follow the given archive.

fritter.social.countFollowers(archive)

await fritter.social.countFollowers(alice)
  • archive DatArchive or String. The archive to find followers of.

Count users in db that follow the given archive.

fritter.social.listFriends(archive)

await fritter.social.listFriends(alice)
  • archive DatArchive or String. The archive to find friends of.

List users in db that mutually follow the given archive.

fritter.social.countFriends(archive)

await fritter.social.countFriends(alice)
  • archive DatArchive or String. The archive to find friends of.

Count users in db that mutually follow the given archive.

fritter.social.isFollowing(archiveA, archiveB)

await fritter.social.isFollowing(alice, bob) // => true
  • archiveA DatArchive or String. The archive to test.
  • archiveB DatArchive or String. The follow target.

Test if archiveA is following archiveB.

fritter.social.isFriendsWith(archiveA, archiveB)

await fritter.social.isFriendsWith(alice, bob) // => true
  • archiveA DatArchive or String.
  • archiveB DatArchive or String.

Test if archiveA and archiveB are mutually following each other.

fritter.feed.post(archive, post)

// posting a new thread
await fritter.feed.post(alice, {
  text: 'Hello, world!',
})

// posting a reply
await fritter.feed.post(alice, {
  text: 'Hello, world!',
  threadParent: parent.getRecordURL(), // url of message replying to
  threadRoot: root.getRecordURL() // url of topmost ancestor message
})
  • archive DatArchive or String. The archive to modify.
  • post Object.
    • text String. The content of the post.
    • threadParent String. The URL of the parent post in the thread. Only needed in a reply; must also include threadRoot.
    • threadRoot String. The URL of the root post in the thread. Only needed in a reply; must also include threadParent.
    • mentions Array<{url: String, name: String}. An array of users mentioned in the posts, who should be pinged.

Post a new message to the feed.

fritter.feed.listPosts([opts])

await fritter.feed.listPosts({limit: 30})
  • opts Object.
    • author String | DatArchive. Single-author filter.
    • authors Array. Multi-author filter.
    • rootPostsOnly Boolean. Remove posts in the feed that are replies
    • after Number. Filter out posts created before the given timestamp.
    • before Number. Filter out posts created after the given timestamp.
    • limit Number. Add a limit to the number of results given.
    • offset Number. Add an offset to the results given. Useful in pagination.
    • reverse Boolean. Reverse the order of the output.
    • fetchAuthor Boolean. Populate the .author attribute of the result objects with the author's profile record.
    • countReplies Boolean. Populate the .replies attribute of the result objects with number of replies to the post.
    • countVotes Boolean. Populate the .votes attribute of the result objects with the results of countVotesFor.

Fetch a list of posts in the feed index.

fritter.feed.countPosts([opts])

await fritter.feed.countPosts({author: alice})
  • opts Object.
    • author String | DatArchive. Single-author filter.
    • authors Array. Multi-author filter.
    • rootPostsOnly Boolean. Remove posts in the feed that are replies
    • after Number. Filter out posts created before the given timestamp.
    • before Number. Filter out posts created after the given timestamp.
    • limit Number. Add a limit to the number of results given.
    • offset Number. Add an offset to the results given. Useful in pagination.

Count posts in the feed index.

fritter.feed.getThread(url[, opts])

await fritter.feed.getThread('dat://alice.com/posts/1.json')
  • url String. The URL of the thread.
  • opts Object.
    • authors Array. Filter the posts in the thread down to those published by the given list of archive urls.

Fetch a discussion thread, including all replies.

fritter.feed.vote(archive, data)

await fritter.feed.vote(alice, {
  vote: 1,
  subject: 'dat://bob.com/posts/1.json'
})
  • archive DatArchive or String. The archive to modify.
  • data Object.
    • vote Number. The vote value. Must be -1 (dislike), 0 (no opinion), or 1 (like).
    • subject String. The url of the item being voted on.

Publish a vote on the given subject.

fritter.feed.listVotesFor(subject)

await fritter.feed.listVotesFor('dat://bob.com/posts/1.json')
  • subject String. The url of the item.

Returns a vote tabulation of the given subject.

fritter.notifications.listNotifications([opts])

await fritter.notifications.listNotifications({limit: 30})
  • opts Object.
    • after Number. Filter out notifications created before the given timestamp.
    • before Number. Filter out notifications created after the given timestamp.
    • limit Number. Add a limit to the number of results given.
    • offset Number. Add an offset to the results given. Useful in pagination.
    • reverse Boolean. Reverse the order of the output.
    • fetchAuthor Boolean. Populate the .author attribute of the result objects with the author's profile record.
    • fetchPost Boolean. Populate the .post attribute of the result objects with the post that's the subject of the notification.

Fetch a list of events in the notifications index.

fritter.notifications.countNotifications([opts])

await fritter.notifications.countNotifications()
  • opts Object.
    • after Number. Filter out notifications created before the given timestamp.
    • before Number. Filter out notifications created after the given timestamp.
    • limit Number. Add a limit to the number of results given.
    • offset Number. Add an offset to the results given. Useful in pagination.

Fetch a count of events in the notifications index.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.