diff --git a/README.md b/README.md
index b4b960f8..4048ee22 100644
--- a/README.md
+++ b/README.md
@@ -853,7 +853,7 @@ Please use **box.openSpace** to get the instance of this class
| Name | Type | Description |
| --- | --- | --- |
-| syncDone | Promise | A promise that is resolved when the box is synced |
+| syncDone | Promise | A promise that is resolved when the space data is synced |
String | DID of first moderator of a thread, by default, user is first moderator |
| opts.members | Boolean | join a members only thread, which only members can post in, defaults to open thread |
| opts.noAutoSub | Boolean | Disable auto subscription to the thread when posting to it (default false) |
+| opts.ghost | Boolean | Enable ephemeral messaging via Ghost Thread |
+| opts.ghostBacklogLimit | Number | The number of posts to maintain in the ghost backlog |
Threads:
Members Only Thread
Ghost ?
+ Join thread
diff --git a/example/index.js b/example/index.js
index 730c1bba..64e7fc7a 100644
--- a/example/index.js
+++ b/example/index.js
@@ -100,10 +100,15 @@ bopen.addEventListener('click', event => {
const name = threadName.value
const firstModerator = threadfirstModerator.value
const membersBool = members.checked
+ const ghostBool = ghostCheck.checked
+ console.log('ghost?', ghostBool);
posts.style.display = 'block'
threadModeration.style.display = 'block'
if (members.checked) threadMembers.style.display = 'block'
- box.spaces[window.currentSpace].joinThread(name, {firstModerator, members: membersBool}).then(thread => {
+ if (ghostCheck.checked) {
+ addThreadMod.disabled = true
+ }
+ box.spaces[window.currentSpace].joinThread(name, {firstModerator, members: membersBool, ghost: ghostBool}).then(thread => {
window.currentThread = thread
thread.onUpdate(() => {
updateThreadData()
@@ -111,8 +116,10 @@ bopen.addEventListener('click', event => {
thread.onNewCapabilities(() => {
updateThreadCapabilities()
})
- updateThreadData()
- updateThreadCapabilities()
+ if (window.currentThread._room == undefined) {
+ updateThreadData()
+ updateThreadCapabilities()
+ }
}).catch(updateThreadError)
})
@@ -153,19 +160,28 @@ bopen.addEventListener('click', event => {
const updateThreadCapabilities = () => {
threadMemberList.innerHTML = ''
- if (window.currentThread._members) {
+ // if else statement cause ghost thread can't list moderators
+ if (window.currentThread._peerId) {
window.currentThread.listMembers().then(members => {
members.map(member => {
threadMemberList.innerHTML += member + '} users online
+ */
+ async listMembers () {
+ return Object.keys(this._members).filter(id => !id.startsWith('Qm'))
+ }
+
+ /**
+ * Get a peerId's corresponding 3ID
+ *
+ * @param {String} did The DID of the user
+ * @return {String} ipfs peer id
+ */
+ _threeIdToPeerId (did) {
+ return this._members[did]
+ }
+
+ /**
+ * Get backlog of all past messages
+ *
+ * @return {Array} users online
+ */
+ async getPosts (num = this._backlogLimit) {
+ const posts = [...this._backlog]
+ .map(msg => JSON.parse(msg))
+ .sort((p1, p2) => p1.timestamp - p2.timestamp)
+ .slice(-num)
+
+ const stringifiedPosts = posts.map(msg => JSON.stringify(msg))
+ this._backlog = new Set(stringifiedPosts)
+
+ return posts
+ }
+
+ /**
+ * Announce entry in chat and share our 3id and peerID
+ *
+ * @param {String} to The PeerID of a user (optional)
+ */
+ async _announce (to) {
+ !to ? await this._broadcast({ type: 'join' })
+ : await this._sendDirect({ type: 'join' }, to)
+ }
+
+ /**
+ * Post a message to the thread
+ *
+ * @param {Object} message The message
+ * @param {String} to PeerID to send the message to (optional)
+ */
+ async post (message, to) {
+ !to ? await this._broadcast({ type: 'chat', message })
+ : await this._sendDirect({ type: 'chat', message }, to)
+ }
+
+ async deletePost (hash) {
+ throw new Error('Not possible to delete post in Ghost Thread')
+ }
+
+ async addModerator (id) {
+ throw new Error('Not possible to add moderator in Ghost Thread')
+ }
+
+ async listModerators () {
+ throw new Error('Not possible to list moderators in Ghost Thread')
+ }
+
+ async addMember (id) {
+ throw new Error('Not possible to add member in Ghost Thread')
+ }
+
+ /**
+ * Request a backlog of past messages from peers in the chat
+ *
+ * @param {String} to The PeerID of a user (optional)
+ */
+ async _requestBacklog (to) {
+ !to ? await this._broadcast({ type: 'request_backlog' })
+ : await this._sendDirect({ type: 'request_backlog' }, to)
+ }
+
+ /**
+ * Leave the chat
+ *
+ */
+ async close () {
+ await this._room.leave()
+ }
+
+ /**
+ * Broadcast a message to peers in the room
+ *
+ * @param {Object} message The message
+ */
+ async _broadcast (message) {
+ const jwt = await this._3id.signJWT(message, { use3ID: true })
+ this._room.broadcast(jwt)
+ }
+
+ /**
+ * Send a direct message to a peer
+ *
+ * @param {Object} message The message
+ * @param {String} to The PeerID or 3ID of the receiver
+ */
+ async _sendDirect (message, to) {
+ const jwt = await this._3id.signJWT(message, { use3ID: true })
+ to.startsWith('Qm') ? this._room.sendTo(to, jwt)
+ : this._room.sendTo(this._threeIdToPeerId(to), jwt)
+ }
+
+ /**
+ * Register a function to be called after new updates
+ * have been received from the network or locally.
+ *
+ * @param {Function} updateFn The function that will get called
+ */
+ onUpdate (updateFn) {
+ this.removeAllListeners('message')
+ this.removeAllListeners('backlog-received')
+ this.on('message', updateFn)
+ this.on('backlog-received', updateFn)
+ }
+
+ /**
+ * Register a function to be called after new capabilities
+ * have been received from the network or locally.
+ *
+ * @param {Function} updateFn The function that will get called
+ */
+ onNewCapabilities (updateFn) {
+ this.removeAllListeners('user-joined')
+ this.removeAllListeners('user-left')
+ this.on('user-joined', updateFn)
+ this.on('user-left', updateFn)
+ }
+
+ /**
+ * Handler function for users joining
+ *
+ * @param {String} did The DID of the user
+ * @param {Object} peerID The peerID of the user
+ */
+ async _userJoined (did, peerID) {
+ const members = await this.listMembers()
+ if (!members.includes(did) && this._3id.DID !== did) {
+ this._members[did] = peerID
+ this._members[peerID] = did
+ this.emit('user-joined', 'joined', did, peerID)
+ }
+ }
+
+ /**
+ * Handler function for users leaving
+ *
+ * @param {String} peerID The peerID of the user
+ */
+ async _userLeft (peerID) {
+ const did = this._members[peerID]
+ delete this._members[did]
+ delete this._members[peerID]
+ this.emit('user-left', 'left', did, peerID)
+ }
+
+ /**
+ * Handler function for received messages
+ *
+ * @param {String} issuer The issuer of the message
+ * @param {Object} payload The payload of the message
+ */
+ async _messageReceived (payload) {
+ const { type, message, iss: author, iat: timestamp } = payload
+ this._backlog.add(JSON.stringify({ type, author, message, timestamp }))
+ this.emit('message', { type, author, message, timestamp })
+ }
+
+ /**
+ * Verifies the data received
+ *
+ * @param {Buffer} data A buffer of the jwt
+ * @return {JWT} A verified JWT with our payload and issuer
+ */
+ async _verifyData (data) {
+ const jwt = data.toString()
+ try {
+ return await verifyJWT(jwt)
+ } catch (e) {
+ console.log(e)
+ }
+ }
+}
+
+module.exports = GhostThread
diff --git a/src/keyValueStore.js b/src/keyValueStore.js
index 8f7ee4a4..7f3fceee 100644
--- a/src/keyValueStore.js
+++ b/src/keyValueStore.js
@@ -204,10 +204,12 @@ class KeyValueStore {
*/
async log () {
return this._db._oplog.values.map(obj => {
- return { op: obj.payload.op,
+ return {
+ op: obj.payload.op,
key: obj.payload.key,
value: obj.payload.value ? obj.payload.value.value : null,
- timeStamp: obj.payload.value ? obj.payload.value.timeStamp : null }
+ timeStamp: obj.payload.value ? obj.payload.value.timeStamp : null
+ }
})
}
}
diff --git a/src/space.js b/src/space.js
index 5bdeaeaa..d4f4c441 100644
--- a/src/space.js
+++ b/src/space.js
@@ -1,10 +1,12 @@
const KeyValueStore = require('./keyValueStore')
const Thread = require('./thread')
+const GhostThread = require('./ghost')
const { throwIfUndefined, throwIfNotEqualLenArrays } = require('./utils')
const OrbitDBAddress = require('orbit-db/src/orbit-db-address')
const nameToSpaceName = name => `3box.space.${name}.keyvalue`
const namesTothreadName = (spaceName, threadName) => `3box.thread.${spaceName}.${threadName}`
+const namesToChatName = (spaceName, chatName) => `3box.ghost.${spaceName}.${chatName}`
class Space {
/**
@@ -25,7 +27,7 @@ class Space {
*/
this.private = null
/**
- * @property {Promise} syncDone A promise that is resolved when the box is synced
+ * @property {Promise} syncDone A promise that is resolved when the space data is synced
*/
this.syncDone = null
}
@@ -65,18 +67,28 @@ class Space {
* @param {String} opts.firstModerator DID of first moderator of a thread, by default, user is first moderator
* @param {Boolean} opts.members join a members only thread, which only members can post in, defaults to open thread
* @param {Boolean} opts.noAutoSub Disable auto subscription to the thread when posting to it (default false)
+ * @param {Boolean} opts.ghost Enable ephemeral messaging via Ghost Thread
+ * @param {Number} opts.ghostBacklogLimit The number of posts to maintain in the ghost backlog
*
- * @return {Thread} An instance of the thread class for the joined thread
+ * @return {Thread} An instance of the thread class for the joined thread
*/
async joinThread (name, opts = {}) {
- const subscribeFn = opts.noAutoSub ? () => {} : this.subscribeThread.bind(this)
- if (!opts.firstModerator) opts.firstModerator = this._3id.getSubDID(this._name)
- const thread = new Thread(namesTothreadName(this._name, name), this._replicator, this._3id, opts.members, opts.firstModerator, subscribeFn)
- const address = await thread._getThreadAddress()
- if (this._activeThreads[address]) return this._activeThreads[address]
- await thread._load()
- this._activeThreads[address] = thread
- return thread
+ if (opts.ghost) {
+ const ghostAddress = namesToChatName(this._name, name)
+ if (!this._activeThreads[ghostAddress]) {
+ this._activeThreads[ghostAddress] = new GhostThread(ghostAddress, this._replicator, this._3id, opts)
+ }
+ return this._activeThreads[ghostAddress]
+ } else {
+ const subscribeFn = opts.noAutoSub ? () => {} : this.subscribeThread.bind(this)
+ if (!opts.firstModerator) opts.firstModerator = this._3id.getSubDID(this._name)
+ const thread = new Thread(namesTothreadName(this._name, name), this._replicator, this._3id, opts.members, opts.firstModerator, subscribeFn)
+ const address = await thread._getThreadAddress()
+ if (this._activeThreads[address]) return this._activeThreads[address]
+ await thread._load()
+ this._activeThreads[address] = thread
+ return thread
+ }
}
/**
diff --git a/src/thread.js b/src/thread.js
index c0103ed9..86a901a4 100644
--- a/src/thread.js
+++ b/src/thread.js
@@ -78,7 +78,7 @@ class Thread {
*/
async listModerators () {
this._requireLoad()
- return this._db.access.capabilities['moderators']
+ return this._db.access.capabilities.moderators
}
/**
@@ -105,7 +105,7 @@ class Thread {
async listMembers () {
this._throwIfNotMembers()
this._requireLoad()
- return this._db.access.capabilities['members']
+ return this._db.access.capabilities.members
}
_throwIfNotMembers () {