@shhhum/simplex-chat 0.0.0-stage → 7.1.0-beta.6.1

package/docs/util.Function.contactAddressStr.md

@@ -0,0 +1,21 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [util](Namespace.util.md) / contactAddressStr
+
+# Function: contactAddressStr()
+
+> **contactAddressStr**(`link`): `string`
+
+Defined in: [src/util.ts:44](../src/util.ts#L44)
+
+## Parameters
+
+### link
+
+`CreatedConnLink`
+
+## Returns
+
+`string`

package/docs/util.Function.fromLocalProfile.md

@@ -0,0 +1,21 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [util](Namespace.util.md) / fromLocalProfile
+
+# Function: fromLocalProfile()
+
+> **fromLocalProfile**(`__namedParameters`): `Profile`
+
+Defined in: [src/util.ts:56](../src/util.ts#L56)
+
+## Parameters
+
+### \_\_namedParameters
+
+`LocalProfile`
+
+## Returns
+
+`Profile`

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")
+  await bot.run({
+    profile: {displayName: "Squaring bot example", fullName: ""},
+    dbOpts: {type: "sqlite", filePrefix: "./squaring_bot"},
+    options: {
+      addressSettings: {welcomeMessage: "Send a number, I will square it."},
+    },
+    onMessage: async (ci, content, chat) => {
+      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."
+  await bot.run({
+    profile: {displayName: "Squaring bot example", fullName: ""},
+    dbOpts: {type: "sqlite", filePrefix: "./squaring_bot"},
+    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, chat) => {
+      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, chat) => {
+        await chat.apiSendTextMessage(ci.chatInfo, welcomeMessage)
+      },
+      // fallback handler that will be called for all other commands
+      "": async (ci: T.AChatItem, _cmd: util.BotCommand, chat) => {
+        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,6 +1,57 @@
 {
   "name": "@shhhum/simplex-chat",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "7.1.0-beta.6.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "simplex-chat": "dist/cli.js"
+  },
+  "files": [
+    "src",
+    "dist",
+    "tsconfig.json",
+    "docs",
+    "examples"
+  ],
+  "scripts": {
+    "install-tools": "npm install -g node-gyp",
+    "configure": "node-gyp configure",
+    "build": "node-gyp rebuild && tsc && cp ./src/simplex.* ./dist",
+    "run": "node src/index.js",
+    "build-run": "node-gyp build && node src/index.js",
+    "test": "jest",
+    "docs": "typedoc"
+  },
+  "dependencies": {
+    "@simplex-chat/types": "npm:@shhhum/types@^0.12.1",
+    "extract-zip": "^2.0.1",
+    "fast-deep-equal": "^3.1.3"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.0.5",
+    "jest": "^30.2.0",
+    "node-addon-api": "^8.5.0",
+    "ts-jest": "^29.4.6",
+    "typedoc": "^0.28.15",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typescript": "^5.9.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shumvgolove/sx.git"
+  },
+  "keywords": [
+    "messenger",
+    "chat",
+    "privacy",
+    "security"
+  ],
+  "author": "SimpleX Chat",
+  "license": "AGPL-3.0",
+  "bugs": {
+    "url": "https://github.com/simplex-chat/simplex-chat/issues"
+  },
+  "homepage": "https://github.com/simplex-chat/simplex-chat/tree/stable/packages/simplex-chat-nodejs#readme",
+  "description": "SimpleX Chat Node.js library for chat bots"
+}