An API framework for interfacing with Mastodon servers
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
src
.gitattributes
CHANGELOG.md
CONTRIBUTING.md
Cakefile
LICENSE.md
README.md

README.md

LABORATORY

Laboratory is a client-side engine for interfacing with the API of Mastodon, a free and open-source social networking server. Laboratory pulls and stores data from a Mastodon server and makes it accessible to frontends through its Request API. Check out the source code for more information how to Laboratory in your own projects. Or, you can keep reading for a brief overview of the project and what it's about.

Why Laboratory?

There are a number of client-side API's for interacting with servers like Mastodon. The advantage to using Laboratory is that it provides more than just a repackaging of XMLHttpRequest—it is an extensive library for interacting with the data types that Mastodon provides and storing them for later use. Laboratory maintains a store of all the data it receives from the server for quick access later, and uses an event-based API to manage its asynchronous operations.

The principles which guide Laboratory development are as follows:

  • Abstraction of API and data storage. Laboratory does not make its internal storage mechanisms available to users, and data is only accessible through its request interface. This allows multiple components to share the same Laboratory store without conflicting with each other's operation. Laboratory does not require users to be familiar with the Mastodon API or its data structures.

  • Asynchronous, event-based operation. Because much of Laboratory's operation involves making requests to an external server, asynchronous operation is a given. However, because Laboratory routes all its behaviour through events and their handlers, multiple components can easily pick up on and share the same data. Logging Laboratory operations, as well as extending them with your own components, is a breeze.

  • Literate, readable source code. Laboratory is written using Literate CoffeeScript, which enables it to combine its source and documentation into the same files. Each source file can be viewed in any Markdown reader, including directly from its hosted location on GitHub.

  • Compatibility with frontend frameworks like React. Laboratory wouldn't be very useful if you couldn't use it to make stuff in your project. It has been designed with technologies like React in mind, to make operation as seamless as possible.

Compatibility

Laboratory makes heavy use of ECMAScript 5.1 features; consequently, you will need a system which supports this. Laboratory does not make use of features exclusive to ECMAScript 2015.

Laboratory requires basic support for XMLHttpRequest to communicate with a Mastodon server, and CustomEvent for its event handling. However, it does not require the CustomEvent() constructor as this is not available everywhere.

Given these requirements, the baseline browser compatability for Laboratory should be as seen in the table below:

Chrome Edge Firefox IE Opera Safari (Webkit)
6 Any 6 9 12.10 5.1

Certain aspects of the API have additional requirements. Laboratory will not attempt to polyfill these features but will take advantage of them if present.

  • Remembering authorization credentials between sessions requires access to localStorage()
  • Attachment.Request() requires support for FormData() and File()

If your system doesn't support these features, you should still be able to safely use the remaining parts of the API.

API Quick Reference

Current version: 0.4.0

Mastodon API Request
Initialization
Request
Client
/api/v1/apps Laboratory.Client.Request()
Authorization
/oauth/token, /api/v1/accounts/verify_credentials Laboratory.Authorization.Request()
Profile
/api/v1/accounts/:id, /api/v1/accounts/relationships Laboratory.Profile.Request()
/api/v1/accounts/follow, /api/v1/accounts/unfollow Laboratory.Profile.SetFollow()
/api/v1/accounts/block, /api/v1/accounts/unblock Laboratory.Profile.SetBlock()
/api/v1/accounts/mute, /api/v1/accounts/unmute Laboratory.Profile.SetMute()
/api/v1/follow_requests/authorize, /api/v1/follow_requests/reject Laboratory.Profile.LetFollow()
Rolodex
/api/v1/accounts/search, /api/v1/accounts/:id/followers, /api/v1/accounts/:id/following, /api/v1/statuses/:id/reblogged_by, /api/v1/statuses/:id/favourited_by, /api/v1/blocks, /api/v1/follow_requests Laboratory.Rolodex.Request()
Attachment
/api/v1/media Laboratory.Attachment.Request()
Post
/api/v1/statuses/:id Laboratory.Post.Request()
/api/v1/statuses Laboratory.Post.Create()
/api/v1/statuses/:id Laboratory.Post.Delete()
/api/v1/statuses/:id/reblog, /api/v1/statuses/:id/unreblog Laboratory.Post.SetReblog()
/api/v1/statuses/:id/favourite, /api/v1/statuses/:id/unfavourite Laboratory.Post.SetFavourite()
Timeline
/api/v1/timelines/home, /api/v1/timelines/public, /api/v1/timelines/tag/:hashtag, /api/v1/notifications/, /api/v1/favourites Laboratory.Timeline.Request()

Issue #5 : Support for conversations / post context is planned but not yet implemented.

Issue #7 : Support for /api/v1/instances is forthcoming.

Issue #17 : Support for notification clearing is under discussion.

Issue #47 : Support for /api/v1/follows is forthcoming.

Issue #59 : Support for reporting is forthcoming.

Issue #60 : Support for the new /api/v1/search API is forthcoming.

Issue #61 : Card support is forthcoming.

Extending Laboratory

Issue #55 : Documentation for Laboratory extensions is forthcoming.

Labcoat

Labcoat is a sample frontend built with Laboratory. Take a look if you want to see what this framework can do!