dandri/simplex-chat
1
0
Fork 0
mirror of https://github.com/simplex-chat/simplex-chat.git synced 2026-04-26 13:08:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

support-bot: use apiCreateMemberContact and apiSendMemberContactInvitation instead of raw commands

Browse Source 
Replace sendChatCmd("/_create member contact ...") and sendChatCmd("/_invite member contact ...")
with the typed API methods added in simplex-chat-nodejs. Update plans and build script accordingly.
This commit is contained in:
Narasimha-sc
2026-04-10 12:10:54 +00:00
committed by Dev
parent 1998f9d051
commit 8c9fe703a2
4 changed files with 22 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
apps/simplex-support-bot/build.sh
View File

@@ -21,10 +21,10 @@ echo "Building simplex-support-bot..."
cd "$SCRIPT_DIR"
npm install
# npm install copies the file: dependency but doesn't run its build script,
# so simplex.js/simplex.d.ts (native addon loader) are missing from dist/.
cp node_modules/simplex-chat/src/simplex.js node_modules/simplex-chat/dist/
cp node_modules/simplex-chat/src/simplex.d.ts node_modules/simplex-chat/dist/
# npm install copies file: dependencies, missing the native addon (build/)
# and some dist files. Replace the copy with a symlink to the local package.
rm -rf node_modules/simplex-chat
ln -s "$REPO_ROOT/packages/simplex-chat-nodejs" node_modules/simplex-chat
npm run build

24
apps/simplex-support-bot/plans/20260207-support-bot-implementation.md
View File

@@ -417,7 +417,7 @@ chat.on("connectedToGroupMember", (evt) => {
| `newChatItems` | `onNewChatItems` | Route: team group → handle `/join`; customer group → derive state, dispatch; direct message → reply with business address link |
| `chatItemUpdated` | `onChatItemUpdated` | Schedule card update |
| `leftMember` | `onLeftMember` | Customer left → cleanup, card remains. Grok left → cleanup. Team member left → revert if no message sent. |
| `joinedGroupMember` | `onJoinedGroupMember` | Team group joiner (link-join): initiate DM via raw `/_create member contact` + `/_invite member contact` commands. Fires for any member joining via group invite link. |
| `joinedGroupMember` | `onJoinedGroupMember` | Team group joiner (link-join): initiate DM via `apiCreateMemberContact` + `apiSendMemberContactInvitation`. Fires for any member joining via group invite link. |
| `connectedToGroupMember` | `onMemberConnected` | In team group: send DM with contact ID (if not already sent by `onJoinedGroupMember`). In customer group: promote to Owner (unless customer or Grok). |
| `chatItemReaction` | `onChatItemReaction` | Team/Grok reaction in customer group → schedule card update (auto-complete) |
| `newMemberContactReceivedInv` | `onMemberContactReceivedInv` | Team group member DM contact received: send contact ID message immediately (dedup via `sentTeamDMs`) |
@@ -556,10 +556,10 @@ Customer messages always in `user` role, never `system`.
**DM handshake:** When a team member joins or connects in the team group, the bot sends a DM with the member's contact ID. Four delivery paths, deduplicated via `sentTeamDMs` Set:
1. **`onJoinedGroupMember`** — fires when ANY member joins the team group via invite link (`joinedGroupMember` event). Calls `sendTeamMemberDM` without a `memberContact`. Since link-joiners typically have no existing DM contact, this triggers the raw command path: `/_create member contact #<groupId> <groupMemberId>` (creates the contact), then `/_invite member contact @<contactId> text <msg>` (sends invitation with message). This is the same protocol SimpleX's CLI uses for `@#group @member message`.
1. **`onJoinedGroupMember`** — fires when ANY member joins the team group via invite link (`joinedGroupMember` event). Calls `sendTeamMemberDM` without a `memberContact`. Since link-joiners typically have no existing DM contact, this creates the contact via `apiCreateMemberContact(groupId, groupMemberId)`, then sends the invitation with message via `apiSendMemberContactInvitation(contactId, msg)`.
2. **`onMemberConnected`** — `sendTeamMemberDM` called with `memberContact` from the event. If not already sent by path 1:
- If `contactId` exists: sends DM via `apiSendTextMessage`.
- If `contactId` is null: uses the same raw command path as path 1.
- If `contactId` is null: uses the same `apiCreateMemberContact` + `apiSendMemberContactInvitation` path as path 1.
3. **`onMemberContactReceivedInv`** — fires when the member initiates a DM first. Sends the contact ID message immediately. If send fails, queues for `contactConnected`/`contactSndReady`.
4. **`onContactConnected` / `onContactSndReady`** — delivers any pending DM queued by paths 1, 2, or 3.
@@ -689,8 +689,8 @@ If a user contacts the bot via a regular direct-message address (not business ad
| 23 | List members | main | `apiListMembers(gId)` | State derivation, duplicate check |
| 24 | Register team commands | main | `apiUpdateGroupProfile(teamGId, profile)` | Startup — register `/join` in team group |
| 25 | Get group info | main | `apiListGroups()` + find by ID | Card compose — read `customData.cardItemId` from `groupInfo` |
| 26 | Create DM contact | main | `sendChatCmd("/_create member contact #gId memberId")` | `joinedGroupMember` / `onMemberConnected` — bot-initiated DM with team member |
| 27 | Send DM invitation | main | `sendChatCmd("/_invite member contact @contactId text msg")` | After #26 — sends invite with message in one step |
| 26 | Create DM contact | main | `apiCreateMemberContact(gId, memberId)` | `joinedGroupMember` / `onMemberConnected` — bot-initiated DM with team member |
| 27 | Send DM invitation | main | `apiSendMemberContactInvitation(contactId, msg)` | After #26 — sends invite with message in one step |
## 17. Implementation Sequence
@@ -774,7 +774,7 @@ GROK_API_KEY=xai-... npx ts-node src/index.ts \
19. Team/Grok reaction → verify card auto-complete (✅ icon, "done")
20. DM contact text message → verify business address link reply
21. DM contact non-message event (e.g. contactConnected) → verify no reply (rcvMsgContent guard)
22. DM handshake via `joinedGroupMember` → team member joins team group via link → verify raw `/_create member contact` + `/_invite member contact` called, contact ID message sent
22. DM handshake via `joinedGroupMember` → team member joins team group via link → verify `apiCreateMemberContact` + `apiSendMemberContactInvitation` called, contact ID message sent
23. DM handshake via `connectedToGroupMember` → verify contact ID message sent (dedup with #22)
24. Restart → verify same team group + Grok contact from state file, cards resume via `customData`
25. No `--auto-add-team-members` (`-a`) → `/team` → verify "no team members available"
@@ -825,13 +825,14 @@ export default defineConfig({
**`MockChatApi`** — inline class in `bot.test.ts`:
- **Tracking arrays:** `sent`, `added`, `removed`, `joined`, `deleted`, `customData`, `roleChanges`, `profileUpdates`, `rawCmds`
- **Tracking arrays:** `sent`, `added`, `removed`, `joined`, `deleted`, `customData`, `roleChanges`, `profileUpdates`, `memberContacts`, `memberContactInvitations`
- **Simulated DB:** `members` (Map), `chatItems` (Map), `groups` (Map), `activeUserId`
- **Failure injection:** `apiAddMemberWillFail(err?)`, `apiDeleteChatItemsWillFail()`
- **Query helpers:** `sentTo(groupId)`, `lastSentTo(groupId)`, `sentDirect(contactId)`
- `apiSendTextMessage` returns `[{chatItem: {meta: {itemId: N}}}]` — auto-incrementing IDs
- `apiGetChat` returns from `chatItems` map with `chatInfo.groupInfo` from `groups` map
- `sendChatCmd(cmd)` — parses `/_create member contact` and `/_invite member contact` raw commands, returns appropriate response objects (`newMemberContact`, `newMemberContactSentInv`). Tracks all raw commands in `rawCmds` array.
- `apiCreateMemberContact(groupId, groupMemberId)` — returns a contact object with auto-incrementing `contactId`. Tracks calls in `memberContacts` array.
- `apiSendMemberContactInvitation(contactId, msg)` — returns a contact object. Tracks calls in `memberContactInvitations` array.
**`MockGrokApi`** — inline class:
@@ -887,7 +888,8 @@ expectDmSent(contactId, substring) // DM containing substring sent to con
expectAnySent(substring) // any message (group or DM) containing substring
expectMemberAdded(groupId, contactId) // apiAddMember called with groupId + contactId
expectCardDeleted(cardItemId) // apiDeleteChatItems called with cardItemId
expectRawCmd(substring) // sendChatCmd called with substring
expectMemberContactCreated(groupId, memberId) // apiCreateMemberContact called
expectMemberContactInvSent(contactId) // apiSendMemberContactInvitation called
```
### 20.3 State Setup Helpers
@@ -984,8 +986,8 @@ Called as: `const p = simulateGrokJoinSuccess(); await bot.onNewChatItems(...);
- team member joins team group → DM with contact ID
- name with spaces → single-quoted
- pending DM delivered on contactConnected
- team member with no DM contact → creates member contact via raw command and sends invitation
- joinedGroupMember in team group → creates member contact and sends invitation
- team member with no DM contact → creates member contact via `apiCreateMemberContact` and sends invitation via `apiSendMemberContactInvitation`
- joinedGroupMember in team group → creates member contact via `apiCreateMemberContact` and sends invitation via `apiSendMemberContactInvitation`
- no duplicate DM when sendTeamMemberDM succeeds AND onMemberContactReceivedInv fires
#### 12. Direct Messages (3 tests)

2
apps/simplex-support-bot/plans/20260207-support-bot.md
View File

@@ -131,7 +131,7 @@ The operator shares the link with team members. They must join within the 10-min
> Added you to be able to invite you to customer chats later, keep this contact. Your contact ID is `N:name`
This ID is needed for `--auto-add-team-members` (`-a`) config. The DM is sent as soon as the member joins the team group — the bot proactively creates a DM contact via raw SimpleX commands (`/_create member contact` + `/_invite member contact`) and delivers the message with the invitation. If the contact already exists, the message is sent directly. Multiple delivery paths ensure the DM arrives regardless of connection timing.
This ID is needed for `--auto-add-team-members` (`-a`) config. The DM is sent as soon as the member joins the team group — the bot proactively creates a DM contact via `apiCreateMemberContact` and delivers the message with the invitation via `apiSendMemberContactInvitation`. If the contact already exists, the message is sent directly. Multiple delivery paths ensure the DM arrives regardless of connection timing.
Team members are configured as a single comma-separated `--auto-add-team-members` flag (shortcut `-a`; e.g., `--auto-add-team-members "42:alice,55:bob"` or `-a "42:alice,55:bob"`), using the IDs from the DMs above. The bot validates every configured member against its contact list at startup and exits if any ID is missing or the display name does not match.

12
apps/simplex-support-bot/src/bot.ts
View File

@@ -750,14 +750,10 @@ export class SupportBot {
if (!contactId) {
// No DM contact yet — create one and send invitation with message
try {
const createResp: any = await this.withMainProfile(() =>
this.chat.sendChatCmd(`/_create member contact #${this.config.teamGroup.id} ${member.groupMemberId}`)
const contact = await this.withMainProfile(() =>
this.chat.apiCreateMemberContact(this.config.teamGroup.id, member.groupMemberId)
)
if (createResp.type !== "newMemberContact" || !createResp.contact?.contactId) {
logError(`Unexpected response creating member contact for ${name}`, createResp)
return
}
contactId = createResp.contact.contactId as number
contactId = contact.contactId as number
log(`Created DM contact ${contactId} for team member ${name}`)
} catch (err) {
logError(`Failed to create member contact for ${name}`, err)
@@ -767,7 +763,7 @@ export class SupportBot {
const msg = `Added you to be able to invite you to customer chats later, keep this contact. Your contact ID is ${contactId}:${formatted}`
try {
await this.withMainProfile(() =>
this.chat.sendChatCmd(`/_invite member contact @${contactId} text ${msg}`)
this.chat.apiSendMemberContactInvitation(contactId!, msg)
)
this.sentTeamDMs.add(contactId)
this.pendingTeamDMs.delete(contactId)