wingbot-dynamodb v3.3.1

DynamoDB plugin for wingbot

DynamoDB tables definition

All tables uses ${self:custom.prefix} to be able to use configuration on different bots and environments.

Conversation States and bot configuration

StatesTable:
    Type: AWS::DynamoDB::Table
    Properties:
    TableName: ${self:custom.prefix}-states
    AttributeDefinitions:
      - AttributeName: senderId
        AttributeType: S
      - AttributeName: pageId
        AttributeType: S
    KeySchema:
      - AttributeName: senderId
        KeyType: HASH
      - AttributeName: pageId
        KeyType: RANGE
    ProvisionedThroughput:
      ReadCapacityUnits: 1
      WriteCapacityUnits: 1

BotConfigTable:
    Type: AWS::DynamoDB::Table
    Properties:
    TableName: ${self:custom.prefix}-botconfig
    AttributeDefinitions:
      - AttributeName: k
        AttributeType: S
    KeySchema:
      - AttributeName: k
        KeyType: HASH
    ProvisionedThroughput:
      ReadCapacityUnits: 1
      WriteCapacityUnits: 1

Chat Logs (optional)

ChatlogTable:
    Type: AWS::DynamoDB::Table
    Properties:
    TableName: ${self:custom.prefix}-chatlog
    AttributeDefinitions:
      - AttributeName: userId
        AttributeType: S
      - AttributeName: timestamp
        AttributeType: N
    KeySchema:
      - AttributeName: userId
        KeyType: HASH
      - AttributeName: timestamp
        KeyType: RANGE
    ProvisionedThroughput:
      ReadCapacityUnits: 1
      WriteCapacityUnits: 1

Chatbot tokens (optional)

BottokensTable:
    Type: AWS::DynamoDB::Table
    Properties:
    TableName: ${self:custom.prefix}-bottokens
    AttributeDefinitions:
      - AttributeName: senderId
        AttributeType: S
      - AttributeName: token
        AttributeType: S
      - AttributeName: pageId
        AttributeType: S
    KeySchema:
      - AttributeName: senderId
        KeyType: HASH
      - AttributeName: pageId
        KeyType: RANGE
    GlobalSecondaryIndexes:
        - IndexName: token
        KeySchema:
            - AttributeName: token
            KeyType: HASH
        Projection:
            ProjectionType: ALL
        ProvisionedThroughput:
            ReadCapacityUnits: 1
            WriteCapacityUnits: 1
    ProvisionedThroughput:
        ReadCapacityUnits: 1
        WriteCapacityUnits: 1

Facebook Attachment cache (optional)

AttachmentsTable:
  Type: AWS::DynamoDB::Table
  Properties:
    TableName: ${self:custom.prefix}-attachments
    AttributeDefinitions:
      - AttributeName: url
        AttributeType: S
    KeySchema:
      - AttributeName: url
        KeyType: HASH
    ProvisionedThroughput:
      ReadCapacityUnits: 1
      WriteCapacityUnits: 1

API

Classes

Typedefs

StateStorage

Conversation state DynamoDB storage

Kind: global class

• StateStorage
  • new StateStorage([tableName], [dynamoDbService])
  • .getState(senderId, pageId) ⇒ Promise.<(State|null)>
  • .getOrCreateAndLock(senderId, pageId, [defaultState], [timeout]) ⇒ Promise.<Object>
  • .saveState(state) ⇒ Promise.<Object>

new StateStorage(tableName, dynamoDbService)

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

Kind: instance method of StateStorage

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

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

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

Kind: instance method of StateStorage

BotTokenStorage

Conversation DynamoDB state storage

Kind: global class

• BotTokenStorage
  • new BotTokenStorage([tableName], [tokensIndexName], [dynamoDbService])
  • .findByToken(token) ⇒ Promise.<(Token|null)>
  • .getOrCreateToken(senderId, pageId, customTokenFactory) ⇒ Promise.<(Token|null)>
  • ._getToken(senderId, pageId) ⇒ Promise.<({senderId:string, token:string}|null)>

new BotTokenStorage(tableName, tokensIndexName, dynamoDbService)

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

Kind: instance method of BotTokenStorage

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

Kind: instance method of BotTokenStorage

botTokenStorage._getToken(senderId, pageId) ⇒ Promise.<({senderId:string, token:string}|null)>

Kind: instance method of BotTokenStorage

ChatLogStorage

DynamoDB Chat Log storage

Kind: global class

• ChatLogStorage
  • new ChatLogStorage([tableName], [dynamoDbService], [log])
  • .log(userId, responses, request) ⇒ Promise

new ChatLogStorage(tableName, dynamoDbService, log)

chatLogStorage.log(userId, responses, request) ⇒ Promise

Log single event

Kind: instance method of ChatLogStorage

BotConfigStorage

Storage for wingbot.ai conversation config

Kind: global class

• BotConfigStorage
  • new BotConfigStorage([tableName], [dynamoDbService])
  • .api([onUpdate], [acl]) ⇒ Object
  • .invalidateConfig() ⇒ Promise
  • .getConfigTimestamp() ⇒ Promise.<number>
  • .updateConfig(newConfig) ⇒ Promise.<T>
  • .getConfig() ⇒ Promise.<(Object|null)>

new BotConfigStorage(tableName, dynamoDbService)

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

Kind: instance method of BotConfigStorage Template: T

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

Kind: instance method of BotConfigStorage

AttachmentCache

Storage for Facebook attachment ids

Kind: global class

• AttachmentCache
  • new AttachmentCache([tableName], [dynamoDbService])
  • .findAttachmentByUrl(url) ⇒ Promise.<(number|null)>
  • .saveAttachmentId(url, attachmentId) ⇒ Promise

new AttachmentCache(tableName, dynamoDbService)

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

Kind: instance method of AttachmentCache

attachmentCache.saveAttachmentId(url, attachmentId) ⇒ Promise

Kind: instance method of AttachmentCache

State : Object

Kind: global typedef Properties

Token : Object

Kind: global typedef Properties