wingbot-mongodb

MongoDB plugin for wingbot.ai

Contains storage for tokens, chat states, bot config and chat logs.

---

API

Classes

StateStorage

Storage for chat states

BotTokenStorage

Storage for webview tokens

ChatLogStorage

Storage for conversation logs

BotConfigStorage

Storage for wingbot.ai conversation config

AttachmentCache

Cache storage for Facebook attachments

Typedefs

State : Object

Token : Object

StateStorage

Storage for chat states

Kind: global class

• StateStorage
  • new StateStorage(mongoDb, collectionName)
  • ._collection : mongodb.Collection
  • ._getCollection() ⇒ Promise.<mongodb.Collection>
  • .getState(senderId, pageId) ⇒ Promise.<(State|null)>
  • .getOrCreateAndLock(senderId, pageId, [defaultState], [timeout]) ⇒ Promise.<Object>
  • .saveState(state) ⇒ Promise.<Object>

new StateStorage(mongoDb, collectionName)

Param	Type	Default
mongoDb	mongodb.Db | Object
collectionName	string	"states"

stateStorage._collection : mongodb.Collection

Kind: instance property of StateStorage

stateStorage._getCollection() ⇒ Promise.<mongodb.Collection>

Kind: instance method of StateStorage

stateStorage.getState(senderId, pageId) ⇒ Promise.<(State|null)>

Kind: instance method of StateStorage

Param	Type
senderId	string
pageId	string

stateStorage.getOrCreateAndLock(senderId, pageId, [defaultState], [timeout]) ⇒ Promise.<Object>

Load state from database and lock it to prevent another reads

Kind: instance method of StateStorage
Returns: Promise.<Object> - - conversation state

Param	Type	Default	Description
senderId	string		sender identifier
pageId	string		page identifier
[defaultState]	Object		default state of the conversation
[timeout]	number	300	given default state

stateStorage.saveState(state) ⇒ Promise.<Object>

Save the state to database

Kind: instance method of StateStorage

Param	Type	Description
state	Object	conversation state

BotTokenStorage

Storage for webview tokens

Kind: global class

• BotTokenStorage
  • new BotTokenStorage(mongoDb, collectionName)
  • ._collection : mongodb.Collection
  • ._getCollection() ⇒ Promise.<mongodb.Collection>
  • .findByToken(token) ⇒ Promise.<(Token|null)>
  • .getOrCreateToken(senderId, pageId, createToken) ⇒ Promise.<(Token|null)>

new BotTokenStorage(mongoDb, collectionName)

Param	Type	Default
mongoDb	mongodb.Db | Object
collectionName	string	"tokens"

botTokenStorage._collection : mongodb.Collection

Kind: instance property of BotTokenStorage

botTokenStorage._getCollection() ⇒ Promise.<mongodb.Collection>

Kind: instance method of BotTokenStorage

botTokenStorage.findByToken(token) ⇒ Promise.<(Token|null)>

Kind: instance method of BotTokenStorage

Param	Type
token	string

botTokenStorage.getOrCreateToken(senderId, pageId, createToken) ⇒ Promise.<(Token|null)>

Kind: instance method of BotTokenStorage

Param	Type
senderId	string
pageId	string
createToken	Object

ChatLogStorage

Storage for conversation logs

Kind: global class

• ChatLogStorage
  • new ChatLogStorage(mongoDb, collectionName, [log])
  • ._collection : mongodb.Collection
  • ._getCollection() ⇒ Promise.<mongodb.Collection>
  • .log(senderId, responses, request)

new ChatLogStorage(mongoDb, collectionName, [log])

Param	Type	Default	Description
mongoDb	mongodb.Db | Object
collectionName	string	"chatlogs"
[log]	Object		console like logger

chatLogStorage._collection : mongodb.Collection

Kind: instance property of ChatLogStorage

chatLogStorage._getCollection() ⇒ Promise.<mongodb.Collection>

Kind: instance method of ChatLogStorage

chatLogStorage.log(senderId, responses, request)

Log single event

Kind: instance method of ChatLogStorage

Param	Type	Description
senderId	string
responses	Array.<Object>	list of sent responses
request	Object	event request

BotConfigStorage

Storage for wingbot.ai conversation config

Kind: global class

• BotConfigStorage
  • new BotConfigStorage(mongoDb, collectionName)
  • ._collection : mongodb.Collection
  • ._getCollection() ⇒ Promise.<mongodb.Collection>
  • .invalidateConfig() ⇒ Promise
  • .getConfigTimestamp() ⇒ Promise.<number>
  • .updateConfig(newConfig) ⇒ Promise.<T>
  • .getConfig() ⇒ Promise.<(Object|null)>

new BotConfigStorage(mongoDb, collectionName)

Param	Type	Default
mongoDb	mongodb.Db | Object
collectionName	string	"botconfig"

botConfigStorage._collection : mongodb.Collection

Kind: instance property of BotConfigStorage

botConfigStorage._getCollection() ⇒ Promise.<mongodb.Collection>

Kind: instance method of BotConfigStorage

botConfigStorage.invalidateConfig() ⇒ Promise

Invalidates current configuration

Kind: instance method of BotConfigStorage

botConfigStorage.getConfigTimestamp() ⇒ Promise.<number>

Kind: instance method of BotConfigStorage

botConfigStorage.updateConfig(newConfig) ⇒ Promise.<T>

Kind: instance method of BotConfigStorage
Template: T

Param	Type
newConfig	T

botConfigStorage.getConfig() ⇒ Promise.<(Object|null)>

Kind: instance method of BotConfigStorage

AttachmentCache

Cache storage for Facebook attachments

Kind: global class

• AttachmentCache
  • new AttachmentCache(mongoDb, collectionName)
  • ._collection : mongodb.Collection
  • ._getCollection() ⇒ Promise.<mongodb.Collection>
  • .findAttachmentByUrl(url) ⇒ Promise.<(number|null)>
  • .saveAttachmentId(url, attachmentId) ⇒ Promise

new AttachmentCache(mongoDb, collectionName)

Param	Type	Default
mongoDb	mongodb.Db | Object
collectionName	string	"attachments"

attachmentCache._collection : mongodb.Collection

Kind: instance property of AttachmentCache

attachmentCache._getCollection() ⇒ Promise.<mongodb.Collection>

Kind: instance method of AttachmentCache

attachmentCache.findAttachmentByUrl(url) ⇒ Promise.<(number|null)>

Kind: instance method of AttachmentCache

Param	Type
url	string

attachmentCache.saveAttachmentId(url, attachmentId) ⇒ Promise

Kind: instance method of AttachmentCache

Param	Type
url	string
attachmentId	number

State : Object

Kind: global typedef
Properties

Name	Type
senderId	string
pageId	string
state	Object

Token : Object

Kind: global typedef
Properties

Name	Type
senderId	string
pageId	string
token	string