bots: SimpleX Calculator demo bot (#7583)

* bots: SimpleX Calculator demo bot

* refactor

* use local server in test

* simplify

* icon

* simplify

* expression

* replies

* improve

* log

* update name in bot address

* @simplex-chat/type: 0.12.0

* simplex-chat nodejs: 7.1.0-beta.4.2

* update dependencies

* option to add domain to bot address

---------

Co-authored-by: Evgeny @ SimpleX Chat <259188159+evgeny-simplex@users.noreply.github.com>

packages/simplex-chat-nodejs/src/api.ts

@@ -47,7 +47,7 @@ export const defaultBotAddressSettings: BotAddressSettings = {
   businessAddress: false
 }
 
-export type EventSubscriberFunc<K extends CEvt.Tag> = (event: ChatEvent & {type: K}) => void | Promise<void>
+export type EventSubscriberFunc<K extends CEvt.Tag> = (event: ChatEvent & {type: K}, chat: ChatApi) => void | Promise<void>
 
 export type EventSubscribers = {[K in CEvt.Tag]?: EventSubscriberFunc<K>}
 
@@ -177,7 +177,7 @@ export class ChatApi {
         if (subs) {
           for (const {subscriber, once} of [...subs]) {
             try {
-              const p = (subscriber as EventSubscriberFunc<typeof event.type>)(event)
+              const p = (subscriber as EventSubscriberFunc<typeof event.type>)(event, this)
               if (p instanceof Promise) await p
             } catch(e) {
               console.log(`${event.type} event processing error`, e)
@@ -187,7 +187,7 @@ export class ChatApi {
         }
         for (const r of [...this.receivers]) {          
           try {
-            const p = r(event)
+            const p = r(event, this)
             if (p instanceof Promise) await p
           } catch(e) {
             console.log(`${event.type} event processing error`, e)
@@ -422,7 +422,18 @@ export class ChatApi {
     const r = await this.sendChatCmd(CC.APISetAddressSettings.cmdString({userId, settings}))
     if (r.type !== "userContactLinkUpdated") {
       throw new ChatCommandError("error changing user contact address settings", r)
-    }  
+    }
+  }
+
+  async apiSetUserDomain(userId: number, simplexDomain?: string): Promise<T.User> {
+    const r = await this.sendChatCmd(CC.APISetUserDomain.cmdString({userId, simplexDomain}))
+    switch (r.type) {
+      case "userProfileUpdated":
+      case "userProfileNoChange":
+        return r.user
+      default:
+        throw new ChatCommandError("error setting SimpleX name", r)
+    }
   }
 
   /**

packages/simplex-chat-nodejs/src/bot.ts

@@ -35,17 +35,18 @@ const defaultOpts: Required<BotOptions> = {
 
 export interface BotConfig {
   profile: T.Profile,
+  simplexDomain?: string | null,
   dbOpts: BotDbOpts,
   options: BotOptions,
-  onMessage?: (chatItem: T.AChatItem, content: T.MsgContent) => void | Promise<void>,
+  onMessage?: (chatItem: T.AChatItem, content: T.MsgContent, chat: api.ChatApi) => void | Promise<void>,
   // command handlers can be different from commands to be shown in client UI
-  onCommands?: {[K in string]?: ((chatItem: T.AChatItem, command: util.BotCommand) => void | Promise<void>)},
+  onCommands?: {[K in string]?: ((chatItem: T.AChatItem, command: util.BotCommand, chat: api.ChatApi) => void | Promise<void>)},
   // If you use `onMessage` and to subscribe "newChatItems" event, exclude content messages from processing
   // If you use `onCommands` and to subscribe "newChatItems" event, exclude commands from processing
   events?: api.EventSubscribers
 }
 
-export async function run({profile, dbOpts, options = defaultOpts, onMessage, onCommands = {}, events = {}}: BotConfig): Promise<[api.ChatApi, T.User, T.UserContactLink | undefined]> {
+export async function run({profile, simplexDomain, dbOpts, options = defaultOpts, onMessage, onCommands = {}, events = {}}: BotConfig): Promise<[api.ChatApi, T.User, T.UserContactLink | undefined]> {
   const bot = await api.ChatApi.init(dbOpts, dbOpts.confirmMigrations || core.MigrationConfirmation.YesUp, dbOpts.queueSize)
   const opts = fullOptions(options)
   if (onMessage || Object.keys(onCommands).length > 0) subscribeChatItems(bot, onMessage, onCommands)
@@ -60,7 +61,8 @@ export async function run({profile, dbOpts, options = defaultOpts, onMessage, on
     console.log(`Bot address: ${addressLink}`)
     if (opts.useBotProfile) botProfile.contactLink = addressLink
   }
-  await updateBotUserProfile(bot, user, botProfile, opts)  
+  const namedUser = await updateBotSimplexDomain(bot, user, simplexDomain, opts)
+  await updateBotUserProfile(bot, namedUser, botProfile, opts)
   return [bot, user, address]
 }
 
@@ -107,8 +109,8 @@ function mkBotProfile(profile: T.Profile, opts: Required<BotOptions>): T.Profile
 
 export function subscribeChatItems(
   bot: api.ChatApi,
-  onMessage: ((chatItem: T.AChatItem, content: T.MsgContent) => void | Promise<void>) | undefined,
-  commands: {[K in string]?: ((chatItem: T.AChatItem, command: util.BotCommand) => void | Promise<void>)}
+  onMessage: ((chatItem: T.AChatItem, content: T.MsgContent, chat: api.ChatApi) => void | Promise<void>) | undefined,
+  commands: {[K in string]?: ((chatItem: T.AChatItem, command: util.BotCommand, chat: api.ChatApi) => void | Promise<void>)}
 ) {
   bot.on("newChatItems", async ({chatItems}) => {
     for (const ci of chatItems) {
@@ -117,8 +119,8 @@ export function subscribeChatItems(
       const cmd = util.ciBotCommand(ci.chatItem)
       const cmdFunc = cmd && (commands[cmd.keyword] || commands[""])
       try {
-        if (cmd && cmdFunc) await cmdFunc(ci, cmd)
-        else if (onMessage) await onMessage(ci, content.msgContent)
+        if (cmd && cmdFunc) await cmdFunc(ci, cmd, bot)
+        else if (onMessage) await onMessage(ci, content.msgContent, bot)
       } catch (e) {
         console.log(cmd && cmdFunc ? `${cmd.keyword} command processing error` : "message processing error", e)
       }
@@ -180,15 +182,33 @@ async function createOrUpdateAddress(bot: api.ChatApi, user: T.User, opts: Requi
     }
   }
   
-  return address    
+  return address
+}
+
+async function updateBotSimplexDomain(bot: api.ChatApi, user: T.User, simplexDomain: string | null | undefined, opts: Required<BotOptions>): Promise<T.User> {
+  if (simplexDomain === undefined) return user
+  const domain = simplexDomain === null ? undefined : simplexDomain.toLowerCase()
+  if (user.profile.contactDomain?.domain === domain) return user
+  if (!opts.updateAddress) {
+    console.log("Bot SimpleX name changed")
+    return user
+  }
+  console.log("Bot SimpleX name changed, updating...")
+  try {
+    return await bot.apiSetUserDomain(user.userId, domain)
+  } catch (e) {
+    console.log("Error updating bot SimpleX name", e)
+    return user
+  }
 }
 
 async function updateBotUserProfile(bot: api.ChatApi, user: T.User, profile: T.Profile, opts: Required<BotOptions>): Promise<void> {
   const {userId} = user
-  if (!equal(util.fromLocalProfile(user.profile), profile)) {
+  const {contactDomain, ...currentProfile} = util.fromLocalProfile(user.profile)
+  if (!equal(currentProfile, profile)) {
     if (opts.updateProfile) {
       console.log("Bot profile changed, updating...")
-      const summary = await bot.apiUpdateProfile(userId, profile)
+      const summary = await bot.apiUpdateProfile(userId, {...profile, contactDomain})
       console.log(
         summary
         ? `Bot profile updated: ${summary.updateSuccesses} updated contact(s), ${summary.updateFailures} failed contact update(s).`

packages/simplex-chat-nodejs/src/util.ts

@@ -53,8 +53,8 @@ export function botAddressSettings({addressSettings}: T.UserContactLink): BotAdd
   }
 }
 
-export function fromLocalProfile({displayName, fullName, shortDescr, image, contactLink, preferences, peerType}: T.LocalProfile): T.Profile {
-  const profile = {displayName, fullName, shortDescr, image, contactLink, preferences, peerType}
+export function fromLocalProfile({displayName, fullName, shortDescr, image, contactLink, preferences, peerType, contactDomain}: T.LocalProfile): T.Profile {
+  const profile = {displayName, fullName, shortDescr, image, contactLink, preferences, peerType, contactDomain: contactDomain && {domain: contactDomain.domain}}
   for (const key in profile) {
     if (typeof (profile as any)[key] === "undefined") delete (profile as any)[key]
   }