simplex-chat 6.5.0-beta.4.1 → 6.5.0-beta.4.3

package/docs/util.Function.reactionText.md

@@ -0,0 +1,21 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [util](Namespace.util.md) / reactionText
+
+# Function: reactionText()
+
+> **reactionText**(`reaction`): `string`
+
+Defined in: [src/util.ts:89](../src/util.ts#L89)
+
+## Parameters
+
+### reaction
+
+`ACIReaction`
+
+## Returns
+
+`string`

package/docs/util.Function.senderName.md

@@ -0,0 +1,25 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [util](Namespace.util.md) / senderName
+
+# Function: senderName()
+
+> **senderName**(`cInfo`, `chatDir`): `string`
+
+Defined in: [src/util.ts:37](../src/util.ts#L37)
+
+## Parameters
+
+### cInfo
+
+`ChatInfo`
+
+### chatDir
+
+`CIDirection`
+
+## Returns
+
+`string`

package/docs/util.Interface.BotCommand.md

@@ -0,0 +1,25 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [util](Namespace.util.md) / BotCommand
+
+# Interface: BotCommand
+
+Defined in: [src/util.ts:72](../src/util.ts#L72)
+
+## Properties
+
+### keyword
+
+> **keyword**: `string`
+
+Defined in: [src/util.ts:73](../src/util.ts#L73)
+
+***
+
+### params
+
+> **params**: `string`
+
+Defined in: [src/util.ts:74](../src/util.ts#L74)

package/examples/squaring-bot-readme.js

@@ -0,0 +1,17 @@
+(async () => {
+  const {bot} = await import("../dist/index.js")
+  const [chat, _user, _address] = await bot.run({
+    profile: {displayName: "Squaring bot example", fullName: ""},
+    dbOpts: {dbFilePrefix: "./squaring_bot", dbKey: ""},
+    options: {
+      addressSettings: {welcomeMessage: "If you send me a number, I will calculate its square."},
+    },
+    onMessage: async (ci, content) => {
+      const n = +content.text
+      const reply = typeof n === "number" && !isNaN(n)
+                    ? `${n} * ${n} = ${n * n}`
+                    : `this is not a number`
+      await chat.apiSendTextReply(ci, reply)
+    }
+  })
+})()

package/examples/squaring-bot.ts

@@ -0,0 +1,42 @@
+import {T} from "@simplex-chat/types"
+import {bot, util} from "../dist"
+
+(async () => {
+  const welcomeMessage = "Hello! I am a simple squaring bot.\n\nIf you send me a number, I will calculate its square."
+  const [chat, _user, _address] = await bot.run({
+    profile: {displayName: "Squaring bot example", fullName: ""},
+    dbOpts: {dbFilePrefix: "./squaring_bot", dbKey: ""},
+    options: {
+      addressSettings: {autoAccept: true, welcomeMessage, businessAddress: false},
+      commands: [ // commands to show in client UI
+        {type: "command", keyword: "help", label: "Send welcome message"},
+        {type: "command", keyword: "info", label: "More information (not implemented)"}
+      ],
+      logContacts: true,
+      logNetwork: false
+    },
+    onMessage: async (ci, content) => {
+      const n = +content.text
+      const reply = typeof n === "number" && !isNaN(n)
+                    ? `${n} * ${n} = ${n * n}`
+                    : `this is not a number`
+      await chat.apiSendTextReply(ci, reply)
+    },
+    onCommands: { // command handlers can be different from commands to be shown in client UI
+      "help": async (ci: T.AChatItem, _cmd: util.BotCommand) => {
+        await chat.apiSendTextMessage(ci.chatInfo, welcomeMessage)
+      },
+      // fallback handler that will be called for all other commands
+      "": async (ci: T.AChatItem, _cmd: util.BotCommand) => {
+        await chat.apiSendTextReply(ci, "This command is not supported")
+      }
+    },
+    // If you use `onMessage` and subscribe to "newChatItems" event, exclude content messages from processing
+    // If you use `onCommands` and subscribe to "newChatItems" event, exclude commands from processing
+    events: {
+      "chatItemReaction": ({added, reaction}) => {
+        console.log(`${util.senderName(reaction.chatInfo, reaction.chatReaction.chatDir)} ${added ? "added" : "removed"} reaction ${util.reactionText(reaction)}`)
+      }
+    },
+  })
+})()

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "simplex-chat",
-  "version": "6.5.0-beta.4.1",
+  "version": "6.5.0-beta.4.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist",
     "src",
-    "binding.gyp"
+    "cpp",
+    "dist",
+    "binding.gyp",
+    "tsconfig.json",
+    "docs",
+    "examples"
   ],
   "scripts": {
     "preinstall": "node src/download-libs.js",

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "include": ["src"],
+  "compilerOptions": {
+    "declaration": true,
+    "forceConsistentCasingInFileNames": true,
+    "lib": ["ES2018"],
+    "module": "CommonJS",
+    "moduleResolution": "Node",
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "noImplicitReturns": true,
+    "noImplicitThis": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noEmitOnError": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "target": "ES2018",
+    "types": ["node"]
+  }
+}