Based on:
- http://jasnell.github.io/w3c-socialwg-activitystreams/activitystreams2.html
- http://jasnell.github.io/w3c-socialwg-activitystreams/activitystreams2-vocabulary.html
Includes experimental support for:
npm install activitystrea.ms
var as = require('activitystrea.ms');
// Create a simple object
as.object().
displayName('baz').
content('bar', 'en').
content('foo', 'fr').
publishedNow().
prettyWrite(function(err,doc) {
console.log(doc);
});Which produces the output:
{
"@context": "http://www.w3.org/ns/activitystreams#",
"@type": "Object",
"contentMap": {
"en": "bar",
"fr": "foo"
},
"displayName": "baz",
"published": "2015-07-17T00:50:09.889Z"
}// Create a simple activity
as.create().
actor('acct:sally@example.org').
object('http://www.example.org/post').
prettyWrite(function(err,doc) {
console.log(doc);
});Which produces the output:
{
"@context": "http://www.w3.org/ns/activitystreams#",
"@type": "Create",
"actor": "acct:sally@example.org",
"object": "http://www.example.org/post"
}The API uses a fluent factory pattern for creating AS objects. There are
factory methods for each of the main types of objects defined by the Activity
Streams 2.0 vocabulary. Each takes an optional array of types that will be set
on the object. If the [types] is unspecified, a default will be assigned
depending on the object being created. Each of the factory methods returns a
builder specific to the kind of object being generated. Once the object has
been built, call the get method to return the generated object.
as.object([types])as.actor([types])as.activity([types])as.collection([types])as.orderedCollection([types])as.content([types])as.link([types])as.accept([types])as.tentativeAccept([types])as.add([types])as.arrive([types])as.create([types])as.delete([types])as.favorite([types])as.follow([types])as.ignore([types])as.join([types])as.leave([types])as.like([types])as.offer([types])as.invite([types])as.reject([types])as.tentativeReject([types])as.remove([types])as.undo([types])as.update([types])as.experience([types])as.view([types])as.listen([types])as.read([types])as.respond([types])as.move([types])as.travel([types])as.announce([types])as.block([types])as.flag([types])as.dislike([types])as.application([types])as.content([types])as.group([types])as.person([types])as.process([types])as.service([types])as.article([types])as.album([types])as.folder([types])as.story([types])as.document([types])as.profile([types])as.audio([types])as.image([types])as.video([types])as.note([types])as.page([types])as.question([types])as.event([types])as.place([types])as.connection([types])as.mention([types])as.interval([types])as.interval.open([types])as.interval.closed([types])as.interval.openClosed([types])as.interval.closedOpen([types])as.interval.rightOpen([types])as.interval.leftClosed([types])as.interval.rightClosed([types])as.social.population([types])as.social.everyone([types])as.social.public([types])as.social.private([types])as.social.direct([types])as.social.common([types])as.social.interested([types])as.social.self([types])as.social.all([types])as.social.any([types])as.social.none([types])
The object returned by get is a read-only view of the Activity Stream object.
It will have property methods that are specific to the object's type. You can
export the built object as an ordinary Javascript object using the export
method. This will generate a JSON-LD compliant Javascript object.
var as = require('activitystrea.ms');
var note = as.note().
displayName('foo').
content('this is a simple note').
get();
console.log(note.displayName.valueOf());
console.log(note.content.valueOf());
console.log(note.type);var as = require('activitystrea.ms');
as.note().
displayName('foo').
content('this is a simple note').
get().
export(function (err, obj) {
// obj is an ordinary javascript object
console.log(obj['@type']);
console.log(obj['displayName']);
console.log(obj['content']);
});To serialize the Activity Streams object out as JSON, use the write or
prettyWrite methods.
var as = require('activitystrea.ms');
as.note().
displayName('foo').
content('this is a simple note').
write(function (err, doc) {
// doc is a string
console.log(doc);
});var as = require('activitystrea.ms');
as.note().
displayName('foo').
content('this is a simple note').
prettyWrite(function (err, doc) {
// doc is a string
console.log(doc);
});Note that The export, write, and prettyWrite methods are all async. You
MUST pass in a callback function. This is largely because of the JSON-LD
processing that's happening under the covers.