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

AuditLogStorage

Storage for audit logs with signatures chain

NotificationsStorage

BaseStorage

Typedefs

State : object

StateCondition : object

Token : object

Db : module:mongodb/lib/db

Db : module:mongodb/lib/db

Collection : module:mongodb/lib/collection

Db : module:mongodb/lib/db

TrackingEvent : object

User : object

Meta : object

LogEntry : object

JwtVerifier ⇒ Promise.<boolean>

JWT Verifier

AuditLogEntry : object

AuditLogCallback ⇒ Promise

Audit Log Callback

Target : Object

Subscribtion : Object

Campaign : object

Task : Object

Db : module:mongodb/lib/db

Collection : module:mongodb/lib/collection

StateStorage

Storage for chat states

Kind: global class

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

$3

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| mongoDb | mongodb.Db \| Object | | |
| collectionName | string | "states" | |
| [log] | Object | | console like logger |
| isCosmo | boolean | false | |

$3

Deprecated

Add custom indexing rule

Kind: instance method of StateStorage

| Param | Type |
| --- | --- |
| index | object |
| options | object |
| options.name | string |

$3

Kind: instance method of StateStorage

| Param | Type |
| --- | --- |
| senderId | string |
| pageId | string |

$3

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 |

$3

Kind: instance method of StateStorage

| Param | Type | Default |
| --- | --- | --- |
| condition | StateCondition | |
| limit | number | 20 |
| lastKey | string | null |

$3

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)>

$3

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

$3

Kind: instance property of BotTokenStorage

$3

Kind: instance method of BotTokenStorage

$3

Kind: instance method of BotTokenStorage

| Param | Type |
| --- | --- |
| token | string |

$3

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], [isCosmo], [secret])](#new_ChatLogStorage_new)
* [.getInteractions(senderId, pageId, [limit], [endAt], [startAt])](#ChatLogStorage+getInteractions) ⇒ Promise.<Array.<object>>
* [.log(senderId, responses, request, [metadata])](#ChatLogStorage+log) ⇒ Promise

$3

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| mongoDb | Db \| Object | | |
| collectionName | string | "chatlogs" | |
| [log] | Object | | console like logger |
| [isCosmo] | boolean | false | |
| [secret] | string \| Promise.<string> | null | |

$3

Interate history
all limits are inclusive

Kind: instance method of ChatLogStorage

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| senderId | string | | |
| pageId | string | | |
| [limit] | number | 10 | |
| [endAt] | number | | iterate backwards to history |
| [startAt] | number | | iterate forward to last interaction |

$3

Log single event

Kind: instance method of ChatLogStorage

| Param | Type | Description |
| --- | --- | --- |
| senderId | string | |
| responses | Array.<object> | list of sent responses |
| request | object | event request |
| [metadata] | object | request metadata |

BotConfigStorage

Storage for wingbot.ai conversation config

Kind: global class

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

$3

| Param | Type | Default |
| --- | --- | --- |
| mongoDb | Db \| Object | |
| collectionName | string | "botconfig" |

$3

Kind: instance property of BotConfigStorage

$3

Kind: instance method of BotConfigStorage

$3

Returns botUpdate API for wingbot

Kind: instance method of BotConfigStorage

| Param | Type | Description |
| --- | --- | --- |
| [onUpdate] | function | async update handler function |
| [acl] | function \| Array.<string> | acl configuration |

$3

Invalidates current configuration

Kind: instance method of BotConfigStorage

$3

Kind: instance method of BotConfigStorage

$3

Kind: instance method of BotConfigStorage

| Param | Type |
| --- | --- |
| newConfig | T |
| [id] | string |

$3

Kind: instance method of BotConfigStorage

| Param | Type |
| --- | --- |
| id | string |
| newConfig | object |

$3

Kind: instance method of BotConfigStorage

| Param | Type |
| --- | --- |
| [id] | string |

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

$3

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

$3

Kind: instance property of AttachmentCache

$3

Kind: instance method of AttachmentCache

$3

Kind: instance method of AttachmentCache

| Param | Type |
| --- | --- |
| url | string |

$3

Kind: instance method of AttachmentCache

| Param | Type |
| --- | --- |
| url | string |
| attachmentId | number |

AuditLogStorage

Storage for audit logs with signatures chain

Kind: global class

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

$3

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| mongoDb | Db \| Object | | |
| collectionName | string | "auditlog" | |
| [log] | Object | | console like logger |
| [isCosmo] | boolean | false | |
| [secret] | string \| Promise.<string> | null | |
| [jwtVerifier] | string \| Promise.<string> | null | |

$3

Kind: instance property of AuditLogStorage

$3

Kind: instance property of AuditLogStorage

$3

Add a log

Kind: instance method of AuditLogStorage

| Param | Type | Description |
| --- | --- | --- |
| event | TrackingEvent | |
| user | User | |
| [meta] | Meta | |
| [wid] | string | workspace ID |
| [type] | string | |
| [level] | string | |
| [date] | Date | |

$3

Kind: instance method of AuditLogStorage

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [wid] | string | | workspace id |
| [fromSeq] | number | 0 | for paging |
| [limit] | number | 40 | |

NotificationsStorage

Kind: global class

* NotificationsStorage
* [new NotificationsStorage(mongoDb, collectionsPrefix, [log], isCosmo)](#new_NotificationsStorage_new)
* ._collections : Map.<string, Promise.<mongodb.Collection>>
* ._getCollection(collectionName) ⇒ Promise.<mongodb.Collection>
* .pushTasks(tasks) ⇒ Promise.<Array.<Task>>
* [.getUnsuccessfulSubscribersByCampaign(campaignId, [sentWithoutReaction], [pageId])](#NotificationsStorage+getUnsuccessfulSubscribersByCampaign)
* .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])](#NotificationsStorage+upsertCampaign) ⇒ Promise.<Campaign>
* .removeCampaign(campaignId) ⇒ Promise
* .incrementCampaign(campaignId, increment) ⇒ Promise
* .updateCampaign(campaignId, data) ⇒ Promise.<(Campaign\|null)>
* [.popCampaign([now])](#NotificationsStorage+popCampaign) ⇒ Promise.<(Campaign\|null)>
* .getCampaignById(campaignId) ⇒ Promise.<(null\|Campaign)>
* .getCampaignByIds(campaignIds) ⇒ Promise.<Array.<Campaign>>
* [.getCampaigns(condition, [limit], [lastKey])](#NotificationsStorage+getCampaigns) ⇒ Promise.<{Array.<data:Campaign>, lastKey:string}>
* .subscribe(senderId, pageId, tag) ⇒ Promise
* [.unsubscribe(senderId, pageId, [tag])](#NotificationsStorage+unsubscribe) ⇒ Promise.<Array.<string>>
* [.getSubscribtionsCount(include, exclude, [pageId])](#NotificationsStorage+getSubscribtionsCount) ⇒ Promise.<number>
* [.getSubscribtions(include, exclude, limit, [pageId], lastKey)](#NotificationsStorage+getSubscribtions) ⇒ Promise.<{data: Array.<Target>, lastKey: string}>
* .getSenderSubscribtions(senderId, pageId) ⇒ Promise.<Array.<string>>

$3

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| mongoDb | mongodb.Db \| Object | | |
| collectionsPrefix | string | | |
| [log] | Object | | console like logger |
| isCosmo | boolean | false | |

$3

Kind: instance property of NotificationsStorage

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| collectionName | string |

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| tasks | object |

$3

Kind: instance method of NotificationsStorage

| Param | Type | Default |
| --- | --- | --- |
| campaignId | string | |
| [sentWithoutReaction] | boolean | false |
| [pageId] | string | null |

$3

Return Task By Id

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| taskId | string |

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| taskId | string |
| data | object |

$3

Get last sent task from campaign

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| pageId | string |
| senderId | string |
| campaignId | string |

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| pageId | string |
| senderId | string |
| checkCampaignIds | Array.<string> |

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| senderId | string |
| pageId | string |
| watermark | number |
| eventType | 'read' \| 'delivery' |
| ts | number |

$3

Kind: instance method of NotificationsStorage

| Param | Type | Default |
| --- | --- | --- |
| campaign | object | |
| [updateCampaign] | object | |

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| campaignId | string |

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| campaignId | string |
| increment | object |

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| campaignId | string |
| data | object |

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| [now] | number |

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| campaignId | string |

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| campaignIds | Array.<string> |

$3

Kind: instance method of NotificationsStorage

| Param | Type | Default |
| --- | --- | --- |
| condition | object | |
| [limit] | number | |
| [lastKey] | object | |

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| senderId | string |
| pageId | string |
| tag | string |

$3

Kind: instance method of NotificationsStorage

| Param | Type | Default |
| --- | --- | --- |
| senderId | string | |
| pageId | string | |
| [tag] | string | null |

$3

Kind: instance method of NotificationsStorage

| Param | Type | Default |
| --- | --- | --- |
| include | Array.<string> | |
| exclude | Array.<string> | |
| [pageId] | string | null |

$3

Kind: instance method of NotificationsStorage

| Param | Type | Default |
| --- | --- | --- |
| include | Array.<string> | |
| exclude | Array.<string> | |
| limit | number | |
| [pageId] | string | null |
| lastKey | \* | |

$3

Kind: instance method of NotificationsStorage

| Param | Type |
| --- | --- |
| senderId | string |
| pageId | string |

BaseStorage

Kind: global class

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

$3

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| mongoDb | Db \| Object | | |
| collectionName | string | | |
| [log] | Object | | console like logger |
| [isCosmo] | boolean | false | |

Example
``javascript
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'
});
}

}
``

$3

Kind: instance property of BaseStorage

$3

Insert defalt document to DB

Kind: instance method of BaseStorage

| Param | Type |
| --- | --- |
| ...objects | any |

$3

Add custom indexing rule

Kind: instance method of BaseStorage

| Param | Type |
| --- | --- |
| index | object |
| options | mongodb.IndexOptions |

$3

Returns the collection to operate with

Kind: instance method of BaseStorage

State : object

Kind: global typedef
Properties

| Name | Type |
| --- | --- |
| senderId | string |
| pageId | string |
| state | object |

StateCondition : object

Kind: global typedef
Properties

| Name | Type |
| --- | --- |
| [search] | string |

Token : object

Kind: global typedef
Properties

| Name | Type |
| --- | --- |
| senderId | string |
| pageId | string |
| token | string |

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

| Name | Type | Default |
| --- | --- | --- |
| [type] | string | "'audit'" |
| category | string | |
| action | string | |
| [label] | string | |
| [payload] | object | |

User : object

Kind: global typedef
Properties

| Name | Type | Description |
| --- | --- | --- |
| [id] | string | |
| [senderId] | string | |
| [pageId] | string | |
| [jwt] | string | jwt to check the authorship |

Meta : object

Kind: global typedef
Properties

| Name | Type | Description |
| --- | --- | --- |
| [ip] | string | |
| [ua] | string | |
| [ro] | string | referrer || origin |

LogEntry : object

Kind: global typedef
Properties

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| date | string | | ISO date |
| delta | number | | time skew in ms if there was a write conflict |
| [eventType] | string | "'audit'" | |
| category | string | | |
| action | string | | |
| [label] | string | | |
| [payload] | object | | |
| level | string | | (Critical|Important|Debug) |
| ok | boolean | | signature matches |
| seq | number | | sequence number |
| type | string | | (Error|Warn|Info) |
| user | User | | |
| wid | string | | workspace id |
| meta | Meta | | |

JwtVerifier ⇒ Promise.<boolean>

JWT Verifier

Kind: global typedef

| Param | Type |
| --- | --- |
| token | string |
| userId | string |
| [user] | User |

AuditLogEntry : object

Kind: global typedef
Properties

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| date | string | | ISO date |
| [eventType] | string | "'audit'" | |
| category | string | | |
| action | string | | |
| [label] | string | | |
| [payload] | object | | |
| level | string | | (Critical|Important|Debug) |
| type | string | | (Error|Warn|Info) |
| user | User | | |
| wid | string | | workspace id |
| meta | Meta | | |

AuditLogCallback ⇒ Promise

Audit Log Callback

Kind: global typedef

| Param | Type |
| --- | --- |
| entry | AuditLogEntry |

Target : Object

Kind: global typedef
Properties

| Name | Type |
| --- | --- |
| senderId | string |
| pageId | string |

Subscribtion : Object

Kind: global typedef
Properties

| Name | Type |
| --- | --- |
| senderId | string |
| pageId | string |
| subs | Array.<string> |

Campaign : object

Kind: global typedef
Properties

| Name | Type | Description |
| --- | --- | --- |
| id | string | |
| name | string | Tatgeting |
| include | Array.<string> | |
| exclude | Array.<string> | Stats |
| sent | number | |
| succeeded | number | |
| failed | number | |
| unsubscribed | number | |
| delivery | number | |
| read | number | |
| notSent | number | |
| leaved | number | |
| queued | number | Interaction |
| action | string | |
| [data] | object | Setup |
| sliding | boolean | |
| slide | number | |
| slideRound | number | |
| active | boolean | |
| in24hourWindow | boolean | |
| startAt | number | |

Task : Object

Kind: global typedef
Properties

| Name | Type | Description |
| --- | --- | --- |
| id | string | |
| pageId | string | |
| senderId | string | |
| campaignId | string | |
| enqueue | number | |
| [read] | number | |
| [delivery] | number | |
| [sent] | number | |
| [insEnqueue] | number | |
| [reaction] | boolean | user reacted |
| [leaved] | number | time the event was not sent because user left |

Db : module:mongodb/lib/db

Kind: global typedef

Collection : module:mongodb/lib/collection

Kind: global typedef