wingbot-mongodb v4.2.0

MongoDB plugin for wingbot.ai

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

API

Classes

Typedefs

StateStorage

Storage for chat states

Kind: global class

• StateStorage
  • new StateStorage(mongoDb, collectionName, [log], isCosmo)
  • .addCustomIndex(index, options)
  • .getState(senderId, pageId) ⇒ Promise.<(State|null)>
  • .getOrCreateAndLock(senderId, pageId, [defaultState], [timeout]) ⇒ Promise.<object>
  • .getStates(condition, limit, lastKey) ⇒ Promise.<{Array.<data:State>, lastKey:string}>
  • .saveState(state) ⇒ Promise.<object>

new StateStorage(mongoDb, collectionName, log, isCosmo)

stateStorage.addCustomIndex(index, options)

Deprecated

Add custom indexing rule

Kind: instance method of StateStorage

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

Kind: instance method of StateStorage

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

stateStorage.getStates(condition, limit, lastKey) ⇒ Promise.<{Array.<data:State>, lastKey:string}>

Kind: instance method of StateStorage

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

Save the state to database

Kind: instance method of StateStorage

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)

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

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

Kind: instance method of BotTokenStorage

ChatLogStorage

Storage for conversation logs

Kind: global class

• ChatLogStorage
  • new ChatLogStorage(mongoDb, collectionName, [log], [isCosmo], [secret])
  • .getInteractions(senderId, pageId, [limit], [endAt], [startAt]) ⇒ Promise.<Array.<object>>
  • .log(senderId, responses, request, [metadata]) ⇒ Promise

new ChatLogStorage(mongoDb, collectionName, log, isCosmo, secret)

chatLogStorage.getInteractions(senderId, pageId, limit, endAt, startAt) ⇒ Promise.<Array.<object>>

Interate history all limits are inclusive

Kind: instance method of ChatLogStorage

chatLogStorage.log(senderId, responses, request, metadata) ⇒ Promise

Log single event

Kind: instance method of ChatLogStorage

BotConfigStorage

Storage for wingbot.ai conversation config

Kind: global class

• BotConfigStorage
  • new BotConfigStorage(mongoDb, collectionName)
  • ._collection : Collection
  • ._getCollection() ⇒ Promise.<Collection>
  • .api([onUpdate], [acl]) ⇒ Object
  • .invalidateConfig() ⇒ Promise
  • .getConfigTimestamp() ⇒ Promise.<number>
  • .updateConfig(newConfig, [id]) ⇒ Promise.<T>
  • .setConfig(id, newConfig)
  • .getConfig([id]) ⇒ Promise.<(object|null)>

new BotConfigStorage(mongoDb, collectionName)

botConfigStorage._collection : Collection

Kind: instance property of BotConfigStorage

botConfigStorage._getCollection() ⇒ Promise.<Collection>

Kind: instance method of BotConfigStorage

botConfigStorage.api(onUpdate, acl) ⇒ Object

Returns botUpdate API for wingbot

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, id) ⇒ Promise.<T>

Kind: instance method of BotConfigStorage

botConfigStorage.setConfig(id, newConfig)

Kind: instance method of BotConfigStorage

botConfigStorage.getConfig(id) ⇒ 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)

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

attachmentCache.saveAttachmentId(url, attachmentId) ⇒ Promise

Kind: instance method of AttachmentCache

AuditLogStorage

Storage for audit logs with signatures chain

Kind: global class

• AuditLogStorage
  • new AuditLogStorage(mongoDb, collectionName, [log], [isCosmo], [secret], [jwtVerifier])
  • ._jwtVerify : JwtVerifier
  • .callback : AuditLogCallback
  • .log(event, user, [meta], [wid], [type], [level], [date]) ⇒ Promise
  • .list([wid], [fromSeq], [limit]) ⇒ Promise.<Array.<LogEntry>>

new AuditLogStorage(mongoDb, collectionName, log, isCosmo, secret, jwtVerifier)

auditLogStorage._jwtVerify : JwtVerifier

Kind: instance property of AuditLogStorage

auditLogStorage.callback : AuditLogCallback

Kind: instance property of AuditLogStorage

auditLogStorage.log(event, user, meta, wid, type, level, date) ⇒ Promise

Add a log

Kind: instance method of AuditLogStorage

auditLogStorage.list(wid, fromSeq, limit) ⇒ Promise.<Array.<LogEntry>>

Kind: instance method of AuditLogStorage

NotificationsStorage

Kind: global class

• NotificationsStorage
  • new NotificationsStorage(mongoDb, collectionsPrefix, [log], isCosmo)
  • ._collections : Map.<string, Promise.<mongodb.Collection>>
  • ._getCollection(collectionName) ⇒ Promise.<mongodb.Collection>
  • .pushTasks(tasks) ⇒ Promise.<Array.<Task>>
  • .getUnsuccessfulSubscribersByCampaign(campaignId, [sentWithoutReaction], [pageId])
  • .getTaskById(taskId) ⇒ Promise.<(Task|null)>
  • .updateTask(taskId, data)
  • .getSentTask(pageId, senderId, campaignId) ⇒ Promise.<(Task|null)>
  • .getSentCampagnIds(pageId, senderId, checkCampaignIds) ⇒ Promise.<Array.<string>>
  • .updateTasksByWatermark(senderId, pageId, watermark, eventType, ts) ⇒ Promise.<Array.<Task>>
  • .upsertCampaign(campaign, [updateCampaign]) ⇒ Promise.<Campaign>
  • .removeCampaign(campaignId) ⇒ Promise
  • .incrementCampaign(campaignId, increment) ⇒ Promise
  • .updateCampaign(campaignId, data) ⇒ Promise.<(Campaign|null)>
  • .popCampaign([now]) ⇒ Promise.<(Campaign|null)>
  • .getCampaignById(campaignId) ⇒ Promise.<(null|Campaign)>
  • .getCampaignByIds(campaignIds) ⇒ Promise.<Array.<Campaign>>
  • .getCampaigns(condition, [limit], [lastKey]) ⇒ Promise.<{Array.<data:Campaign>, lastKey:string}>
  • .subscribe(senderId, pageId, tag) ⇒ Promise
  • .unsubscribe(senderId, pageId, [tag]) ⇒ Promise.<Array.<string>>
  • .getSubscribtionsCount(include, exclude, [pageId]) ⇒ Promise.<number>
  • .getSubscribtions(include, exclude, limit, [pageId], lastKey) ⇒ Promise.<{data: Array.<Target>, lastKey: string}>
  • .getSenderSubscribtions(senderId, pageId) ⇒ Promise.<Array.<string>>

new NotificationsStorage(mongoDb, collectionsPrefix, log, isCosmo)

notificationsStorage._collections : Map.<string, Promise.<mongodb.Collection>>

Kind: instance property of NotificationsStorage

notificationsStorage._getCollection(collectionName) ⇒ Promise.<mongodb.Collection>

Kind: instance method of NotificationsStorage

notificationsStorage.pushTasks(tasks) ⇒ Promise.<Array.<Task>>

Kind: instance method of NotificationsStorage

notificationsStorage.getUnsuccessfulSubscribersByCampaign(campaignId, sentWithoutReaction, pageId)

Kind: instance method of NotificationsStorage

notificationsStorage.getTaskById(taskId) ⇒ Promise.<(Task|null)>

Return Task By Id

Kind: instance method of NotificationsStorage

notificationsStorage.updateTask(taskId, data)

Kind: instance method of NotificationsStorage

notificationsStorage.getSentTask(pageId, senderId, campaignId) ⇒ Promise.<(Task|null)>

Get last sent task from campaign

Kind: instance method of NotificationsStorage

notificationsStorage.getSentCampagnIds(pageId, senderId, checkCampaignIds) ⇒ Promise.<Array.<string>>

Kind: instance method of NotificationsStorage

notificationsStorage.updateTasksByWatermark(senderId, pageId, watermark, eventType, ts) ⇒ Promise.<Array.<Task>>

Kind: instance method of NotificationsStorage

notificationsStorage.upsertCampaign(campaign, updateCampaign) ⇒ Promise.<Campaign>

Kind: instance method of NotificationsStorage

notificationsStorage.removeCampaign(campaignId) ⇒ Promise

Kind: instance method of NotificationsStorage

notificationsStorage.incrementCampaign(campaignId, increment) ⇒ Promise

Kind: instance method of NotificationsStorage

notificationsStorage.updateCampaign(campaignId, data) ⇒ Promise.<(Campaign|null)>

Kind: instance method of NotificationsStorage

notificationsStorage.popCampaign(now) ⇒ Promise.<(Campaign|null)>

Kind: instance method of NotificationsStorage

notificationsStorage.getCampaignById(campaignId) ⇒ Promise.<(null|Campaign)>

Kind: instance method of NotificationsStorage

notificationsStorage.getCampaignByIds(campaignIds) ⇒ Promise.<Array.<Campaign>>

Kind: instance method of NotificationsStorage

notificationsStorage.getCampaigns(condition, limit, lastKey) ⇒ Promise.<{Array.<data:Campaign>, lastKey:string}>

Kind: instance method of NotificationsStorage

notificationsStorage.subscribe(senderId, pageId, tag) ⇒ Promise

Kind: instance method of NotificationsStorage

notificationsStorage.unsubscribe(senderId, pageId, tag) ⇒ Promise.<Array.<string>>

Kind: instance method of NotificationsStorage

notificationsStorage.getSubscribtionsCount(include, exclude, pageId) ⇒ Promise.<number>

Kind: instance method of NotificationsStorage

notificationsStorage.getSubscribtions(include, exclude, limit, pageId, lastKey) ⇒ Promise.<{data: Array.<Target>, lastKey: string}>

Kind: instance method of NotificationsStorage

notificationsStorage.getSenderSubscribtions(senderId, pageId) ⇒ Promise.<Array.<string>>

Kind: instance method of NotificationsStorage

BaseStorage

Kind: global class

• BaseStorage
  • new BaseStorage(mongoDb, collectionName, [log], [isCosmo])
  • ._collection : Collection | Promise.<Collection>
  • .addFixtureDoc(...objects)
  • .addIndex(index, options)
  • ._getCollection() ⇒ Promise.<Collection>

new BaseStorage(mongoDb, collectionName, log, isCosmo)

Example

const { BaseStorage } = require('winbot-mongodb');

class MyCoolDataStorage extends BaseStorage {

    constructor (mongoDb, collectionName = 'myCoolData', log = console, isCosmo = false) {
         super(mongoDb, collectionName, log, isCosmo);

         this.addIndex({
             foo: -1
         }, {
             name: 'foo_1'
         });

         this.addIndex({
             bar: -1,
             baz: 1
         }, {
             name: 'bar_-1_baz_1'
         });
    }

}

baseStorage._collection : Collection | Promise.<Collection>

Kind: instance property of BaseStorage

baseStorage.addFixtureDoc(...objects)

Insert defalt document to DB

Kind: instance method of BaseStorage

baseStorage.addIndex(index, options)

Add custom indexing rule

Kind: instance method of BaseStorage

baseStorage._getCollection() ⇒ Promise.<Collection>

Returns the collection to operate with

Kind: instance method of BaseStorage

State : object

Kind: global typedef
Properties

StateCondition : object

Kind: global typedef
Properties

Token : object

Kind: global typedef
Properties

Db : module:mongodb/lib/db

Kind: global typedef

Db : module:mongodb/lib/db

Kind: global typedef

Collection : module:mongodb/lib/collection

Kind: global typedef

Db : module:mongodb/lib/db

Kind: global typedef

TrackingEvent : object

Kind: global typedef
Properties

User : object

Kind: global typedef
Properties

Meta : object

Kind: global typedef
Properties

LogEntry : object

Kind: global typedef
Properties

JwtVerifier ⇒ Promise.<boolean>

JWT Verifier

Kind: global typedef

AuditLogEntry : object

Kind: global typedef
Properties

AuditLogCallback ⇒ Promise

Audit Log Callback

Kind: global typedef

Target : Object

Kind: global typedef
Properties

Subscribtion : Object

Kind: global typedef
Properties

Campaign : object

Kind: global typedef
Properties

Task : Object

Kind: global typedef
Properties

Db : module:mongodb/lib/db

Kind: global typedef

Collection : module:mongodb/lib/collection

Kind: global typedef