@mainframe/bot-sdk/types.js

// @flow

export type Config = {|
  +mainframe_secret: string,
  +mainframe_url: string,
  +port: number,
|}

export type ClientContext = {|
  +user: {
    +id: string,
    +username: string,
    +name: string,
  },
  +conversation?: {
    +id: string,
    +subject: ?string,
    +type: 'bot' | 'direct' | 'default' | 'space',
  },
  +organization?: {
    +id: string,
    +username: string,
    +name: string,
  },
  +subscription?: {
    +id?: string,
    +token: string,
  },
|}

export type PostPayload = {|
  +user_id: string,
  +data: Object,
  +context: ClientContext,
|}

type SendMessagePayload = {
  conversation_id: string,
  message?: string,
  data?: Object,
}

type SubscriptionResponse = {
  subscription_id: string,
}

export type BotContext = {|
  +config: Config,
  +callMainframe: (endpoint: string, data?: Object) => Promise<void | Object>,
  +sendMessage: (payload: SendMessagePayload) => Promise<void>,
  +setupSubscription: (payload: {
    subscription_token: string,
    label: string,
  }) => Promise<SubscriptionResponse>,
  +editSubscription: (payload: {
    subscription_token: string,
    label?: string,
  }) => Promise<SubscriptionResponse>,
|}

export type BotResponse = {|
  success: boolean,
  message?: string,
  data?: Object,
|}

export type Handlers = {|
  +enable?: (payload: { user_id: string }, context: BotContext) => void,
  +disable?: (payload: { user_id: string }, context: BotContext) => void,
  +conversation_added?: (
    payload: {
      user_id: string,
      conversation_id: string,
    },
    context: BotContext,
  ) => void,
  +conversation_removed?: (
    payload: {
      user_id: string,
      conversation_id: string,
    },
    context: BotContext,
  ) => void,
  +edit_subscription?: (
    payload: {
      user_id: string,
      conversation_id: string,
      subscription_id: string,
    },
    context: BotContext,
  ) => void,
  +delete_subscription?: (
    payload: { subscription_id: string },
    context: BotContext,
  ) => void,
  +post?: (
    payload: PostPayload,
    context: BotContext,
  ) => BotResponse | Promise<BotResponse>,
|}