dandri/simplex-chat
1
0
Fork 0
mirror of https://github.com/simplex-chat/simplex-chat.git synced 2026-05-14 16:55:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into ae/oklch-color-space-plan

Browse Source
This commit is contained in:
Evgeny Poberezkin
2026-05-13 16:11:15 +01:00
parent 6c6f1aef69 7497b90e7c
commit 7aa7d0ae4e
167 changed files with 19532 additions and 708 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+552
View File
@@ -0,0 +1,552 @@
# Release History
## v6.5
30 April, 2026
Public channels - speak freely!
- Reliability: many relays per channel.
- Ownership: you can run your own relays.
- Security: owners hold channel keys.
- Privacy: for owners and subscribers.
Easier to invite your friends: we made connecting simpler for new users.
Safe web links:
- opt-in to send link previews.
- use SOCKS proxy for previews (if enabled).
- prevent hyperlink phishing.
- remove link tracking.
Non-profit governance: to make SimpleX Network last.
Read more on April 30 at 20:00 UTC: https://simplex.chat/blog/20260430-simplex-channels-v6-5-consortium-crowdfunding-freedom-of-speech.html
## v6.4
15 July, 2025
- Connect faster: message instantly once you tap Connect.
- Review group members: chat with new members before they join.
- Chat with admins: send your private feedback to group owners.
- New group role: Moderator - can remove messages and block members.
- Improved message delivery - less traffic on mobile networks.
Read about the new UX for making connections in the blog post: https://simplex.chat/blog/20250703-simplex-network-protocol-extension-for-securely-connecting-people.html
## v6.3
7 March, 2025
Better groups.
- Mention members and get notified when mentioned.
- Send private reports to moderators.
- Delete, block and change role for multiple members at once (Android and desktop only).
- Faster sending messages and faster deletion.
Better chat navigation
- Organize chats into lists to keep track of what's important.
- Jump to found and forwarded messages.
Better privacy and security.
- Private media file names.
- Message expiration in chats.
Read more on March 8: https://simplex.chat/blog/20250308-simplex-chat-v6-3-new-user-experience-safety-in-public-groups.html
## v6.2
7 December, 2024
- SimpleX Chat and Flux (https://runonflux.com) made an agreement to include servers operated by Flux into the app – to improve metadata privacy.
- Business chats – your customers' privacy.
- Improved user experience of chats:
- Open chat on the first unread message.
- Jump to quoted messages anywhere in the conversation.
- See who reacted to messages.
- Improved iOS push notifications.
Read more on December 10: https://simplex.chat/blog/20241210-simplex-network-v6-2-servers-by-flux-business-chats.html
## v6.1
12 October, 2024
Better security:
- SimpleX protocols reviewed by Trail of Bits.
- security improvements (don't worry, there is nothing critical there).
Better calls:
- you can switch audio and video during the call
- share the screen from desktop app.
Better iOS notifications:
- improved delivery, reduced traffic usage.
- more improvements are coming soon!
Better user experience:
- switch chat profile for 1-time invitations.
- customizable message shape.
- better message dates.
- forward up to 20 messages at once.
- delete or moderate up to 200 messages.
The protocols review by Trail of Bits and release announcement will be published on October 14 afternoon here: https://simplex.chat/blog/20241014-simplex-network-v6-1-security-review-better-calls-user-experience.html
## v6.0
11 August, 2024
New chat experience:
- connect to your friends faster.
- archive contacts to chat later.
- delete up to 20 messages at once.
- increase font size.
- new chat themes on iOS - same as on Android and desktop in the previous version.
- reachable chat toolbar - use the app with one hand.
New media options:
- share from other apps (iOS).
- play from the chat list.
- blur for better privacy.
Private routing: it protects your IP address and connections and is now enabled by default.
Connection and servers information: to control your network status and usage.
Read more on 8/14: https://simplex.chat/blog/20240814-simplex-chat-vision-funding-v6-private-routing-new-user-experience.html
## v5.8
3 June, 2024
- private message routing to protect IP addresses (opt-in in this version).
- protect IP address when receiving files.
- chat themes with wallpapers - set themes for all chats app-wide, per chat profile and per conversation - Android and desktop apps.
- some groups permissions can now be granted to admins only.
- improved message and file delivery with reduced battery usage.
- Persian interface language - Android and desktop apps.
Read more: https://simplex.chat/blog/20240604-simplex-chat-v5.8-private-message-routing-chat-themes.html
## v5.7
26 April, 2024
- quantum resistant end-to-end encryption – will be enabled for all direct chats!
- forward and save messages and files, without revealing the source.
- improved calls: in-call sounds when connecting calls, better support for bluetooth headphones.
- customizable shapes of profile images - from square to circle.
- more reliable network connection.
Lithuanian UI language in Android and desktop apps - thanks to our users!
Read more: https://simplex.chat/blog/20240426-simplex-legally-binding-transparency-v5-7-better-user-experience.html
## v5.6
21 March, 2024
1. **Quantum resistant end-to-end encryption** in direct chats (BETA).
It can be enabled for the new contacts by *Post-quantum E2EE* toggle in dev tools, and for the existing contacts - both users need to tap *Allow PQ encryption* in contact information page (and the toggle in dev tools should be enable for this button to be available).
Once quantum resistant shared secret is agreed, there will be a message indicating it - it takes about 2-3 messages from each side to be sent in turns before it gets enabled.
Read more about end-to-end encryption in SimpleX Chat here: https://simplex.chat/blog/20240314-simplex-chat-v5-6-quantum-resistance-signal-double-ratchet-algorithm.html
2. **App data migration**.
As suggested by one of SimpleX Chat users in our [users group](simplex:/contact#/?v=1-4&smp=smp%3A%2F%2FPQUV2eL0t7OStZOoAsPEV2QYWt4-xilbakvGUGOItUo%3D%40smp6.simplex.im%2Fos8FftfoV8zjb2T89fUEjJtF7y64p5av%23%2F%3Fv%3D1-2%26dh%3DMCowBQYDK2VuAyEAQqMgh0fw2lPhjn3PDIEfAKA_E0-gf8Hr8zzhYnDivRs%253D%26srv%3Dbylepyau3ty4czmn77q4fglvperknl4bi2eb2fdy2bh4jxtf32kf73yd.onion&data=%7B%22type%22%3A%22group%22%2C%22groupLinkId%22%3A%22lBPiveK2mjfUH43SN77R0w%3D%3D%22%7D), you can now migrate all data from one device to a new app installation by uploading it to the configured XFTP relays and then scanning QR code from the new device – choose *Migrate to another device* from the app settings and *Migrate from another device* on the first screen after installing the app.
3. **Use the app during the audio and video calls**.
Now you can continue using the app, with small video if it's a video call.
Also in this version:
- admins can block a member for all other members.
- much faster leaving and deleting groups.
- filtering chats no longer includes muted chats with unread messages.
- reduced memory usage when sending large files.
- desktop: scrollbars in all views with the scrolling - finally!
- iOS:
- fixed rendering glitches with messages and context menus.
- added Hungarian interface language.
The blog post with the announcement is coming on 3/23/2024.
## v5.5
23 January, 2024
- private notes - with encrypted files and media.
- paste link to connect - search bar now accepts invitation links.
- optional recent history in groups.
- improved message delivery - with reduced battery usage.
- reveal secrets in messages by tapping them.
- all files in local app storage are encrypted by default.
- allow deleting the last visible user profile.
- do not share contact address in member profile.
- many fixes!
Also, we added Hungarian (Android only) and Turkish interface - thanks to the users and Weblate (https://github.com/simplex-chat/simplex-chat/tree/stable#help-translating-simplex-chat).
## v5.4
25 November, 2023
- Link mobile and desktop apps via secure quantum-resistant protocol.
- Better groups:
- Faster to join and more reliable.
- Create groups with incognito profile.
- Block group members to hide their messages.
- Prohibit files and media in a group.
- Better calls:
- Connect faster and more stable (still far from great).
- Screen sharing in video calls in desktop app.
- Other improvements:
- profile names now allow spaces.
- when you delete contacts, they are optionally notified.
- previously used and your own SimpleX links are recognised by the app.
- many fixes and improvements.
## v5.3
22 September, 2023
All apps (Android, iOS, desktop):
- encrypt local files in app storage (except videos).
- improved groups:
- delivery receipts (up to 20 members).
- send direct messages to members even after contact is deleted.
- faster and more stable.
- simplified incognito mode.
- new privacy settings: show last messages & save draft.
- faster app loading.
- reduced memory usage by 40%.
- fixed bug preventing group members connecting (it will only help the new connections).
- iOS app fixes:
- playing videos on full screen.
- screen reader for messages.
- fixed most background crashes.
Also, 6 new interface languages added by the users: Arabic*, Bulgarian, Finnish, Hebrew*, Thai and Ukrainian!
\* Android and desktop only
## v5.2
22 July, 2023
- message delivery receipts – with opt out per contact!
- filter favorite and unread chats.
- keep your connections working after restoring from backup.
- share your address with group members via your chat profile.
- improved disappearing messages.
- a bit more usable groups.
- chat preference to prohibit message reactions.
- restart and shutdown buttons.
- more stable message delivery.
Read more: https://simplex.chat/blog/20230722-simplex-chat-v5-2-message-delivery-receipts.html
## v5.1
22 May, 2023
Mobile apps:
- message reactions 🚀
- self-destruct passcode
- improved messages:
- voice messages up to 5 minutes.
- custom time to disappear - can be set just for one message.
- message editing history.
- setting to disable audio/video calls per contact.
- welcome message visible in group profile.
Android only:
- new design and custom themes for Android - you can share them!
- configurable SOCKS proxy port.
- improved calls on lock screen.
- fixes for sending files.
- locale-dependent formatting of time and date.
Also, the users have added Japanese and Portuguese (Brazil) interfaces (the latter is available on Android only) - huge thanks!
## v5.0
20 April, 2023
- send videos and files up to 1gb - the recipient must have at least version 4.6.1.
- you can self-host XFTP servers and configure the app to use your servers.
- passcode as an alternative to system/device authentication.
- support for IPv6 server addresses.
- configurable SOCKS proxy host and port in Android app.
Also we added Polish interface language – [thanks to the users and Weblate](https://github.com/simplex-chat/simplex-chat#help-translating-simplex-chat).
See more details in this post: https://simplex.chat/blog/20230422-simplex-chat-vision-funding-v5-videos-files-passcode.html
## v4.6
25 March, 2023
Mobile apps:
- hidden chat profiles – you can protect them with a password!
- audio/video calls:
- iOS: completely re-implemented using WebRTC native library and iOS CallKit. Calls now work when the app is in background, and can be answered when the app is fully stopped.
- Android: added support for bluetooth headphones, volume control in video calls, proximity sensor turns off screen in audio calls.
- group moderation. Admins now can delete member messages and disable members (by assigning "observer" role).
- group welcome message to show to the new users when they join.
- reduced battery usage, particularly when sending messages to large groups.
- Chinese and Spanish interface.
Android app now supports Android 8+ (API 26+), and also supports 32 bit/ARMv7a devices via a separate APK. If you don't know which APK you need, try simplex.apk first. You can check your device CPU in z-cpu app.
Terminal / CLI app:
- hidden profiles are supported.
- improved help, with all supported commands included.
## v4.5
3 February, 2023
- multiple chat profiles: use different names, avatars and transport isolation.
- transport isolation: separate transport connections are used for each chat profile (default) or for each connection (BETA – enable dev tools to make this option available in Network & Servers.)
- message draft: the last message text and any attachments are now preserved when you leave the conversation (while the app is running).
- private filenames: to protect your timezone, image and voice message files now use UTC time.
## v4.4
31 December, 2022
- disappearing messages - with mutual agreement!
- live messages – they update for all recipients as you type them, every few seconds.
- connection security code verification, for contacts and group members – protect from MITM attack (e.g. invitation link substitution).
- performance improvements - faster UI loading, faster group deletion, etc.
Mobile apps:
- French language support in the UI!
iOS app:
- send animated images and "stickers" (e.g., from GIF and PNG files and from 3rd party keyboards)
## v4.3
4 December, 2022
Mobile apps:
- instant voice messages!
- irreversible deletion of sent messages on recipients devices (depends on chat preferences)
- an option to hide the app screen in the recent apps, and also prevent the screenshots on Android
- add SMP servers by scanning QR code, support for server passwords (with the new version 4.0 of SMP server)
- improved privacy and security of SimpleX invitation links in the app
## v4.2
6 November, 2022
- fixed issues from security audit!
- group links - group admins can create the links for new members to join
- auto-accept contact requests + configure to accept incognito and welcome message
- change group member role
- mark chat as unread
- on Android:
- support for image/gif/sticker keyboards
- fix keyboard bug with backspace
Beta features (enable Developer tools):
- manually switch contact or member to another address / server
- receive files faster (enable in Privacy settings)
## v4.1
13 October, 2022
Changes:
- automatic message deletion (set TTL per-chat or globally)
- change group member roles
- send multiple images at once
- connection aliases and information view
- share text and files from other apps into SimpleX (Android)
- image gallery (Android)
- scroll to quoted message (Android)
- German translations
- improved connection stability and performance
## v4.0
24 September, 2022
Changes:
Local database encryption with passphrase on iOS, Android, Linux, Mac!
Mobile apps:
- configurable WebRTC ICE servers - see https://github.com/simplex-chat/simplex-chat/blob/stable/docs/WEBRTC.md
- improved stability of establishing direct and group connections, files transfers and message reception.
- support for animated images on Android
- German language UI
- deleting files and media
Terminal app:
- disable messages and notifications per contact / group
For developers:
- [TypeScript SDK for integrating with SimpleX Chat](#typescript-sdk-for-integrating-with-simplex-chat) (e.g., chat bots or chat assistants).
## v3.2
20 August, 2022
Changes:
- use .onion addresses of the servers (if available) when Tor is used – it is based on a separate setting on iOS.
- endless scrolling and search in chats
- UI improvements
- reduced Android APK size (from 200 to 46Mb)
## v3.1
6 August, 2022
Mobile apps:
- secret chat groups!
- support accessing SimpleX messaging servers via Orbot (both iOS and Android)
- new app icons
- advanced network settings
- improved battery usage and traffic
Terminal app:
- support SOCKS5 proxy
- `/info` command to show information and servers for contacts and group members: use `/info <name>` for contact and `/info #<group> <name>` for member information.
## v3.0
9 July, 2022
Changes:
Chat core:
- support for push notifications on iOS
- support for database export/import in mobile clients
Terminal client:
- automatically accept contact requests and sending reply message with `/auto_accept on` and `/auto_accept on <message>` coomands
Mobile clients:
- instant push notifications for iOS (the sending clients have to be upgraded too for notifications to work),
- e2e encrypted WebRTC audio/video calls,
- export and import of chat database, allowing to move the chat profile to another device,
- improved privacy and performance of the protocol.
Please see [this post](https://github.com/simplex-chat/simplex-chat/blob/stable/blog/20220711-simplex-chat-v3-released-ios-notifications-audio-video-calls-database-export-import-protocol-improvements.md) for more details.
## v2.2
1 June, 2022
Changes:
- WebRTC calls integrated with CallKit (iOS)
- call notifications and alerts (Android)
- local authentication / app lock (both platforms)
- call settings and invitation timeouts
- privacy settings: auto-accepting images, link previews
- paste image from clipboard (iOS)
- SMP servers settings page (iOS)
## v2.1
21 May, 2022
New commands for terminal users:
- /clear - delete all messages in a conversation
- /image - send file as image for mobile clients
- /fforward - forward file to another conversation
- /image_forward - forward image to another conversation
## v2.0
11 May, 2022
For terminal users:
- /tail command to show the last messages from a given chat or from all chats
## v1.6
16 April, 2022
Changes:
- Improved stability of network connection.
- The new protocol to exchange files, in preparation to support images, files and groups in mobile apps. It makes sending files to groups much more efficient, and allows attaching files to the text messages. This version is backwards and forwards compatible, so you can exchange the files with the previous version. It will not be possible to receive the files sent from the next version (1.7) in the previous version (1.5) - please upgrade.
- **Up arrow** key in the terminal can be used to edit the last message you sent.
- CLI option to execute a single command / send one message, e.g. to use in CI to notify about the build completion, or for any other scenario.
- Library support + [chat bot examples](https://github.com/simplex-chat/simplex-chat/tree/stable/apps) to create SimpleX Chat chat bots.
## v1.5
3 April, 2022
Edit, delete and reply to messages, in the mobile apps and from the terminal.
## v1.4
26 March, 2022
Changes:
- message edit and delete in mobile apps
- profile images
- TCP keep-alive replacing SMP protocol pings (improved connection stability)
- bug fixes for chat scrolling and empty chat views
## v1.3
26 February, 2022
Changes:
- markdown support in messages (both platforms)
- user addresses (Android)
- group member names shown in messages
- display name validation
- asynchronous message processing (improved performance)
- search in chats
- Android app UI redesign (welcome page, help view, dark mode fixes)
## v1.2
14 February, 2022
Changes:
- message sent/unread status indicators (iOS)
- search in chats
- auto-accept contact requests option
- deduplicate contact requests
- iOS public beta launch
- connection stability fixes
## v1.1
2 February, 2022
- TLS 1.3 support.
- Terminal app is now also a backend for our new mobile app - public access to our new iOS app via TestFlight is coming soon!
- The code base now includes an iOS app preview.
## v1.0
12 January, 2022
### The most private and secure chat and application platform
We are building a new platform for distributed Internet applications where privacy of the messages _and_ the network matter. [SimpleX Chat](https://github.com/simplex-chat/simplex-chat) is our first application, a messaging application built on the SimpleX platform.
### What is SimpleX?
There is currently no messaging application other than SimpleX Chat that guarantees metadata privacy - who is communicating with whom and when. SimpleX is designed to not use any permanent users identities to protect meta-data privacy. See [SimpleX overview](https://github.com/simplex-chat/simplexmq/blob/master/protocol/overview-tjr.md) for more details.
### SimpleX protocol changes
Best possible E2E encryption - the only messenger using two-layer E2E encryption, with one layer using double ratchet protocol that provides forward secrecy and break-in recovery, and additional encryption layer providing meta-data protection. See more details about encryption algorithms in [SimpleXMQ change log](https://github.com/simplex-chat/simplexmq/blob/master/CHANGELOG.md#100).
Performance and space efficiency improvements - protocol overhead is reduced from circa 15% to 3.7% thanks to binary encoding, and performance is substantially improved due to more efficient cryptographic algorithms.
Shorter invitation and contact links due to switching from long RSA to much shorter Curve448/25519 keys - for example, you can connect to the team via [team's SimpleX Chat contact address](https://simplex.chat/contact#/?v=1&smp=smp%3A%2F%2FPQUV2eL0t7OStZOoAsPEV2QYWt4-xilbakvGUGOItUo%3D%40smp6.simplex.im%2FK1rslx-m5bpXVIdMZg9NLUZ_8JBm8xTt%23MCowBQYDK2VuAyEALDeVe-sG8mRY22LsXlPgiwTNs9dbiLrNuA7f3ZMAJ2w%3D) (you need to use it in terminal app) or just by using `/simplex` command in the chat.
This [this post](https://github.com/simplex-chat/simplex-chat/blob/master/blog/20220112-simplex-chat-v1-released.md) for more information.
apps/ios/Shared/Model/AppAPITypes.swift
+9
View File
@@ -73,6 +73,7 @@ enum ChatCommand: ChatCmdProtocol {
case apiNewGroup(userId: Int64, incognito: Bool, groupProfile: GroupProfile)
case apiNewPublicGroup(userId: Int64, incognito: Bool, relayIds: [Int64], groupProfile: GroupProfile)
case apiGetGroupRelays(groupId: Int64)
case apiAddGroupRelays(groupId: Int64, relayIds: [Int64])
case apiAddMember(groupId: Int64, contactId: Int64, memberRole: GroupMemberRole)
case apiJoinGroup(groupId: Int64)
case apiAcceptMember(groupId: Int64, groupMemberId: Int64, memberRole: GroupMemberRole)
@@ -275,6 +276,7 @@ enum ChatCommand: ChatCmdProtocol {
case let .apiNewGroup(userId, incognito, groupProfile): return "/_group \(userId) incognito=\(onOff(incognito)) \(encodeJSON(groupProfile))"
case let .apiNewPublicGroup(userId, incognito, relayIds, groupProfile): return "/_public group \(userId) incognito=\(onOff(incognito)) \(relayIds.map(String.init).joined(separator: ",")) \(encodeJSON(groupProfile))"
case let .apiGetGroupRelays(groupId): return "/_get relays #\(groupId)"
case let .apiAddGroupRelays(groupId, relayIds): return "/_add relays #\(groupId) \(relayIds.map(String.init).joined(separator: ","))"
case let .apiAddMember(groupId, contactId, memberRole): return "/_add #\(groupId) \(contactId) \(memberRole)"
case let .apiJoinGroup(groupId): return "/_join #\(groupId)"
case let .apiAcceptMember(groupId, groupMemberId, memberRole): return "/_accept member #\(groupId) \(groupMemberId) \(memberRole.rawValue)"
@@ -468,6 +470,7 @@ enum ChatCommand: ChatCmdProtocol {
case .apiNewGroup: return "apiNewGroup"
case .apiNewPublicGroup: return "apiNewPublicGroup"
case .apiGetGroupRelays: return "apiGetGroupRelays"
case .apiAddGroupRelays: return "apiAddGroupRelays"
case .apiAddMember: return "apiAddMember"
case .apiJoinGroup: return "apiJoinGroup"
case .apiAcceptMember: return "apiAcceptMember"
@@ -944,6 +947,8 @@ enum ChatResponse2: Decodable, ChatAPIResult {
case publicGroupCreated(user: UserRef, groupInfo: GroupInfo, groupLink: GroupLink, groupRelays: [GroupRelay])
case publicGroupCreationFailed(user: UserRef, addRelayResults: [AddRelayResult])
case groupRelays(user: UserRef, groupInfo: GroupInfo, groupRelays: [GroupRelay])
case groupRelaysAdded(user: UserRef, groupInfo: GroupInfo, groupLink: GroupLink, groupRelays: [GroupRelay])
case groupRelaysAddFailed(user: UserRef, addRelayResults: [AddRelayResult])
case sentGroupInvitation(user: UserRef, groupInfo: GroupInfo, contact: Contact, member: GroupMember)
case userAcceptedGroupSent(user: UserRef, groupInfo: GroupInfo, hostContact: Contact?)
case userDeletedMembers(user: UserRef, groupInfo: GroupInfo, members: [GroupMember], withMessages: Bool)
@@ -997,6 +1002,8 @@ enum ChatResponse2: Decodable, ChatAPIResult {
case .publicGroupCreated: "publicGroupCreated"
case .publicGroupCreationFailed: "publicGroupCreationFailed"
case .groupRelays: "groupRelays"
case .groupRelaysAdded: "groupRelaysAdded"
case .groupRelaysAddFailed: "groupRelaysAddFailed"
case .sentGroupInvitation: "sentGroupInvitation"
case .userAcceptedGroupSent: "userAcceptedGroupSent"
case .userDeletedMembers: "userDeletedMembers"
@@ -1046,6 +1053,8 @@ enum ChatResponse2: Decodable, ChatAPIResult {
case let .publicGroupCreated(u, groupInfo, groupLink, groupRelays): return withUser(u, "groupInfo: \(groupInfo)\ngroupLink: \(groupLink)\ngroupRelays: \(groupRelays)")
case let .publicGroupCreationFailed(u, addRelayResults): return withUser(u, "addRelayResults: \(addRelayResults)")
case let .groupRelays(u, groupInfo, groupRelays): return withUser(u, "groupInfo: \(groupInfo)\ngroupRelays: \(groupRelays)")
case let .groupRelaysAdded(u, groupInfo, groupLink, groupRelays): return withUser(u, "groupInfo: \(groupInfo)\ngroupLink: \(groupLink)\ngroupRelays: \(groupRelays)")
case let .groupRelaysAddFailed(u, addRelayResults): return withUser(u, "addRelayResults: \(addRelayResults)")
case let .sentGroupInvitation(u, groupInfo, contact, member): return withUser(u, "groupInfo: \(groupInfo)\ncontact: \(contact)\nmember: \(member)")
case let .userAcceptedGroupSent(u, groupInfo, hostContact): return withUser(u, "groupInfo: \(groupInfo)\nhostContact: \(String(describing: hostContact))")
case let .userDeletedMembers(u, groupInfo, members, withMessages): return withUser(u, "groupInfo: \(groupInfo)\nmembers: \(members)\nwithMessages: \(withMessages)")
apps/ios/Shared/Model/ChatModel.swift
+6 -3
View File
@@ -344,9 +344,12 @@ class ChannelRelaysModel: ObservableObject {
}
func updateRelay(_ groupInfo: GroupInfo, _ relay: GroupRelay) {
if groupId == groupInfo.groupId,
let i = groupRelays.firstIndex(where: { $0.groupRelayId == relay.groupRelayId }) {
groupRelays[i] = relay
if groupId == groupInfo.groupId {
if let i = groupRelays.firstIndex(where: { $0.groupRelayId == relay.groupRelayId }) {
groupRelays[i] = relay
} else {
groupRelays.append(relay)
}
}
}
apps/ios/Shared/Model/SimpleXAPI.swift
+16
View File
@@ -1891,6 +1891,22 @@ func apiGetGroupRelays(_ groupId: Int64) async -> [GroupRelay] {
return []
}
enum AddGroupRelaysResult {
case added(GroupInfo, GroupLink, [GroupRelay])
case addFailed([AddRelayResult])
}
func apiAddGroupRelays(_ groupId: Int64, relayIds: [Int64]) async throws -> AddGroupRelaysResult? {
let r: APIResult<ChatResponse2>? = await chatApiSendCmdWithRetry(.apiAddGroupRelays(groupId: groupId, relayIds: relayIds))
switch r {
case let .result(.groupRelaysAdded(_, groupInfo, groupLink, groupRelays)):
return .added(groupInfo, groupLink, groupRelays)
case let .result(.groupRelaysAddFailed(_, addRelayResults)):
return .addFailed(addRelayResults)
default: if let r { throw r.unexpected } else { return nil }
}
}
func apiAddMember(_ groupId: Int64, _ contactId: Int64, _ memberRole: GroupMemberRole) async throws -> GroupMember {
let r: ChatResponse2 = try await chatSendCmd(.apiAddMember(groupId: groupId, contactId: contactId, memberRole: memberRole))
if case let .sentGroupInvitation(_, _, _, member) = r { return member }
apps/ios/Shared/Views/Chat/ChatItem/CILinkView.swift
+4 -2
View File
File diff suppressed because one or more lines are too long
apps/ios/Shared/Views/Chat/ChatItem/FramedItemView.swift
+1 -1
View File
@@ -167,7 +167,7 @@ struct FramedItemView: View {
case let .report(text, reason):
ciMsgContentView(chatItem, txtPrefix: reason.attrString)
case let .link(_, preview):
CILinkView(linkPreview: preview)
CILinkView(linkPreview: preview, maxWidth: maxWidth)
ciMsgContentView(chatItem)
case let .chat(text, chatLink, ownerSig):
let hasText = text != chatLink.connLinkStr
apps/ios/Shared/Views/Chat/ChatView.swift
+31 -5
View File
@@ -745,7 +745,7 @@ struct ChatView: View {
ChannelRelaysModel.shared.set(groupId: groupInfo.groupId, groupRelays: relays)
}
}
} else {
} else if groupInfo.membership.memberCurrent {
Task {
if let gInfo = await apiGetUpdatedGroupLinkData(groupInfo.groupId) {
await MainActor.run {
@@ -2175,8 +2175,14 @@ struct ChatView: View {
)
}
.confirmationDialog("Delete message?", isPresented: $showDeleteMessage, titleVisibility: .visible) {
Button("Delete for me", role: .destructive) {
deleteMessage(.cidmInternal, moderate: false)
if publicGroupEditor(chat) {
Button("Delete from history", role: .destructive) {
deleteMessage(.cidmHistory, moderate: false)
}
} else {
Button("Delete for me", role: .destructive) {
deleteMessage(.cidmInternal, moderate: false)
}
}
if let di = deletingItem, di.meta.deletable && !di.localNote && !di.isReport {
Button(broadcastDeleteButtonText(chat), role: .destructive) {
@@ -2185,8 +2191,14 @@ struct ChatView: View {
}
}
.confirmationDialog(deleteMessagesTitle, isPresented: $showDeleteMessages, titleVisibility: .visible) {
Button("Delete for me", role: .destructive) {
deleteMessages(chat, deletingItems, moderate: false)
if publicGroupEditor(chat) {
Button("Delete from history", role: .destructive) {
deleteMessages(chat, deletingItems, .cidmHistory, moderate: false)
}
} else {
Button("Delete for me", role: .destructive) {
deleteMessages(chat, deletingItems, moderate: false)
}
}
}
.confirmationDialog(archivingReports?.count == 1 ? "Archive report?" : "Archive \(archivingReports?.count ?? 0) reports?", isPresented: $showArchivingReports, titleVisibility: .visible) {
@@ -2817,6 +2829,9 @@ struct ChatView: View {
}
} catch {
logger.error("ChatView.deleteMessage error: \(error)")
await MainActor.run {
showAlert(NSLocalizedString("Error deleting message", comment: "alert title"), message: responseError(error))
}
}
}
}
@@ -2963,6 +2978,14 @@ class FloatingButtonModel: ObservableObject {
}
private func publicGroupEditor(_ chat: Chat) -> Bool {
if case let .group(groupInfo, _) = chat.chatInfo {
groupInfo.useRelays && groupInfo.membership.memberRole >= .moderator
} else {
false
}
}
private func broadcastDeleteButtonText(_ chat: Chat) -> LocalizedStringKey {
chat.chatInfo.featureEnabled(.fullDelete) ? "Delete for everyone" : "Mark deleted for everyone"
}
@@ -3010,6 +3033,9 @@ private func deleteMessages(_ chat: Chat, _ deletingItems: [Int64], _ mode: CIDe
await onSuccess()
} catch {
logger.error("ChatView.deleteMessages error: \(error.localizedDescription)")
await MainActor.run {
showAlert(NSLocalizedString("Error deleting message", comment: "alert title"), message: responseError(error))
}
}
}
}
apps/ios/Shared/Views/Chat/ComposeMessage/ComposeView.swift
+17 -9
View File
@@ -395,13 +395,13 @@ struct ComposeView: View {
if let gInfo = chat.chatInfo.groupInfo, gInfo.useRelays,
![.memRejected, .memLeft, .memRemoved, .memGroupDeleted].contains(gInfo.membership.memberStatus) {
if gInfo.membership.memberRole == .owner {
if let s = ownerState, s.activeCount < s.relays.count {
if let s = ownerState, s.relays.isEmpty || s.activeCount < s.relays.count {
ownerChannelRelayBar(relays: s.relays, activeCount: s.activeCount, failedCount: s.failedCount, removedCount: s.removedCount)
}
} else {
let hostnames = (chatModel.channelRelayHostnames[gInfo.groupId] ?? []).sorted()
let relayMembers = chatModel.groupMembers
.filter { $0.wrapped.memberRole == .relay }
.filter { $0.wrapped.memberRole == .relay && ![.memRemoved, .memGroupDeleted].contains($0.wrapped.memberStatus) }
.sorted { hostFromRelayLink($0.wrapped.relayLink ?? "") < hostFromRelayLink($1.wrapped.relayLink ?? "") }
let showProgress = !gInfo.nextConnectPrepared || composeState.inProgress
let removedCount = relayMembers.filter { relayMemberRemoved($0.wrapped.memberStatus) }.count
@@ -409,7 +409,7 @@ struct ComposeView: View {
let failedCount = relayMembers.filter { !relayMemberRemoved($0.wrapped.memberStatus) && $0.wrapped.activeConn?.connFailedErr != nil }.count
let resolvedCount = connectedCount + removedCount + failedCount
let total = relayMembers.count > 0 ? relayMembers.count : hostnames.count
if total > 0, removedCount + failedCount > 0 || resolvedCount < total {
if total == 0 || removedCount + failedCount > 0 || resolvedCount < total {
subscriberChannelRelayBar(
hostnames: hostnames,
relayMembers: relayMembers,
@@ -735,9 +735,9 @@ struct ComposeView: View {
gInfo.membership.memberRole == .owner,
![.memLeft, .memRemoved, .memGroupDeleted].contains(gInfo.membership.memberStatus)
else { return nil }
let relays = channelRelaysModel.groupId == gInfo.groupId
? channelRelaysModel.groupRelays : []
guard !relays.isEmpty else { return nil }
guard channelRelaysModel.groupId == gInfo.groupId else { return nil }
let relays = channelRelaysModel.groupRelays
guard !relays.isEmpty else { return ([], 0, 0, 0, true) }
let relayMembers = relays.map { relay in
(relay, chatModel.groupMembers.first(where: { $0.wrapped.groupMemberId == relay.groupMemberId })?.wrapped)
}
@@ -763,7 +763,11 @@ struct ComposeView: View {
if !allBroken && activeCount + failedCount + removedCount < total {
RelayProgressIndicator(active: activeCount, total: total)
}
if allBroken {
if total == 0 {
Text("No relays")
Image(systemName: "exclamationmark.triangle")
.foregroundColor(.orange)
} else if allBroken {
if removedCount == total {
Text("All relays removed")
} else if failedCount == total {
@@ -793,7 +797,7 @@ struct ComposeView: View {
}
if relayListExpanded {
if allBroken {
Text("Adding relays will be supported later.")
Text("Add relays to restore message delivery.")
.frame(maxWidth: .infinity, alignment: .leading)
.font(.caption)
.foregroundColor(theme.colors.secondary)
@@ -843,7 +847,11 @@ struct ComposeView: View {
let allBroken = connectedCount == 0 && errorCount == total
VStack(spacing: 0) {
relayBarHeader {
if allBroken {
if total == 0 {
Text("No relays")
Image(systemName: "exclamationmark.triangle")
.foregroundColor(.orange)
} else if allBroken {
if removedCount == total {
Text("All relays removed")
} else if failedCount == total {
apps/ios/Shared/Views/Chat/Group/AddGroupRelayView.swift
+161
View File
@@ -0,0 +1,161 @@
//
// AddGroupRelayView.swift
// SimpleX (iOS)
//
// Created by simplex on 29.04.2026.
// Copyright © 2026 SimpleX Chat. All rights reserved.
//
import SwiftUI
import SimpleXChat
struct AddGroupRelayView: View {
var groupInfo: GroupInfo
var existingRelayIds: Set<Int64>
var onRelayAdded: () -> Void
@EnvironmentObject var theme: AppTheme
@Environment(\.dismiss) var dismiss
@State private var availableRelays: [(relayId: Int64, relay: UserChatRelay, operatorName: String?)] = []
@State private var selectedRelayIds: Set<Int64> = []
@State private var isLoading = true
@State private var isAdding = false
var body: some View {
NavigationView {
List {
if isLoading {
Section {
ProgressView()
.frame(maxWidth: .infinity)
}
} else if availableRelays.isEmpty {
Section {
Text("No available relays")
.foregroundColor(theme.colors.secondary)
}
} else {
Section {
ForEach(availableRelays, id: \.relayId) { item in
relayCheckRow(item.relayId, item.relay, operatorName: item.operatorName)
}
}
}
}
.modifier(ThemedBackground(grouped: true))
.navigationTitle("Add relays")
.navigationBarTitleDisplayMode(.inline)
.toolbar {
ToolbarItem(placement: .cancellationAction) {
Button("Cancel") { dismiss() }
}
ToolbarItem(placement: .confirmationAction) {
Button("Add") { addSelectedRelays() }
.disabled(selectedRelayIds.isEmpty || isAdding)
}
}
}
.task { await loadAvailableRelays() }
}
private func relayCheckRow(_ relayId: Int64, _ relay: UserChatRelay, operatorName: String?) -> some View {
let selected = selectedRelayIds.contains(relayId)
return Button {
if selected {
selectedRelayIds.remove(relayId)
} else {
selectedRelayIds.insert(relayId)
}
} label: {
HStack {
VStack(alignment: .leading) {
Text(chatRelayDisplayName(relay))
.foregroundColor(theme.colors.onBackground)
.lineLimit(1)
if let opName = operatorName {
Text(opName)
.font(.caption)
.foregroundColor(theme.colors.secondary)
.lineLimit(1)
}
}
Spacer()
Image(systemName: selected ? "checkmark.circle.fill" : "circle")
.foregroundColor(selected ? theme.colors.primary : Color(uiColor: .tertiaryLabel).asAnotherColorFromSecondary(theme))
}
}
}
private func loadAvailableRelays() async {
do {
let servers = try await getUserServers()
var relays: [(relayId: Int64, relay: UserChatRelay, operatorName: String?)] = []
for op in servers {
if let oper = op.operator, oper.enabled != true { continue }
let opName: String? = op.operator?.operatorTag != nil ? op.operator?.tradeName : nil
for relay in op.chatRelays {
if relay.enabled && !relay.deleted,
let relayId = relay.chatRelayId,
!existingRelayIds.contains(relayId) {
relays.append((relayId, relay, opName))
}
}
}
await MainActor.run {
availableRelays = relays
isLoading = false
}
} catch {
logger.error("loadAvailableRelays error: \(responseError(error))")
await MainActor.run {
isLoading = false
}
}
}
private func addSelectedRelays() {
let relayIds = Array(selectedRelayIds)
guard !relayIds.isEmpty else { return }
isAdding = true
Task {
do {
guard let result = try await apiAddGroupRelays(groupInfo.groupId, relayIds: relayIds) else {
await MainActor.run { isAdding = false }
return
}
await MainActor.run {
isAdding = false
switch result {
case let .added(gInfo, _, relays):
ChannelRelaysModel.shared.set(groupId: gInfo.groupId, groupRelays: relays)
onRelayAdded()
dismiss()
case let .addFailed(results):
let successIds = Set(results.filter { $0.relayError == nil }.compactMap { $0.relay.chatRelayId })
if !successIds.isEmpty {
selectedRelayIds.subtract(successIds)
availableRelays.removeAll { successIds.contains($0.relayId) }
onRelayAdded()
}
let errorLines = results.filter { $0.relayError != nil }
.map { "\(chatRelayDisplayName($0.relay)): \($0.relayError.map { connErrorText($0) } ?? "")" }
let successNames = results.filter { $0.relayError == nil }
.map { chatRelayDisplayName($0.relay) }
var msg = errorLines.joined(separator: "\n")
if !successNames.isEmpty {
msg += "\n" + String.localizedStringWithFormat(NSLocalizedString("Relays added: %@.", comment: "alert message"), successNames.joined(separator: ", "))
}
showAlert(
NSLocalizedString("Error adding relays", comment: "alert title"),
message: msg
)
}
}
} catch {
await MainActor.run {
isAdding = false
showAlert(NSLocalizedString("Error adding relays", comment: "alert title"), message: responseError(error))
}
}
}
}
}
apps/ios/Shared/Views/Chat/Group/ChannelRelaysView.swift
+43 -4
View File
@@ -14,24 +14,49 @@ struct ChannelRelaysView: View {
var groupInfo: GroupInfo
@EnvironmentObject var chatModel: ChatModel
@EnvironmentObject var theme: AppTheme
@State private var groupRelays: [GroupRelay] = []
@ObservedObject private var channelRelaysModel = ChannelRelaysModel.shared
@State private var showAddRelay = false
private var groupRelays: [GroupRelay] {
channelRelaysModel.groupId == groupInfo.groupId ? channelRelaysModel.groupRelays : []
}
var body: some View {
List {
relaysList()
// TODO [relays] re-enable when relay management ships
// if groupInfo.isOwner {
// Section {
// Button {
// showAddRelay = true
// } label: {
// Label("Add relay", systemImage: "plus")
// }
// }
// }
}
// TODO [relays] re-enable when relay management ships
// .sheet(isPresented: $showAddRelay) {
// let existingRelayIds = Set(groupRelays.filter { $0.relayStatus != .rsInactive }.compactMap { $0.userChatRelay.chatRelayId })
// AddGroupRelayView(groupInfo: groupInfo, existingRelayIds: existingRelayIds) {
// Task { await chatModel.loadGroupMembers(groupInfo) }
// }
// }
.onAppear {
Task {
await chatModel.loadGroupMembers(groupInfo)
if groupInfo.isOwner {
groupRelays = await apiGetGroupRelays(groupInfo.groupId)
let relays = await apiGetGroupRelays(groupInfo.groupId)
await MainActor.run {
ChannelRelaysModel.shared.set(groupId: groupInfo.groupId, groupRelays: relays)
}
}
}
}
}
@ViewBuilder private func relaysList() -> some View {
let relayMembers = chatModel.groupMembers.filter { $0.wrapped.memberRole == .relay }
let relayMembers = chatModel.groupMembers.filter { $0.wrapped.memberRole == .relay && $0.wrapped.memberStatus != .memRemoved && $0.wrapped.memberStatus != .memGroupDeleted }
if relayMembers.isEmpty {
Section {
Text("No chat relays")
@@ -40,7 +65,7 @@ struct ChannelRelaysView: View {
} else {
Section {
ForEach(relayMembers) { member in
NavigationLink {
let link = NavigationLink {
GroupMemberInfoView(
groupInfo: groupInfo,
chat: chat,
@@ -55,6 +80,20 @@ struct ChannelRelaysView: View {
: subscriberRelayStatusText(member.wrapped)
relayMemberRow(member.wrapped, statusText: statusText)
}
// TODO [relays] re-enable when relay management ships
// if groupInfo.isOwner && member.wrapped.canBeRemoved(groupInfo: groupInfo) {
// link.swipeActions(edge: .trailing) {
// Button {
// showRemoveMemberAlert(groupInfo, member.wrapped)
// } label: {
// Label("Remove relay", systemImage: "trash")
// }
// .tint(.red)
// }
// } else {
// link
// }
link
}
} footer: {
Text("Chat relays forward messages to channel subscribers.")
apps/ios/Shared/Views/Chat/Group/GroupChatInfoView.swift
+48 -20
View File
@@ -924,26 +924,54 @@ struct GroupChatInfoView: View {
}
func showRemoveMemberAlert(_ groupInfo: GroupInfo, _ mem: GroupMember, dismiss: DismissAction? = nil) {
showAlert(
groupInfo.useRelays
? NSLocalizedString("Remove subscriber?", comment: "alert title")
: NSLocalizedString("Remove member?", comment: "alert title"),
message:
groupInfo.useRelays
? NSLocalizedString("Subscriber will be removed from channel - this cannot be undone!", comment: "alert message")
: groupInfo.businessChat == nil
? NSLocalizedString("Member will be removed from group - this cannot be undone!", comment: "alert message")
: NSLocalizedString("Member will be removed from chat - this cannot be undone!", comment: "alert message"),
actions: {[
UIAlertAction(title: NSLocalizedString("Remove", comment: "alert action"), style: .destructive) { _ in
removeMember(groupInfo, mem, withMessages: false, dismiss: dismiss)
},
UIAlertAction(title: NSLocalizedString("Remove and delete messages", comment: "alert action"), style: .destructive) { _ in
removeMember(groupInfo, mem, withMessages: true, dismiss: dismiss)
},
cancelAlertAction
]}
)
if mem.memberRole == .relay {
let isLastActive = groupInfo.useRelays && mem.memberCurrent && {
let activeRelays = ChatModel.shared.groupMembers.filter { $0.wrapped.memberRole == .relay && $0.wrapped.memberCurrent }
return activeRelays.count <= 1
}()
showAlert(
NSLocalizedString("Remove relay?", comment: "alert title"),
message: isLastActive
? NSLocalizedString("This is the last active relay. Removing it will prevent message delivery to subscribers.", comment: "alert message")
: NSLocalizedString("Relay will be removed from channel - this cannot be undone!", comment: "alert message"),
actions: {[
UIAlertAction(title: NSLocalizedString("Remove", comment: "alert action"), style: .destructive) { _ in
removeMember(groupInfo, mem, withMessages: false, dismiss: dismiss)
},
cancelAlertAction
]}
)
} else if groupInfo.useRelays {
showAlert(
NSLocalizedString("Remove subscriber?", comment: "alert title"),
message: NSLocalizedString("Subscriber will be removed from channel - this cannot be undone!", comment: "alert message"),
actions: {[
UIAlertAction(title: NSLocalizedString("Remove", comment: "alert action"), style: .destructive) { _ in
removeMember(groupInfo, mem, withMessages: false, dismiss: dismiss)
},
UIAlertAction(title: NSLocalizedString("Remove and delete messages", comment: "alert action"), style: .destructive) { _ in
removeMember(groupInfo, mem, withMessages: true, dismiss: dismiss)
},
cancelAlertAction
]}
)
} else {
showAlert(
NSLocalizedString("Remove member?", comment: "alert title"),
message: groupInfo.businessChat == nil
? NSLocalizedString("Member will be removed from group - this cannot be undone!", comment: "alert message")
: NSLocalizedString("Member will be removed from chat - this cannot be undone!", comment: "alert message"),
actions: {[
UIAlertAction(title: NSLocalizedString("Remove", comment: "alert action"), style: .destructive) { _ in
removeMember(groupInfo, mem, withMessages: false, dismiss: dismiss)
},
UIAlertAction(title: NSLocalizedString("Remove and delete messages", comment: "alert action"), style: .destructive) { _ in
removeMember(groupInfo, mem, withMessages: true, dismiss: dismiss)
},
cancelAlertAction
]}
)
}
}
func removeMember(_ groupInfo: GroupInfo, _ mem: GroupMember, withMessages: Bool, dismiss: DismissAction?) {
apps/ios/Shared/Views/Chat/Group/GroupMemberInfoView.swift
+8 -6
View File
@@ -641,13 +641,12 @@ struct GroupMemberInfoView: View {
blockForAllButton(mem)
}
}
// TODO [relays] removing relay should also remove its link from group link data;
// TODO - removing last relay should be prohibited or show warning
// TODO [relays] re-enable when relay management ships
if canRemove && mem.memberRole != .relay {
if mem.memberStatus == .memRemoved || mem.memberStatus == .memLeft {
deleteMemberMessagesButton(mem)
} else {
if mem.memberStatus != .memRemoved && (mem.memberStatus != .memLeft || mem.memberRole == .relay) {
removeMemberButton(mem)
} else if mem.memberRole != .relay {
deleteMemberMessagesButton(mem)
}
}
}
@@ -705,7 +704,10 @@ struct GroupMemberInfoView: View {
Button(role: .destructive) {
showRemoveMemberAlert(groupInfo, mem, dismiss: dismiss)
} label: {
Label(groupInfo.useRelays ? "Remove subscriber" : "Remove member", systemImage: "trash")
let text = mem.memberRole == .relay ? "Remove relay"
: groupInfo.useRelays ? "Remove subscriber"
: "Remove member"
Label(text, systemImage: "trash")
.foregroundColor(.red)
}
}
apps/ios/Shared/Views/NewChat/AddChannelView.swift
+5 -7
View File
@@ -338,6 +338,9 @@ struct AddChannelView: View {
.compactSectionSpacing()
Section {
Button("Cancel and delete channel", role: .destructive) {
showCancelChannelAlert(gInfo)
}
Button("Continue") {
if activeCount >= total {
showLinkStep = true
@@ -365,11 +368,6 @@ struct AddChannelView: View {
}
.navigationTitle("Creating channel")
.navigationBarBackButtonHidden(true)
.toolbar {
ToolbarItem(placement: .navigationBarTrailing) {
Button("Delete channel") { showCancelChannelAlert(gInfo) }
}
}
.onDisappear {
if !showLinkStep && m.creatingChannelId == gInfo.id {
showCancelChannelAlert(gInfo)
@@ -481,7 +479,7 @@ func relayDisplayName(_ relay: GroupRelay) -> String {
return "relay \(relay.groupRelayId)"
}
private func chatRelayDisplayName(_ relay: UserChatRelay) -> String {
func chatRelayDisplayName(_ relay: UserChatRelay) -> String {
if !relay.displayName.isEmpty { return relay.displayName }
return relay.address
}
@@ -489,7 +487,7 @@ private func chatRelayDisplayName(_ relay: UserChatRelay) -> String {
func relayStatusIndicator(_ status: RelayStatus, connFailed: Bool = false, memberStatus: GroupMemberStatus? = nil) -> some View {
let removed = memberStatus.map { [.memLeft, .memRemoved, .memGroupDeleted].contains($0) } ?? false
let color: Color = connFailed || removed ? .red : (status == .rsActive ? .green : .yellow)
let text: LocalizedStringKey = connFailed ? "failed" : memberStatus == .memLeft ? "removed by operator" : status.text
let text: LocalizedStringKey = connFailed ? "failed" : memberStatus == .memLeft ? "removed by operator" : removed ? "removed" : status.text
return HStack(spacing: 4) {
Circle()
.fill(color)
apps/ios/SimpleX.xcodeproj/project.pbxproj
+4
View File
@@ -169,6 +169,7 @@
648679AB2BC96A74006456E7 /* ChatItemForwardingView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 648679AA2BC96A74006456E7 /* ChatItemForwardingView.swift */; };
6495D7042F48CFC50060512B /* ChannelMembersView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6495D7032F48CFC50060512B /* ChannelMembersView.swift */; };
6495D7062F48CFFD0060512B /* ChannelRelaysView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6495D7052F48CFFD0060512B /* ChannelRelaysView.swift */; };
6495D7082F48D0000060512B /* AddGroupRelayView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 6495D7072F48D0000060512B /* AddGroupRelayView.swift */; };
649BCDA0280460FD00C3A862 /* ComposeImageView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 649BCD9F280460FD00C3A862 /* ComposeImageView.swift */; };
649BCDA22805D6EF00C3A862 /* CIImageView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 649BCDA12805D6EF00C3A862 /* CIImageView.swift */; };
64A779F62DBFB9F200FDEF2F /* MemberAdmissionView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 64A779F52DBFB9F200FDEF2F /* MemberAdmissionView.swift */; };
@@ -546,6 +547,7 @@
6493D667280ED77F007A76FB /* en */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = en; path = en.lproj/Localizable.strings; sourceTree = "<group>"; };
6495D7032F48CFC50060512B /* ChannelMembersView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChannelMembersView.swift; sourceTree = "<group>"; };
6495D7052F48CFFD0060512B /* ChannelRelaysView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChannelRelaysView.swift; sourceTree = "<group>"; };
6495D7072F48D0000060512B /* AddGroupRelayView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AddGroupRelayView.swift; sourceTree = "<group>"; };
649BCD9F280460FD00C3A862 /* ComposeImageView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ComposeImageView.swift; sourceTree = "<group>"; };
649BCDA12805D6EF00C3A862 /* CIImageView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CIImageView.swift; sourceTree = "<group>"; };
64A779F52DBFB9F200FDEF2F /* MemberAdmissionView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MemberAdmissionView.swift; sourceTree = "<group>"; };
@@ -1173,6 +1175,7 @@
64A779FD2DC3AFF200FDEF2F /* MemberSupportChatToolbar.swift */,
6495D7032F48CFC50060512B /* ChannelMembersView.swift */,
6495D7052F48CFFD0060512B /* ChannelRelaysView.swift */,
6495D7072F48D0000060512B /* AddGroupRelayView.swift */,
);
path = Group;
sourceTree = "<group>";
@@ -1633,6 +1636,7 @@
8C9BC2652C240D5200875A27 /* ThemeModeEditor.swift in Sources */,
647B15E82F4C8D2500EB431E /* AddChannelView.swift in Sources */,
6495D7062F48CFFD0060512B /* ChannelRelaysView.swift in Sources */,
6495D7082F48D0000060512B /* AddGroupRelayView.swift in Sources */,
5CB346E92869E8BA001FD2EF /* PushEnvironment.swift in Sources */,
5C55A91F283AD0E400C4E99E /* CallManager.swift in Sources */,
649BCDA22805D6EF00C3A862 /* CIImageView.swift in Sources */,
apps/ios/SimpleXChat/ChatTypes.swift
+1
View File
@@ -4091,6 +4091,7 @@ public enum CIDeleteMode: String, Decodable, Hashable {
case cidmBroadcast = "broadcast"
case cidmInternal = "internal"
case cidmInternalMark = "internalMark"
case cidmHistory = "history"
}
protocol ItemContent {
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/ChatModel.kt
+3 -1
View File
@@ -92,6 +92,7 @@ object ChannelRelaysModel {
if (groupId.value == groupInfo.groupId) {
val i = groupRelays.indexOfFirst { it.groupRelayId == relay.groupRelayId }
if (i >= 0) groupRelays[i] = relay
else groupRelays.add(relay)
}
}
@@ -3734,7 +3735,8 @@ sealed class CIForwardedFrom {
enum class CIDeleteMode(val deleteMode: String) {
@SerialName("internal") cidmInternal("internal"),
@SerialName("internalMark") cidmInternalMark("internalMark"),
@SerialName("broadcast") cidmBroadcast("broadcast");
@SerialName("broadcast") cidmBroadcast("broadcast"),
@SerialName("history") cidmHistory("history");
}
interface ItemContent {
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/model/SimpleXAPI.kt
+50 -13
View File
@@ -91,6 +91,13 @@ enum class SimplexLinkMode {
}
}
enum class CloseBehavior {
Ask, Quit, MinimizeToTray;
companion object { val default = Ask }
}
class HintPref(val reset: () -> Unit, val isUnchanged: () -> Boolean)
// Spec: spec/state.md#AppPreferences
class AppPreferences {
// deprecated, remove in 2024
@@ -99,6 +106,7 @@ class AppPreferences {
SHARED_PREFS_NOTIFICATIONS_MODE,
if (!runServiceInBackground.get()) NotificationsMode.OFF else NotificationsMode.default
) { NotificationsMode.values().firstOrNull { it.name == this } }
val closeBehavior: SharedPreference<CloseBehavior> = mkSafeEnumPreference(SHARED_PREFS_DESKTOP_CLOSE_BEHAVIOR, CloseBehavior.default)
val notificationPreviewMode = mkStrPreference(SHARED_PREFS_NOTIFICATION_PREVIEW_MODE, NotificationPreviewMode.default.name)
val canAskToEnableNotifications = mkBoolPreference(SHARED_PREFS_CAN_ASK_TO_ENABLE_NOTIFICATIONS, true)
val backgroundServiceNoticeShown = mkBoolPreference(SHARED_PREFS_SERVICE_NOTICE_SHOWN, false)
@@ -257,17 +265,23 @@ class AppPreferences {
val oneHandUI = mkBoolPreference(SHARED_PREFS_ONE_HAND_UI, true)
val chatBottomBar = mkBoolPreference(SHARED_PREFS_CHAT_BOTTOM_BAR, true)
val hintPreferences: List<Pair<SharedPreference<Boolean>, Boolean>> = listOf(
laNoticeShown to false,
oneHandUICardShown to false,
addressCreationCardShown to false,
liveMessageAlertShown to false,
showHiddenProfilesNotice to true,
showMuteProfileAlert to true,
showReportsInSupportChatAlert to true,
showDeleteConversationNotice to true,
showDeleteContactNotice to true,
privacyLinkPreviewsShowAlert to true,
val hintPreferences: List<HintPref> = listOf(
hintPref(laNoticeShown, false),
hintPref(oneHandUICardShown, false),
hintPref(addressCreationCardShown, false),
hintPref(liveMessageAlertShown, false),
hintPref(showHiddenProfilesNotice, true),
hintPref(showMuteProfileAlert, true),
hintPref(showReportsInSupportChatAlert, true),
hintPref(showDeleteConversationNotice, true),
hintPref(showDeleteContactNotice, true),
hintPref(privacyLinkPreviewsShowAlert, true),
hintPref(closeBehavior, CloseBehavior.default),
)
private fun <T> hintPref(pref: SharedPreference<T>, default: T) = HintPref(
reset = { pref.set(default) },
isUnchanged = { pref.state.value == default },
)
private fun mkIntPreference(prefName: String, default: Int) =
@@ -479,6 +493,7 @@ class AppPreferences {
private const val SHARED_PREFS_CONNECT_REMOTE_VIA_MULTICAST_AUTO = "ConnectRemoteViaMulticastAuto"
private const val SHARED_PREFS_OFFER_REMOTE_MULTICAST = "OfferRemoteMulticast"
private const val SHARED_PREFS_DESKTOP_WINDOW_STATE = "DesktopWindowState"
private const val SHARED_PREFS_DESKTOP_CLOSE_BEHAVIOR = "DesktopCloseBehavior"
private const val SHARED_PREFS_SHOW_DELETE_CONVERSATION_NOTICE = "showDeleteConversationNotice"
private const val SHARED_PREFS_SHOW_DELETE_CONTACT_NOTICE = "showDeleteContactNotice"
private const val SHARED_PREFS_SHOW_SENT_VIA_RPOXY = "showSentViaProxy"
@@ -1198,14 +1213,14 @@ object ChatController {
suspend fun apiDeleteChatItems(rh: Long?, type: ChatType, id: Long, scope: GroupChatScope?, itemIds: List<Long>, mode: CIDeleteMode): List<ChatItemDeletion>? {
val r = sendCmd(rh, CC.ApiDeleteChatItem(type, id, scope, itemIds, mode))
if (r is API.Result && r.res is CR.ChatItemsDeleted) return r.res.chatItemDeletions
Log.e(TAG, "apiDeleteChatItem bad response: ${r.responseType} ${r.details}")
apiErrorAlert("apiDeleteChatItems", generalGetString(MR.strings.error_deleting_message), r)
return null
}
suspend fun apiDeleteMemberChatItems(rh: Long?, groupId: Long, itemIds: List<Long>): List<ChatItemDeletion>? {
val r = sendCmd(rh, CC.ApiDeleteMemberChatItem(groupId, itemIds))
if (r is API.Result && r.res is CR.ChatItemsDeleted) return r.res.chatItemDeletions
Log.e(TAG, "apiDeleteMemberChatItem bad response: ${r.responseType} ${r.details}")
apiErrorAlert("apiDeleteMemberChatItems", generalGetString(MR.strings.error_deleting_message), r)
return null
}
@@ -2163,6 +2178,19 @@ object ChatController {
return emptyList()
}
sealed class AddGroupRelaysResult {
data class Added(val groupInfo: GroupInfo, val groupLink: GroupLink, val groupRelays: List<GroupRelay>): AddGroupRelaysResult()
data class AddFailed(val addRelayResults: List<AddRelayResult>): AddGroupRelaysResult()
}
suspend fun apiAddGroupRelays(groupId: Long, relayIds: List<Long>): AddGroupRelaysResult? {
val r = sendCmdWithRetry(null, CC.ApiAddGroupRelays(groupId, relayIds))
if (r is API.Result && r.res is CR.GroupRelaysAdded) return AddGroupRelaysResult.Added(r.res.groupInfo, r.res.groupLink, r.res.groupRelays)
if (r is API.Result && r.res is CR.GroupRelaysAddFailed) return AddGroupRelaysResult.AddFailed(r.res.addRelayResults)
if (r != null) throw Exception("${r.responseType}: ${r.details}")
return null
}
suspend fun apiAddMember(rh: Long?, groupId: Long, contactId: Long, memberRole: GroupMemberRole): GroupMember? {
val r = sendCmd(rh, CC.ApiAddMember(groupId, contactId, memberRole))
if (r is API.Result && r.res is CR.SentGroupInvitation) return r.res.member
@@ -3666,6 +3694,7 @@ sealed class CC {
class ApiNewGroup(val userId: Long, val incognito: Boolean, val groupProfile: GroupProfile): CC()
class ApiNewPublicGroup(val userId: Long, val incognito: Boolean, val relayIds: List<Long>, val groupProfile: GroupProfile): CC()
class ApiGetGroupRelays(val groupId: Long): CC()
class ApiAddGroupRelays(val groupId: Long, val relayIds: List<Long>): CC()
class ApiAddMember(val groupId: Long, val contactId: Long, val memberRole: GroupMemberRole): CC()
class ApiJoinGroup(val groupId: Long): CC()
class ApiAcceptMember(val groupId: Long, val groupMemberId: Long, val memberRole: GroupMemberRole): CC()
@@ -3870,6 +3899,7 @@ sealed class CC {
is ApiNewGroup -> "/_group $userId incognito=${onOff(incognito)} ${json.encodeToString(groupProfile)}"
is ApiNewPublicGroup -> "/_public group $userId incognito=${onOff(incognito)} ${relayIds.joinToString(",")} ${json.encodeToString(groupProfile)}"
is ApiGetGroupRelays -> "/_get relays #$groupId"
is ApiAddGroupRelays -> "/_add relays #$groupId ${relayIds.joinToString(",")}"
is ApiAddMember -> "/_add #$groupId $contactId ${memberRole.memberRole}"
is ApiJoinGroup -> "/_join #$groupId"
is ApiAcceptMember -> "/_accept member #$groupId $groupMemberId ${memberRole.memberRole}"
@@ -4053,6 +4083,7 @@ sealed class CC {
is ApiNewGroup -> "apiNewGroup"
is ApiNewPublicGroup -> "apiNewPublicGroup"
is ApiGetGroupRelays -> "apiGetGroupRelays"
is ApiAddGroupRelays -> "apiAddGroupRelays"
is ApiAddMember -> "apiAddMember"
is ApiJoinGroup -> "apiJoinGroup"
is ApiAcceptMember -> "apiAcceptMember"
@@ -6402,6 +6433,8 @@ sealed class CR {
@Serializable @SerialName("publicGroupCreated") class PublicGroupCreated(val user: UserRef, val groupInfo: GroupInfo, val groupLink: GroupLink, val groupRelays: List<GroupRelay>): CR()
@Serializable @SerialName("publicGroupCreationFailed") class PublicGroupCreationFailed(val user: UserRef, val addRelayResults: List<AddRelayResult>): CR()
@Serializable @SerialName("groupRelays") class GroupRelays(val user: UserRef, val groupInfo: GroupInfo, val groupRelays: List<GroupRelay>): CR()
@Serializable @SerialName("groupRelaysAdded") class GroupRelaysAdded(val user: UserRef, val groupInfo: GroupInfo, val groupLink: GroupLink, val groupRelays: List<GroupRelay>): CR()
@Serializable @SerialName("groupRelaysAddFailed") class GroupRelaysAddFailed(val user: UserRef, val addRelayResults: List<AddRelayResult>): CR()
@Serializable @SerialName("sentGroupInvitation") class SentGroupInvitation(val user: UserRef, val groupInfo: GroupInfo, val contact: Contact, val member: GroupMember): CR()
@Serializable @SerialName("userAcceptedGroupSent") class UserAcceptedGroupSent (val user: UserRef, val groupInfo: GroupInfo, val hostContact: Contact? = null): CR()
@Serializable @SerialName("groupLinkConnecting") class GroupLinkConnecting (val user: UserRef, val groupInfo: GroupInfo, val hostMember: GroupMember): CR()
@@ -6591,6 +6624,8 @@ sealed class CR {
is PublicGroupCreated -> "publicGroupCreated"
is PublicGroupCreationFailed -> "publicGroupCreationFailed"
is GroupRelays -> "groupRelays"
is GroupRelaysAdded -> "groupRelaysAdded"
is GroupRelaysAddFailed -> "groupRelaysAddFailed"
is SentGroupInvitation -> "sentGroupInvitation"
is UserAcceptedGroupSent -> "userAcceptedGroupSent"
is GroupLinkConnecting -> "groupLinkConnecting"
@@ -6773,6 +6808,8 @@ sealed class CR {
is PublicGroupCreated -> withUser(user, "groupInfo: $groupInfo\ngroupLink: $groupLink\ngroupRelays: $groupRelays")
is PublicGroupCreationFailed -> withUser(user, "addRelayResults: $addRelayResults")
is GroupRelays -> withUser(user, "groupInfo: $groupInfo\ngroupRelays: $groupRelays")
is GroupRelaysAdded -> withUser(user, "groupInfo: $groupInfo\ngroupLink: $groupLink\ngroupRelays: $groupRelays")
is GroupRelaysAddFailed -> withUser(user, "addRelayResults: $addRelayResults")
is SentGroupInvitation -> withUser(user, "groupInfo: $groupInfo\ncontact: $contact\nmember: $member")
is UserAcceptedGroupSent -> json.encodeToString(groupInfo)
is GroupLinkConnecting -> withUser(user, "groupInfo: $groupInfo\nhostMember: $hostMember")
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chat/ChatView.kt
+8 -3
View File
@@ -211,7 +211,7 @@ fun ChatView(
withContext(Dispatchers.Main) {
ChannelRelaysModel.set(cInfo.groupInfo.groupId, relays)
}
} else {
} else if (cInfo.groupInfo.membership.memberCurrent) {
val gInfo = chatModel.controller.apiGetUpdatedGroupLinkData(chatRh, cInfo.groupInfo.groupId)
if (gInfo != null) {
withContext(Dispatchers.Main) {
@@ -317,6 +317,7 @@ fun ChatView(
itemIds.sorted(),
questionText = questionText,
forAll = canDeleteForAll,
editorial = publicGroupEditor(chatInfo),
deleteMessages = { ids, forAll ->
deleteMessages(chatRh, chatInfo, ids, forAll, moderate = false) {
selectedChatItems.value = null
@@ -3351,7 +3352,9 @@ private fun deleteMessages(chatRh: Long?, chatInfo: ChatInfo, itemIds: List<Long
id = chatInfo.apiId,
scope = chatInfo.groupChatScope(),
itemIds = itemIds,
mode = if (forAll) CIDeleteMode.cidmBroadcast else CIDeleteMode.cidmInternal
mode = if (forAll) CIDeleteMode.cidmBroadcast
else if (publicGroupEditor(chatInfo)) CIDeleteMode.cidmHistory
else CIDeleteMode.cidmInternal
)
}
if (deleted != null) {
@@ -3597,7 +3600,6 @@ fun providerForGallery(
override fun scrollToStart() {
initialIndex = 0
initialChatId = chatItems.firstOrNull { canShowMedia(it) }?.id ?: return
}
override fun onDismiss(index: Int) {
@@ -3614,6 +3616,9 @@ fun providerForGallery(
typealias ChatViewItemKey = Pair<Long, Long>
fun publicGroupEditor(chatInfo: ChatInfo): Boolean =
chatInfo is ChatInfo.Group && chatInfo.groupInfo.useRelays && chatInfo.groupInfo.membership.memberRole >= GroupMemberRole.Moderator
private fun keyForItem(item: ChatItem): ChatViewItemKey = ChatViewItemKey(item.id, item.meta.createdAt.toEpochMilliseconds())
private fun ViewConfiguration.bigTouchSlop(slop: Float = 50f) = object: ViewConfiguration {
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chat/ComposeView.kt
+22 -6
View File
@@ -1543,14 +1543,14 @@ fun ComposeView(
) {
if (gInfo.membership.memberRole == GroupMemberRole.Owner) {
ownerRelayState?.let { s ->
if (s.activeCount < s.relays.size) {
if (s.relays.isEmpty() || s.activeCount < s.relays.size) {
OwnerChannelRelayBar(chatModel, s.relays, s.activeCount, s.failedCount, s.removedCount, relayListExpanded)
}
}
} else {
val hostnames = (chatModel.channelRelayHostnames[gInfo.groupId] ?: emptyList()).sorted()
val relayMembers = chatModel.groupMembers.value
.filter { it.memberRole == GroupMemberRole.Relay }
.filter { it.memberRole == GroupMemberRole.Relay && it.memberStatus !in listOf(GroupMemberStatus.MemRemoved, GroupMemberStatus.MemGroupDeleted) }
.sortedBy { hostFromRelayLink(it.relayLink ?: "") }
val showProgress = !gInfo.nextConnectPrepared || composeState.value.inProgress
val removedCount = relayMembers.count { relayMemberRemoved(it.memberStatus) }
@@ -1558,7 +1558,7 @@ fun ComposeView(
val failedCount = relayMembers.count { !relayMemberRemoved(it.memberStatus) && it.activeConn?.connFailedErr != null }
val resolvedCount = connectedCount + removedCount + failedCount
val total = if (relayMembers.isNotEmpty()) relayMembers.size else hostnames.size
if (total > 0 && (removedCount + failedCount > 0 || resolvedCount < total)) {
if (total == 0 || removedCount + failedCount > 0 || resolvedCount < total) {
SubscriberChannelRelayBar(hostnames, relayMembers, connectedCount, removedCount, failedCount, total, showProgress, relayListExpanded)
}
}
@@ -1756,7 +1756,15 @@ private fun OwnerChannelRelayBar(
if (!allBroken && activeCount + failedCount + removedCount < total) {
RelayProgressIndicator(active = activeCount, total = total)
}
if (allBroken) {
if (total == 0) {
Text(generalGetString(MR.strings.relay_bar_no_relays), color = MaterialTheme.colors.secondary)
Icon(
painterResource(MR.images.ic_warning),
contentDescription = null,
tint = WarningOrange,
modifier = Modifier.size(18.dp)
)
} else if (allBroken) {
val statusText = if (removedCount == total) {
generalGetString(MR.strings.relay_bar_all_relays_removed)
} else if (failedCount == total) {
@@ -1842,7 +1850,15 @@ private fun SubscriberChannelRelayBar(
val allBroken = connectedCount == 0 && errorCount == total
Column(Modifier.background(MaterialTheme.colors.surface)) {
RelayBarHeader(relayListExpanded) {
if (allBroken) {
if (total == 0) {
Text(generalGetString(MR.strings.relay_bar_no_relays), color = MaterialTheme.colors.secondary)
Icon(
painterResource(MR.images.ic_warning),
contentDescription = null,
tint = WarningOrange,
modifier = Modifier.size(18.dp)
)
} else if (allBroken) {
val statusText = if (removedCount == total) {
generalGetString(MR.strings.relay_bar_all_relays_removed)
} else if (failedCount == total) {
@@ -1990,7 +2006,7 @@ private fun ownerRelayState(chat: Chat, chatModel: ChatModel): OwnerRelayState?
gInfo.membership.memberStatus in listOf(GroupMemberStatus.MemLeft, GroupMemberStatus.MemRemoved, GroupMemberStatus.MemGroupDeleted)
) return null
val relays = if (ChannelRelaysModel.groupId.value == gInfo.groupId) ChannelRelaysModel.groupRelays.toList() else emptyList()
if (relays.isEmpty()) return null
if (relays.isEmpty()) return OwnerRelayState(emptyList(), 0, 0, 0, true)
val relayMembers = relays.map { relay ->
relay to chatModel.groupMembers.value.firstOrNull { it.groupMemberId == relay.groupMemberId }
}
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chat/TextSelection.kt
+36 -10
View File
@@ -36,6 +36,7 @@ import androidx.compose.ui.unit.IntSize
import androidx.compose.ui.unit.dp
import chat.simplex.common.model.*
import chat.simplex.common.platform.*
import chat.simplex.common.views.chat.item.itemPrefixText
import chat.simplex.common.views.chat.item.itemSegmentDisplayText
import chat.simplex.common.views.helpers.generalGetString
import chat.simplex.res.MR
@@ -52,8 +53,10 @@ val LocalItemContext = compositionLocalOf { ItemContext() }
data class SelectionRange(
val startIndex: Int,
val startItemId: Long,
val startOffset: Int,
val endIndex: Int,
val endItemId: Long,
val endOffset: Int
)
@@ -79,11 +82,13 @@ class SelectionManager {
var viewportPosition by mutableStateOf(Offset.Zero)
var focusCharRect by mutableStateOf(Rect.Zero) // X: absolute window, Y: relative to item
var listState: State<LazyListState>? = null
var mergedItemsState: State<MergedItems>? = null
var onCopySelection: (() -> Unit)? = null
private var autoScrollJob: Job? = null
fun startSelection(startIndex: Int, anchorY: Float, anchorX: Float) {
range = SelectionRange(startIndex, -1, startIndex, -1)
val id = mergedItemsState?.value?.items?.getOrNull(startIndex)?.newest()?.item?.id ?: return
range = SelectionRange(startIndex, id, -1, startIndex, id, -1)
selectionState = SelectionState.Selecting
anchorWindowY = anchorY
anchorWindowX = anchorX
@@ -96,7 +101,8 @@ class SelectionManager {
fun updateFocusIndex(index: Int) {
val r = range ?: return
range = r.copy(endIndex = index)
val id = mergedItemsState?.value?.items?.getOrNull(index)?.newest()?.item?.id ?: return
range = r.copy(endIndex = index, endItemId = id)
}
fun updateFocusOffset(offset: Int, charRect: Rect = Rect.Zero) {
@@ -175,6 +181,15 @@ class SelectionManager {
updateFocusIndex(idx)
}
fun resyncIndices() {
val r = range ?: return
val items = mergedItemsState?.value?.items ?: return
val newStartIndex = items.indexOfFirst { it.newest().item.id == r.startItemId }
val newEndIndex = items.indexOfFirst { it.newest().item.id == r.endItemId }
if (newStartIndex < 0 || newEndIndex < 0) clearSelection()
else range = r.copy(startIndex = newStartIndex, endIndex = newEndIndex)
}
fun updateAutoScroll(draggingDown: Boolean, pointerY: Float, scope: CoroutineScope) {
val edgeDistance = if (draggingDown) viewportBottom - pointerY else pointerY - viewportTop
if (edgeDistance !in 0f..AUTO_SCROLL_ZONE_PX) {
@@ -240,15 +255,22 @@ fun selectedRange(range: SelectionRange?, index: Int): IntRange? {
}
// Extracts source text for the selected range within one item.
// Selection offsets are in display-text space. For transformed segments (mentions, links with showText),
// the full source is emitted if any part is selected. For untransformed segments, partial substring works.
// Selection offsets are in display-text space (which includes any leading itemPrefixText).
// For transformed segments (mentions, links with showText), the full source is emitted if any part
// is selected. For untransformed segments, partial substring works.
private fun selectedItemCopiedText(ci: ChatItem, sel: IntRange, linkMode: SimplexLinkMode): String {
val formattedText = ci.formattedText ?: return ci.text.substring(
sel.first.coerceAtMost(ci.text.length),
(sel.last + 1).coerceAtMost(ci.text.length)
)
val prefix = itemPrefixText(ci)
val sb = StringBuilder()
var displayOffset = 0
if (sel.first < prefix.length) {
sb.append(prefix, sel.first, minOf(prefix.length, sel.last + 1))
}
val formattedText = ci.formattedText ?: run {
val start = (sel.first - prefix.length).coerceAtLeast(0).coerceAtMost(ci.text.length)
val end = (sel.last + 1 - prefix.length).coerceAtMost(ci.text.length)
if (start < end) sb.append(ci.text, start, end)
return sb.toString()
}
var displayOffset = prefix.length
for (ft in formattedText) {
val segDisplay = itemSegmentDisplayText(ft, ci, linkMode)
val displayEnd = displayOffset + segDisplay.length
@@ -269,7 +291,7 @@ private fun selectedItemCopiedText(ci: ChatItem, sel: IntRange, linkMode: Simple
// Snaps a boundary offset to include full transformed segments.
private fun snapOffset(ci: ChatItem, offset: Int, linkMode: SimplexLinkMode, expandRight: Boolean): Int {
val formattedText = ci.formattedText ?: return offset
var displayOffset = 0
var displayOffset = itemPrefixText(ci).length
for (ft in formattedText) {
val segDisplay = itemSegmentDisplayText(ft, ci, linkMode)
val displayEnd = displayOffset + segDisplay.length
@@ -312,11 +334,15 @@ fun BoxScope.SelectionHandler(
}
manager.listState = listState
manager.mergedItemsState = mergedItems
manager.onCopySelection = {
clipboard.setText(AnnotatedString(manager.getSelectedCopiedText(mergedItems.value.items, revealedItems.value, linkMode)))
showToast(generalGetString(MR.strings.copied))
}
// Resync after the items list mutates (new message arrives, item deleted).
SideEffect { manager.resyncIndices() }
return Modifier
.focusRequester(focusRequester)
.focusable()
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chat/group/AddGroupRelayView.kt
+237
View File
@@ -0,0 +1,237 @@
package chat.simplex.common.views.chat.group
import SectionBottomSpacer
import SectionCustomFooter
import SectionDividerSpaced
import SectionItemView
import SectionView
import androidx.compose.foundation.layout.*
import androidx.compose.material.*
import androidx.compose.runtime.*
import androidx.compose.ui.Alignment
import androidx.compose.ui.Modifier
import androidx.compose.ui.unit.dp
import androidx.compose.ui.unit.sp
import chat.simplex.common.model.*
import chat.simplex.common.platform.*
import chat.simplex.common.ui.theme.*
import chat.simplex.common.views.helpers.*
import chat.simplex.common.views.newchat.chatRelayDisplayName
import chat.simplex.common.views.usersettings.SettingsActionItem
import chat.simplex.res.MR
import dev.icerock.moko.resources.compose.painterResource
import kotlinx.coroutines.launch
data class AvailableRelay(
val relayId: Long,
val relay: UserChatRelay,
val operatorName: String?
)
@Composable
fun AddGroupRelayView(
groupInfo: GroupInfo,
existingRelayIds: Set<Long>,
onRelayAdded: () -> Unit,
close: () -> Unit
) {
var availableRelays by remember { mutableStateOf<List<AvailableRelay>>(emptyList()) }
var selectedRelayIds by remember { mutableStateOf<Set<Long>>(emptySet()) }
var isLoading by remember { mutableStateOf(true) }
var isAdding by remember { mutableStateOf(false) }
val scope = rememberCoroutineScope()
BackHandler(onBack = close)
LaunchedEffect(Unit) {
try {
val servers = ChatController.getUserServers(null)
if (servers != null) {
val relays = mutableListOf<AvailableRelay>()
for (op in servers) {
if (op.operator != null && op.operator.enabled != true) continue
val opName: String? = if (op.operator?.operatorTag != null) op.operator.tradeName else null
for (relay in op.chatRelays) {
val relayId = relay.chatRelayId
if (relay.enabled && !relay.deleted && relayId != null && relayId !in existingRelayIds) {
relays.add(AvailableRelay(relayId, relay, opName))
}
}
}
availableRelays = relays
}
} catch (e: Exception) {
Log.e(TAG, "loadAvailableRelays error: ${e.message}")
}
isLoading = false
}
AddGroupRelayLayout(
availableRelays = availableRelays,
selectedRelayIds = selectedRelayIds,
isLoading = isLoading,
isAdding = isAdding,
onToggleRelay = { relayId ->
selectedRelayIds = if (relayId in selectedRelayIds) selectedRelayIds - relayId else selectedRelayIds + relayId
},
onAddRelays = {
val relayIds = selectedRelayIds.toList()
if (relayIds.isEmpty()) return@AddGroupRelayLayout
isAdding = true
scope.launch {
addSelectedRelays(groupInfo, relayIds, selectedRelayIds, availableRelays, onRelayAdded, close) { newSelectedIds, newAvailableRelays ->
selectedRelayIds = newSelectedIds
availableRelays = newAvailableRelays
isAdding = false
}
}
}
)
}
@Composable
private fun AddGroupRelayLayout(
availableRelays: List<AvailableRelay>,
selectedRelayIds: Set<Long>,
isLoading: Boolean,
isAdding: Boolean,
onToggleRelay: (Long) -> Unit,
onAddRelays: () -> Unit
) {
ColumnWithScrollBar {
AppBarTitle(generalGetString(MR.strings.add_relays_title))
if (isLoading) {
Box(Modifier.fillMaxWidth().padding(vertical = DEFAULT_PADDING), contentAlignment = Alignment.Center) {
CircularProgressIndicator()
}
} else if (availableRelays.isEmpty()) {
SectionView {
SectionItemView(padding = PaddingValues(horizontal = DEFAULT_PADDING)) {
Text(
generalGetString(MR.strings.no_available_relays),
color = MaterialTheme.colors.secondary
)
}
}
} else {
SectionView {
AddRelaysButton(
onClick = onAddRelays,
disabled = selectedRelayIds.isEmpty() || isAdding
)
}
SectionCustomFooter {
val count = selectedRelayIds.size
Text(
if (count == 0) generalGetString(MR.strings.no_relays_selected)
else String.format(generalGetString(MR.strings.num_relays_selected), count),
color = MaterialTheme.colors.secondary,
lineHeight = 18.sp,
fontSize = 14.sp
)
}
SectionDividerSpaced(maxTopPadding = true)
SectionView(generalGetString(MR.strings.select_relays).uppercase()) {
availableRelays.forEach { item ->
val selected = item.relayId in selectedRelayIds
SectionItemView(
click = { onToggleRelay(item.relayId) },
padding = PaddingValues(horizontal = DEFAULT_PADDING, vertical = 4.dp)
) {
Column(Modifier.weight(1f)) {
Text(
chatRelayDisplayName(item.relay),
maxLines = 1,
color = MaterialTheme.colors.onBackground
)
if (item.operatorName != null) {
Text(
item.operatorName,
fontSize = 12.sp,
maxLines = 1,
color = MaterialTheme.colors.secondary
)
}
}
Spacer(Modifier.width(8.dp))
Icon(
painterResource(if (selected) MR.images.ic_check_circle_filled else MR.images.ic_circle),
contentDescription = null,
tint = if (selected) MaterialTheme.colors.primary else MaterialTheme.colors.secondary,
modifier = Modifier.size(24.dp)
)
}
}
}
}
SectionBottomSpacer()
}
}
@Composable
private fun AddRelaysButton(onClick: () -> Unit, disabled: Boolean) {
SettingsActionItem(
painterResource(MR.images.ic_check),
generalGetString(MR.strings.add_relays_title),
click = onClick,
textColor = MaterialTheme.colors.primary,
iconColor = MaterialTheme.colors.primary,
disabled = disabled,
)
}
private suspend fun addSelectedRelays(
groupInfo: GroupInfo,
relayIds: List<Long>,
selectedRelayIds: Set<Long>,
availableRelays: List<AvailableRelay>,
onRelayAdded: () -> Unit,
close: () -> Unit,
updateState: (Set<Long>, List<AvailableRelay>) -> Unit
) {
try {
val result = ChatController.apiAddGroupRelays(groupInfo.groupId, relayIds)
if (result == null) {
updateState(selectedRelayIds, availableRelays)
return
}
when (result) {
is ChatController.AddGroupRelaysResult.Added -> {
ChannelRelaysModel.set(groupId = result.groupInfo.groupId, groupRelays = result.groupRelays)
onRelayAdded()
close()
}
is ChatController.AddGroupRelaysResult.AddFailed -> {
val results = result.addRelayResults
val successIds = results.filter { it.relayError == null }.mapNotNull { it.relay.chatRelayId }.toSet()
var newSelectedIds = selectedRelayIds
var newAvailableRelays = availableRelays
if (successIds.isNotEmpty()) {
newSelectedIds = selectedRelayIds - successIds
newAvailableRelays = availableRelays.filter { it.relayId !in successIds }
onRelayAdded()
}
val errorLines = results.filter { it.relayError != null }
.map { "${chatRelayDisplayName(it.relay)}: ${it.relayError?.let { e -> ChatController.connErrorText(e) } ?: ""}" }
val successNames = results.filter { it.relayError == null }
.map { chatRelayDisplayName(it.relay) }
var msg = errorLines.joinToString("\n")
if (successNames.isNotEmpty()) {
msg += "\n" + String.format(generalGetString(MR.strings.relays_added_format), successNames.joinToString(", "))
}
AlertManager.shared.showAlertMsg(
title = generalGetString(MR.strings.error_adding_relays),
text = msg
)
updateState(newSelectedIds, newAvailableRelays)
}
}
} catch (e: Exception) {
AlertManager.shared.showAlertMsg(
title = generalGetString(MR.strings.error_adding_relays),
text = e.message ?: ""
)
updateState(selectedRelayIds, availableRelays)
}
}
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chat/group/ChannelRelaysView.kt
+52 -4
View File
@@ -2,6 +2,7 @@ package chat.simplex.common.views.chat.group
import SectionBottomSpacer
import SectionItemView
import SectionItemViewLongClickable
import SectionTextFooter
import SectionView
import androidx.compose.foundation.layout.*
@@ -16,9 +17,11 @@ import androidx.compose.ui.unit.sp
import chat.simplex.common.model.*
import chat.simplex.common.platform.*
import chat.simplex.common.ui.theme.*
import chat.simplex.common.views.chat.item.ItemAction
import chat.simplex.common.views.chatlist.setGroupMembers
import chat.simplex.common.views.helpers.*
import chat.simplex.res.MR
import dev.icerock.moko.resources.compose.painterResource
@Composable
fun ChannelRelaysView(
@@ -29,16 +32,18 @@ fun ChannelRelaysView(
showMemberInfo: (GroupMember, GroupRelay?) -> Unit
) {
BackHandler(onBack = close)
var groupRelays by remember { mutableStateOf<List<GroupRelay>>(emptyList()) }
val groupRelays = ChannelRelaysModel.groupRelays
LaunchedEffect(Unit) {
setGroupMembers(rhId, groupInfo, chatModel)
if (groupInfo.isOwner) {
groupRelays = chatModel.controller.apiGetGroupRelays(groupInfo.groupId)
val relays = chatModel.controller.apiGetGroupRelays(groupInfo.groupId)
ChannelRelaysModel.set(groupId = groupInfo.groupId, groupRelays = relays)
}
}
ChannelRelaysLayout(
rhId = rhId,
groupInfo = groupInfo,
chatModel = chatModel,
groupRelays = groupRelays,
@@ -48,13 +53,14 @@ fun ChannelRelaysView(
@Composable
private fun ChannelRelaysLayout(
rhId: Long?,
groupInfo: GroupInfo,
chatModel: ChatModel,
groupRelays: List<GroupRelay>,
showMemberInfo: (GroupMember, GroupRelay?) -> Unit
) {
val relayMembers = remember { chatModel.groupMembers }.value
.filter { it.memberRole == GroupMemberRole.Relay }
.filter { it.memberRole == GroupMemberRole.Relay && it.memberStatus != GroupMemberStatus.MemRemoved && it.memberStatus != GroupMemberStatus.MemGroupDeleted }
ColumnWithScrollBar {
AppBarTitle(generalGetString(MR.strings.channel_relays_title))
@@ -74,11 +80,24 @@ private fun ChannelRelaysLayout(
if (index > 0) {
Divider()
}
SectionItemView(
val showMenu = remember { mutableStateOf(false) }
SectionItemViewLongClickable(
click = { showMemberInfo(member, groupRelays.firstOrNull { it.groupMemberId == member.groupMemberId }) },
longClick = { showMenu.value = true },
minHeight = 54.dp,
padding = PaddingValues(horizontal = DEFAULT_PADDING)
) {
// TODO [relays] re-enable when relay management ships
/*
if (groupInfo.isOwner && member.canBeRemoved(groupInfo)) {
DefaultDropdownMenu(showMenu) {
ItemAction(generalGetString(MR.strings.button_remove_relay), painterResource(MR.images.ic_delete), color = MaterialTheme.colors.error, onClick = {
removeMemberAlert(rhId, groupInfo, member)
showMenu.value = false
})
}
}
*/
val statusText = if (groupInfo.isOwner) {
ownerRelayStatusText(member, groupRelays)
} else {
@@ -90,6 +109,35 @@ private fun ChannelRelaysLayout(
}
SectionTextFooter(generalGetString(MR.strings.chat_relays_forward_messages))
}
// TODO [relays] re-enable when relay management ships
/*
if (groupInfo.isOwner) {
SectionView {
SectionItemView(click = {
val existingRelayIds = groupRelays.filter { it.relayStatus != RelayStatus.RsInactive }.mapNotNull { it.userChatRelay.chatRelayId }.toSet()
ModalManager.end.showModalCloseable(true) { close ->
AddGroupRelayView(
groupInfo = groupInfo,
existingRelayIds = existingRelayIds,
onRelayAdded = { withBGApi { setGroupMembers(rhId, groupInfo, chatModel) } },
close = close
)
}
}, padding = PaddingValues(horizontal = DEFAULT_PADDING)) {
Icon(
painterResource(MR.images.ic_add),
contentDescription = null,
tint = MaterialTheme.colors.primary
)
Spacer(Modifier.width(4.dp))
Text(
generalGetString(MR.strings.add_relay_button),
color = MaterialTheme.colors.primary
)
}
}
}
*/
SectionBottomSpacer()
}
}
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chat/group/GroupChatInfoView.kt
+79 -30
View File
@@ -239,39 +239,88 @@ fun leaveGroupDialog(rhId: Long?, groupInfo: GroupInfo, chatModel: ChatModel, cl
)
}
private fun removeMemberAlert(rhId: Long?, groupInfo: GroupInfo, mem: GroupMember) {
val titleId = if (groupInfo.useRelays) MR.strings.button_remove_subscriber_question
else MR.strings.button_remove_member_question
val messageId = if (groupInfo.useRelays)
MR.strings.subscriber_will_be_removed_from_channel_cannot_be_undone
else if (groupInfo.businessChat == null)
MR.strings.member_will_be_removed_from_group_cannot_be_undone
else
MR.strings.member_will_be_removed_from_chat_cannot_be_undone
AlertManager.shared.showAlertDialogButtonsColumn(
generalGetString(titleId),
generalGetString(messageId),
buttons = {
Column {
SectionItemView({
AlertManager.shared.hideAlert()
removeMembers(rhId, groupInfo, listOf(mem.groupMemberId), withMessages = false)
}) {
Text(generalGetString(MR.strings.remove_member_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
fun removeMemberAlert(rhId: Long?, groupInfo: GroupInfo, mem: GroupMember) {
if (mem.memberRole == GroupMemberRole.Relay) {
val isLastActive = groupInfo.useRelays && mem.memberCurrent && run {
val activeRelays = ChatModel.groupMembers.value.filter { it.memberRole == GroupMemberRole.Relay && it.memberCurrent }
activeRelays.size <= 1
}
val message = if (isLastActive) generalGetString(MR.strings.last_active_relay_warning)
else generalGetString(MR.strings.relay_will_be_removed_from_channel)
AlertManager.shared.showAlertDialogButtonsColumn(
generalGetString(MR.strings.button_remove_relay_question),
message,
buttons = {
Column {
SectionItemView({
AlertManager.shared.hideAlert()
removeMembers(rhId, groupInfo, listOf(mem.groupMemberId), withMessages = false)
}) {
Text(generalGetString(MR.strings.remove_member_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
}
SectionItemView({
AlertManager.shared.hideAlert()
}) {
Text(generalGetString(MR.strings.cancel_verb), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = MaterialTheme.colors.primary)
}
}
SectionItemView({
AlertManager.shared.hideAlert()
removeMembers(rhId, groupInfo, listOf(mem.groupMemberId), withMessages = true)
}) {
Text(generalGetString(MR.strings.remove_member_delete_messages_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
})
} else if (groupInfo.useRelays) {
AlertManager.shared.showAlertDialogButtonsColumn(
generalGetString(MR.strings.button_remove_subscriber_question),
generalGetString(MR.strings.subscriber_will_be_removed_from_channel_cannot_be_undone),
buttons = {
Column {
SectionItemView({
AlertManager.shared.hideAlert()
removeMembers(rhId, groupInfo, listOf(mem.groupMemberId), withMessages = false)
}) {
Text(generalGetString(MR.strings.remove_member_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
}
SectionItemView({
AlertManager.shared.hideAlert()
removeMembers(rhId, groupInfo, listOf(mem.groupMemberId), withMessages = true)
}) {
Text(generalGetString(MR.strings.remove_member_delete_messages_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
}
SectionItemView({
AlertManager.shared.hideAlert()
}) {
Text(generalGetString(MR.strings.cancel_verb), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = MaterialTheme.colors.primary)
}
}
SectionItemView({
AlertManager.shared.hideAlert()
}) {
Text(generalGetString(MR.strings.cancel_verb), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = MaterialTheme.colors.primary)
})
} else {
val titleId = MR.strings.button_remove_member_question
val messageId = if (groupInfo.businessChat == null)
MR.strings.member_will_be_removed_from_group_cannot_be_undone
else
MR.strings.member_will_be_removed_from_chat_cannot_be_undone
AlertManager.shared.showAlertDialogButtonsColumn(
generalGetString(titleId),
generalGetString(messageId),
buttons = {
Column {
SectionItemView({
AlertManager.shared.hideAlert()
removeMembers(rhId, groupInfo, listOf(mem.groupMemberId), withMessages = false)
}) {
Text(generalGetString(MR.strings.remove_member_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
}
SectionItemView({
AlertManager.shared.hideAlert()
removeMembers(rhId, groupInfo, listOf(mem.groupMemberId), withMessages = true)
}) {
Text(generalGetString(MR.strings.remove_member_delete_messages_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
}
SectionItemView({
AlertManager.shared.hideAlert()
}) {
Text(generalGetString(MR.strings.cancel_verb), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = MaterialTheme.colors.primary)
}
}
}
})
})
}
}
private fun removeMembersAlert(rhId: Long?, groupInfo: GroupInfo, memberIds: List<Long>, onSuccess: () -> Unit = {}) {
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chat/group/GroupLinkView.kt
+7 -2
View File
@@ -281,8 +281,13 @@ fun GroupLinkLayout(
)
}
if (creatingGroup && close != null) {
Spacer(Modifier.height(DEFAULT_PADDING_HALF))
ContinueButton(close)
SettingsActionItem(
painterResource(MR.images.ic_check),
stringResource(MR.strings.continue_to_next_step),
click = close,
iconColor = MaterialTheme.colors.primary,
textColor = MaterialTheme.colors.primary,
)
}
}
}
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chat/group/GroupMemberInfoView.kt
+85 -30
View File
@@ -242,34 +242,86 @@ fun GroupMemberInfoView(
}
fun removeMemberDialog(rhId: Long?, groupInfo: GroupInfo, member: GroupMember, chatModel: ChatModel, close: (() -> Unit)? = null) {
val messageId = if (groupInfo.businessChat == null)
MR.strings.member_will_be_removed_from_group_cannot_be_undone
else
MR.strings.member_will_be_removed_from_chat_cannot_be_undone
AlertManager.shared.showAlertDialogButtonsColumn(
generalGetString(MR.strings.button_remove_member_question),
generalGetString(messageId),
buttons = {
Column {
SectionItemView({
AlertManager.shared.hideAlert()
removeMember(rhId, groupInfo, member, withMessages = false, chatModel, close)
}) {
Text(generalGetString(MR.strings.remove_member_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
if (member.memberRole == GroupMemberRole.Relay) {
val isLastActive = groupInfo.useRelays && run {
val activeRelays = chatModel.groupMembers.value.filter { it.memberRole == GroupMemberRole.Relay && it.memberCurrent }
activeRelays.size <= 1
}
val message = if (isLastActive) generalGetString(MR.strings.last_active_relay_warning)
else generalGetString(MR.strings.relay_will_be_removed_from_channel)
AlertManager.shared.showAlertDialogButtonsColumn(
generalGetString(MR.strings.button_remove_relay_question),
message,
buttons = {
Column {
SectionItemView({
AlertManager.shared.hideAlert()
removeMember(rhId, groupInfo, member, withMessages = false, chatModel, close)
}) {
Text(generalGetString(MR.strings.remove_member_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
}
SectionItemView({
AlertManager.shared.hideAlert()
}) {
Text(generalGetString(MR.strings.cancel_verb), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = MaterialTheme.colors.primary)
}
}
SectionItemView({
AlertManager.shared.hideAlert()
removeMember(rhId, groupInfo, member, withMessages = true, chatModel, close)
}) {
Text(generalGetString(MR.strings.remove_member_delete_messages_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
})
} else if (groupInfo.useRelays) {
AlertManager.shared.showAlertDialogButtonsColumn(
generalGetString(MR.strings.button_remove_subscriber_question),
generalGetString(MR.strings.subscriber_will_be_removed_from_channel_cannot_be_undone),
buttons = {
Column {
SectionItemView({
AlertManager.shared.hideAlert()
removeMember(rhId, groupInfo, member, withMessages = false, chatModel, close)
}) {
Text(generalGetString(MR.strings.remove_member_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
}
SectionItemView({
AlertManager.shared.hideAlert()
removeMember(rhId, groupInfo, member, withMessages = true, chatModel, close)
}) {
Text(generalGetString(MR.strings.remove_member_delete_messages_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
}
SectionItemView({
AlertManager.shared.hideAlert()
}) {
Text(generalGetString(MR.strings.cancel_verb), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = MaterialTheme.colors.primary)
}
}
SectionItemView({
AlertManager.shared.hideAlert()
}) {
Text(generalGetString(MR.strings.cancel_verb), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = MaterialTheme.colors.primary)
})
} else {
val messageId = if (groupInfo.businessChat == null)
MR.strings.member_will_be_removed_from_group_cannot_be_undone
else
MR.strings.member_will_be_removed_from_chat_cannot_be_undone
AlertManager.shared.showAlertDialogButtonsColumn(
generalGetString(MR.strings.button_remove_member_question),
generalGetString(messageId),
buttons = {
Column {
SectionItemView({
AlertManager.shared.hideAlert()
removeMember(rhId, groupInfo, member, withMessages = false, chatModel, close)
}) {
Text(generalGetString(MR.strings.remove_member_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
}
SectionItemView({
AlertManager.shared.hideAlert()
removeMember(rhId, groupInfo, member, withMessages = true, chatModel, close)
}) {
Text(generalGetString(MR.strings.remove_member_delete_messages_confirmation), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = Color.Red)
}
SectionItemView({
AlertManager.shared.hideAlert()
}) {
Text(generalGetString(MR.strings.cancel_verb), Modifier.fillMaxWidth(), textAlign = TextAlign.Center, color = MaterialTheme.colors.primary)
}
}
}
})
})
}
}
fun deleteMemberMessagesDialog(rhId: Long?, groupInfo: GroupInfo, member: GroupMember, chatModel: ChatModel, close: (() -> Unit)? = null) {
@@ -368,6 +420,7 @@ fun GroupMemberInfoLayout(
@Composable
fun ModeratorDestructiveSection() {
val canBlockForAll = member.canBlockForAll(groupInfo)
// TODO [relays] re-enable when relay management ships
val canRemove = member.canBeRemoved(groupInfo) && member.memberRole != GroupMemberRole.Relay
if (canBlockForAll || canRemove) {
SectionDividerSpaced(maxBottomPadding = false)
@@ -380,10 +433,10 @@ fun GroupMemberInfoLayout(
}
}
if (canRemove) {
if (member.memberStatus == GroupMemberStatus.MemRemoved || member.memberStatus == GroupMemberStatus.MemLeft) {
if (member.memberStatus != GroupMemberStatus.MemRemoved && (member.memberStatus != GroupMemberStatus.MemLeft || member.memberRole == GroupMemberRole.Relay)) {
RemoveMemberButton(groupInfo.useRelays, member.memberRole == GroupMemberRole.Relay, removeMember)
} else if (member.memberRole != GroupMemberRole.Relay) {
DeleteMemberMessagesButton(deleteMemberMessages)
} else {
RemoveMemberButton(groupInfo.useRelays, removeMember)
}
}
}
@@ -753,8 +806,10 @@ fun UnblockForAllButton(onClick: () -> Unit) {
}
@Composable
fun RemoveMemberButton(useRelays: Boolean = false, onClick: () -> Unit) {
val label = if (useRelays) MR.strings.button_remove_subscriber else MR.strings.button_remove_member
fun RemoveMemberButton(useRelays: Boolean = false, isRelay: Boolean = false, onClick: () -> Unit) {
val label = if (isRelay) MR.strings.button_remove_relay
else if (useRelays) MR.strings.button_remove_subscriber
else MR.strings.button_remove_member
SettingsActionItem(
painterResource(MR.images.ic_delete),
stringResource(label),
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chat/item/CIImageView.kt
+1 -1
View File
@@ -182,7 +182,7 @@ fun CIImageView(
.then(
if (!smallView) {
val w = if (previewBitmap.width * 0.97 <= previewBitmap.height) imageViewFullWidth() * 0.75f else DEFAULT_MAX_IMAGE_WIDTH
Modifier.width(w).aspectRatio(previewBitmap.width.toFloat() / previewBitmap.height.toFloat())
Modifier.width(w).aspectRatio((previewBitmap.width.toFloat() / previewBitmap.height.toFloat()).coerceAtLeast(1f / 2.33f))
} else Modifier
)
.desktopModifyBlurredState(!smallView, blurred, showMenu),
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chat/item/ChatItemView.kt
+31 -21
View File
@@ -374,7 +374,7 @@ fun ChatItemView(
@Composable
fun DeleteItemMenu() {
DefaultDropdownMenu(showMenu) {
DeleteItemAction(chatsCtx, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
DeleteItemAction(chatsCtx, cInfo, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
if (cItem.canBeDeletedForSelf) {
Divider()
SelectItemAction(showMenu, selectChatItem)
@@ -392,7 +392,7 @@ fun ChatItemView(
if (cItem.chatDir !is CIDirection.GroupSnd && cInfo.groupInfo.membership.memberRole >= GroupMemberRole.Moderator) {
ArchiveReportItemAction(cItem.id, cInfo.groupInfo.membership.memberActive, showMenu, archiveReports)
}
DeleteItemAction(chatsCtx, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages, buttonText = stringResource(MR.strings.delete_report))
DeleteItemAction(chatsCtx, cInfo, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages, buttonText = stringResource(MR.strings.delete_report))
Divider()
SelectItemAction(showMenu, selectChatItem)
}
@@ -482,7 +482,7 @@ fun ChatItemView(
CancelFileItemAction(cItem.file.fileId, showMenu, cancelFile = cancelFile, cancelAction = cItem.file.cancelAction)
}
if (!(live && cItem.meta.isLive) && !preview) {
DeleteItemAction(chatsCtx, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
DeleteItemAction(chatsCtx, cInfo, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
}
if (cItem.chatDir !is CIDirection.GroupSnd) {
val groupInfo = cItem.memberToModerate(cInfo)?.first
@@ -508,7 +508,7 @@ fun ChatItemView(
ExpandItemAction(revealed, showMenu, reveal)
}
ItemInfoAction(cInfo, cItem, showItemDetails, showMenu)
DeleteItemAction(chatsCtx, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
DeleteItemAction(chatsCtx, cInfo, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
if (cItem.canBeDeletedForSelf) {
Divider()
SelectItemAction(showMenu, selectChatItem)
@@ -518,7 +518,7 @@ fun ChatItemView(
cItem.isDeletedContent -> {
DefaultDropdownMenu(showMenu) {
ItemInfoAction(cInfo, cItem, showItemDetails, showMenu)
DeleteItemAction(chatsCtx, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
DeleteItemAction(chatsCtx, cInfo, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
if (cItem.canBeDeletedForSelf) {
Divider()
SelectItemAction(showMenu, selectChatItem)
@@ -532,7 +532,7 @@ fun ChatItemView(
} else {
ExpandItemAction(revealed, showMenu, reveal)
}
DeleteItemAction(chatsCtx, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
DeleteItemAction(chatsCtx, cInfo, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
if (cItem.canBeDeletedForSelf) {
Divider()
SelectItemAction(showMenu, selectChatItem)
@@ -541,7 +541,7 @@ fun ChatItemView(
}
else -> {
DefaultDropdownMenu(showMenu) {
DeleteItemAction(chatsCtx, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
DeleteItemAction(chatsCtx, cInfo, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
if (selectedChatItems.value == null) {
Divider()
SelectItemAction(showMenu, selectChatItem)
@@ -558,7 +558,7 @@ fun ChatItemView(
RevealItemAction(revealed, showMenu, reveal)
}
ItemInfoAction(cInfo, cItem, showItemDetails, showMenu)
DeleteItemAction(chatsCtx, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
DeleteItemAction(chatsCtx, cInfo, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
if (cItem.canBeDeletedForSelf) {
Divider()
SelectItemAction(showMenu, selectChatItem)
@@ -587,7 +587,7 @@ fun ChatItemView(
DeletedItemView(cItem, cInfo.timedMessagesTTL, showViaProxy = showViaProxy, showTimestamp = showTimestamp)
DefaultDropdownMenu(showMenu) {
ItemInfoAction(cInfo, cItem, showItemDetails, showMenu)
DeleteItemAction(chatsCtx, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
DeleteItemAction(chatsCtx, cInfo, cItem, revealed, showMenu, questionText = deleteMessageQuestionText(), deleteMessage, deleteMessages)
if (cItem.canBeDeletedForSelf) {
Divider()
SelectItemAction(showMenu, selectChatItem)
@@ -661,7 +661,7 @@ fun ChatItemView(
ExpandItemAction(revealed, showMenu, reveal)
}
ItemInfoAction(cInfo, cItem, showItemDetails, showMenu)
DeleteItemAction(chatsCtx, cItem, revealed, showMenu, questionText = generalGetString(MR.strings.delete_message_cannot_be_undone_warning), deleteMessage, deleteMessages)
DeleteItemAction(chatsCtx, cInfo, cItem, revealed, showMenu, questionText = generalGetString(MR.strings.delete_message_cannot_be_undone_warning), deleteMessage, deleteMessages)
if (cItem.canBeDeletedForSelf) {
Divider()
SelectItemAction(showMenu, selectChatItem)
@@ -866,6 +866,7 @@ fun ItemInfoAction(
@Composable
fun DeleteItemAction(
chatsCtx: ChatModel.ChatsContext,
cInfo: ChatInfo,
cItem: ChatItem,
revealed: State<Boolean>,
showMenu: MutableState<Boolean>,
@@ -898,13 +899,13 @@ fun DeleteItemAction(
deleteMessages = { ids, _ -> deleteMessages(ids) }
)
} else {
deleteMessageAlertDialog(cItem, questionText, deleteMessage = deleteMessage)
deleteMessageAlertDialog(cItem, questionText, cInfo, deleteMessage = deleteMessage)
}
} else {
deleteMessageAlertDialog(cItem, questionText, deleteMessage = deleteMessage)
deleteMessageAlertDialog(cItem, questionText, cInfo, deleteMessage = deleteMessage)
}
} else {
deleteMessageAlertDialog(cItem, questionText, deleteMessage = deleteMessage)
deleteMessageAlertDialog(cItem, questionText, cInfo, deleteMessage = deleteMessage)
}
},
color = Color.Red
@@ -1371,7 +1372,9 @@ fun cancelFileAlertDialog(fileId: Long, cancelFile: (Long) -> Unit, cancelAction
)
}
fun deleteMessageAlertDialog(chatItem: ChatItem, questionText: String, deleteMessage: (Long, CIDeleteMode) -> Unit) {
fun deleteMessageAlertDialog(chatItem: ChatItem, questionText: String, chatInfo: ChatInfo, deleteMessage: (Long, CIDeleteMode) -> Unit) {
val canDeleteForEveryone = chatItem.meta.deletable && !chatItem.localNote && !chatItem.isReport
val editorial = publicGroupEditor(chatInfo)
AlertManager.shared.showAlertDialogButtons(
title = generalGetString(MR.strings.delete_message__question),
text = questionText,
@@ -1382,11 +1385,18 @@ fun deleteMessageAlertDialog(chatItem: ChatItem, questionText: String, deleteMes
.padding(horizontal = 8.dp, vertical = 2.dp),
horizontalArrangement = Arrangement.Center,
) {
TextButton(onClick = {
deleteMessage(chatItem.id, CIDeleteMode.cidmInternal)
AlertManager.shared.hideAlert()
}) { Text(stringResource(MR.strings.for_me_only), color = MaterialTheme.colors.error) }
if (chatItem.meta.deletable && !chatItem.localNote && !chatItem.isReport) {
if (editorial) {
TextButton(onClick = {
deleteMessage(chatItem.id, CIDeleteMode.cidmHistory)
AlertManager.shared.hideAlert()
}) { Text(stringResource(MR.strings.from_history), color = MaterialTheme.colors.error) }
} else {
TextButton(onClick = {
deleteMessage(chatItem.id, CIDeleteMode.cidmInternal)
AlertManager.shared.hideAlert()
}) { Text(stringResource(MR.strings.for_me_only), color = MaterialTheme.colors.error) }
}
if (canDeleteForEveryone) {
Spacer(Modifier.padding(horizontal = 4.dp))
TextButton(onClick = {
deleteMessage(chatItem.id, CIDeleteMode.cidmBroadcast)
@@ -1398,7 +1408,7 @@ fun deleteMessageAlertDialog(chatItem: ChatItem, questionText: String, deleteMes
)
}
fun deleteMessagesAlertDialog(itemIds: List<Long>, questionText: String, forAll: Boolean, deleteMessages: (List<Long>, Boolean) -> Unit) {
fun deleteMessagesAlertDialog(itemIds: List<Long>, questionText: String, forAll: Boolean, editorial: Boolean = false, deleteMessages: (List<Long>, Boolean) -> Unit) {
AlertManager.shared.showAlertDialogButtons(
title = generalGetString(MR.strings.delete_messages__question).format(itemIds.size),
text = questionText,
@@ -1412,7 +1422,7 @@ fun deleteMessagesAlertDialog(itemIds: List<Long>, questionText: String, forAll:
TextButton(onClick = {
deleteMessages(itemIds, false)
AlertManager.shared.hideAlert()
}) { Text(stringResource(MR.strings.for_me_only), color = MaterialTheme.colors.error) }
}) { Text(stringResource(if (editorial) MR.strings.from_history else MR.strings.for_me_only), color = MaterialTheme.colors.error) }
if (forAll) {
TextButton(onClick = {
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chat/item/FramedItemView.kt
+1 -1
View File
@@ -365,7 +365,7 @@ fun FramedItemView(
is MsgContent.MCReport -> {
val prefix = buildAnnotatedString {
withStyle(SpanStyle(color = Color.Red, fontStyle = FontStyle.Italic)) {
append(if (mc.text.isEmpty()) mc.reason.text else "${mc.reason.text}: ")
append(itemPrefixText(ci))
}
}
CIMarkdownText(chatsCtx, ci, chat, chatTTL, linkMode, uriHandler, onLinkLongClick, showViaProxy = showViaProxy, showTimestamp = showTimestamp, prefix = prefix)
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chat/item/TextItemView.kt
+7
View File
@@ -85,6 +85,13 @@ fun itemDisplayText(ci: ChatItem, linkMode: SimplexLinkMode): String {
return formattedText.joinToString("") { itemSegmentDisplayText(it, ci, linkMode) }
}
// Display-only prefix rendered before ci.text (e.g. "Spam: " for reports).
// Renderers and selection code MUST share this string — otherwise selection offsets drift from screen.
fun itemPrefixText(ci: ChatItem): String = when (val mc = ci.content.msgContent) {
is MsgContent.MCReport -> if (mc.text.isEmpty()) mc.reason.text else "${mc.reason.text}: "
else -> ""
}
// Text transformations in MarkdownText must match itemSegmentDisplayText above
@Composable
fun MarkdownText (
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/chatlist/ChatPreviewView.kt
+2 -2
View File
@@ -255,11 +255,11 @@ fun ChatPreviewView(
ci.content.msgContent is MsgContent.MCChat -> null
else -> ci.formattedText
}
val prefix = when (val mc = ci.content.msgContent) {
val prefix = when (ci.content.msgContent) {
is MsgContent.MCReport ->
buildAnnotatedString {
withStyle(SpanStyle(color = Color.Red, fontStyle = FontStyle.Italic)) {
append(if (text.isEmpty()) mc.reason.text else "${mc.reason.text}: ")
append(itemPrefixText(ci))
}
}
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/newchat/AddChannelView.kt
+10 -8
View File
@@ -404,11 +404,6 @@ private fun ProgressStepView(
ModalView(
close = { showCancelAlert() },
showClose = false,
endButtons = {
TextButton(onClick = { showCancelAlert() }) {
Text(generalGetString(MR.strings.button_delete_channel))
}
}
) {
ColumnWithScrollBar {
AppBarTitle(generalGetString(MR.strings.creating_channel))
@@ -481,9 +476,16 @@ private fun ProgressStepView(
Spacer(Modifier.height(16.dp))
SectionView {
SettingsActionItem(
painterResource(MR.images.ic_delete),
generalGetString(MR.strings.button_cancel_and_delete_channel),
click = { showCancelAlert() },
textColor = Color.Red,
iconColor = Color.Red,
)
val enabled = activeCount > 0
SettingsActionItem(
painterResource(MR.images.ic_link),
painterResource(MR.images.ic_check),
generalGetString(MR.strings.continue_to_next_step),
click = {
if (activeCount >= total) {
@@ -586,7 +588,7 @@ fun relayDisplayName(relay: GroupRelay): String {
return "relay ${relay.groupRelayId}"
}
private fun chatRelayDisplayName(relay: UserChatRelay): String {
fun chatRelayDisplayName(relay: UserChatRelay): String {
if (relay.displayName.isNotEmpty()) return relay.displayName
return relay.address
}
@@ -595,7 +597,7 @@ private fun chatRelayDisplayName(relay: UserChatRelay): String {
fun RelayStatusIndicator(status: RelayStatus, connFailed: Boolean = false, memberStatus: GroupMemberStatus? = null) {
val removed = memberStatus in listOf(GroupMemberStatus.MemLeft, GroupMemberStatus.MemRemoved, GroupMemberStatus.MemGroupDeleted)
val color = if (connFailed || removed) Color.Red else if (status == RelayStatus.RsActive) Color.Green else WarningYellow
val text = if (connFailed) generalGetString(MR.strings.relay_status_failed) else if (memberStatus == GroupMemberStatus.MemLeft) generalGetString(MR.strings.relay_conn_status_removed_by_operator) else status.text
val text = if (connFailed) generalGetString(MR.strings.relay_status_failed) else if (memberStatus == GroupMemberStatus.MemLeft) generalGetString(MR.strings.relay_conn_status_removed_by_operator) else if (removed) generalGetString(MR.strings.relay_conn_status_removed) else status.text
Row(
verticalAlignment = Alignment.CenterVertically,
horizontalArrangement = Arrangement.spacedBy(4.dp)
apps/multiplatform/common/src/commonMain/kotlin/chat/simplex/common/views/usersettings/SettingsView.kt
+2 -6
View File
@@ -295,14 +295,10 @@ fun ChatLockItem(
}
private fun resetHintPreferences() {
for ((pref, def) in appPreferences.hintPreferences) {
pref.set(def)
}
appPreferences.hintPreferences.forEach { it.reset() }
}
fun unchangedHintPreferences(): Boolean = appPreferences.hintPreferences.all { (pref, def) ->
pref.state.value == def
}
fun unchangedHintPreferences(): Boolean = appPreferences.hintPreferences.all { it.isUnchanged() }
@Composable
fun AppVersionItem(showVersion: () -> Unit) {
apps/multiplatform/common/src/commonMain/resources/MR/base/strings.xml
+31 -1
View File
@@ -207,6 +207,7 @@
<string name="error_deleting_group">Error deleting group</string>
<string name="error_deleting_note_folder">Error deleting private notes</string>
<string name="error_deleting_contact_request">Error deleting contact request</string>
<string name="error_deleting_message">Error deleting message</string>
<string name="error_deleting_pending_contact_connection">Error deleting pending contact connection</string>
<string name="error_changing_address">Error changing address</string>
<string name="error_aborting_address_change">Error aborting address change</string>
@@ -424,6 +425,7 @@
<string name="moderate_messages_will_be_marked_warning">The messages will be marked as moderated for all members.</string>
<string name="for_me_only">Delete for me</string>
<string name="for_everybody">For everyone</string>
<string name="from_history">From history</string>
<string name="stop_file__action">Stop file</string>
<string name="stop_snd_file__title">Stop sending file?</string>
<string name="stop_snd_file__message">Sending file will be stopped.</string>
@@ -1887,6 +1889,7 @@
<string name="group_info_member_you">you: %1$s</string>
<string name="button_delete_group">Delete group</string>
<string name="button_delete_channel">Delete channel</string>
<string name="button_cancel_and_delete_channel">Cancel and delete channel</string>
<string name="button_delete_chat">Delete chat</string>
<string name="delete_group_question">Delete group?</string>
<string name="delete_channel_question">Delete channel?</string>
@@ -2985,6 +2988,7 @@
<string name="relay_conn_status_deleted">deleted</string>
<string name="relay_conn_status_failed">failed</string>
<string name="relay_conn_status_removed_by_operator">removed by operator</string>
<string name="relay_conn_status_removed">removed</string>
<string name="relay_status_new">new</string>
<string name="relay_status_invited">invited</string>
<string name="relay_status_accepted">accepted</string>
@@ -3006,7 +3010,8 @@
<string name="relay_bar_connected_with_failures">%1$d/%2$d relays connected, %3$d failed</string>
<string name="relay_bar_connected_with_removed">%1$d/%2$d relays connected, %3$d removed</string>
<string name="relay_bar_connected">%1$d/%2$d relays connected</string>
<string name="relay_bar_owner_no_delivery">Adding relays will be supported later.</string>
<string name="relay_bar_no_relays">No relays</string>
<string name="relay_bar_owner_no_delivery">Add relays to restore message delivery.</string>
<string name="relay_bar_subscriber_waiting">Waiting for channel owner to add relays.</string>
<!-- GroupMemberInfoView.kt channel-related -->
@@ -3021,6 +3026,10 @@
<string name="relay_section_footer_owner">Subscribers use relay link to connect to the channel.\nRelay address was used to set up this relay for the channel.</string>
<string name="relay_section_footer_subscriber">You connected to the channel via this relay link.</string>
<string name="button_remove_subscriber">Remove subscriber</string>
<string name="button_remove_relay">Remove relay</string>
<string name="button_remove_relay_question">Remove relay?</string>
<string name="relay_will_be_removed_from_channel">Relay will be removed from channel - this cannot be undone!</string>
<string name="last_active_relay_warning">This is the last active relay. Removing it will prevent message delivery to subscribers.</string>
<string name="block_subscriber_for_all_question">Block subscriber for all?</string>
<!-- AddChannelView.kt -->
@@ -3040,6 +3049,15 @@
<string name="your_profile_shared_with_channel_relays">Your profile %1$s will be shared with channel relays and subscribers.\nRelays can access channel messages.</string>
<string name="configure_relays">Configure relays</string>
<string name="relay_status_failed">failed</string>
<string name="add_button">Add</string>
<string name="add_relay_button">Add relay</string>
<string name="add_relays_title">Add relays</string>
<string name="no_available_relays">No available relays</string>
<string name="error_adding_relays">Error adding relays</string>
<string name="relays_added_format">Relays added: %1$s.</string>
<string name="select_relays">Select relays</string>
<string name="no_relays_selected">No relays selected</string>
<string name="num_relays_selected">%d relay(s) selected</string>
<string name="relay_connection_failed">Relay connection failed</string>
<string name="not_all_relays_connected">Not all relays connected</string>
<string name="wait_verb">Wait</string>
@@ -3063,4 +3081,16 @@
<string name="link_previews_alert_desc_socks">Link preview will be requested via SOCKS proxy. DNS lookup may still happen locally via your DNS resolver.</string>
<string name="link_previews_alert_enable">Enable</string>
<string name="link_previews_alert_disable">Disable</string>
<!-- Desktop tray / minimize-to-tray -->
<string name="close_behavior_dialog_title">Minimize to tray?</string>
<string name="close_behavior_dialog_text">If you choose Close, messages won\'t be received.\nYou can change it later in Appearance settings.</string>
<string name="close_behavior_dialog_close">Close the app</string>
<string name="close_behavior_dialog_minimize">Minimize to tray</string>
<string name="tray_show">Show SimpleX</string>
<string name="tray_quit">Quit SimpleX</string>
<string name="tray_tooltip">SimpleX</string>
<string name="tray_tooltip_unread">SimpleX — %d unread</string>
<string name="appearance_minimize_to_tray">Minimize to tray when closing window</string>
<string name="appearance_minimize_to_tray_desc">Keep SimpleX running in the background to receive messages.</string>
</resources>
apps/multiplatform/common/src/commonMain/resources/MR/images/ic_simplex_tray_dot.svg
+46
View File
@@ -0,0 +1,46 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
width="120"
height="120"
viewBox="121 0 40 40"
fill="none"
version="1.1"
id="svg3"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
clip-rule="evenodd"
d="m 126.52238,11.425398 5.80302,5.716401 5.88962,-5.889626 2.8582,2.858201 L 135.1836,20 l 5.7164,5.716402 -2.94482,2.8582 -5.7164,-5.629789 -5.88962,5.803014 -2.8582,-2.858201 5.88962,-5.803014 -5.803,-5.716402 z"
fill="#030749"
id="path1"
style="stroke-width:0.866122" />
<path
fill-rule="evenodd"
clip-rule="evenodd"
d="m 137.86858,28.661214 2.94481,-2.944812 v 0 l 5.88963,-5.803014 -5.80302,-5.62979 v 0 l -2.8582,-2.8582 -5.7164,-5.7164023 2.94481,-2.9448129 5.7164,5.7164017 5.88963,-5.8030138 2.8582,2.8582008 -5.88962,5.8030145 5.7164,5.716401 5.88962,-5.803014 2.8582,2.858201 -5.88962,5.803014 5.803,5.716402 -2.9448,2.858201 -5.7164,-5.716402 -5.88963,5.803013 5.7164,5.716402 -2.8582,2.944813 -5.80301,-5.716402 -5.80302,5.803015 -2.8582,-2.858201 z"
fill="url(#paint0_linear_40_164)"
id="path2"
style="fill:url(#paint0_linear_40_164);stroke-width:0.866122" />
<!-- Unread dot in bottom-right; cy ≤ 34 to keep it inside the 40×40 viewBox bottom edge -->
<circle cx="155" cy="34" r="6" fill="#e53935" />
<defs
id="defs3">
<linearGradient
x1="135.948"
y1="-0.81632602"
x2="132.09599"
y2="36.985699"
gradientUnits="userSpaceOnUse"
id="paint0_linear_40_164"
gradientTransform="matrix(0.86612147,0,0,0.86612147,18.863485,2.6775707)">
<stop
stop-color="#01f1ff"
id="stop2" />
<stop
offset="1"
stop-color="#0197ff"
id="stop3" />
</linearGradient>
</defs>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.8 KiB

apps/multiplatform/common/src/commonMain/resources/MR/images/ic_simplex_tray_dot_light.svg
+46
View File
@@ -0,0 +1,46 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
width="120"
height="120"
viewBox="121 0 40 40"
fill="none"
version="1.1"
id="svg3"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
clip-rule="evenodd"
d="m 126.52238,11.425398 5.80302,5.716401 5.88962,-5.889626 2.8582,2.858201 L 135.1836,20 l 5.7164,5.716402 -2.94482,2.8582 -5.7164,-5.629789 -5.88962,5.803014 -2.8582,-2.858201 5.88962,-5.803014 -5.803,-5.716402 z"
fill="#ffffff"
id="path1"
style="stroke-width:0.866122" />
<path
fill-rule="evenodd"
clip-rule="evenodd"
d="m 137.86858,28.661214 2.94481,-2.944812 v 0 l 5.88963,-5.803014 -5.80302,-5.62979 v 0 l -2.8582,-2.8582 -5.7164,-5.7164023 2.94481,-2.9448129 5.7164,5.7164017 5.88963,-5.8030138 2.8582,2.8582008 -5.88962,5.8030145 5.7164,5.716401 5.88962,-5.803014 2.8582,2.858201 -5.88962,5.803014 5.803,5.716402 -2.9448,2.858201 -5.7164,-5.716402 -5.88963,5.803013 5.7164,5.716402 -2.8582,2.944813 -5.80301,-5.716402 -5.80302,5.803015 -2.8582,-2.858201 z"
fill="url(#paint0_linear_40_164)"
id="path2"
style="fill:url(#paint0_linear_40_164);stroke-width:0.866122" />
<!-- Unread dot in bottom-right; cy ≤ 34 to keep it inside the 40×40 viewBox bottom edge -->
<circle cx="155" cy="34" r="6" fill="#e53935" />
<defs
id="defs3">
<linearGradient
x1="135.948"
y1="-0.81632602"
x2="132.09599"
y2="36.985699"
gradientUnits="userSpaceOnUse"
id="paint0_linear_40_164"
gradientTransform="matrix(0.86612147,0,0,0.86612147,18.863485,2.6775707)">
<stop
stop-color="#01f1ff"
id="stop2" />
<stop
offset="1"
stop-color="#0197ff"
id="stop3" />
</linearGradient>
</defs>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.8 KiB

apps/multiplatform/common/src/commonMain/resources/MR/images/ic_simplex_tray_light.svg
+44
View File
@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg
width="120"
height="120"
viewBox="121 0 40 40"
fill="none"
version="1.1"
id="svg3"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg">
<path
fill-rule="evenodd"
clip-rule="evenodd"
d="m 126.52238,11.425398 5.80302,5.716401 5.88962,-5.889626 2.8582,2.858201 L 135.1836,20 l 5.7164,5.716402 -2.94482,2.8582 -5.7164,-5.629789 -5.88962,5.803014 -2.8582,-2.858201 5.88962,-5.803014 -5.803,-5.716402 z"
fill="#ffffff"
id="path1"
style="stroke-width:0.866122" />
<path
fill-rule="evenodd"
clip-rule="evenodd"
d="m 137.86858,28.661214 2.94481,-2.944812 v 0 l 5.88963,-5.803014 -5.80302,-5.62979 v 0 l -2.8582,-2.8582 -5.7164,-5.7164023 2.94481,-2.9448129 5.7164,5.7164017 5.88963,-5.8030138 2.8582,2.8582008 -5.88962,5.8030145 5.7164,5.716401 5.88962,-5.803014 2.8582,2.858201 -5.88962,5.803014 5.803,5.716402 -2.9448,2.858201 -5.7164,-5.716402 -5.88963,5.803013 5.7164,5.716402 -2.8582,2.944813 -5.80301,-5.716402 -5.80302,5.803015 -2.8582,-2.858201 z"
fill="url(#paint0_linear_40_164)"
id="path2"
style="fill:url(#paint0_linear_40_164);stroke-width:0.866122" />
<defs
id="defs3">
<linearGradient
x1="135.948"
y1="-0.81632602"
x2="132.09599"
y2="36.985699"
gradientUnits="userSpaceOnUse"
id="paint0_linear_40_164"
gradientTransform="matrix(0.86612147,0,0,0.86612147,18.863485,2.6775707)">
<stop
stop-color="#01f1ff"
id="stop2" />
<stop
offset="1"
stop-color="#0197ff"
id="stop3" />
</linearGradient>
</defs>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.7 KiB

apps/multiplatform/common/src/commonTest/kotlin/chat/simplex/app/ProviderForGalleryTest.kt
+67
View File
@@ -0,0 +1,67 @@
package chat.simplex.app
import chat.simplex.common.model.*
import chat.simplex.common.platform.chatModel
import chat.simplex.common.views.chat.providerForGallery
import kotlinx.datetime.Clock
import kotlin.test.AfterTest
import kotlin.test.BeforeTest
import kotlin.test.Test
import kotlin.test.assertEquals
// Regression for PR #6869: scrollToStart() must not rewrite initialChatId.
class ProviderForGalleryTest {
// Synthetic items pass canShowMedia only when chatModel.connectedToRemote() is true.
@BeforeTest
fun connectChatModelToRemote() {
chatModel.currentRemoteHost.value = RemoteHostInfo(
remoteHostId = 0L,
hostDeviceName = "",
storePath = "",
bindAddress_ = null,
bindPort_ = null,
sessionState = null,
)
}
@AfterTest
fun resetChatModel() {
chatModel.currentRemoteHost.value = null
}
@Test
fun testScrollToStartPreservesAnchor() {
val items = listOf(imageItem(1L), imageItem(2L), imageItem(3L))
var scrolledTo: Int? = null
val provider = providerForGallery(items, cItemId = 3L) { scrolledTo = it }
provider.currentPageChanged(provider.initialIndex - 1)
provider.scrollToStart()
provider.onDismiss(0)
assertEquals(1, scrolledTo)
}
// Pins the onDismiss early-return contract that testScrollToStartPreservesAnchor
// relies on to read the anchor back through the scrollTo callback.
@Test
fun testOnDismissOnActiveItemDoesNotScroll() {
val items = listOf(imageItem(1L), imageItem(2L), imageItem(3L))
var scrolledTo: Int? = null
val provider = providerForGallery(items, cItemId = 3L) { scrolledTo = it }
provider.onDismiss(provider.initialIndex)
assertEquals(null, scrolledTo)
}
private fun imageItem(id: Long): ChatItem =
ChatItem(
chatDir = CIDirection.DirectRcv(),
meta = CIMeta.getSample(id, Clock.System.now(), text = ""),
content = CIContent.RcvMsgContent(MsgContent.MCImage(text = "", image = "")),
reactions = emptyList(),
file = CIFile.getSample(fileId = id, fileName = "img-$id.jpg", filePath = "img-$id.jpg"),
)
}
apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/DesktopApp.kt
+35 -4
View File
@@ -31,8 +31,11 @@ import kotlin.system.exitProcess
val simplexWindowState = SimplexWindowState()
fun showApp() {
val closedByError = mutableStateOf(true)
while (closedByError.value) {
// Probe SystemTray off the EDT — the lazy's first read would otherwise block the
// EDT during composition; JDK-8322750's GNOME detection forks a subprocess.
trayIsAvailable
while (true) {
val closedByError = mutableStateOf(false)
application(exitProcessOnExit = false) {
CompositionLocalProvider(
LocalWindowExceptionHandlerFactory provides WindowExceptionHandlerFactory { window ->
@@ -43,8 +46,9 @@ fun showApp() {
shareText = true
)
Log.e(TAG, "App crashed, thread name: " + Thread.currentThread().name + ", exception: " + e.stackTraceToString())
window.dispatchEvent(WindowEvent(window, WindowEvent.WINDOW_CLOSING))
// Must precede dispatchEvent — handleCloseRequest reads this flag.
closedByError.value = true
window.dispatchEvent(WindowEvent(window, WindowEvent.WINDOW_CLOSING))
includeMoreFailedComposables()
// If the left side of screen has open modal, it's probably caused the crash
if (ModalManager.start.hasModalsOpen()) {
@@ -73,9 +77,11 @@ fun showApp() {
}
}
) {
SimplexTray()
AppWindow(closedByError)
}
}
if (!closedByError.value) break
}
exitProcess(0)
}
@@ -115,7 +121,7 @@ private fun ApplicationScope.AppWindow(closedByError: MutableState<Boolean>) {
simplexWindowState.windowState = windowState
// Reload all strings in all @Composable's after language change at runtime
if (remember { ChatController.appPrefs.appLanguage.state }.value != "") {
Window(state = windowState, icon = painterResource(MR.images.ic_simplex), onCloseRequest = { closedByError.value = false; exitApplication() }, onKeyEvent = {
Window(state = windowState, visible = simplexWindowState.windowVisible.value, icon = painterResource(MR.images.ic_simplex), onCloseRequest = { handleCloseRequest(closedByError) }, onKeyEvent = {
if (it.key == Key.Escape && it.type == KeyEventType.KeyUp) {
simplexWindowState.backstack.lastOrNull()?.invoke() != null
} else {
@@ -224,6 +230,30 @@ private fun ApplicationScope.AppWindow(closedByError: MutableState<Boolean>) {
}
}
// Not invoked for macOS Cmd+Q — that goes through AWT's default QuitHandler and
// exits the process directly. Intentional: Cmd+Q is canonical "always quit" on macOS.
private fun ApplicationScope.handleCloseRequest(closedByError: MutableState<Boolean>) {
// Crash dispatch — bypass user-facing policy and exit; outer loop will restart.
if (closedByError.value) {
exitApplication()
return
}
val pref = ChatController.appPrefs.closeBehavior
when (pref.get()) {
CloseBehavior.Quit -> exitApplication()
CloseBehavior.MinimizeToTray -> if (trayIsAvailable) {
simplexWindowState.windowVisible.value = false
} else exitApplication()
CloseBehavior.Ask -> if (trayIsAvailable) {
requestCloseBehavior()
} else {
// Tray unavailable — Minimize is not a real option; remember Quit and exit.
pref.set(CloseBehavior.Quit)
exitApplication()
}
}
}
class SimplexWindowState {
lateinit var windowState: WindowState
val backstack = mutableStateListOf<() -> Unit>()
@@ -232,6 +262,7 @@ class SimplexWindowState {
val saveDialog = DialogState<File?>()
val toasts = mutableStateListOf<Pair<String, Long>>()
var windowFocused = mutableStateOf(true)
val windowVisible = mutableStateOf(true)
var window: ComposeWindow? = null
}
apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/DesktopTray.kt
+127
View File
@@ -0,0 +1,127 @@
package chat.simplex.common
import SectionItemView
import androidx.compose.foundation.layout.*
import androidx.compose.material.*
import androidx.compose.runtime.*
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.text.AnnotatedString
import androidx.compose.ui.text.style.TextAlign
import androidx.compose.ui.window.*
import chat.simplex.common.model.ChatModel
import chat.simplex.common.model.CloseBehavior
import chat.simplex.common.model.ChatController.appPrefs
import chat.simplex.common.platform.Log
import chat.simplex.common.platform.TAG
import chat.simplex.common.ui.theme.isInDarkTheme
import chat.simplex.common.views.helpers.AlertManager
import chat.simplex.common.views.helpers.generalGetString
import chat.simplex.res.MR
import dev.icerock.moko.resources.compose.painterResource
import dev.icerock.moko.resources.compose.stringResource
import java.awt.AWTException
import java.awt.SystemTray
import java.awt.TrayIcon
import java.awt.image.BufferedImage
// Probed once at startup. False on stock GNOME ≥ JDK 21.0.3 per JDK-8322750, and
// also when SystemTray.add() fails despite isSupported() returning true (an older
// JDK pattern Compose-MP does not catch). When false: the Appearance toggle is
// hidden, the first-close dialog is skipped (Ask migrates silently to Quit), and
// the close handler treats MinimizeToTray as Quit.
val trayIsAvailable: Boolean by lazy {
if (!SystemTray.isSupported()) return@lazy false
try {
val tray = SystemTray.getSystemTray()
val probe = TrayIcon(BufferedImage(1, 1, BufferedImage.TYPE_INT_ARGB))
tray.add(probe)
tray.remove(probe)
true
} catch (e: AWTException) {
Log.w(TAG, "SystemTray probe failed: ${e.stackTraceToString()}")
false
} catch (e: SecurityException) {
Log.w(TAG, "SystemTray probe denied: ${e.stackTraceToString()}")
false
}
}
fun showWindow() {
simplexWindowState.windowVisible.value = true
simplexWindowState.window?.toFront()
simplexWindowState.window?.requestFocus()
}
@Composable
fun ApplicationScope.SimplexTray() {
if (!trayIsAvailable) return
if (remember { appPrefs.closeBehavior.state }.value != CloseBehavior.MinimizeToTray) return
// Sum of per-profile unread (UserInfo.unreadCount, the same field UserPicker renders
// per row). Skip muted profiles unless they're the active one.
val unread by remember {
derivedStateOf {
ChatModel.users.sumOf {
if (!it.user.showNtfs && !it.user.activeUser) 0 else it.unreadCount
}
}
}
val iconRes = if (unread > 0) {
if (isInDarkTheme()) MR.images.ic_simplex_tray_dot_light else MR.images.ic_simplex_tray_dot
} else {
if (isInDarkTheme()) MR.images.ic_simplex_tray_light else MR.images.ic_simplex
}
val tooltip =
if (unread > 0) stringResource(MR.strings.tray_tooltip_unread, unread)
else stringResource(MR.strings.tray_tooltip)
Tray(
icon = painterResource(iconRes),
tooltip = tooltip,
onAction = ::showWindow,
menu = {
Item(stringResource(MR.strings.tray_show), onClick = ::showWindow)
Separator()
Item(stringResource(MR.strings.tray_quit), onClick = { exitApplication() })
}
)
}
// Renders in the main app window via AlertManager (same surface as e.g. the link
// previews confirmation). Lambdas close over the calling ApplicationScope; if the
// app crashes while the dialog is open, the crash handler's alert replaces it, so
// stale closures never get clicked.
fun ApplicationScope.requestCloseBehavior() {
val pref = appPrefs.closeBehavior
AlertManager.shared.showAlertDialogButtonsColumn(
title = generalGetString(MR.strings.close_behavior_dialog_title),
text = AnnotatedString(generalGetString(MR.strings.close_behavior_dialog_text)),
buttons = {
Column {
SectionItemView({
AlertManager.shared.hideAlert()
pref.set(CloseBehavior.Quit)
exitApplication()
}) {
Text(
stringResource(MR.strings.close_behavior_dialog_close),
Modifier.fillMaxWidth(),
textAlign = TextAlign.Center,
color = Color.Red
)
}
SectionItemView({
AlertManager.shared.hideAlert()
pref.set(CloseBehavior.MinimizeToTray)
simplexWindowState.windowVisible.value = false
}) {
Text(
stringResource(MR.strings.close_behavior_dialog_minimize),
Modifier.fillMaxWidth(),
textAlign = TextAlign.Center,
color = MaterialTheme.colors.primary
)
}
}
}
)
}
apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/platform/PlatformTextField.desktop.kt
+2 -2
View File
@@ -86,8 +86,8 @@ actual fun PlatformTextField(
// Different padding here is for a text that is considered RTL with non-RTL locale set globally.
// In this case padding from right side should be bigger
val startEndPadding = if (cs.message.text.isEmpty() && showVoiceButton && isRtlByCharacters && isLtrGlobally) 95.dp else 50.dp
val startPadding = if (isRtlByCharacters && isLtrGlobally) startEndPadding else 0.dp
val endPadding = if (isRtlByCharacters && isLtrGlobally) 0.dp else startEndPadding
val startPadding = 0.dp
val endPadding = startEndPadding
val padding = PaddingValues(startPadding, 12.dp, endPadding, 0.dp)
var textFieldValueState by remember { mutableStateOf(TextFieldValue(text = cs.message.text, selection = cs.message.selection)) }
val textFieldValue = textFieldValueState.copy(text = cs.message.text, selection = cs.message.selection)
apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/views/call/CallView.desktop.kt
+22 -13
View File
@@ -17,6 +17,7 @@ import org.nanohttpd.protocols.http.response.Response.newFixedLengthResponse
import org.nanohttpd.protocols.http.response.Status
import org.nanohttpd.protocols.websockets.*
import java.io.IOException
import java.net.BindException
import java.net.URI
private const val SERVER_HOST = "localhost"
@@ -157,17 +158,18 @@ fun WebRTCController(callCommand: SnapshotStateList<WCallCommand>, onResponse: (
if (call != null) withBGApi { chatModel.callManager.endCall(call) }
}
val server = remember {
try {
uriHandler.openUri("http://${SERVER_HOST}:$SERVER_PORT/simplex/call/")
} catch (e: Exception) {
Log.e(TAG, "Unable to open browser: ${e.stackTraceToString()}")
AlertManager.shared.showAlertMsg(
title = generalGetString(MR.strings.unable_to_open_browser_title),
text = generalGetString(MR.strings.unable_to_open_browser_desc)
)
endCall()
startServer(onResponse).apply {
try {
uriHandler.openUri("http://${SERVER_HOST}:${listeningPort}/simplex/call/")
} catch (e: Exception) {
Log.e(TAG, "Unable to open browser: ${e.stackTraceToString()}")
AlertManager.shared.showAlertMsg(
title = generalGetString(MR.strings.unable_to_open_browser_title),
text = generalGetString(MR.strings.unable_to_open_browser_desc)
)
endCall()
}
}
startServer(onResponse)
}
fun processCommand(cmd: WCallCommand) {
val apiCall = WVAPICall(command = cmd)
@@ -206,8 +208,8 @@ fun WebRTCController(callCommand: SnapshotStateList<WCallCommand>, onResponse: (
}
}
fun startServer(onResponse: (WVAPIMessage) -> Unit): NanoWSD {
val server = object: NanoWSD(SERVER_HOST, SERVER_PORT) {
fun startServer(onResponse: (WVAPIMessage) -> Unit, port: Int = SERVER_PORT): NanoWSD {
val server = object: NanoWSD(SERVER_HOST, port) {
override fun openWebSocket(session: IHTTPSession): WebSocket = MyWebSocket(onResponse, session)
fun resourcesToResponse(path: String): Response {
@@ -231,7 +233,14 @@ fun startServer(onResponse: (WVAPIMessage) -> Unit): NanoWSD {
}
}
}
server.start(60_000_000)
try {
server.start(60_000_000)
} catch (e: BindException) {
if (port == 0) throw e
Log.w(TAG, "Call server port $port is busy, using a random port: ${e.message}")
server.stop()
return startServer(onResponse, port = 0)
}
return server
}
apps/multiplatform/common/src/desktopMain/kotlin/chat/simplex/common/views/usersettings/Appearance.desktop.kt
+23
View File
@@ -3,6 +3,7 @@ package chat.simplex.common.views.usersettings
import SectionBottomSpacer
import SectionDividerSpaced
import SectionSpacer
import SectionTextFooter
import SectionView
import androidx.compose.foundation.*
import androidx.compose.foundation.layout.*
@@ -18,7 +19,9 @@ import androidx.compose.ui.platform.LocalDensity
import androidx.compose.ui.unit.*
import chat.simplex.common.model.ChatController.appPrefs
import chat.simplex.common.model.ChatModel
import chat.simplex.common.model.CloseBehavior
import chat.simplex.common.model.SharedPreference
import chat.simplex.common.trayIsAvailable
import chat.simplex.common.platform.*
import chat.simplex.common.ui.theme.DEFAULT_PADDING
import chat.simplex.common.views.helpers.*
@@ -65,6 +68,11 @@ fun AppearanceScope.AppearanceLayout(
SectionDividerSpaced()
ThemesSection(systemDarkTheme)
if (trayIsAvailable) {
SectionDividerSpaced()
MinimizeToTraySection()
}
SectionDividerSpaced()
AppToolbarsSection()
@@ -84,6 +92,21 @@ fun AppearanceScope.AppearanceLayout(
}
}
@Composable
private fun MinimizeToTraySection() {
val pref = remember { appPrefs.closeBehavior.state }
val on = pref.value == CloseBehavior.MinimizeToTray
SectionView {
PreferenceToggle(
stringResource(MR.strings.appearance_minimize_to_tray),
checked = on,
) { checked ->
appPrefs.closeBehavior.set(if (checked) CloseBehavior.MinimizeToTray else CloseBehavior.Quit)
}
}
SectionTextFooter(stringResource(MR.strings.appearance_minimize_to_tray_desc))
}
@Composable
fun DensityScaleSection() {
val localDensityScale = remember { mutableStateOf(appPrefs.densityScale.get()) }
apps/multiplatform/spec/services/calls.md
+2 -2
View File
@@ -119,9 +119,9 @@ The `actual` platform implementation of `ActiveCallView()` and supporting compos
Desktop calls run WebRTC in the system browser, not an embedded WebView:
- **NanoWSD server** ([line 209](../../common/src/desktopMain/kotlin/chat/simplex/common/views/call/CallView.desktop.kt#L209)): `startServer()` creates a `NanoWSD` instance bound to `localhost:50395`. The server serves `call.html` from JAR resources at `/assets/www/desktop/call.html` for the path `/simplex/call/`. All other paths serve resources from `/assets/www/`.
- **NanoWSD server** ([line 209](../../common/src/desktopMain/kotlin/chat/simplex/common/views/call/CallView.desktop.kt#L209)): `startServer()` creates a `NanoWSD` instance bound to `localhost:50395`. If that port is already in use it falls back to an OS-assigned free port (`port 0`); `WebRTCController` reads `server.listeningPort` for the browser URL. The server serves `call.html` from JAR resources at `/assets/www/desktop/call.html` for the path `/simplex/call/`. All other paths serve resources from `/assets/www/`.
- **WebSocket communication** ([line 238](../../common/src/desktopMain/kotlin/chat/simplex/common/views/call/CallView.desktop.kt#L238)): `MyWebSocket` handles WebSocket frames from the browser. `onMessage` deserializes JSON into `WVAPIMessage` and forwards to the response handler. `onClose` triggers `WCallResponse.End`.
- **WebRTCController** ([line 153](../../common/src/desktopMain/kotlin/chat/simplex/common/views/call/CallView.desktop.kt#L153)): Opens `http://localhost:50395/simplex/call/` via `LocalUriHandler`. Processes `WCallCommand` queue by sending JSON over WebSocket to all active connections. On dispose, sends `WCallCommand.End` and stops the server.
- **WebRTCController** ([line 153](../../common/src/desktopMain/kotlin/chat/simplex/common/views/call/CallView.desktop.kt#L153)): Starts the server, then opens `http://localhost:<listeningPort>/simplex/call/` (normally `50395`) via `LocalUriHandler`. Processes `WCallCommand` queue by sending JSON over WebSocket to all active connections. On dispose, sends `WCallCommand.End` and stops the server.
- **SendStateUpdates** ([line 137](../../common/src/desktopMain/kotlin/chat/simplex/common/views/call/CallView.desktop.kt#L137)): Sends `WCallCommand.Description` with call state and encryption info text to the browser for display.
- **ActiveCallView** ([line 28](../../common/src/desktopMain/kotlin/chat/simplex/common/views/call/CallView.desktop.kt#L28)): Handles `WCallResponse` messages identically to Android (same state machine), plus a `WCallCommand.Permission` message on `Capabilities` error for browser permission denial guidance.
apps/simplex-support-bot/bot.test.ts
+243 -18
View File
@@ -1,9 +1,14 @@
import {describe, test, expect, beforeEach, vi} from "vitest"
import {mkdtempSync, writeFileSync} from "fs"
import {tmpdir} from "os"
import {join} from "path"
import {core} from "simplex-chat"
import {SupportBot} from "./src/bot.js"
import {CardManager} from "./src/cards.js"
import {parseConfig} from "./src/config.js"
import {GrokApiClient} from "./src/grok.js"
import {welcomeMessage, queueMessage, grokActivatedMessage, teamLockedMessage} from "./src/messages.js"
import {loadGrokContext} from "./src/context.js"
import {welcomeMessage, queueMessage, grokActivatedMessage, teamLockedMessage, teamAlreadyInvitedMessage} from "./src/messages.js"
// Silence console output during tests
vi.spyOn(console, "log").mockImplementation(() => {})
@@ -83,15 +88,39 @@ class MockChatApi {
async apiListMembers(groupId: number) {
return this.members.get(groupId) || []
}
async apiGetChat(_chatType: string, chatId: number, _count: number) {
async apiGetChat(chatType: string, chatId: number, _count: number) {
if (chatType === ChatType.Direct) {
// Tests don't exercise direct lookups; throw the same shape production
// would so getContact() resolves to null instead of synthesizing a contact.
throw new core.ChatAPIError("contact not found", {
type: "errorStore",
storeError: {type: "contactNotFound", contactId: chatId},
} as any)
}
const baseGroupInfo = this.groups.get(chatId)
if (!baseGroupInfo) {
// Mirror production behavior: the real apiGetChat throws "groupNotFound"
// for an unknown id; getGroupInfo() catches and returns null.
throw new core.ChatAPIError("group not found", {
type: "errorStore",
storeError: {type: "groupNotFound", groupId: chatId},
} as any)
}
const items = this.chatItems.get(chatId) || []
const groupInfo = this.groups.get(chatId)
const groupInfo = {...baseGroupInfo, customData: this.customData.get(chatId)}
return {
chatInfo: {type: "group", groupInfo: groupInfo || makeGroupInfo(chatId)},
chatInfo: {type: "group", groupInfo},
chatItems: items,
chatStats: {unreadCount: 0, unreadMentions: 0, reportsCount: 0, minUnreadItemId: 0, unreadChat: false},
}
}
async apiGetChats(_userId: number, _pagination: any, _query?: any, _pcc?: boolean) {
return [...this.groups.values()].map(g => ({
chatInfo: {type: "group", groupInfo: {...g, customData: this.customData.get(g.groupId)}},
chatItems: [],
chatStats: {unreadCount: 0, unreadMentions: 0, reportsCount: 0, minUnreadItemId: 0, unreadChat: false},
}))
}
async apiListGroups(_userId: number) {
return [...this.groups.values()].map(g => ({...g, customData: this.customData.get(g.groupId)}))
}
@@ -187,13 +216,15 @@ const GROK_LOCAL_GROUP_ID = 200
const CUSTOMER_ID = "customer-1"
// Commands passed into SupportBot; matches what index.ts constructs when
// Grok is enabled. Tests that disable grokApi still pass the full list
// because the ctor doesn't care; the value is pushed to a group's
// groupPreferences on the first sendToGroup() call.
// Grok is enabled. The ctor uses this to decide which `/keyword` messages
// from customers are commands vs. plain text — tests that disable grokApi
// should pass a list that excludes "grok" to mirror production wiring (see
// index.ts where `grokEnabled` gates that entry).
const DESIRED_COMMANDS = [
{type: "command" as const, keyword: "grok", label: "Ask Grok"},
{type: "command" as const, keyword: "team", label: "Switch to team"},
]
const DESIRED_COMMANDS_NO_GROK = [DESIRED_COMMANDS[1]]
// ─── Member factories ───
@@ -638,7 +669,7 @@ describe("/grok Activation", () => {
await joinPromise
await bot.flush()
expectMemberAdded(CUSTOMER_GROUP_ID, GROK_CONTACT_ID)
expectSentToGroup(CUSTOMER_GROUP_ID, "You are chatting with Grok")
expectSentToGroup(CUSTOMER_GROUP_ID, grokActivatedMessage)
})
test("/grok as first message → WELCOME→GROK directly, no queue message", async () => {
@@ -646,7 +677,7 @@ describe("/grok Activation", () => {
await bot.onNewChatItems(customerMessage("/grok"))
await joinPromise
await bot.flush()
expectSentToGroup(CUSTOMER_GROUP_ID, "You are chatting with Grok")
expectSentToGroup(CUSTOMER_GROUP_ID, grokActivatedMessage)
expectNotSentToGroup(CUSTOMER_GROUP_ID, "The team will reply to your message")
expect(chat.sentTo(TEAM_GROUP_ID).length).toBeGreaterThan(0)
})
@@ -654,7 +685,7 @@ describe("/grok Activation", () => {
test("/grok in TEAM → rejected with teamLockedMessage", async () => {
await reachTeam()
await bot.onNewChatItems(customerMessage("/grok"))
expectSentToGroup(CUSTOMER_GROUP_ID, "team mode")
expectSentToGroup(CUSTOMER_GROUP_ID, teamLockedMessage)
})
test("/grok when grokContactId is null → grokUnavailableMessage", async () => {
@@ -704,6 +735,28 @@ describe("Grok Conversation", () => {
expect(grokApi.calls.length).toBe(0)
})
test("Grok answers messages containing a slash mid-word", async () => {
// Regression: an unanchored regex in ciBotCommand once parsed `/read`
// inside "follow/read" as a command, causing Grok to skip the message.
grokApi.willRespond("We post on X and Mastodon.")
await bot.onGrokNewChatItems(grokViewCustomerMessage(
"What social media do you use? Anything I can follow/read for updates?"
))
expect(grokApi.calls.length).toBe(1)
expect(grokApi.calls[0].message).toBe(
"What social media do you use? Anything I can follow/read for updates?"
)
})
test("Grok answers an unknown slash-prefixed message", async () => {
// `/help` is not in desiredCommands, so it should be treated as plain
// text and reach Grok rather than being silently dropped.
grokApi.willRespond("Sure, here's what I can do.")
await bot.onGrokNewChatItems(grokViewCustomerMessage("/help me with groups"))
expect(grokApi.calls.length).toBe(1)
expect(grokApi.calls[0].message).toBe("/help me with groups")
})
test("Grok per-message: history includes prior Grok sent response as assistant", async () => {
addCustomerMessageToHistory("How do I create a group?", GROK_LOCAL_GROUP_ID)
addBotMessage("To create a group, tap + then New Group.", GROK_LOCAL_GROUP_ID)
@@ -841,6 +894,52 @@ describe("Grok Conversation", () => {
})
})
describe("Grok requests /team", () => {
beforeEach(() => setup())
test("Grok per-message reply containing /team → team added, teamAddedMessage sent, reply still sent", async () => {
await reachGrok()
await bot.flush()
grokApi.willRespond("I can't help with billing — please send /team for a human.")
addCustomerMessageToHistory("Can you refund me?", GROK_LOCAL_GROUP_ID)
await bot.onGrokNewChatItems(grokViewCustomerMessage("Can you refund me?"))
expectAnySent("I can't help with billing")
expectMemberAdded(CUSTOMER_GROUP_ID, TEAM_MEMBER_1_ID)
expectMemberAdded(CUSTOMER_GROUP_ID, TEAM_MEMBER_2_ID)
expectSentToGroup(CUSTOMER_GROUP_ID, "We will reply within")
})
test("Grok per-message reply without /team → no team members added", async () => {
await reachGrok()
await bot.flush()
grokApi.willRespond("To create a group, tap +, then New Group.")
addCustomerMessageToHistory("How do I create a group?", GROK_LOCAL_GROUP_ID)
await bot.onGrokNewChatItems(grokViewCustomerMessage("How do I create a group?"))
expect(chat.added.some(a => a.groupId === CUSTOMER_GROUP_ID && a.contactId === TEAM_MEMBER_1_ID)).toBe(false)
})
test("/team in Grok's initial reply after /grok → escalates", async () => {
await reachQueue()
addBotMessage("The team will reply to your message")
// Customer's question visible in Grok's view → activateGrok reads it for the initial reply
chat.groups.set(GROK_LOCAL_GROUP_ID, makeGroupInfo(GROK_LOCAL_GROUP_ID))
addCustomerMessageToHistory("I'm really stuck, please help", GROK_LOCAL_GROUP_ID)
grokApi.willRespond("That sounds urgent — send /team to reach a person.")
const grokJoinPromise = simulateGrokJoinSuccess()
await bot.onNewChatItems(customerMessage("/grok"))
await grokJoinPromise
await bot.flush()
expectAnySent("That sounds urgent")
expectMemberAdded(CUSTOMER_GROUP_ID, TEAM_MEMBER_1_ID)
expectMemberAdded(CUSTOMER_GROUP_ID, TEAM_MEMBER_2_ID)
expectSentToGroup(CUSTOMER_GROUP_ID, "We will reply within")
})
})
describe("/team Activation", () => {
beforeEach(() => setup())
@@ -864,7 +963,7 @@ describe("/team Activation", () => {
addBotMessage("We will reply within 24 hours.")
chat.members.set(CUSTOMER_GROUP_ID, [makeTeamMember(TEAM_MEMBER_1_ID, "Alice")])
await bot.onNewChatItems(customerMessage("/team"))
expectSentToGroup(CUSTOMER_GROUP_ID, "already been invited")
expectSentToGroup(CUSTOMER_GROUP_ID, teamAlreadyInvitedMessage)
})
test("/team with no team members → noTeamMembersMessage", async () => {
@@ -898,7 +997,7 @@ describe("One-Way Gate", () => {
test("/grok after gate → teamLockedMessage", async () => {
await reachTeam()
await bot.onNewChatItems(customerMessage("/grok"))
expectSentToGroup(CUSTOMER_GROUP_ID, "team mode")
expectSentToGroup(CUSTOMER_GROUP_ID, teamLockedMessage)
})
test("customer text in TEAM → card update scheduled, no bot reply", async () => {
@@ -948,6 +1047,17 @@ describe("One-Way Gate with Grok Disabled", () => {
// Grok should not respond (grokApi is null)
expect(grokApi.calls.length).toBe(0)
})
test("Grok disabled: customer /grok is treated as text and queued", async () => {
// When Grok is disabled, index.ts excludes "grok" from desiredCommands,
// so /grok from a customer parses as an unknown command → routed as
// plain text → first-message-in-WELCOME transitions to QUEUE.
setup()
bot = new SupportBot(chat as any, null, config as any, MAIN_USER_ID, null, DESIRED_COMMANDS_NO_GROK)
bot.cards = cards
await bot.onNewChatItems(customerMessage("/grok"))
expectSentToGroup(CUSTOMER_GROUP_ID, "The team will reply to your message")
})
})
describe("Team Member Lifecycle", () => {
@@ -1456,7 +1566,7 @@ describe("Error Handling", () => {
// Only the "Inviting Grok" message is sent — no activated/unavailable result
expect(chat.sent.length).toBe(sentBefore + 1)
expectSentToGroup(CUSTOMER_GROUP_ID, "Inviting Grok")
expectNotSentToGroup(CUSTOMER_GROUP_ID, "You are chatting with Grok")
expectNotSentToGroup(CUSTOMER_GROUP_ID, grokActivatedMessage)
expectNotSentToGroup(CUSTOMER_GROUP_ID, "temporarily unavailable")
})
@@ -1646,7 +1756,7 @@ describe("Grok Join Flow", () => {
await bot.flush()
expect(chat.joined).toContain(GROK_LOCAL_GROUP_ID)
expectSentToGroup(CUSTOMER_GROUP_ID, "You are chatting with Grok")
expectSentToGroup(CUSTOMER_GROUP_ID, grokActivatedMessage)
})
test("per-message responses suppressed during activateGrok initial response", async () => {
@@ -1794,7 +1904,7 @@ describe("End-to-End Flows", () => {
await joinPromise
await bot.flush()
expectSentToGroup(CUSTOMER_GROUP_ID, "You are chatting with Grok")
expectSentToGroup(CUSTOMER_GROUP_ID, grokActivatedMessage)
expectNotSentToGroup(CUSTOMER_GROUP_ID, "The team will reply to your message")
expect(chat.sentTo(TEAM_GROUP_ID).length).toBeGreaterThan(0)
})
@@ -1834,8 +1944,8 @@ describe("Message Templates", () => {
expect(grokActivatedMessage).toContain("chatting with Grok")
})
test("teamLockedMessage mentions team mode", () => {
expect(teamLockedMessage).toContain("team mode")
test("teamLockedMessage tells customer the team will handle the conversation", () => {
expect(teamLockedMessage).toContain("team")
})
test("queueMessage mentions hours", () => {
@@ -2402,7 +2512,7 @@ describe("GrokApiClient HTTP timeout", () => {
new Response(JSON.stringify({choices: [{message: {content: "ok"}}]}), {status: 200}),
)
const client = new GrokApiClient("test-key", "system prompt")
const client = new GrokApiClient("test-key", [{role: "system", content: "system prompt"}])
await client.chat([], "hello")
expect(timeoutSpy).toHaveBeenCalledWith(60_000)
@@ -2479,3 +2589,118 @@ describe("Command sync in sendToGroup", () => {
expect(prefs.reactions).toEqual({enable: "on"})
})
})
// loadGrokContext: documented behavior is "plain text → single system
// message". A `.yaml` / `.yml` extension is an undocumented alternative
// that parses the harness transcript format and surfaces only `system`
// and `assistant` turns; `user` entries are dropped so they don't merge
// with the customer's runtime message.
describe("loadGrokContext", () => {
const dir = mkdtempSync(join(tmpdir(), "support-bot-context-"))
const writeFile = (name: string, content: string): string => {
const p = join(dir, name)
writeFileSync(p, content)
return p
}
test("plain text (.txt) → single system message with full file content", () => {
const path = writeFile("ctx.txt", "You are Grok.\n\nBe concise.")
expect(loadGrokContext(path)).toEqual([
{role: "system", content: "You are Grok.\n\nBe concise."},
])
})
test("no extension → treated as plain text", () => {
const path = writeFile("plain", "raw context")
expect(loadGrokContext(path)).toEqual([{role: "system", content: "raw context"}])
})
test(".md → treated as plain text (does not look like YAML)", () => {
const path = writeFile("ctx.md", "# Heading\n\nbody")
expect(loadGrokContext(path)).toEqual([
{role: "system", content: "# Heading\n\nbody"},
])
})
test(".yaml → parses transcript and keeps only system + assistant turns", () => {
const path = writeFile("ctx.yaml",
"- role: system\n message: Be terse.\n" +
"- role: user\n message: What is async?\n" +
"- role: assistant\n message: Cooperative concurrency.\n",
)
expect(loadGrokContext(path)).toEqual([
{role: "system", content: "Be terse."},
{role: "assistant", content: "Cooperative concurrency."},
])
})
test(".yml extension also triggers YAML parsing", () => {
const path = writeFile("ctx.yml",
"- role: system\n message: hi\n",
)
expect(loadGrokContext(path)).toEqual([{role: "system", content: "hi"}])
})
test("YAML parsing is case-insensitive on extension", () => {
const path = writeFile("ctx.YAML",
"- role: system\n message: hi\n",
)
expect(loadGrokContext(path)).toEqual([{role: "system", content: "hi"}])
})
test("YAML preserves multi-line literal block scalars verbatim", () => {
const path = writeFile("multiline.yaml",
"- role: assistant\n message: |\n line one\n line two\n",
)
expect(loadGrokContext(path)).toEqual([
{role: "assistant", content: "line one\nline two\n"},
])
})
test("YAML with only user-role entries → empty array", () => {
const path = writeFile("only-user.yaml",
"- role: user\n message: a\n" +
"- role: user\n message: b\n",
)
expect(loadGrokContext(path)).toEqual([])
})
test("empty YAML file → empty array", () => {
const path = writeFile("empty.yaml", "")
expect(loadGrokContext(path)).toEqual([])
})
test("YAML non-list top level throws", () => {
const path = writeFile("not-list.yaml", "role: system\nmessage: x\n")
expect(() => loadGrokContext(path)).toThrow(/top-level must be a list/)
})
test("YAML entry with unknown role throws", () => {
const path = writeFile("bad-role.yaml", "- role: bogus\n message: x\n")
expect(() => loadGrokContext(path)).toThrow(/entry 0 has invalid role/)
})
test("YAML entry missing role throws", () => {
const path = writeFile("no-role.yaml", "- message: x\n")
expect(() => loadGrokContext(path)).toThrow(/entry 0 has invalid role/)
})
test("YAML entry with non-string message throws", () => {
const path = writeFile("bad-message.yaml", "- role: user\n message: 42\n")
expect(() => loadGrokContext(path)).toThrow(/entry 0 has non-string message/)
})
test("YAML entry that is not a mapping throws", () => {
const path = writeFile("bad-entry.yaml", "- just a string\n- role: user\n message: x\n")
expect(() => loadGrokContext(path)).toThrow(/entry 0 is not a mapping/)
})
test("malformed YAML throws", () => {
const path = writeFile("malformed.yaml", "- role: user\n message: [unclosed\n")
expect(() => loadGrokContext(path)).toThrow(/failed to parse YAML/)
})
test("missing file throws ENOENT", () => {
expect(() => loadGrokContext(join(dir, "does-not-exist.yaml"))).toThrow()
})
})
apps/simplex-support-bot/package-lock.json
Generated
+25 -9
View File
@@ -9,10 +9,11 @@
"version": "0.1.0",
"license": "AGPL-3.0",
"dependencies": {
"@simplex-chat/types": "^0.5.0",
"@simplex-chat/types": "^0.6.0",
"async-mutex": "^0.5.0",
"commander": "^14.0.3",
"simplex-chat": "^6.5.0"
"simplex-chat": "^6.5.1",
"yaml": "^2.8.4"
},
"devDependencies": {
"@types/node": "^22.0.0",
@@ -782,9 +783,9 @@
]
},
"node_modules/@simplex-chat/types": {
"version": "0.5.0",
"resolved": "https://registry.npmjs.org/@simplex-chat/types/-/types-0.5.0.tgz",
"integrity": "sha512-f680CRlf+O8WfIaPb7wxVj3PB8mTIOE+HqmetCSe0NBheVAjU3ovg3+zkrWwDlavrHuCLbb7Gmeu4HyNtjDfog==",
"version": "0.6.0",
"resolved": "https://registry.npmjs.org/@simplex-chat/types/-/types-0.6.0.tgz",
"integrity": "sha512-QVYvaRsS6TnS+IROjNkekZYvhvy8QoA8vKCuGe9E6lplXDVutJo9tdDOSWS9NDdtwxT1wRZ29zN4xEZEEG/NHw==",
"license": "AGPL-3.0",
"dependencies": {
"typescript": "^5.9.2"
@@ -1675,13 +1676,13 @@
}
},
"node_modules/simplex-chat": {
"version": "6.5.0",
"resolved": "https://registry.npmjs.org/simplex-chat/-/simplex-chat-6.5.0.tgz",
"integrity": "sha512-QFGI734HhYJ7trSrEKiZ2mbodI0V8CLDGEv2+yt5zsg0FqftxSpFik6zUSezTRZtN1M8WmSlT44qlEt2a1fXQw==",
"version": "6.5.1",
"resolved": "https://registry.npmjs.org/simplex-chat/-/simplex-chat-6.5.1.tgz",
"integrity": "sha512-1cv91iMCqtP+9R1PQM3NKazocoUInKT2/06pIOuzORD5/VzulR6cMZnEQmaT02Jz+8FVkEKTsaAIJfVP6/tJmw==",
"hasInstallScript": true,
"license": "AGPL-3.0",
"dependencies": {
"@simplex-chat/types": "^0.5.0",
"@simplex-chat/types": "^0.6.0",
"extract-zip": "^2.0.1",
"fast-deep-equal": "^3.1.3",
"node-addon-api": "^8.5.0"
@@ -1995,6 +1996,21 @@
"integrity": "sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==",
"license": "ISC"
},
"node_modules/yaml": {
"version": "2.8.4",
"resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.4.tgz",
"integrity": "sha512-ml/JPOj9fOQK8RNnWojA67GbZ0ApXAUlN2UQclwv2eVgTgn7O9gg9o7paZWKMp4g0H3nTLtS9LVzhkpOFIKzog==",
"license": "ISC",
"bin": {
"yaml": "bin.mjs"
},
"engines": {
"node": ">= 14.6"
},
"funding": {
"url": "https://github.com/sponsors/eemeli"
}
},
"node_modules/yauzl": {
"version": "2.10.0",
"resolved": "https://registry.npmjs.org/yauzl/-/yauzl-2.10.0.tgz",
apps/simplex-support-bot/package.json
+3 -2
View File
@@ -8,10 +8,11 @@
"start": "node dist/index.js"
},
"dependencies": {
"@simplex-chat/types": "^0.5.0",
"@simplex-chat/types": "^0.6.0",
"async-mutex": "^0.5.0",
"commander": "^14.0.3",
"simplex-chat": "^6.5.0"
"simplex-chat": "^6.5.1",
"yaml": "^2.8.4"
},
"devDependencies": {
"@types/node": "^22.0.0",
apps/simplex-support-bot/src/bot.ts
+40 -12
View File
@@ -8,7 +8,23 @@ import {
teamAlreadyInvitedMessage, teamLockedMessage, noTeamMembersMessage,
grokUnavailableMessage, grokErrorMessage, grokNoHistoryMessage,
} from "./messages.js"
import {profileMutex, log, logError} from "./util.js"
import {profileMutex, log, logError, getGroupInfo} from "./util.js"
// Collects the keyword of every "command" entry in the bot's registered
// commands tree, descending into "menu" entries. Used to distinguish real
// commands from arbitrary text that happens to start with `/` (e.g. URLs,
// "/help" the user invented).
function commandKeywords(commands: T.ChatBotCommand[]): Set<string> {
const out = new Set<string>()
const visit = (cmds: T.ChatBotCommand[]): void => {
for (const c of cmds) {
if (c.type === "command") out.add(c.keyword)
else if (c.type === "menu") visit(c.commands)
}
}
visit(commands)
return out
}
// True for any non-terminal status — invited but not yet accepted, through
// connected. Used to decide whether a contact is already in the group so we
@@ -62,6 +78,11 @@ export class SupportBot {
// send to each group.
private syncedGroups = new Set<number>()
// Keywords from desiredCommands. A customer message is treated as a
// command only when its parsed keyword is in this set; anything else
// (URLs, "/help", arbitrary slashes) is routed as plain text.
private readonly customerKeywords: ReadonlySet<string>
constructor(
private chat: api.ChatApi,
private grokApi: GrokApiClient | null,
@@ -71,6 +92,12 @@ export class SupportBot {
private desiredCommands: T.ChatBotCommand[],
) {
this.cards = new CardManager(chat, config, mainUserId, config.cardFlushSeconds * 1000)
this.customerKeywords = commandKeywords(desiredCommands)
}
private customerCommand(chatItem: T.ChatItem): util.BotCommand | undefined {
const cmd = util.ciBotCommand(chatItem)
return cmd && this.customerKeywords.has(cmd.keyword) ? cmd : undefined
}
private get grokEnabled(): boolean {
@@ -357,7 +384,7 @@ export class SupportBot {
if (chatInfo.type !== "group") continue
if (chatItem.chatDir.type !== "groupRcv") continue
if (!util.ciContentText(chatItem)?.trim()) continue
if (util.ciBotCommand(chatItem)) continue
if (this.customerCommand(chatItem)) continue
const bc = chatInfo.groupInfo.businessChat
if (!bc) continue
if (chatItem.chatDir.groupMember.memberId !== bc.customerId) continue
@@ -444,9 +471,7 @@ export class SupportBot {
// 8. Customer message → derive state and dispatch
const state = await this.cards.deriveState(groupId)
const rawCmd = util.ciBotCommand(chatItem)
// When Grok is disabled, ignore /grok so it behaves like an unknown command
const cmd = rawCmd?.keyword === "grok" && !this.grokEnabled ? null : rawCmd
const cmd = this.customerCommand(chatItem)
const text = util.ciContentText(chatItem)?.trim() || null
switch (state) {
@@ -547,7 +572,7 @@ export class SupportBot {
if (!text) return // ignore non-text
// Ignore bot commands
if (util.ciBotCommand(chatItem)) return
if (this.customerCommand(chatItem)) return
// Only respond in business groups (survives restart without in-memory maps)
const bc = groupInfo.businessChat
@@ -569,7 +594,7 @@ export class SupportBot {
history.push({role: "assistant", content: histText})
} else if (histCi.chatDir.type === "groupRcv"
&& histCi.chatDir.groupMember.memberId === bc.customerId
&& !util.ciBotCommand(histCi)) {
&& !this.customerCommand(histCi)) {
history.push({role: "user", content: histText})
}
}
@@ -587,6 +612,9 @@ export class SupportBot {
await this.withGrokProfile(() =>
this.chat.apiSendTextMessage([T.ChatType.Group, grokGroupId], response)
)
// Grok asked for the team → escalate as if the customer sent /team
if (mainGroupId !== undefined && response.includes("/team")) await this.activateTeam(mainGroupId)
} catch (err) {
logError(`Grok per-message error for grokGroup ${grokGroupId}`, err)
try {
@@ -706,7 +734,7 @@ export class SupportBot {
if (ci.chatDir.type !== "groupRcv") continue
if (!grokBc || ci.chatDir.groupMember.memberId !== grokBc.customerId) continue
const t = util.ciContentText(ci)?.trim()
if (t && !util.ciBotCommand(ci)) customerMessages.push(t)
if (t && !this.customerCommand(ci)) customerMessages.push(t)
}
if (customerMessages.length === 0) {
@@ -722,6 +750,9 @@ export class SupportBot {
await this.withGrokProfile(() =>
this.chat.apiSendTextMessage([T.ChatType.Group, grokLocalGId], response)
)
// Grok asked for the team → escalate as if the customer sent /team
if (response.includes("/team")) await this.activateTeam(groupId)
} catch (err) {
logError(`Grok initial response failed for group ${groupId}`, err)
await this.sendToGroup(groupId, grokUnavailableMessage)
@@ -795,10 +826,7 @@ export class SupportBot {
private async handleJoinCommand(targetGroupId: number, senderContactId: number): Promise<void> {
// Validate target is a business group
const groups = await this.withMainProfile(() =>
this.chat.apiListGroups(this.mainUserId)
)
const targetGroup = groups.find(g => g.groupId === targetGroupId)
const targetGroup = await this.withMainProfile(() => getGroupInfo(this.chat, targetGroupId))
if (!targetGroup?.businessChat) {
await this.sendToGroup(this.config.teamGroup.id, `Error: group ${targetGroupId} is not a business chat`)
return
apps/simplex-support-bot/src/cards.ts
+18 -12
View File
@@ -2,7 +2,7 @@ import {T} from "@simplex-chat/types"
import {api, util} from "simplex-chat"
import {Mutex} from "async-mutex"
import {Config} from "./config.js"
import {profileMutex, log, logError} from "./util.js"
import {profileMutex, log, logError, getGroupInfo} from "./util.js"
// State derivation types
export type ConversationState = "WELCOME" | "QUEUE" | "GROK" | "TEAM-PENDING" | "TEAM"
@@ -117,8 +117,7 @@ export class CardManager {
// Dispatches to create-path when cardItemId is absent so a failed createCard retries.
private async flushOne(groupId: number): Promise<void> {
const groups = await this.withMainProfile(() => this.chat.apiListGroups(this.mainUserId))
const groupInfo = groups.find(g => g.groupId === groupId)
const groupInfo = await this.withMainProfile(() => getGroupInfo(this.chat, groupId))
if (!groupInfo) return
const data = groupInfo.customData as Record<string, unknown> | undefined
if (typeof data?.cardItemId === "number") {
@@ -129,12 +128,22 @@ export class CardManager {
}
async refreshAllCards(): Promise<void> {
const groups = await this.withMainProfile(() => this.chat.apiListGroups(this.mainUserId))
// Scan the most recently active 1000 chats. Active cards live on
// recently-active customer chats by definition — a card stays open
// while the conversation is in flight. If the bot has been offline
// long enough that an active card has fallen outside this window, the
// card refreshes lazily on the next customer message (which moves the
// chat back into the recent window).
const chats = await this.withMainProfile(() =>
this.chat.apiGetChats(this.mainUserId, {type: "last", count: 1000})
)
const activeCards: {groupId: number; cardItemId: number}[] = []
for (const group of groups) {
const customData = group.customData as Record<string, unknown> | undefined
for (const c of chats) {
if (c.chatInfo.type !== "group") continue
const groupInfo = c.chatInfo.groupInfo
const customData = groupInfo.customData as Record<string, unknown> | undefined
if (customData && typeof customData.cardItemId === "number" && !customData.complete) {
activeCards.push({groupId: group.groupId, cardItemId: customData.cardItemId})
activeCards.push({groupId: groupInfo.groupId, cardItemId: customData.cardItemId})
}
}
if (activeCards.length === 0) return
@@ -210,8 +219,7 @@ export class CardManager {
// --- Custom data ---
async getRawCustomData(groupId: number): Promise<Partial<CardData> | null> {
const groups = await this.withMainProfile(() => this.chat.apiListGroups(this.mainUserId))
const group = groups.find(g => g.groupId === groupId)
const group = await this.withMainProfile(() => getGroupInfo(this.chat, groupId))
if (!group?.customData) return null
const data = group.customData as Record<string, unknown>
const result: Partial<CardData> = {}
@@ -247,9 +255,7 @@ export class CardManager {
// --- Internal ---
private async updateCard(groupId: number): Promise<void> {
// Read customData and groupInfo in one apiListGroups call
const groups = await this.withMainProfile(() => this.chat.apiListGroups(this.mainUserId))
const groupInfo = groups.find(g => g.groupId === groupId)
const groupInfo = await this.withMainProfile(() => getGroupInfo(this.chat, groupId))
if (!groupInfo) return
const customData = groupInfo.customData as Record<string, unknown> | undefined
apps/simplex-support-bot/src/context.ts
+59
View File
@@ -0,0 +1,59 @@
import {readFileSync} from "fs"
import {parse as parseYaml} from "yaml"
import {GrokMessage} from "./grok.js"
const ALLOWED_ROLES: ReadonlySet<GrokMessage["role"]> = new Set(["system", "user", "assistant"])
// Roles surfaced from a YAML transcript. `user` entries from the file are
// validated but dropped — the customer's runtime message is the only
// `user` content sent to Grok.
const PREPEND_ROLES: ReadonlySet<GrokMessage["role"]> = new Set(["system", "assistant"])
// Loads --context-file. The flag is documented as "text file with Grok
// system context"; a `.yaml` / `.yml` extension is an undocumented
// alternative that switches to a multi-turn transcript in the harness
// format (a flat list of `{role, message}` entries).
export function loadGrokContext(path: string): GrokMessage[] {
const text = readFileSync(path, "utf-8")
return isYamlPath(path) ? parseYamlTranscript(path, text) : [{role: "system", content: text}]
}
function isYamlPath(path: string): boolean {
const lower = path.toLowerCase()
return lower.endsWith(".yaml") || lower.endsWith(".yml")
}
// Parses the harness transcript format. Returns only `system` and
// `assistant` turns; `user` entries are intentionally excluded so they
// don't merge with the customer's runtime message. Malformed YAML,
// unknown roles, or non-string messages throw — operator-supplied
// configuration should fail-fast at startup, not silently degrade.
function parseYamlTranscript(path: string, text: string): GrokMessage[] {
let raw: unknown
try {
raw = parseYaml(text)
} catch (e) {
throw new Error(`${path}: failed to parse YAML: ${(e as Error).message}`)
}
if (raw === null || raw === undefined) return []
if (!Array.isArray(raw)) {
throw new Error(`${path}: top-level must be a list, got ${typeof raw}`)
}
const context: GrokMessage[] = []
for (let i = 0; i < raw.length; i++) {
const entry = raw[i]
if (entry === null || typeof entry !== "object" || Array.isArray(entry)) {
throw new Error(`${path}: entry ${i} is not a mapping`)
}
const {role, message} = entry as {role?: unknown; message?: unknown}
if (typeof role !== "string" || !ALLOWED_ROLES.has(role as GrokMessage["role"])) {
throw new Error(`${path}: entry ${i} has invalid role: ${JSON.stringify(role)}`)
}
if (typeof message !== "string") {
throw new Error(`${path}: entry ${i} has non-string message`)
}
if (PREPEND_ROLES.has(role as GrokMessage["role"])) {
context.push({role: role as GrokMessage["role"], content: message})
}
}
return context
}
apps/simplex-support-bot/src/grok.ts
+6 -6
View File
@@ -7,11 +7,11 @@ export interface GrokMessage {
export class GrokApiClient {
private readonly apiKey: string
private readonly systemPrompt: string
private readonly initialContext: readonly GrokMessage[]
constructor(apiKey: string, systemPrompt: string) {
constructor(apiKey: string, initialContext: readonly GrokMessage[]) {
this.apiKey = apiKey
this.systemPrompt = systemPrompt
this.initialContext = initialContext
}
async chatRaw(messages: GrokMessage[]): Promise<string> {
@@ -22,7 +22,7 @@ export class GrokApiClient {
"Authorization": `Bearer ${this.apiKey}`,
},
body: JSON.stringify({
model: "grok-3-mini",
model: "grok-latest",
messages,
temperature: 0.3,
max_tokens: 1024,
@@ -45,9 +45,9 @@ export class GrokApiClient {
}
async chat(history: GrokMessage[], userMessage: string): Promise<string> {
log(`Grok API call: ${history.length} history msgs, user msg ${userMessage.length} chars`)
log(`Grok API call: ${this.initialContext.length} context msgs, ${history.length} history msgs, user msg ${userMessage.length} chars`)
return this.chatRaw([
{role: "system", content: this.systemPrompt},
...this.initialContext,
...history,
{role: "user", content: userMessage},
])
apps/simplex-support-bot/src/index.ts
+25 -21
View File
@@ -3,9 +3,10 @@ import {api, bot, util} from "simplex-chat"
import {T} from "@simplex-chat/types"
import {parseConfig} from "./config.js"
import {SupportBot} from "./bot.js"
import {GrokApiClient} from "./grok.js"
import {GrokApiClient, GrokMessage} from "./grok.js"
import {loadGrokContext} from "./context.js"
import {welcomeMessage} from "./messages.js"
import {profileMutex, log, logError} from "./util.js"
import {profileMutex, log, logError, getGroupInfo, getContact} from "./util.js"
interface BotState {
teamGroupId?: number
@@ -163,14 +164,12 @@ async function main(): Promise<void> {
await chat.apiSetAutoAcceptMemberContacts(mainUser.userId, true)
log("Auto-accept member contacts enabled")
// Step 5: List contacts, resolve Grok contact
const contacts = await chat.apiListContacts(mainUser.userId)
log(`Contacts connected: ${contacts.length || "(none)"}`)
// Step 5: Resolve Grok contact by ID. Avoid apiListContacts — it loads
// every contact in one response and OOMs the native binding on large DBs.
// Always restore grokContactId so the one-way gate can find and remove
// Grok members even when Grok API is disabled.
if (typeof state.grokContactId === "number") {
const found = contacts.find(c => c.contactId === state.grokContactId)
const found = await getContact(chat, state.grokContactId)
if (found) {
config.grokContactId = found.contactId
log(`Grok contact from state: ID=${config.grokContactId}`)
@@ -210,14 +209,13 @@ async function main(): Promise<void> {
}
}
// Step 6: Resolve team group
// Step 6: Resolve team group by ID. Avoid apiListGroups — it loads every
// group in one response and OOMs the native binding on large DBs.
log("Resolving team group...")
const groups = await chat.apiListGroups(mainUser.userId)
let existingGroup: T.GroupInfo | undefined
let existingGroup: T.GroupInfo | null = null
if (typeof state.teamGroupId === "number") {
existingGroup = groups.find(g => g.groupId === state.teamGroupId)
existingGroup = await getGroupInfo(chat, state.teamGroupId)
if (existingGroup) {
config.teamGroup.id = existingGroup.groupId
log(`Team group from state: ${config.teamGroup.id}:${existingGroup.groupProfile.displayName}`)
@@ -302,13 +300,13 @@ async function main(): Promise<void> {
inviteLinkTimer.unref()
}
// Step 9: Validate team members
// Step 9: Validate team members (lookup by ID, one round-trip per member)
if (config.teamMembers.length > 0) {
log("Validating team members...")
for (const member of config.teamMembers) {
const contact = contacts.find(c => c.contactId === member.id)
const contact = await getContact(chat, member.id)
if (!contact) {
console.error(`Team member not found: ID=${member.id}. Available: ${contacts.map(c => `${c.contactId}:${c.profile.displayName}`).join(", ") || "(none)"}`)
console.error(`Team member not found: ID=${member.id}`)
process.exit(1)
}
if (contact.profile.displayName !== member.name) {
@@ -322,16 +320,22 @@ async function main(): Promise<void> {
// Load Grok context and build API client only if enabled
let grokApi: GrokApiClient | null = null
if (grokEnabled) {
let contextFile = ""
let initialContext: GrokMessage[] = []
if (config.contextFile) {
try {
contextFile = readFileSync(config.contextFile, "utf-8")
log(`Loaded Grok context: ${contextFile.length} chars from ${config.contextFile}`)
} catch {
log(`Warning: context file not found: ${config.contextFile}`)
initialContext = loadGrokContext(config.contextFile)
log(`Loaded Grok context: ${initialContext.length} message(s) from ${config.contextFile}`)
} catch (err) {
const e = err as NodeJS.ErrnoException
if (e.code === "ENOENT") {
log(`Warning: context file not found: ${config.contextFile}`)
} else {
logError(`Failed to load Grok context file ${config.contextFile}`, err)
throw err
}
}
}
grokApi = new GrokApiClient(config.grokApiKey!, contextFile)
grokApi = new GrokApiClient(config.grokApiKey!, initialContext)
}
// Create SupportBot
apps/simplex-support-bot/src/util.ts
+29
View File
@@ -1,7 +1,36 @@
import {Mutex} from "async-mutex"
import {api, core} from "simplex-chat"
import {T} from "@simplex-chat/types"
export const profileMutex = new Mutex()
export function isChatNotFound(err: unknown, kind: "group" | "contact"): boolean {
if (!(err instanceof core.ChatAPIError)) return false
if (err.chatError?.type !== "errorStore") return false
const seType = err.chatError.storeError.type
return kind === "group" ? seType === "groupNotFound" : seType === "contactNotFound"
}
export async function getGroupInfo(chat: api.ChatApi, groupId: number): Promise<T.GroupInfo | null> {
try {
const c = await chat.apiGetChat(T.ChatType.Group, groupId, 0)
return c.chatInfo.type === "group" ? c.chatInfo.groupInfo : null
} catch (err) {
if (isChatNotFound(err, "group")) return null
throw err
}
}
export async function getContact(chat: api.ChatApi, contactId: number): Promise<T.Contact | null> {
try {
const c = await chat.apiGetChat(T.ChatType.Direct, contactId, 0)
return c.chatInfo.type === "direct" ? c.chatInfo.contact : null
} catch (err) {
if (isChatNotFound(err, "contact")) return null
throw err
}
}
export function isWeekend(timezone: string): boolean {
const day = new Intl.DateTimeFormat("en-US", {timeZone: timezone, weekday: "short"}).format(new Date())
return day === "Sat" || day === "Sun"
apps/simplex-support-bot/test/__mocks__/simplex-chat.js
+11 -1
View File
@@ -9,7 +9,7 @@ function ciContentText(chatItem) {
function ciBotCommand(chatItem) {
const text = ciContentText(chatItem)?.trim()
if (text) {
const r = text.match(/\/([^\s]+)(.*)/)
const r = text.match(/^\/([^\s]+)(.*)/)
if (r && r.length >= 3) return {keyword: r[1], params: r[2].trim()}
}
return undefined
@@ -19,8 +19,18 @@ function contactAddressStr(link) {
return link.connShortLink || link.connFullLink
}
// Mirrors core.ChatAPIError so isChatNotFound's instanceof check passes when
// MockChatApi throws. Tests should construct these directly.
class ChatAPIError extends Error {
constructor(message, chatError) {
super(message)
this.chatError = chatError
}
}
module.exports = {
api: {ChatApi: {}},
bot: {},
core: {ChatAPIError},
util: {ciContentText, ciBotCommand, contactAddressStr},
}
blog/20260430-simplex-channels-v6-5-consortium-crowdfunding-freedom-of-speech.md
+1 -1
View File
@@ -52,7 +52,7 @@ We've seen open-source privacy-focussed projects die without funding, or worse &
So we're building both: a governance structure and a real business. The governance protects the network neutrality. The commercial model funds the network and makes our and other businesses on the network profitable, ensuring their independence. Neither works without the other.
We recently published [a preliminary design of commercial model](https://simplex.chat/vouchers/) &mdash; private Community Credits that fund servers, development, and governance without surveillance or speculation. The full investment case will be published when crowdfunding launches.
We recently published [a preliminary design of commercial model](https://simplex.chat/credits/) &mdash; private Community Credits that fund servers, development, and governance without surveillance or speculation. The full investment case will be published when crowdfunding launches.
You can *register your interest* to participate in crowdfunding here: https://simplexchat.typeform.com/crowdfunding
bots/api/COMMANDS.md
+94 -7
View File
@@ -32,6 +32,7 @@ This file is generated automatically.
- [APINewGroup](#apinewgroup)
- [APINewPublicGroup](#apinewpublicgroup)
- [APIGetGroupRelays](#apigetgrouprelays)
- [APIAddGroupRelays](#apiaddgrouprelays)
- [APIUpdateGroupProfile](#apiupdategroupprofile)
[Group link commands](#group-link-commands)
@@ -51,6 +52,7 @@ This file is generated automatically.
[Chat commands](#chat-commands)
- [APIListContacts](#apilistcontacts)
- [APIListGroups](#apilistgroups)
- [APIGetChats](#apigetchats)
- [APIDeleteChat](#apideletechat)
- [APISetGroupCustomData](#apisetgroupcustomdata)
- [APISetContactCustomData](#apisetcontactcustomdata)
@@ -293,7 +295,7 @@ Send messages.
```
```python
'/_send ' + str(sendRef) + (' live=on' if liveMessage else '') + ((' ttl=' + str(ttl)) if ttl is not None else '') + ' json ' + json.dumps(composedMessages) # Python
'/_send ' + ChatRef_cmd_string(sendRef) + (' live=on' if liveMessage else '') + ((' ttl=' + str(ttl)) if ttl is not None else '') + ' json ' + json.dumps(composedMessages) # Python
```
**Responses**:
@@ -333,7 +335,7 @@ Update message.
```
```python
'/_update item ' + str(chatRef) + ' ' + str(chatItemId) + (' live=on' if liveMessage else '') + ' json ' + json.dumps(updatedMessage) # Python
'/_update item ' + ChatRef_cmd_string(chatRef) + ' ' + str(chatItemId) + (' live=on' if liveMessage else '') + ' json ' + json.dumps(updatedMessage) # Python
```
**Responses**:
@@ -372,7 +374,7 @@ Delete message.
**Syntax**:
```
/_delete item <str(chatRef)> <chatItemIds[0]>[,<chatItemIds[1]>...] broadcast|internal|internalMark
/_delete item <str(chatRef)> <chatItemIds[0]>[,<chatItemIds[1]>...] broadcast|internal|internalMark|history
```
```javascript
@@ -380,7 +382,7 @@ Delete message.
```
```python
'/_delete item ' + str(chatRef) + ' ' + ','.join(map(str, chatItemIds)) + ' ' + str(deleteMode) # Python
'/_delete item ' + ChatRef_cmd_string(chatRef) + ' ' + ','.join(map(str, chatItemIds)) + ' ' + str(deleteMode) # Python
```
**Responses**:
@@ -462,7 +464,7 @@ Add/remove message reaction.
```
```python
'/_reaction ' + str(chatRef) + ' ' + str(chatItemId) + ' ' + ('on' if add else 'off') + ' ' + json.dumps(reaction) # Python
'/_reaction ' + ChatRef_cmd_string(chatRef) + ' ' + str(chatItemId) + ' ' + ('on' if add else 'off') + ' ' + json.dumps(reaction) # Python
```
**Responses**:
@@ -1033,6 +1035,51 @@ ChatCmdError: Command error (only used in WebSockets API).
---
### APIAddGroupRelays
Add relays to group.
*Network usage*: interactive.
**Parameters**:
- groupId: int64
- relayIds: [int64]
**Syntax**:
```
/_add relays #<groupId> <relayIds[0]>[,<relayIds[1]>...]
```
```javascript
'/_add relays #' + groupId + ' ' + relayIds.join(',') // JavaScript
```
```python
'/_add relays #' + str(groupId) + ' ' + ','.join(map(str, relayIds)) # Python
```
**Responses**:
GroupRelaysAdded: Group relays added.
- type: "groupRelaysAdded"
- user: [User](./TYPES.md#user)
- groupInfo: [GroupInfo](./TYPES.md#groupinfo)
- groupLink: [GroupLink](./TYPES.md#grouplink)
- groupRelays: [[GroupRelay](./TYPES.md#grouprelay)]
GroupRelaysAddFailed: Group relays add failed.
- type: "groupRelaysAddFailed"
- user: [User](./TYPES.md#user)
- addRelayResults: [[AddRelayResult](./TYPES.md#addrelayresult)]
ChatCmdError: Command error (only used in WebSockets API).
- type: "chatCmdError"
- chatError: [ChatError](./TYPES.md#chaterror)
---
### APIUpdateGroupProfile
Update group profile.
@@ -1339,7 +1386,7 @@ Connect via prepared SimpleX link. The link can be 1-time invitation link, conta
```
```python
'/_connect ' + str(userId) + ((' ' + str(preparedLink_)) if preparedLink_ is not None else '') # Python
'/_connect ' + str(userId) + ((' ' + CreatedConnLink_cmd_string(preparedLink_)) if preparedLink_ is not None else '') # Python
```
**Responses**:
@@ -1574,6 +1621,46 @@ ChatCmdError: Command error (only used in WebSockets API).
---
### APIGetChats
Get chat previews. Supports time-based pagination — use this instead of APIListContacts / APIListGroups when scanning at scale (those load every record into memory and fail on large databases).
*Network usage*: no.
**Parameters**:
- userId: int64
- pendingConnections: bool
- pagination: [PaginationByTime](./TYPES.md#paginationbytime)
- query: [ChatListQuery](./TYPES.md#chatlistquery)
**Syntax**:
```
/_get chats <userId>[ pcc=on] <str(pagination)> <json(query)>
```
```javascript
'/_get chats ' + userId + (pendingConnections ? ' pcc=on' : '') + ' ' + PaginationByTime.cmdString(pagination) + ' ' + JSON.stringify(query) // JavaScript
```
```python
'/_get chats ' + str(userId) + (' pcc=on' if pendingConnections else '') + ' ' + PaginationByTime_cmd_string(pagination) + ' ' + json.dumps(query) # Python
```
**Responses**:
ApiChats: Chat previews (paginated). Use this instead of CRContactsList / CRGroupsList when scanning at scale..
- type: "apiChats"
- user: [User](./TYPES.md#user)
- chats: [[AChat](./TYPES.md#achat)]
ChatCmdError: Command error (only used in WebSockets API).
- type: "chatCmdError"
- chatError: [ChatError](./TYPES.md#chaterror)
---
### APIDeleteChat
Delete chat.
@@ -1595,7 +1682,7 @@ Delete chat.
```
```python
'/_delete ' + str(chatRef) + ' ' + str(chatDeleteMode) # Python
'/_delete ' + ChatRef_cmd_string(chatRef) + ' ' + ChatDeleteMode_cmd_string(chatDeleteMode) # Python
```
**Responses**:
bots/api/TYPES.md
+45 -1
View File
@@ -41,6 +41,7 @@ This file is generated automatically.
- [ChatInfo](#chatinfo)
- [ChatItem](#chatitem)
- [ChatItemDeletion](#chatitemdeletion)
- [ChatListQuery](#chatlistquery)
- [ChatPeerType](#chatpeertype)
- [ChatRef](#chatref)
- [ChatSettings](#chatsettings)
@@ -136,6 +137,7 @@ This file is generated automatically.
- [NewUser](#newuser)
- [NoteFolder](#notefolder)
- [OwnerVerification](#ownerverification)
- [PaginationByTime](#paginationbytime)
- [PendingContactConnection](#pendingcontactconnection)
- [PrefEnabled](#prefenabled)
- [Preferences](#preferences)
@@ -587,6 +589,7 @@ ChatBanner:
- "broadcast"
- "internal"
- "internalMark"
- "history"
---
@@ -1327,6 +1330,22 @@ Message deletion result.
- toChatItem: [AChatItem](#achatitem)?
---
## ChatListQuery
**Discriminated union type**:
Filters:
- type: "filters"
- favorite: bool
- unread: bool
Search:
- type: "search"
- search: string
---
## ChatPeerType
@@ -1358,7 +1377,7 @@ ChatType.cmdString(chatType) + chatId + (chatScope ? GroupChatScope.cmdString(ch
```
```python
str(chatType) + str(chatId) + ((str(chatScope)) if chatScope is not None else '') # Python
ChatType_cmd_string(chatType) + str(chatId) + ((GroupChatScope_cmd_string(chatScope)) if chatScope is not None else '') # Python
```
@@ -2893,6 +2912,31 @@ Failed:
- reason: string
---
## PaginationByTime
**Discriminated union type**:
Last:
- type: "last"
- count: int
**Syntax**:
```
count=<count>
```
```javascript
'count=' + count // JavaScript
```
```python
'count=' + str(count) # Python
```
---
## PendingContactConnection
bots/src/API/Docs/Commands.hs
+3 -1
View File
@@ -119,6 +119,7 @@ chatCommandsDocsData =
("APINewGroup", [], "Create group.", ["CRGroupCreated", "CRChatCmdError"], [], Nothing, "/_group " <> Param "userId" <> OnOffParam "incognito" "incognito" (Just False) <> " " <> Json "groupProfile"),
("APINewPublicGroup", [], "Create public group.", ["CRPublicGroupCreated", "CRPublicGroupCreationFailed", "CRChatCmdError"], [], Just UNInteractive, "/_public group " <> Param "userId" <> OnOffParam "incognito" "incognito" (Just False) <> " " <> Join ',' "relayIds" <> " " <> Json "groupProfile"),
("APIGetGroupRelays", [], "Get group relays.", ["CRGroupRelays", "CRChatCmdError"], [], Nothing, "/_get relays #" <> Param "groupId"),
("APIAddGroupRelays", [], "Add relays to group.", ["CRGroupRelaysAdded", "CRGroupRelaysAddFailed", "CRChatCmdError"], [], Just UNInteractive, "/_add relays #" <> Param "groupId" <> " " <> Join ',' "relayIds"),
("APIUpdateGroupProfile", [], "Update group profile.", ["CRGroupUpdated", "CRChatCmdError"], [], Just UNBackground, "/_group_profile #" <> Param "groupId" <> " " <> Json "groupProfile")
]
),
@@ -133,6 +134,7 @@ chatCommandsDocsData =
( "Connection commands",
"These commands may be used to create connections. Most bots do not need to use them - bot users will connect via bot address with auto-accept enabled.",
[ ("APIAddContact", [], "Create 1-time invitation link.", ["CRInvitation", "CRChatCmdError"], [], Just UNInteractive, "/_connect " <> Param "userId" <> OnOffParam "incognito" "incognito" (Just False)),
-- `Maybe` in `connectionLink :: Maybe AConnectionLink` is used to signal link parsing error to the runtime (the handler returns CEInvalidConnReq on Nothing); it is NOT API-level optionality. The parameter is required from callers.
("APIConnectPlan", [], "Determine SimpleX link type and if the bot is already connected via this link.", ["CRConnectionPlan", "CRChatCmdError"], [], Just UNInteractive, "/_connect plan " <> Param "userId" <> " " <> Param "connectionLink"),
("APIConnect", [], "Connect via prepared SimpleX link. The link can be 1-time invitation link, contact address or group link.", ["CRSentConfirmation", "CRContactAlreadyExists", "CRSentInvitation", "CRChatCmdError"], [], Just UNInteractive, "/_connect " <> Param "userId" <> Optional "" (" " <> Param "$0") "preparedLink_"),
("Connect", [], "Connect via SimpleX link as string in the active user profile.", ["CRSentConfirmation", "CRContactAlreadyExists", "CRSentInvitation", "CRChatCmdError"], [], Just UNInteractive, "/connect" <> Optional "" (" " <> Param "$0") "connLink_"),
@@ -144,6 +146,7 @@ chatCommandsDocsData =
"Commands to list and delete conversations.",
[ ("APIListContacts", [], "Get contacts.", ["CRContactsList", "CRChatCmdError"], [], Nothing, "/_contacts " <> Param "userId"),
("APIListGroups", [], "Get groups.", ["CRGroupsList", "CRChatCmdError"], [], Nothing, "/_groups " <> Param "userId" <> Optional "" (" @" <> Param "$0") "contactId_" <> Optional "" (" " <> Param "$0") "search"),
("APIGetChats", [], "Get chat previews. Supports time-based pagination — use this instead of APIListContacts / APIListGroups when scanning at scale (those load every record into memory and fail on large databases).", ["CRApiChats", "CRChatCmdError"], [], Nothing, "/_get chats " <> Param "userId" <> OnOffParam "pcc" "pendingConnections" (Just False) <> " " <> Param "pagination" <> " " <> Json "query"),
("APIDeleteChat", [], "Delete chat.", ["CRContactDeleted", "CRContactConnectionDeleted", "CRGroupDeletedUser", "CRChatCmdError"], [], Just UNBackground, "/_delete " <> Param "chatRef" <> " " <> Param "chatDeleteMode"),
("APISetGroupCustomData", [], "Set group custom data.", ["CRCmdOk", "CRChatCmdError"], [], Nothing, "/_set custom #" <> Param "groupId" <> Optional "" (" " <> Json "$0") "customData"),
("APISetContactCustomData", [], "Set contact custom data.", ["CRCmdOk", "CRChatCmdError"], [], Nothing, "/_set custom @" <> Param "contactId" <> Optional "" (" " <> Json "$0") "customData"),
@@ -357,7 +360,6 @@ undocumentedCommands =
"APIGetChatItemInfo",
"APIGetChatItems",
"APIGetChatItemTTL",
"APIGetChats",
"APIGetChatTags",
"APIGetConnNtfMessages",
"APIGetContactCode",
bots/src/API/Docs/Generate.hs
+1 -1
View File
@@ -74,7 +74,7 @@ syntaxText r syntax =
"\n**Syntax**:\n"
<> "\n```\n" <> docSyntaxText r syntax <> "\n```\n"
<> (if isConst syntax then "" else "\n```javascript\n" <> jsSyntaxText False "" r syntax <> " // JavaScript\n```\n")
<> (if isConst syntax then "" else "\n```python\n" <> pySyntaxText r syntax <> " # Python\n```\n")
<> (if isConst syntax then "" else "\n```python\n" <> pySyntaxText "" r syntax <> " # Python\n```\n")
camelToSpace :: String -> String
camelToSpace [] = []
bots/src/API/Docs/Generate/Python.hs
+322
View File
@@ -0,0 +1,322 @@
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
module API.Docs.Generate.Python where
import API.Docs.Commands
import API.Docs.Events
import API.Docs.Generate
import API.Docs.Responses
import API.Docs.Syntax
import API.Docs.Syntax.Types
import API.Docs.Types
import API.TypeInfo
import Data.Char (isAlphaNum, toUpper)
import qualified Data.List.NonEmpty as L
import Data.Text (Text)
import qualified Data.Text as T
commandsCodeFile :: FilePath
commandsCodeFile = "./packages/simplex-chat-python/src/simplex_chat/types/_commands.py"
responsesCodeFile :: FilePath
responsesCodeFile = "./packages/simplex-chat-python/src/simplex_chat/types/_responses.py"
eventsCodeFile :: FilePath
eventsCodeFile = "./packages/simplex-chat-python/src/simplex_chat/types/_events.py"
typesCodeFile :: FilePath
typesCodeFile = "./packages/simplex-chat-python/src/simplex_chat/types/_types.py"
-- | Replace dashes with underscores so Python identifiers stay valid.
pyIdent :: String -> Text
pyIdent = T.replace "-" "_" . T.pack
-- | Python class name for a union member tag.
pyConstrName :: String -> Text
pyConstrName = pyIdent . fstToUpper
commandsCodeText :: Text
commandsCodeText =
("# API Commands\n# " <> autoGenerated <> "\n")
<> "from __future__ import annotations\n"
<> "import json\n"
<> "from typing import NotRequired, TypedDict\n"
<> "from . import _types as T\n"
<> "from . import _responses as CR\n"
<> foldMap commandCatCode chatCommandsDocs
where
commandCatCode CCCategory {categoryName, categoryDescr, commands} =
(T.pack $ "\n# " <> categoryName <> "\n# " <> categoryDescr <> "\n")
<> foldMap commandCode commands
where
commandCode CCDoc {commandType = ATUnionMember tag params, commandDescr, syntax, responses, network} =
("\n# " <> commandDescr <> "\n")
<> ("# Network usage: " <> networkUsage network <> ".\n")
<> classDef
<> (if syntax == "" then "" else cmdStringFunc)
<> respAliasLine
where
constrName = T.pack $ fstToUpper tag
classDef =
("class " <> constrName <> "(TypedDict):\n")
<> bodyOrPass (fieldsCodePy " " "T." params)
<> "\n"
cmdStringFunc =
("\ndef " <> constrName <> "_cmd_string(self: " <> constrName <> ") -> str:\n")
<> " return " <> pySelfSyntaxText "T." (fstToUpper tag, params) syntax <> "\n"
respAliasLine =
"\n" <> constrName <> "_Response = " <> respUnion <> "\n"
respUnion = unionAliasRhs "" (responseRef . responseType) responses
responseRef (ATUnionMember rtag _) = "CR." <> pyConstrName rtag
responsesCodeText :: Text
responsesCodeText =
("# API Responses\n# " <> autoGenerated <> "\n")
<> pythonImports
<> unionTypeCodePy moduleMember "T." "ChatResponse" chatRespConstrs
where
chatRespConstrs = L.fromList $ map responseType chatResponsesDocs
eventsCodeText :: Text
eventsCodeText =
("# API Events\n# " <> autoGenerated <> "\n")
<> pythonImports
<> unionTypeCodePy moduleMember "T." "ChatEvent" chatEventConstrs
where
chatEventConstrs = L.fromList $ concatMap catEvents chatEventsDocs
catEvents CECategory {mainEvents, otherEvents} = map eventType $ mainEvents ++ otherEvents
typesCodeText :: Text
typesCodeText =
("# API Types\n# " <> autoGenerated <> "\n")
<> "from __future__ import annotations\n"
<> "from typing import Literal, NotRequired, TypedDict\n"
<> foldMap typeCode chatTypesDocs
where
typeCode ctd@CTDoc {typeDef = APITypeDef {typeName' = name, typeDef}, typeDescr} =
(if T.null typeDescr then "" else "\n# " <> typeDescr <> "\n")
<> typeDefCode
<> typeCmdStringCode ctd
where
name' = T.pack name
enumValue m = case name of
"ConnectionMode" -> map toUpper m
"FileProtocol" -> map toUpper m
_ -> m
typeDefCode = case typeDef of
ATDRecord fields ->
("\nclass " <> name' <> "(TypedDict):\n")
<> bodyOrPass (fieldsCodePy " " "" fields)
ATDEnum cs ->
"\n" <> name' <> " = Literal["
<> T.intercalate ", " (map (\m -> "\"" <> T.pack (enumValue m) <> "\"") $ L.toList cs)
<> "]\n"
ATDUnion cs -> unionTypeCodePy typeMember "" name cs
-- | For types with non-empty `typeSyntax`, emit a top-level
-- `<TypeName>_cmd_string(self: <TypeName>) -> str` helper that mirrors the
-- Choice/Param expression. Records access fields via `self['<name>']`;
-- enums and unions dispatch on `self` (a literal string) or `self['type']`
-- respectively. Required so generated `_commands.py` produces valid CLI
-- syntax for ChatRef/ChatType/ChatDeleteMode/GroupChatScope/PaginationByTime
-- params instead of stringifying the wire dict.
typeCmdStringCode :: CTDoc -> Text
typeCmdStringCode CTDoc {typeDef = td@APITypeDef {typeName' = name, typeDef}, typeSyntax}
| typeSyntax == "" = ""
| otherwise =
"\n\ndef " <> T.pack name <> "_cmd_string(self: " <> T.pack name <> ") -> str:\n"
<> " return " <> body <> ignore <> "\n"
where
body = pyTypeSyntaxText "" (name, fields) typeSyntax
-- Unions and enums use self/self['type'] to dispatch. Pyright cannot
-- narrow TypedDict access by string-literal key, so suppress per-branch
-- complaints with one ignore on the return.
ignore = case typeDef of
ATDUnion _ -> " # type: ignore[typeddict-item]"
_ -> ""
-- typeFields mirrors TS funcCode: include `self` so Choice "self"
-- resolves; for unions add `type` and flatten member fields.
self = APIRecordField "self" (ATDef td)
fields = case typeDef of
ATDRecord fs -> fs
ATDUnion ms ->
self : APIRecordField "type" tagType : concatMap (\(ATUnionMember _ fs) -> fs) (L.toList ms)
where
tagType = ATDef $ APITypeDef (name <> ".type") $ ATDEnum tags
tags = L.map (\(ATUnionMember tag _) -> tag) ms
ATDEnum _ -> [self]
-- | Like `pySelfSyntaxText` but excludes `self` from the param-rewrite list
-- so `self == 'tag'` (enum dispatch) and `self['type']` (union dispatch)
-- survive verbatim. Used only for type-level cmd_string functions inside
-- @_types.py@, where peer type cmd_string calls don't need a namespace.
pyTypeSyntaxText :: String -> TypeAndFields -> Expr -> Text
pyTypeSyntaxText typeNamespace r expr =
rewriteParams accessors (pySyntaxText typeNamespace r expr)
where
accessors = filter ((/= "self") . fst) (paramAccessors r)
-- | Member class name within the multi-type @_types.py@ module: prefix the
-- tag with the union type name so members from different unions don't
-- collide.
typeMember :: String -> String -> Text
typeMember typeName tag = T.pack typeName <> "_" <> pyIdent tag
-- | Member class name within a single-union module (responses/events): just
-- the PascalCase tag, so commands can reference them as @CR.<Tag>@.
moduleMember :: String -> String -> Text
moduleMember _ tag = pyConstrName tag
-- | Common imports for the responses/events modules.
pythonImports :: Text
pythonImports =
"from __future__ import annotations\n"
<> "from typing import Literal, NotRequired, TypedDict\n"
<> "from . import _types as T\n"
-- | Render a tagged-union type: one TypedDict per member, plus union alias
-- and `<Name>_Tag` Literal alias. The member class names are produced by
-- @memberName@ given the union type name and the member tag.
unionTypeCodePy ::
(String -> String -> Text) ->
Text ->
String ->
L.NonEmpty ATUnionMember ->
Text
unionTypeCodePy memberName typesNamespace name cs =
foldMap memberClass (L.toList cs)
<> "\n" <> name' <> " = " <> unionAliasRhs name' constrTypeRef (L.toList cs)
<> "\n" <> name' <> "_Tag = Literal[" <> tagLiterals <> "]\n"
where
name' = T.pack name
constrTypeRef (ATUnionMember tag _) = memberName name tag
tagLiterals = T.intercalate ", " $ map (\(ATUnionMember tag _) -> "\"" <> T.pack tag <> "\"") $ L.toList cs
memberClass (ATUnionMember tag fields) =
("\nclass " <> memberName name tag <> "(TypedDict):\n")
<> (" type: Literal[\"" <> T.pack tag <> "\"]\n")
<> fieldsCodePy " " typesNamespace fields
-- | Render the right-hand side of a union alias: either inline (one line) or
-- multi-line wrapped in parentheses with `|` separators between alternatives.
unionAliasRhs :: Text -> (a -> Text) -> [a] -> Text
unionAliasRhs lhs constr cs
| T.length (lhs <> " = " <> oneLine) <= 100 = oneLine <> "\n"
| otherwise = "(\n" <> T.intercalate "\n" (map (" " <>) lines') <> "\n)\n"
where
oneLine = T.intercalate " | " cs'
lines' = case cs' of
[] -> []
(h : t) -> h : map ("| " <>) t
cs' = map constr cs
-- | Emit a body of `pass` if there are no fields, otherwise the rendered
-- fields as-is.
bodyOrPass :: Text -> Text
bodyOrPass body
| T.null body = " pass\n"
| otherwise = body
-- | Render record fields for a TypedDict body. Each field becomes
-- `<indent><name>: <type>[ # <comment>]`. Optional fields wrap the type in
-- `NotRequired[...]`.
fieldsCodePy :: Text -> Text -> [APIRecordField] -> Text
fieldsCodePy indent namespace = foldMap render
where
render (APIRecordField name t) =
indent <> T.pack name <> ": " <> wrapOptional t (typeText t) <> typeComment t <> "\n"
wrapOptional t inner = case t of
ATOptional _ -> "NotRequired[" <> inner <> "]"
_ -> inner
typeText = \case
ATPrim (PT t) -> primName t
ATDef (APITypeDef t _) -> quoted (namespace <> T.pack t)
ATRef t -> quoted (namespace <> T.pack t)
ATOptional t -> typeText t
ATArray {elemType} -> "list[" <> typeText elemType <> "]"
ATMap (PT k) v -> "dict[" <> primName k <> ", " <> typeText v <> "]"
primName = \case
TBool -> "bool"
TString -> "str"
TInt -> "int"
TInt64 -> "int"
TWord32 -> "int"
TDouble -> "float"
TJSONObject -> "dict[str, object]"
TUTCTime -> "str"
t -> T.pack t
quoted s = "\"" <> s <> "\""
typeComment t = let c = typeComment' t in if T.null c then "" else " # " <> c
typeComment' = \case
ATPrim (PT t) -> typeComment_ t
ATOptional inner -> typeComment' inner
ATArray {elemType, nonEmpty}
| nonEmpty -> if T.null c then "non-empty" else c <> ", non-empty"
| otherwise -> c
where
c = typeComment' elemType
ATMap (PT k) v ->
let kc = typeComment_ k
vc = typeComment' v
tc t c = if T.null c then t else c
in if T.null kc && T.null vc then "" else tc (primName k) kc <> " : " <> tc (typeText v) vc
_ -> ""
typeComment_ = \case
TInt -> "int"
TInt64 -> "int64"
TWord32 -> "word32"
TDouble -> "double"
TUTCTime -> "ISO-8601 timestamp"
_ -> ""
-- | Wrap `pySyntaxText` so each parameter access uses `self['<name>']`. The
-- output of `pySyntaxText` references params as bare Python identifiers
-- (e.g. `str(userId)`); we rewrite those identifiers — but only outside
-- string literals — into TypedDict subscript accesses. The
-- @typeNamespace@ is prepended to any `<TypeName>_cmd_string(...)` calls
-- emitted for params whose type has its own syntax (e.g. @"T."@ from
-- @_commands.py@, or @""@ from within @_types.py@).
--
-- Unlike the JS variant, we do NOT collapse adjacent string literals via
-- `T.replace "' + '" ""`: that pattern incorrectly matches `' ' + ','`
-- (the space-then-comma sequence between a literal and `','.join(...)`),
-- producing `' ,'.join(...)` which uses ` ,` as the join separator and
-- swallows the leading space. The `intercalate " + "` output is correct
-- without further string fixups.
pySelfSyntaxText :: String -> TypeAndFields -> Expr -> Text
pySelfSyntaxText typeNamespace r expr =
rewriteParams (paramAccessors r) (pySyntaxText typeNamespace r expr)
-- | Map field name to the Python access expression: `self['<name>']` for
-- required fields, `self.get('<name>')` for optional ones (since
-- TypedDict's `NotRequired` allows the key to be absent and `[...]` would
-- raise `KeyError`). Used by the rewriter so the same name is substituted
-- consistently in Optional `is not None` checks and in the value position.
paramAccessors :: TypeAndFields -> [(String, String)]
paramAccessors (_, fields) = map mk fields
where
mk (APIRecordField n t) = (n, accessor n t)
accessor n = \case
ATOptional _ -> "self.get('" ++ n ++ "')"
_ -> "self['" ++ n ++ "']"
-- | Replace bare identifiers (matching a key in @accessors@) with the
-- corresponding accessor expression, skipping characters inside
-- single-quoted string literals and respecting identifier word boundaries.
rewriteParams :: [(String, String)] -> Text -> Text
rewriteParams accessors = T.pack . go False . T.unpack
where
go _ [] = []
-- Toggle in/out of single-quoted string on every unescaped quote.
go inStr ('\'' : rest) = '\'' : go (not inStr) rest
go True (c : rest) = c : go True rest
go False s@(c : rest)
| isIdentStart c = case takeIdent s of
(ident, after) -> case lookup ident accessors of
Just expr -> expr ++ go False after
Nothing -> ident ++ go False after
| otherwise = c : go False rest
isIdentStart c = isAlphaNum c || c == '_'
takeIdent = span (\c -> isAlphaNum c || c == '_')
bots/src/API/Docs/Responses.hs
+4 -3
View File
@@ -71,6 +71,8 @@ chatResponsesDocsData =
("CRPublicGroupCreated", ""),
("CRPublicGroupCreationFailed", ""),
("CRGroupRelays", ""),
("CRGroupRelaysAdded", ""),
("CRGroupRelaysAddFailed", ""),
("CRGroupMembers", ""),
("CRGroupUpdated", ""),
("CRGroupsList", "Groups"),
@@ -95,9 +97,9 @@ chatResponsesDocsData =
("CRUserDeletedMembers", "Members deleted"),
("CRUserProfileUpdated", "User profile updated"),
("CRUserProfileNoChange", "User profile was not changed"),
("CRUsersList", "Users")
("CRUsersList", "Users"),
("CRApiChats", "Chat previews (paginated). Use this instead of CRContactsList / CRGroupsList when scanning at scale.")
-- ("CRApiChat", "Chat and messages"),
-- ("CRApiChats", "Chats with the most recent messages"),
-- ("CRChatCleared", ""),
-- ("CRChatItemInfo", "Message information"),
-- ("CRChatItems", "The most recent messages"),
@@ -120,7 +122,6 @@ undocumentedResponses =
"CRAgentWorkersDetails",
"CRAgentWorkersSummary",
"CRApiChat",
"CRApiChats",
"CRAppSettings",
"CRArchiveExported",
"CRArchiveImported",
bots/src/API/Docs/Syntax.hs
+8 -2
View File
@@ -157,8 +157,8 @@ escapeChar c s
| c `elem` s = concatMap (\c' -> if c' == c then ['\\', c] else [c]) s
| otherwise = s
pySyntaxText :: TypeAndFields -> Expr -> Text
pySyntaxText r = T.pack . go Nothing True
pySyntaxText :: String -> TypeAndFields -> Expr -> Text
pySyntaxText typeNamespace r = T.pack . go Nothing True
where
go param top = \case
Concat exs -> intercalate " + " $ map (go param False) $ L.toList exs
@@ -167,7 +167,13 @@ pySyntaxText r = T.pack . go Nothing True
withParamType r param p $ \case
ATPrim (PT TString) -> paramName param p
ATOptional (ATPrim (PT TString)) -> paramName param p
ATDef td -> toStringSyntax td
ATOptional (ATDef td) -> toStringSyntax td
_ -> "str(" <> paramName param p <> ")"
where
toStringSyntax (APITypeDef typeName _)
| typeHasSyntax typeName = typeNamespace <> typeName <> "_cmd_string(" <> paramName param p <> ")"
| otherwise = "str(" <> paramName param p <> ")"
Optional exN exJ p -> open <> "(" <> go (Just p) False exJ <> ") if " <> n <> " is not None else " <> nothing <> close
where
n = paramName param p
bots/src/API/Docs/Types.hs
+8 -5
View File
@@ -374,11 +374,11 @@ chatTypesDocsData =
(sti @UserPwdHash, STRecord, "", [], "", ""),
(sti @XFTPErrorType, STUnion, "", [], "", ""),
(sti @XFTPRcvFile, STRecord, "", [], "", ""),
(sti @XFTPSndFile, STRecord, "", [], "", "")
(sti @XFTPSndFile, STRecord, "", [], "", ""),
-- (sti @DatabaseError, STUnion, "DB", [], "", ""),
-- (sti @ChatItemInfo, STRecord, "", [], "", ""),
-- (sti @ChatItemVersion, STRecord, "", [], "", ""),
-- (sti @ChatListQuery, STUnion, "CLQ", [], "", ""),
(sti @ChatListQuery, STUnion, "CLQ", [], "", ""),
-- (sti @ChatName, STRecord, "", [], "", ""),
-- (sti @ChatPagination, STRecord, "CP", [], "", ""),
-- (sti @ConnectionStats, STRecord, "", [], "", ""),
@@ -387,7 +387,10 @@ chatTypesDocsData =
-- (sti @MemberReaction, STRecord, "", [], "", ""),
-- (sti @MsgContentTag, (STEnum' $ dropPfxSfx "MC" '_'), "", ["MCUnknown_"], "", ""),
-- (sti @NavigationInfo, STRecord, "", [], "", ""),
-- (sti @PaginationByTime, STRecord, "", [], "", ""),
-- PTAfter / PTBefore are hidden — bots only need "tail last N chats".
-- The wire format is parsed by paginationByTimeP in
-- src/Simplex/Chat/Library/Commands.hs.
(sti @PaginationByTime, STUnion1, "PT", ["PTAfter", "PTBefore"], "count=" <> Param "count", "")
-- (sti @RcvQueueInfo, STRecord, "", [], "", ""),
-- (sti @RcvSwitchStatus, STEnum, "", [], "", ""), -- incorrect
-- (sti @SendRef, STRecord, "", [], "", ""),
@@ -589,7 +592,7 @@ deriving instance Generic XFTPSndFile
-- deriving instance Generic DatabaseError
-- deriving instance Generic ChatItemInfo
-- deriving instance Generic ChatItemVersion
-- deriving instance Generic ChatListQuery
deriving instance Generic ChatListQuery
-- deriving instance Generic ChatName
-- deriving instance Generic ChatPagination
-- deriving instance Generic ConnectionStats
@@ -599,7 +602,7 @@ deriving instance Generic XFTPSndFile
-- deriving instance Generic MemberReaction
-- deriving instance Generic MsgContentTag
-- deriving instance Generic NavigationInfo
-- deriving instance Generic PaginationByTime
deriving instance Generic PaginationByTime
-- deriving instance Generic RcvQueueInfo
-- deriving instance Generic RcvSwitchStatus
-- deriving instance Generic SendRef
docs/DONATIONS.md
+4 -2
View File
@@ -11,6 +11,8 @@ We are prioritizing users' privacy and security - it would be impossible without
Our pledge to our users is that SimpleX protocols are and will remain open, and in public domain, - so anybody can build the future implementations of the clients and the servers. We are building SimpleX platform based on the same principles as email and web, but much more private and secure.
To ensure network independence and neutrality, we are currently finalizing the launch of [SimpleX Network Consortium](https://simplexnetwork.org/) - an agreement between SimpleX Network Foundation that is being formed as 501.c3 non-profit and SimpleX Chat company.
Your donations help us raise more funds - any amount, even the price of the cup of coffee, makes a big difference for us.
Please donate via:
@@ -25,6 +27,6 @@ Thank you,
Evgeny, SimpleX Chat founder
## SimpleX Community Vouchers
## SimpleX Community Credits
Please comment on our plan to make SimpleX network sustainable and get a free access pass (an NFT) for early testing: https://simplex.chat/vouchers
Please comment on our plan to make SimpleX network sustainable: https://simplex.chat/credits
docs/protocol/channels-protocol.md
+16
View File
@@ -9,6 +9,7 @@ For architecture, design rationale, security properties, and threat model, see [
- [Protocol](#protocol)
- [Channel creation](#channel-creation)
- [Relay acceptance](#relay-acceptance)
- [Relay addition](#relay-addition)
- [Subscriber connection](#subscriber-connection)
- [Message signing](#message-signing)
- [Message forwarding](#message-forwarding)
@@ -57,6 +58,20 @@ When a relay receives an invitation to serve a channel, it validates the channel
TODO: Periodic monitoring where the relay retrieves channel link data to verify its relay link is still listed is planned but not yet implemented.
### Relay addition
When the owner adds a relay to an existing channel:
1. **Acceptance.** The new relay accepts the invitation following the [Relay acceptance](#relay-acceptance) flow. The owner promotes the relay to active when the channel link's updated relay list is confirmed.
2. **Announce.** If the channel has at least one subscriber, the owner sends `x.grp.relay.new` (carrying the new relay's short link) to every other currently-connected relay of the channel.
3. **Forward.** Each relay forwards `x.grp.relay.new` to its subscribers. The relay does not create a member record for the announced relay — relays do not connect to other relays of the same channel.
4. **Connect.** On receipt, the subscriber resolves the announced short link and connects to the new relay asynchronously.
The announce is an optimisation. When it does not reach a subscriber — because the channel had no subscribers at announce time, because an older client or relay sits in the path, or because of a transient network failure — the subscriber reaches the same end state on the next channel open via its relay sync against the channel's link data.
### Subscriber connection
A subscriber joins a channel through the following flow:
@@ -89,6 +104,7 @@ Messages that alter the channel's roster, profile, or administrative state are c
| `x.grp.mem.del` | Remove member | Required |
| `x.grp.mem.role` | Change member role | Required |
| `x.grp.mem.restrict` | Restrict member | Required |
| `x.grp.relay.new` | Announce new relay to subscribers | Required |
| `x.grp.leave` | Leave channel | Required (unverified allowed between subscribers) |
| `x.info` | Update member profile | Required (unverified allowed between subscribers) |
| `x.msg.new` | Content message | Not signed |
packages/simplex-chat-client/types/typescript/package.json
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@simplex-chat/types",
"version": "0.5.0",
"version": "0.6.0",
"description": "TypeScript types for SimpleX Chat bot libraries",
"main": "dist/index.js",
"types": "dist/index.d.ts",
packages/simplex-chat-client/types/typescript/src/commands.ts
+32
View File
@@ -372,6 +372,21 @@ export namespace APIGetGroupRelays {
}
}
// Add relays to group.
// Network usage: interactive.
export interface APIAddGroupRelays {
groupId: number // int64
relayIds: number[] // int64, non-empty
}
export namespace APIAddGroupRelays {
export type Response = CR.GroupRelaysAdded | CR.GroupRelaysAddFailed | CR.ChatCmdError
export function cmdString(self: APIAddGroupRelays): string {
return '/_add relays #' + self.groupId + ' ' + self.relayIds.join(',')
}
}
// Update group profile.
// Network usage: background.
export interface APIUpdateGroupProfile {
@@ -575,6 +590,23 @@ export namespace APIListGroups {
}
}
// Get chat previews. Supports time-based pagination — use this instead of APIListContacts / APIListGroups when scanning at scale (those load every record into memory and fail on large databases).
// Network usage: no.
export interface APIGetChats {
userId: number // int64
pendingConnections: boolean
pagination: T.PaginationByTime
query: T.ChatListQuery
}
export namespace APIGetChats {
export type Response = CR.ApiChats | CR.ChatCmdError
export function cmdString(self: APIGetChats): string {
return '/_get chats ' + self.userId + (self.pendingConnections ? ' pcc=on' : '') + ' ' + T.PaginationByTime.cmdString(self.pagination) + ' ' + JSON.stringify(self.query)
}
}
// Delete chat.
// Network usage: background.
export interface APIDeleteChat {
packages/simplex-chat-client/types/typescript/src/responses.ts
+26
View File
@@ -30,6 +30,8 @@ export type ChatResponse =
| CR.PublicGroupCreated
| CR.PublicGroupCreationFailed
| CR.GroupRelays
| CR.GroupRelaysAdded
| CR.GroupRelaysAddFailed
| CR.GroupMembers
| CR.GroupUpdated
| CR.GroupsList
@@ -55,6 +57,7 @@ export type ChatResponse =
| CR.UserProfileUpdated
| CR.UserProfileNoChange
| CR.UsersList
| CR.ApiChats
export namespace CR {
export type Tag =
@@ -84,6 +87,8 @@ export namespace CR {
| "publicGroupCreated"
| "publicGroupCreationFailed"
| "groupRelays"
| "groupRelaysAdded"
| "groupRelaysAddFailed"
| "groupMembers"
| "groupUpdated"
| "groupsList"
@@ -109,6 +114,7 @@ export namespace CR {
| "userProfileUpdated"
| "userProfileNoChange"
| "usersList"
| "apiChats"
interface Interface {
type: Tag
@@ -273,6 +279,20 @@ export namespace CR {
groupRelays: T.GroupRelay[]
}
export interface GroupRelaysAdded extends Interface {
type: "groupRelaysAdded"
user: T.User
groupInfo: T.GroupInfo
groupLink: T.GroupLink
groupRelays: T.GroupRelay[]
}
export interface GroupRelaysAddFailed extends Interface {
type: "groupRelaysAddFailed"
user: T.User
addRelayResults: T.AddRelayResult[]
}
export interface GroupMembers extends Interface {
type: "groupMembers"
user: T.User
@@ -443,4 +463,10 @@ export namespace CR {
type: "usersList"
users: T.UserInfo[]
}
export interface ApiChats extends Interface {
type: "apiChats"
user: T.User
chats: T.AChat[]
}
}
packages/simplex-chat-client/types/typescript/src/types.ts
+41
View File
@@ -527,6 +527,7 @@ export enum CIDeleteMode {
Broadcast = "broadcast",
Internal = "internal",
InternalMark = "internalMark",
History = "history",
}
export type CIDeleted = CIDeleted.Deleted | CIDeleted.Blocked | CIDeleted.BlockedByAdmin | CIDeleted.Moderated
@@ -1577,6 +1578,27 @@ export interface ChatItemDeletion {
toChatItem?: AChatItem
}
export type ChatListQuery = ChatListQuery.Filters | ChatListQuery.Search
export namespace ChatListQuery {
export type Tag = "filters" | "search"
interface Interface {
type: Tag
}
export interface Filters extends Interface {
type: "filters"
favorite: boolean
unread: boolean
}
export interface Search extends Interface {
type: "search"
search: string
}
}
export enum ChatPeerType {
Human = "human",
Bot = "bot",
@@ -3190,6 +3212,25 @@ export namespace OwnerVerification {
}
}
export type PaginationByTime = PaginationByTime.Last
export namespace PaginationByTime {
export type Tag = "last"
interface Interface {
type: Tag
}
export interface Last extends Interface {
type: "last"
count: number // int
}
export function cmdString(self: PaginationByTime): string {
return 'count=' + self.count
}
}
export interface PendingContactConnection {
pccConnId: number // int64
pccAgentConnId: string
packages/simplex-chat-nodejs/README.md
+1 -1
View File
@@ -14,7 +14,7 @@ Please share your use cases and implementations.
## Quick start: a simple bot
```
npm i simplex-chat@6.5.0-beta.10
npm i simplex-chat@6.5.1
```
Simple bot that replies with squares of numbers you send to it:
packages/simplex-chat-nodejs/package.json
+2 -2
View File
@@ -1,6 +1,6 @@
{
"name": "simplex-chat",
"version": "6.5.0",
"version": "6.5.1",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"files": [
@@ -24,7 +24,7 @@
"docs": "typedoc"
},
"dependencies": {
"@simplex-chat/types": "^0.5.0",
"@simplex-chat/types": "^0.6.0",
"extract-zip": "^2.0.1",
"fast-deep-equal": "^3.1.3",
"node-addon-api": "^8.5.0"
packages/simplex-chat-nodejs/src/api.ts
+19
View File
@@ -764,6 +764,25 @@ export class ChatApi {
throw new ChatCommandError("error listing groups", r)
}
/**
* Get chat previews (paginated).
* Network usage: no.
*
* Prefer this over apiListContacts / apiListGroups for any scan: those
* methods load every record into memory in a single response and will fail
* on large databases.
*/
async apiGetChats(
userId: number,
pagination: T.PaginationByTime,
query: T.ChatListQuery = {type: "filters", favorite: false, unread: false},
pendingConnections = false,
): Promise<T.AChat[]> {
const r = await this.sendChatCmd(CC.APIGetChats.cmdString({userId, pendingConnections, pagination, query}))
if (r.type === "apiChats") return r.chats
throw new ChatCommandError("error getting chats", r)
}
/**
* Delete chat.
* Network usage: background.
packages/simplex-chat-nodejs/src/download-libs.js
+1 -1
View File
@@ -4,7 +4,7 @@ const path = require('path');
const extract = require('extract-zip');
const GITHUB_REPO = 'simplex-chat/simplex-chat-libs';
const RELEASE_TAG = 'v6.5.0';
const RELEASE_TAG = 'v6.5.1';
const BACKEND = (process.env.SIMPLEX_BACKEND || process.env.npm_config_simplex_backend || 'sqlite').toLowerCase();
if (BACKEND !== 'sqlite' && BACKEND !== 'postgres') {
packages/simplex-chat-nodejs/src/util.ts
+1 -1
View File
@@ -78,7 +78,7 @@ export interface BotCommand {
export function ciBotCommand(chatItem: T.ChatItem): BotCommand | undefined {
const msg = ciContentText(chatItem)?.trim()
if (msg) {
const r = msg.match(/\/([^\s]+)(.*)/)
const r = msg.match(/^\/([^\s]+)(.*)/)
if (r && r.length >= 3) {
return {keyword: r[1], params: r[2].trim()}
}
packages/simplex-chat-nodejs/tests/util.test.ts
+37
View File
@@ -0,0 +1,37 @@
import {T} from "@simplex-chat/types"
import {ciBotCommand} from "../src/util"
function rcvText(text: string): T.ChatItem {
return {content: {type: "rcvMsgContent", msgContent: {type: "text", text}}} as T.ChatItem
}
describe("ciBotCommand", () => {
it("parses a command at the start of the message", () => {
expect(ciBotCommand(rcvText("/grok hello"))).toEqual({keyword: "grok", params: "hello"})
})
it("returns undefined for a slash in the middle of a word", () => {
expect(ciBotCommand(rcvText("What follow/read blog posts?"))).toBeUndefined()
})
it("returns undefined for a slash after a space", () => {
expect(ciBotCommand(rcvText("see /home for details"))).toBeUndefined()
})
it("strips leading whitespace before matching", () => {
expect(ciBotCommand(rcvText(" /grok ask this"))).toEqual({keyword: "grok", params: "ask this"})
})
it("returns command with empty params when only the keyword is present", () => {
expect(ciBotCommand(rcvText("/team"))).toEqual({keyword: "team", params: ""})
})
it("returns undefined for plain text without slash", () => {
expect(ciBotCommand(rcvText("hello there"))).toBeUndefined()
})
it("returns undefined for non-text chat item content", () => {
const ci = {content: {type: "rcvDeleted"}} as T.ChatItem
expect(ciBotCommand(ci)).toBeUndefined()
})
})
packages/simplex-chat-python/.gitignore
+22
View File
@@ -0,0 +1,22 @@
# Python build / cache artifacts — never commit these
__pycache__/
*.py[cod]
*$py.class
*.egg-info/
build/
dist/
.pytest_cache/
.ruff_cache/
.mypy_cache/
.pyright_cache/
# Virtual environments
.venv/
.venv-*/
venv/
# Lazy-downloaded native libs (handled at runtime by _native._resolve_libs_dir)
libs/
# Local override for SIMPLEX_LIBS_DIR work, etc.
.env
packages/simplex-chat-python/LICENSE
+661
View File
@@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.
packages/simplex-chat-python/README.md
+70
View File
@@ -0,0 +1,70 @@
# SimpleX Chat Python library
Python 3.11+ client for [SimpleX Chat](https://simplex.chat) bots. Equivalent to the [Node.js library](https://www.npmjs.com/package/simplex-chat).
## Install
```bash
pip install simplex-chat
```
The native `libsimplex` is downloaded lazily on first use. To pre-fetch:
```bash
python -m simplex_chat install # sqlite (default)
python -m simplex_chat install --backend postgres # linux-x86_64 only
```
## Quick start
```python
import re
from simplex_chat import Bot, BotProfile, Message, SqliteDb, TextMessage
bot = Bot(
profile=BotProfile(display_name="Squaring bot"),
db=SqliteDb(file_prefix="./squaring_bot"),
welcome="Send me a number, I'll square it.",
)
@bot.on_message(content_type="text", text=re.compile(r"^-?\d+(\.\d+)?$"))
async def square(msg: TextMessage) -> None:
n = float(msg.text or "0")
await msg.reply(f"{n} * {n} = {n * n}")
@bot.on_message(content_type="text")
async def fallback(msg: Message) -> None:
await msg.reply("Send me a number, like 7 or 3.14.")
if __name__ == "__main__":
bot.run()
```
`bot.run()` blocks. The connection address is logged on startup — paste it into a SimpleX client to talk to the bot. `Ctrl+C` to stop.
Three decorators: `@bot.on_message(...)`, `@bot.on_command(name)`, `@bot.on_event(tag)`. Message handlers are first-match-wins in registration order, so register specific filters first and catch-alls last.
See [`examples/squaring_bot.py`](./examples/squaring_bot.py) for the full example.
## Development
```bash
uv venv && source .venv/bin/activate
uv pip install -e '.[dev]'
ruff check && pyright && pytest tests/
```
Wire types under `src/simplex_chat/types/_*.py` are generated. Regenerate with `cabal test simplex-chat-test --test-options='--match Python'`.
## Release
Manual for now. Bump `_version.py:__version__`, build a wheel, upload to PyPI:
```bash
uv build --wheel
uv publish --token "$PYPI_TOKEN"
```
## License
[AGPL-3.0](./LICENSE)
packages/simplex-chat-python/examples/squaring_bot.py
+52
View File
@@ -0,0 +1,52 @@
"""Squaring bot — replies to every number with its square.
Run with the simplex-chat package installed:
python examples/squaring_bot.py
Sends `n * n = ...` for any text message that parses as a number; falls
back to a hint for non-number messages; responds to `/help` with usage.
"""
from __future__ import annotations
import re
from simplex_chat import (
Bot,
BotCommand,
BotProfile,
Message,
ParsedCommand,
SqliteDb,
TextMessage,
)
bot = Bot(
profile=BotProfile(display_name="Squaring bot"),
db=SqliteDb(file_prefix="./squaring_bot"),
welcome="Send me a number, I'll square it.",
commands=[BotCommand(keyword="help", label="Show help")],
)
NUMBER_RE = re.compile(r"^-?\d+(\.\d+)?$")
@bot.on_message(content_type="text", text=NUMBER_RE)
async def square(msg: TextMessage) -> None:
n = float(msg.text or "0")
await msg.reply(f"{n} * {n} = {n * n}")
@bot.on_message(content_type="text")
async def fallback(msg: Message) -> None:
await msg.reply("Send me a number, like 7 or 3.14.")
@bot.on_command("help")
async def help_cmd(msg: Message, _cmd: ParsedCommand) -> None:
await msg.reply("Send a number, I'll square it.")
if __name__ == "__main__":
bot.run()
packages/simplex-chat-python/pyproject.toml
+58
View File
@@ -0,0 +1,58 @@
[build-system]
requires = ["hatchling>=1.24"]
build-backend = "hatchling.build"
[project]
name = "simplex-chat"
description = "SimpleX Chat Python library for chat bots"
readme = "README.md"
license = "AGPL-3.0-only"
authors = [{name = "SimpleX Chat"}]
requires-python = ">=3.11"
keywords = ["simplex", "messenger", "chat", "privacy", "security", "bots"]
classifiers = [
"Development Status :: 4 - Beta",
"License :: OSI Approved :: GNU Affero General Public License v3",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Topic :: Communications :: Chat",
]
dynamic = ["version"]
[project.urls]
Homepage = "https://github.com/simplex-chat/simplex-chat/tree/stable/packages/simplex-chat-python"
Issues = "https://github.com/simplex-chat/simplex-chat/issues"
[project.optional-dependencies]
test = ["pytest>=8", "pytest-asyncio>=0.23"]
dev = ["pytest>=8", "pytest-asyncio>=0.23", "pyright>=1.1.380", "ruff>=0.6"]
[tool.hatch.version]
path = "src/simplex_chat/_version.py"
[tool.hatch.build.targets.wheel]
packages = ["src/simplex_chat"]
[tool.pytest.ini_options]
asyncio_mode = "auto"
[tool.ruff]
line-length = 100
target-version = "py311"
[tool.ruff.format]
# `src/simplex_chat/types/*.py` are generated by the Haskell codegen
# (bots/src/API/Docs/Generate/Python.hs). Re-formatting them locally
# would diverge from the generator's output and break `cabal test
# simplex-chat-test --match Python`. Lint still applies — only format
# is suppressed.
exclude = ["src/simplex_chat/types/_*.py"]
[tool.pyright]
# Same rationale: the generated cmd_string helpers use `self.get('x')`
# call pairs that pyright cannot narrow across (`is not None` followed
# by re-access). Hand-written code is still strictly checked.
include = ["src/simplex_chat"]
exclude = ["src/simplex_chat/types/_*.py", "**/__pycache__", "**/.venv*"]
packages/simplex-chat-python/src/simplex_chat/__init__.py
+59
View File
@@ -0,0 +1,59 @@
"""SimpleX Chat — Python client library for chat bots."""
from ._version import __version__
from .api import ChatApi, ChatCommandError, ConnReqType, Db, PostgresDb, SqliteDb
from .bot import (
Bot,
BotCommand,
BotProfile,
ChatMessage,
CommandHandler,
EventHandler,
FileMessage,
ImageMessage,
LinkMessage,
Message,
MessageHandler,
Middleware,
ParsedCommand,
ReportMessage,
TextMessage,
UnknownMessage,
VideoMessage,
VoiceMessage,
)
from .core import ChatAPIError, ChatInitError, CryptoArgs, MigrationConfirmation
from . import util as util # re-export the util namespace
__all__ = [
"__version__",
"Bot",
"BotCommand",
"BotProfile",
"ChatAPIError",
"ChatApi",
"ChatCommandError",
"ChatInitError",
"ChatMessage",
"CommandHandler",
"ConnReqType",
"CryptoArgs",
"Db",
"EventHandler",
"FileMessage",
"ImageMessage",
"LinkMessage",
"Message",
"MessageHandler",
"Middleware",
"MigrationConfirmation",
"ParsedCommand",
"PostgresDb",
"ReportMessage",
"SqliteDb",
"TextMessage",
"UnknownMessage",
"VideoMessage",
"VoiceMessage",
"util",
]
packages/simplex-chat-python/src/simplex_chat/__main__.py
+35
View File
@@ -0,0 +1,35 @@
"""CLI: ``python -m simplex_chat install [--backend=sqlite|postgres]``."""
from __future__ import annotations
import argparse
import sys
from . import _native
def main(argv: list[str] | None = None) -> int:
p = argparse.ArgumentParser(prog="simplex_chat")
sub = p.add_subparsers(dest="command", required=True)
install = sub.add_parser("install", help="Pre-fetch libsimplex into the user cache")
install.add_argument(
"--backend",
choices=["sqlite", "postgres"],
default="sqlite",
help="which libsimplex variant to download (default: sqlite)",
)
args = p.parse_args(argv)
# `args.command` is always set: `add_subparsers(required=True)` makes
# argparse exit before reaching this point if no subcommand is given.
assert args.command == "install"
try:
path = _native._resolve_libs_dir(args.backend)
print(f"libsimplex installed at: {path}")
return 0
except Exception as e:
print(f"install failed: {e}", file=sys.stderr)
return 1
if __name__ == "__main__":
sys.exit(main())
packages/simplex-chat-python/src/simplex_chat/_native.py
+257
View File
@@ -0,0 +1,257 @@
"""Native libsimplex loader: platform detection, lazy download, ctypes setup.
Internal — users interact with `Bot` / `ChatApi`, never with this module.
"""
from __future__ import annotations
import ctypes
import errno
import os
import platform
import sys
import tempfile
import threading
import urllib.request
import zipfile
from ctypes import POINTER, c_char_p, c_int, c_uint8, c_void_p
from pathlib import Path
from typing import Literal
from ._version import LIBS_VERSION
Backend = Literal["sqlite", "postgres"]
_GITHUB_REPO = "simplex-chat/simplex-chat-libs"
_PLATFORM_MAP = {
"linux": ("linux", {"x86_64": "x86_64", "aarch64": "aarch64"}),
"darwin": ("macos", {"x86_64": "x86_64", "arm64": "aarch64"}),
"win32": ("windows", {"AMD64": "x86_64", "x86_64": "x86_64"}),
}
_LIBNAME = {"linux": "libsimplex.so", "darwin": "libsimplex.dylib", "win32": "libsimplex.dll"}
SUPPORTED = (
"linux-x86_64",
"linux-aarch64",
"macos-x86_64",
"macos-aarch64",
"windows-x86_64",
)
def _platform_tag() -> str:
info = _PLATFORM_MAP.get(sys.platform)
if not info:
raise RuntimeError(f"Unsupported platform: {sys.platform}")
sysname, archs = info
arch = archs.get(platform.machine())
if not arch:
raise RuntimeError(f"Unsupported architecture: {sys.platform}/{platform.machine()}")
tag = f"{sysname}-{arch}"
if tag not in SUPPORTED:
raise RuntimeError(f"Unsupported combination: {tag}; supported: {SUPPORTED}")
return tag
def _libname() -> str:
return _LIBNAME[sys.platform]
def _libs_url(backend: Backend) -> str:
suffix = "-postgres" if backend == "postgres" else ""
return (
f"https://github.com/{_GITHUB_REPO}/releases/download/"
f"v{LIBS_VERSION}/simplex-chat-libs-{_platform_tag()}{suffix}.zip"
)
def _cache_root() -> Path:
if sys.platform == "darwin":
return Path.home() / "Library" / "Caches" / "simplex-chat"
if sys.platform == "win32":
return Path(os.environ["LOCALAPPDATA"]) / "simplex-chat"
base = os.environ.get("XDG_CACHE_HOME") or str(Path.home() / ".cache")
return Path(base) / "simplex-chat"
def _resolve_libs_dir(backend: Backend) -> Path:
if override := os.environ.get("SIMPLEX_LIBS_DIR"):
return Path(override)
if backend == "postgres" and _platform_tag() != "linux-x86_64":
raise RuntimeError(
"postgres backend is only supported on linux-x86_64; "
f"current platform is {_platform_tag()}"
)
target = _cache_root() / f"v{LIBS_VERSION}" / backend
if not (target / _libname()).exists():
_download(target, backend)
return target
_DOWNLOAD_CHUNK = 1 << 16 # 64 KiB
def _stream_to_file(url: str, dest: Path, *, timeout: float = 60.0) -> None:
"""Stream `url` → `dest`, printing a carriage-return progress bar.
`timeout` is per-request; we don't touch `socket.setdefaulttimeout`
so other socket users in the same process aren't affected.
"""
with urllib.request.urlopen(url, timeout=timeout) as resp: # noqa: S310 - https://github.com/...
total = int(resp.headers.get("Content-Length") or 0)
received = 0
with dest.open("wb") as out:
while chunk := resp.read(_DOWNLOAD_CHUNK):
out.write(chunk)
received += len(chunk)
if total > 0:
pct = min(100, received * 100 // total)
msg = f"\r download: {received >> 20} / {total >> 20} MiB ({pct}%)"
else:
msg = f"\r download: {received >> 20} MiB"
print(msg, end="", file=sys.stderr, flush=True)
print("", file=sys.stderr, flush=True) # newline after final progress line
def _download(target: Path, backend: Backend) -> None:
"""Download libs zip → atomic rename into `target`. Concurrent processes safe.
Atomicity strategy: each process extracts to its own sibling tempdir on the same
filesystem, then `os.rename` the `libs/` subdir to `target`. POSIX `os.rename`
onto a NON-EXISTENT path is atomic; if the target exists (another process won
the race), `os.rename` fails on most platforms — we then verify the winner has
what we need and proceed. NEVER rmtree the target: that creates a TOCTOU
window where another process is reading/loading the file we're deleting.
"""
target.parent.mkdir(parents=True, exist_ok=True)
url = _libs_url(backend)
print(
f"Downloading libsimplex ({_platform_tag()}, {backend}) v{LIBS_VERSION} from {url} ...",
file=sys.stderr,
flush=True,
)
with tempfile.TemporaryDirectory(dir=target.parent) as tmp:
zip_path = Path(tmp) / "libs.zip"
_stream_to_file(url, zip_path, timeout=60.0)
with zipfile.ZipFile(zip_path) as zf:
zf.extractall(tmp)
# zip layout: <tmp>/libs/libsimplex.* + libHS*.*
extracted_libs = Path(tmp) / "libs"
if not extracted_libs.is_dir():
raise RuntimeError(f"libs/ missing from {_libs_url(backend)}")
try:
os.rename(extracted_libs, target)
except OSError as e:
# EEXIST / ENOTEMPTY mean another process won the race — fall through
# and check that the winner left a usable libsimplex behind. Anything
# else (ENOSPC, EACCES, EROFS, Windows codes mapped to None) is a real
# failure and must propagate. Same VERSION cached → same content →
# safe to proceed once we've confirmed the file is there.
if e.errno not in (errno.EEXIST, errno.ENOTEMPTY):
raise
if not (target / _libname()).exists():
raise RuntimeError(
f"another process partially populated {target} but libsimplex "
f"is missing; remove the directory manually and retry"
) from e
_lock = threading.Lock()
_lib: ctypes.CDLL | None = None
_libc: ctypes.CDLL | None = None
_backend: Backend | None = None
def _load_libc() -> ctypes.CDLL:
if sys.platform == "win32":
return ctypes.CDLL("msvcrt")
return ctypes.CDLL(None) # libc on POSIX is the process's own symbol table
def _setup_signatures(lib: ctypes.CDLL) -> None:
"""Declare argtypes/restype for the 8 chat_* functions exported by libsimplex.
All result strings come back as raw c_void_p so the caller can free them
after copying — matches HandleCResult in cpp/simplex.cc:157-165.
"""
lib.chat_migrate_init.argtypes = [c_char_p, c_char_p, c_char_p, POINTER(c_void_p)]
lib.chat_migrate_init.restype = c_void_p
lib.chat_close_store.argtypes = [c_void_p]
lib.chat_close_store.restype = c_void_p
lib.chat_send_cmd.argtypes = [c_void_p, c_char_p]
lib.chat_send_cmd.restype = c_void_p
lib.chat_recv_msg_wait.argtypes = [c_void_p, c_int]
lib.chat_recv_msg_wait.restype = c_void_p
# chat_write_file's payload is treated read-only by libsimplex; passing
# `bytes` via c_char_p avoids the from_buffer_copy doubling. ctypes pins
# the bytes buffer for the duration of the call.
lib.chat_write_file.argtypes = [c_void_p, c_char_p, c_char_p, c_int]
lib.chat_write_file.restype = c_void_p
lib.chat_read_file.argtypes = [c_char_p, c_char_p, c_char_p]
lib.chat_read_file.restype = POINTER(c_uint8)
lib.chat_encrypt_file.argtypes = [c_void_p, c_char_p, c_char_p]
lib.chat_encrypt_file.restype = c_void_p
lib.chat_decrypt_file.argtypes = [c_char_p, c_char_p, c_char_p, c_char_p]
lib.chat_decrypt_file.restype = c_void_p
def _hs_init(lib: ctypes.CDLL) -> None:
"""Initialize the Haskell runtime exactly once. Mirrors cpp/simplex.cc:13-32."""
if sys.platform == "win32":
argv_strs = [b"simplex", b"+RTS", b"-A64m", b"-H64m", b"--install-signal-handlers=no"]
else:
argv_strs = [
b"simplex",
b"+RTS",
b"-A64m",
b"-H64m",
b"-xn",
b"--install-signal-handlers=no",
]
argc = c_int(len(argv_strs))
arr = (c_char_p * (len(argv_strs) + 1))(*argv_strs, None)
arr_ptr = ctypes.byref(ctypes.cast(arr, POINTER(c_char_p)))
lib.hs_init_with_rtsopts.argtypes = [POINTER(c_int), POINTER(POINTER(c_char_p))]
lib.hs_init_with_rtsopts.restype = None
lib.hs_init_with_rtsopts(ctypes.byref(argc), arr_ptr)
def lib_for(backend: Backend) -> ctypes.CDLL:
"""Resolve, load, and initialize libsimplex for the given backend.
Idempotent for the same backend; raises if called with a different backend.
Concurrent calls serialize on the module-level lock.
"""
global _lib, _libc, _backend
with _lock:
if _lib is not None:
if _backend != backend:
raise RuntimeError(
f"libsimplex already loaded with backend={_backend!r}; "
f"cannot switch to {backend!r} in the same process"
)
return _lib
libs_dir = _resolve_libs_dir(backend)
lib = ctypes.CDLL(str(libs_dir / _libname()))
_setup_signatures(lib)
_hs_init(lib)
_libc = _load_libc()
_lib = lib
_backend = backend
return lib
def libc() -> ctypes.CDLL:
"""libc — needed by `core` to free Haskell-allocated result strings."""
if _libc is None:
raise RuntimeError("lib_for() must be called before libc()")
return _libc
def lib() -> ctypes.CDLL:
"""Loaded libsimplex handle. Raises if `lib_for()` has not been called."""
if _lib is None:
raise RuntimeError("lib_for() must be called before lib()")
return _lib
packages/simplex-chat-python/src/simplex_chat/_version.py
+9
View File
@@ -0,0 +1,9 @@
"""Single source of truth for both the Python package version and the
simplex-chat-libs release tag we depend on.
Bump both together for normal releases. For wrapper-only fixes use a PEP 440
post-release: __version__ = "6.5.1.post1", LIBS_VERSION unchanged.
"""
__version__ = "6.5.1" # PEP 440 — read by hatchling for wheel metadata
LIBS_VERSION = "6.5.1" # simplex-chat-libs release tag (no 'v' prefix)
packages/simplex-chat-python/src/simplex_chat/api.py
+704
View File
@@ -0,0 +1,704 @@
"""Low-level escape-hatch API. Most users go through `Bot` instead."""
from __future__ import annotations
import json
from dataclasses import dataclass
from typing import Any, Literal
from . import _native, core, util
from .core import MigrationConfirmation
from .types import CC, CEvt, CR, T
# Mirrors Node `ConnReqType` enum (api.ts:15-18) — the two possible outcomes
# of `api_connect` / `api_connect_active_user` depending on the link kind.
ConnReqType = Literal["invitation", "contact"]
@dataclass(slots=True)
class SqliteDb:
file_prefix: str
encryption_key: str | None = None
@dataclass(slots=True)
class PostgresDb:
connection_string: str
schema_prefix: str | None = None
Db = SqliteDb | PostgresDb
def _db_to_migrate_args(db: Db) -> tuple[str, str, _native.Backend]:
"""Returns (path-or-prefix, key-or-conn, backend)."""
if isinstance(db, SqliteDb):
return (db.file_prefix, db.encryption_key or "", "sqlite")
if isinstance(db, PostgresDb):
return (db.schema_prefix or "", db.connection_string, "postgres")
raise TypeError(f"Unknown db: {db!r}")
class ChatCommandError(Exception):
def __init__(self, message: str, response: CR.ChatResponse):
super().__init__(message)
self.response = response
class ChatApi:
def __init__(self, ctrl: int):
self._ctrl: int | None = ctrl
self._started = False
@classmethod
async def init(
cls,
db: Db,
confirm: MigrationConfirmation = MigrationConfirmation.YES_UP,
) -> "ChatApi":
path_or_prefix, key_or_conn, backend = _db_to_migrate_args(db)
# Trigger lazy lib load with the right backend BEFORE chat_migrate_init.
_native.lib_for(backend)
ctrl = await core.chat_migrate_init(path_or_prefix, key_or_conn, confirm)
return cls(ctrl)
@property
def ctrl(self) -> int:
"""Opaque controller pointer. Raises if `close()` has been called."""
if self._ctrl is None:
raise RuntimeError("ChatApi controller not initialized (close() called?)")
return self._ctrl
@property
def initialized(self) -> bool:
"""True until `close()` is called. Mirrors Node `ChatApi.initialized`."""
return self._ctrl is not None
@property
def started(self) -> bool:
"""True between `start_chat()` and the next `stop_chat()` / `close()`."""
return self._started
async def start_chat(self) -> None:
r = await self.send_chat_cmd(
CC.StartChat_cmd_string({"mainApp": True, "enableSndFiles": True})
)
if r.get("type") not in ("chatStarted", "chatRunning"):
raise ChatCommandError("error starting chat", r)
self._started = True
async def stop_chat(self) -> None:
r = await self.send_chat_cmd("/_stop")
if r.get("type") != "chatStopped":
raise ChatCommandError("error stopping chat", r)
self._started = False
async def close(self) -> None:
await core.chat_close_store(self.ctrl)
self._ctrl = None
self._started = False
async def send_chat_cmd(self, cmd: str) -> CR.ChatResponse:
return await core.chat_send_cmd(self.ctrl, cmd)
async def recv_chat_event(self, wait_us: int = 500_000) -> CEvt.ChatEvent | None:
return await core.chat_recv_msg_wait(self.ctrl, wait_us)
# ------------------------------------------------------------------ #
# Address commands
# ------------------------------------------------------------------ #
async def api_create_user_address(self, user_id: int) -> T.CreatedConnLink:
r = await self.send_chat_cmd(CC.APICreateMyAddress_cmd_string({"userId": user_id}))
if r["type"] == "userContactLinkCreated":
return r["connLinkContact"]
raise ChatCommandError("error creating user address", r)
async def api_delete_user_address(self, user_id: int) -> None:
r = await self.send_chat_cmd(CC.APIDeleteMyAddress_cmd_string({"userId": user_id}))
if r["type"] != "userContactLinkDeleted":
raise ChatCommandError("error deleting user address", r)
async def api_get_user_address(self, user_id: int) -> T.UserContactLink | None:
try:
r = await self.send_chat_cmd(CC.APIShowMyAddress_cmd_string({"userId": user_id}))
if r["type"] == "userContactLink":
return r["contactLink"]
raise ChatCommandError("error loading user address", r)
except core.ChatAPIError as e:
ce = e.chat_error
if (
ce is not None
and ce.get("type") == "errorStore"
and ce.get("storeError", {}).get("type") == "userContactLinkNotFound"
):
return None
raise
async def api_set_profile_address(
self, user_id: int, enable: bool
) -> T.UserProfileUpdateSummary:
r = await self.send_chat_cmd(
CC.APISetProfileAddress_cmd_string({"userId": user_id, "enable": enable})
)
if r["type"] == "userProfileUpdated":
return r["updateSummary"]
raise ChatCommandError("error setting profile address", r)
async def api_set_address_settings(self, user_id: int, settings: T.AddressSettings) -> None:
r = await self.send_chat_cmd(
CC.APISetAddressSettings_cmd_string({"userId": user_id, "settings": settings})
)
if r["type"] != "userContactLinkUpdated":
raise ChatCommandError("error changing user contact address settings", r)
# ------------------------------------------------------------------ #
# Message commands
# ------------------------------------------------------------------ #
async def api_send_messages(
self,
chat: list | T.ChatRef | T.ChatInfo,
messages: list[T.ComposedMessage],
live_message: bool = False,
) -> list[T.AChatItem]:
if isinstance(chat, list):
send_ref: T.ChatRef = {"chatType": chat[0], "chatId": chat[1]}
elif "chatType" in chat and "chatId" in chat:
send_ref = chat
else:
ref = util.chat_info_ref(chat)
if ref is None:
raise ValueError("api_send_messages: can't send messages to this chat")
send_ref = ref
r = await self.send_chat_cmd(
CC.APISendMessages_cmd_string(
{
"sendRef": send_ref,
"composedMessages": messages,
"liveMessage": live_message,
}
)
)
if r["type"] == "newChatItems":
return r["chatItems"]
raise ChatCommandError("unexpected response", r)
async def api_send_text_message(
self,
chat: list | T.ChatRef | T.ChatInfo,
text: str,
in_reply_to: int | None = None,
) -> list[T.AChatItem]:
msg: T.ComposedMessage = {"msgContent": {"type": "text", "text": text}, "mentions": {}}
if in_reply_to is not None:
msg["quotedItemId"] = in_reply_to
return await self.api_send_messages(chat, [msg])
async def api_send_text_reply(self, chat_item: T.AChatItem, text: str) -> list[T.AChatItem]:
return await self.api_send_text_message(
chat_item["chatInfo"], text, chat_item["chatItem"]["meta"]["itemId"]
)
async def api_update_chat_item(
self,
chat_type: T.ChatType,
chat_id: int,
chat_item_id: int,
msg_content: T.MsgContent,
live_message: bool = False,
) -> T.ChatItem:
r = await self.send_chat_cmd(
CC.APIUpdateChatItem_cmd_string(
{
"chatRef": {"chatType": chat_type, "chatId": chat_id},
"chatItemId": chat_item_id,
"liveMessage": live_message,
"updatedMessage": {"msgContent": msg_content, "mentions": {}},
}
)
)
if r["type"] == "chatItemUpdated":
return r["chatItem"]["chatItem"]
raise ChatCommandError("error updating chat item", r)
async def api_delete_chat_items(
self,
chat_type: T.ChatType,
chat_id: int,
chat_item_ids: list[int],
delete_mode: T.CIDeleteMode,
) -> list[T.ChatItemDeletion]:
r = await self.send_chat_cmd(
CC.APIDeleteChatItem_cmd_string(
{
"chatRef": {"chatType": chat_type, "chatId": chat_id},
"chatItemIds": chat_item_ids,
"deleteMode": delete_mode,
}
)
)
if r["type"] == "chatItemsDeleted":
return r["chatItemDeletions"]
raise ChatCommandError("error deleting chat item", r)
async def api_delete_member_chat_item(
self, group_id: int, chat_item_ids: list[int]
) -> list[T.ChatItemDeletion]:
r = await self.send_chat_cmd(
CC.APIDeleteMemberChatItem_cmd_string(
{"groupId": group_id, "chatItemIds": chat_item_ids}
)
)
if r["type"] == "chatItemsDeleted":
return r["chatItemDeletions"]
raise ChatCommandError("error deleting member chat item", r)
async def api_chat_item_reaction(
self,
chat_type: T.ChatType,
chat_id: int,
chat_item_id: int,
add: bool,
reaction: T.MsgReaction,
) -> T.ACIReaction:
r = await self.send_chat_cmd(
CC.APIChatItemReaction_cmd_string(
{
"chatRef": {"chatType": chat_type, "chatId": chat_id},
"chatItemId": chat_item_id,
"add": add,
"reaction": reaction,
}
)
)
if r["type"] == "chatItemReaction":
return r["reaction"]
raise ChatCommandError("error setting item reaction", r)
# ------------------------------------------------------------------ #
# File commands
# ------------------------------------------------------------------ #
async def api_receive_file(self, file_id: int) -> T.AChatItem:
r = await self.send_chat_cmd(
CC.ReceiveFile_cmd_string({"fileId": file_id, "userApprovedRelays": True})
)
if r["type"] == "rcvFileAccepted":
return r["chatItem"]
raise ChatCommandError("error receiving file", r)
async def api_cancel_file(self, file_id: int) -> None:
r = await self.send_chat_cmd(CC.CancelFile_cmd_string({"fileId": file_id}))
if r["type"] not in ("sndFileCancelled", "rcvFileCancelled"):
raise ChatCommandError("error canceling file", r)
# ------------------------------------------------------------------ #
# Group commands
# ------------------------------------------------------------------ #
async def api_add_member(
self, group_id: int, contact_id: int, member_role: T.GroupMemberRole
) -> T.GroupMember:
r = await self.send_chat_cmd(
CC.APIAddMember_cmd_string(
{"groupId": group_id, "contactId": contact_id, "memberRole": member_role}
)
)
if r["type"] == "sentGroupInvitation":
return r["member"]
raise ChatCommandError("error adding member", r)
async def api_join_group(self, group_id: int) -> T.GroupInfo:
r = await self.send_chat_cmd(CC.APIJoinGroup_cmd_string({"groupId": group_id}))
if r["type"] == "userAcceptedGroupSent":
return r["groupInfo"]
raise ChatCommandError("error joining group", r)
async def api_accept_member(
self, group_id: int, group_member_id: int, member_role: T.GroupMemberRole
) -> T.GroupMember:
r = await self.send_chat_cmd(
CC.APIAcceptMember_cmd_string(
{"groupId": group_id, "groupMemberId": group_member_id, "memberRole": member_role}
)
)
if r["type"] == "memberAccepted":
return r["member"]
raise ChatCommandError("error accepting member", r)
async def api_set_members_role(
self, group_id: int, group_member_ids: list[int], member_role: T.GroupMemberRole
) -> None:
r = await self.send_chat_cmd(
CC.APIMembersRole_cmd_string(
{"groupId": group_id, "groupMemberIds": group_member_ids, "memberRole": member_role}
)
)
if r["type"] != "membersRoleUser":
raise ChatCommandError("error setting members role", r)
async def api_block_members_for_all(
self, group_id: int, group_member_ids: list[int], blocked: bool
) -> None:
r = await self.send_chat_cmd(
CC.APIBlockMembersForAll_cmd_string(
{"groupId": group_id, "groupMemberIds": group_member_ids, "blocked": blocked}
)
)
if r["type"] != "membersBlockedForAllUser":
raise ChatCommandError("error blocking members", r)
async def api_remove_members(
self, group_id: int, member_ids: list[int], with_messages: bool = False
) -> list[T.GroupMember]:
r = await self.send_chat_cmd(
CC.APIRemoveMembers_cmd_string(
{"groupId": group_id, "groupMemberIds": member_ids, "withMessages": with_messages}
)
)
if r["type"] == "userDeletedMembers":
return r["members"]
raise ChatCommandError("error removing member", r)
async def api_leave_group(self, group_id: int) -> T.GroupInfo:
r = await self.send_chat_cmd(CC.APILeaveGroup_cmd_string({"groupId": group_id}))
if r["type"] == "leftMemberUser":
return r["groupInfo"]
raise ChatCommandError("error leaving group", r)
async def api_list_members(self, group_id: int) -> list[T.GroupMember]:
r = await self.send_chat_cmd(CC.APIListMembers_cmd_string({"groupId": group_id}))
if r["type"] == "groupMembers":
return r["group"]["members"]
raise ChatCommandError("error getting group members", r)
async def api_new_group(self, user_id: int, group_profile: T.GroupProfile) -> T.GroupInfo:
r = await self.send_chat_cmd(
CC.APINewGroup_cmd_string(
{"userId": user_id, "groupProfile": group_profile, "incognito": False}
)
)
if r["type"] == "groupCreated":
return r["groupInfo"]
raise ChatCommandError("error creating group", r)
async def api_update_group_profile(
self, group_id: int, group_profile: T.GroupProfile
) -> T.GroupInfo:
r = await self.send_chat_cmd(
CC.APIUpdateGroupProfile_cmd_string(
{"groupId": group_id, "groupProfile": group_profile}
)
)
if r["type"] == "groupUpdated":
return r["toGroup"]
raise ChatCommandError("error updating group", r)
# ------------------------------------------------------------------ #
# Group link commands
# ------------------------------------------------------------------ #
async def api_create_group_link(self, group_id: int, member_role: T.GroupMemberRole) -> str:
r = await self.send_chat_cmd(
CC.APICreateGroupLink_cmd_string({"groupId": group_id, "memberRole": member_role})
)
if r["type"] == "groupLinkCreated":
link = r["groupLink"]["connLinkContact"]
return link.get("connShortLink") or link["connFullLink"]
raise ChatCommandError("error creating group link", r)
async def api_set_group_link_member_role(
self, group_id: int, member_role: T.GroupMemberRole
) -> None:
r = await self.send_chat_cmd(
CC.APIGroupLinkMemberRole_cmd_string({"groupId": group_id, "memberRole": member_role})
)
if r["type"] != "groupLink":
raise ChatCommandError("error setting group link member role", r)
async def api_delete_group_link(self, group_id: int) -> None:
r = await self.send_chat_cmd(CC.APIDeleteGroupLink_cmd_string({"groupId": group_id}))
if r["type"] != "groupLinkDeleted":
raise ChatCommandError("error deleting group link", r)
async def api_get_group_link(self, group_id: int) -> T.GroupLink:
r = await self.send_chat_cmd(CC.APIGetGroupLink_cmd_string({"groupId": group_id}))
if r["type"] == "groupLink":
return r["groupLink"]
raise ChatCommandError("error getting group link", r)
async def api_get_group_link_str(self, group_id: int) -> str:
link = (await self.api_get_group_link(group_id))["connLinkContact"]
return link.get("connShortLink") or link["connFullLink"]
# ------------------------------------------------------------------ #
# Connection commands
# ------------------------------------------------------------------ #
async def api_create_link(self, user_id: int) -> str:
r = await self.send_chat_cmd(
CC.APIAddContact_cmd_string({"userId": user_id, "incognito": False})
)
if r["type"] == "invitation":
link = r["connLinkInvitation"]
return link.get("connShortLink") or link["connFullLink"]
raise ChatCommandError("error creating link", r)
async def api_connect_plan(
self, user_id: int, connection_link: str
) -> tuple[T.ConnectionPlan, T.CreatedConnLink]:
r = await self.send_chat_cmd(
CC.APIConnectPlan_cmd_string(
{"userId": user_id, "connectionLink": connection_link, "resolveKnown": False}
)
)
if r["type"] == "connectionPlan":
return (r["connectionPlan"], r["connLink"])
raise ChatCommandError("error getting connect plan", r)
async def api_connect(
self,
user_id: int,
incognito: bool,
prepared_link: T.CreatedConnLink | None = None,
) -> ConnReqType:
args: CC.APIConnect = {"userId": user_id, "incognito": incognito}
if prepared_link is not None:
args["preparedLink_"] = prepared_link
r = await self.send_chat_cmd(CC.APIConnect_cmd_string(args))
return self._handle_connect_result(r)
async def api_connect_active_user(self, conn_link: str) -> ConnReqType:
r = await self.send_chat_cmd(
CC.Connect_cmd_string({"incognito": False, "connLink_": conn_link})
)
return self._handle_connect_result(r)
def _handle_connect_result(self, r: CR.ChatResponse) -> ConnReqType:
if r["type"] == "sentConfirmation":
return "invitation"
if r["type"] == "sentInvitation":
return "contact"
if r["type"] == "contactAlreadyExists":
raise ChatCommandError("contact already exists", r)
raise ChatCommandError("connection error", r)
async def api_accept_contact_request(self, contact_req_id: int) -> T.Contact:
r = await self.send_chat_cmd(
CC.APIAcceptContact_cmd_string({"contactReqId": contact_req_id})
)
if r["type"] == "acceptingContactRequest":
return r["contact"]
raise ChatCommandError("error accepting contact request", r)
async def api_reject_contact_request(self, contact_req_id: int) -> None:
r = await self.send_chat_cmd(
CC.APIRejectContact_cmd_string({"contactReqId": contact_req_id})
)
if r["type"] != "contactRequestRejected":
raise ChatCommandError("error rejecting contact request", r)
# ------------------------------------------------------------------ #
# Chat commands
# ------------------------------------------------------------------ #
async def api_list_contacts(self, user_id: int) -> list[T.Contact]:
r = await self.send_chat_cmd(CC.APIListContacts_cmd_string({"userId": user_id}))
if r["type"] == "contactsList":
return r["contacts"]
raise ChatCommandError("error listing contacts", r)
async def api_list_groups(
self,
user_id: int,
contact_id: int | None = None,
search: str | None = None,
) -> list[T.GroupInfo]:
args: CC.APIListGroups = {"userId": user_id}
if contact_id is not None:
args["contactId_"] = contact_id
if search is not None:
args["search"] = search
r = await self.send_chat_cmd(CC.APIListGroups_cmd_string(args))
if r["type"] == "groupsList":
return r["groups"]
raise ChatCommandError("error listing groups", r)
async def api_get_chats(
self,
user_id: int,
pagination: T.PaginationByTime,
query: T.ChatListQuery | None = None,
pending_connections: bool = False,
) -> list[T.AChat]:
if query is None:
query = {"type": "filters", "favorite": False, "unread": False}
r = await self.send_chat_cmd(
CC.APIGetChats_cmd_string(
{
"userId": user_id,
"pendingConnections": pending_connections,
"pagination": pagination,
"query": query,
}
)
)
if r["type"] == "apiChats":
return r["chats"]
raise ChatCommandError("error getting chats", r)
async def api_delete_chat(
self,
chat_type: T.ChatType,
chat_id: int,
delete_mode: T.ChatDeleteMode | None = None,
) -> None:
if delete_mode is None:
delete_mode = {"type": "full", "notify": True}
r = await self.send_chat_cmd(
CC.APIDeleteChat_cmd_string(
{
"chatRef": {"chatType": chat_type, "chatId": chat_id},
"chatDeleteMode": delete_mode,
}
)
)
if chat_type == "direct" and r["type"] == "contactDeleted":
return
if chat_type == "group" and r["type"] == "groupDeletedUser":
return
raise ChatCommandError("error deleting chat", r)
async def api_set_group_custom_data(
self, group_id: int, custom_data: dict[str, object] | None = None
) -> None:
args: CC.APISetGroupCustomData = {"groupId": group_id}
if custom_data is not None:
args["customData"] = custom_data
r = await self.send_chat_cmd(CC.APISetGroupCustomData_cmd_string(args))
if r["type"] != "cmdOk":
raise ChatCommandError("error setting group custom data", r)
async def api_set_contact_custom_data(
self, contact_id: int, custom_data: dict[str, object] | None = None
) -> None:
args: CC.APISetContactCustomData = {"contactId": contact_id}
if custom_data is not None:
args["customData"] = custom_data
r = await self.send_chat_cmd(CC.APISetContactCustomData_cmd_string(args))
if r["type"] != "cmdOk":
raise ChatCommandError("error setting contact custom data", r)
async def api_set_auto_accept_member_contacts(self, user_id: int, on_off: bool) -> None:
r = await self.send_chat_cmd(
CC.APISetUserAutoAcceptMemberContacts_cmd_string({"userId": user_id, "onOff": on_off})
)
if r["type"] != "cmdOk":
raise ChatCommandError("error setting auto-accept member contacts", r)
async def api_get_chat(self, chat_type: T.ChatType, chat_id: int, count: int) -> dict[str, Any]:
ref = T.ChatType_cmd_string(chat_type) + str(chat_id)
r = await self.send_chat_cmd(f"/_get chat {ref} count={count}")
if r["type"] == "apiChat":
return r["chat"]
raise ChatCommandError("error getting chat", r)
# ------------------------------------------------------------------ #
# User profile commands
# ------------------------------------------------------------------ #
async def api_get_active_user(self) -> T.User | None:
try:
r = await self.send_chat_cmd(CC.ShowActiveUser_cmd_string({}))
if r["type"] == "activeUser":
return r["user"]
raise ChatCommandError("unexpected response", r)
except core.ChatAPIError as e:
ce = e.chat_error
if (
ce is not None
and ce.get("type") == "error"
and ce.get("errorType", {}).get("type") == "noActiveUser"
):
return None
raise
async def api_create_active_user(self, profile: T.Profile | None = None) -> T.User:
new_user: T.NewUser = {"pastTimestamp": False, "userChatRelay": False}
if profile is not None:
new_user["profile"] = profile
r = await self.send_chat_cmd(CC.CreateActiveUser_cmd_string({"newUser": new_user}))
if r["type"] == "activeUser":
return r["user"]
raise ChatCommandError("unexpected response", r)
async def api_list_users(self) -> list[T.UserInfo]:
r = await self.send_chat_cmd(CC.ListUsers_cmd_string({}))
if r["type"] == "usersList":
return r["users"]
raise ChatCommandError("error listing users", r)
async def api_set_active_user(self, user_id: int, view_pwd: str | None = None) -> T.User:
args: CC.APISetActiveUser = {"userId": user_id}
if view_pwd is not None:
args["viewPwd"] = view_pwd
r = await self.send_chat_cmd(CC.APISetActiveUser_cmd_string(args))
if r["type"] == "activeUser":
return r["user"]
raise ChatCommandError("error setting active user", r)
async def api_delete_user(
self, user_id: int, del_smp_queues: bool, view_pwd: str | None = None
) -> None:
args: CC.APIDeleteUser = {"userId": user_id, "delSMPQueues": del_smp_queues}
if view_pwd is not None:
args["viewPwd"] = view_pwd
r = await self.send_chat_cmd(CC.APIDeleteUser_cmd_string(args))
if r["type"] != "cmdOk":
raise ChatCommandError("error deleting user", r)
async def api_update_profile(
self, user_id: int, profile: T.Profile
) -> T.UserProfileUpdateSummary | None:
r = await self.send_chat_cmd(
CC.APIUpdateProfile_cmd_string({"userId": user_id, "profile": profile})
)
if r["type"] == "userProfileNoChange":
return None
if r["type"] == "userProfileUpdated":
return r["updateSummary"]
raise ChatCommandError("error updating profile", r)
async def api_set_contact_prefs(self, contact_id: int, preferences: T.Preferences) -> None:
r = await self.send_chat_cmd(
CC.APISetContactPrefs_cmd_string({"contactId": contact_id, "preferences": preferences})
)
if r["type"] != "contactPrefsUpdated":
raise ChatCommandError("error setting contact prefs", r)
# ------------------------------------------------------------------ #
# Member contact commands
# ------------------------------------------------------------------ #
async def api_create_member_contact(self, group_id: int, group_member_id: int) -> T.Contact:
r = await self.send_chat_cmd(f"/_create member contact #{group_id} {group_member_id}")
if r["type"] == "newMemberContact":
return r["contact"]
raise ChatCommandError("error creating member contact", r)
async def api_send_member_contact_invitation(
self,
contact_id: int,
message: T.MsgContent | str | None = None,
) -> T.Contact:
cmd = f"/_invite member contact @{contact_id}"
if message is not None:
if isinstance(message, str):
cmd += f" text {message}"
else:
cmd += f" json {json.dumps(message)}"
r = await self.send_chat_cmd(cmd)
if r["type"] == "newMemberContactSentInv":
return r["contact"]
raise ChatCommandError("error sending member contact invitation", r)
packages/simplex-chat-python/src/simplex_chat/bot.py
+727
View File
@@ -0,0 +1,727 @@
"""User-facing `Bot` API: decorators, filters, Message wrapper, lifecycle."""
from __future__ import annotations
import asyncio
import logging
import os
import signal as _signal
from collections.abc import Awaitable, Callable
from dataclasses import dataclass
from typing import Any, Generic, Literal, TypeVar, overload
from . import util
from .api import ChatApi, Db
from .core import ChatAPIError, MigrationConfirmation
from .filters import compile_message_filter
from .types import CEvt, T
log = logging.getLogger("simplex_chat")
C = TypeVar("C", bound="T.MsgContent")
@dataclass(slots=True)
class BotProfile:
display_name: str
full_name: str = ""
short_descr: str | None = None
image: str | None = None
@dataclass(slots=True)
class BotCommand:
keyword: str
label: str
@dataclass(slots=True, frozen=True)
class ParsedCommand:
keyword: str
args: str
@dataclass(slots=True, frozen=True)
class Message(Generic[C]):
chat_item: T.AChatItem
content: C
bot: "Bot"
@property
def chat_info(self) -> T.ChatInfo:
return self.chat_item["chatInfo"]
@property
def text(self) -> str | None:
c = self.content
if isinstance(c, dict):
return c.get("text") # type: ignore[return-value]
return None
async def reply(self, text: str) -> "Message[T.MsgContent]":
items = await self.bot.api.api_send_text_reply(self.chat_item, text)
ci = items[0]
content = ci["chatItem"]["content"]
# content is CIContent — snd variant has msgContent; cast for type safety.
msg_content: T.MsgContent = content["msgContent"] # type: ignore[index]
return Message(chat_item=ci, content=msg_content, bot=self.bot)
async def reply_content(self, content: T.MsgContent) -> "Message[T.MsgContent]":
items = await self.bot.api.api_send_messages(
self.chat_info, [{"msgContent": content, "mentions": {}}]
)
ci = items[0]
ci_content = ci["chatItem"]["content"]
msg_content: T.MsgContent = ci_content["msgContent"] # type: ignore[index]
return Message(chat_item=ci, content=msg_content, bot=self.bot)
# Concrete narrowed aliases — one per MsgContent_<tag> variant in _types.py.
TextMessage = Message[T.MsgContent_text]
LinkMessage = Message[T.MsgContent_link]
ImageMessage = Message[T.MsgContent_image]
VideoMessage = Message[T.MsgContent_video]
VoiceMessage = Message[T.MsgContent_voice]
FileMessage = Message[T.MsgContent_file]
ReportMessage = Message[T.MsgContent_report]
ChatMessage = Message[T.MsgContent_chat]
UnknownMessage = Message[T.MsgContent_unknown]
MessageHandler = Callable[[Message[Any]], Awaitable[None]]
CommandHandler = Callable[[Message[Any], ParsedCommand], Awaitable[None]]
EventHandler = Callable[[CEvt.ChatEvent], Awaitable[None]]
class Middleware:
"""Override `__call__` to wrap message handlers with cross-cutting logic.
`handler` is the next stage in the chain — call it with `(message, data)`
to continue, or skip the call to short-circuit. `data` is a per-dispatch
dict that middleware can use to pass values down the chain.
"""
async def __call__(
self,
handler: Callable[[Message[Any], dict[str, object]], Awaitable[None]],
message: Message[Any],
data: dict[str, object],
) -> None:
await handler(message, data)
class Bot:
def __init__(
self,
*,
profile: BotProfile,
db: Db,
welcome: str | T.MsgContent | None = None,
commands: list[BotCommand] | None = None,
confirm_migrations: MigrationConfirmation = MigrationConfirmation.YES_UP,
create_address: bool = True,
update_address: bool = True,
update_profile: bool = True,
auto_accept: bool = True,
business_address: bool = False,
allow_files: bool = False,
use_bot_profile: bool = True,
log_contacts: bool = True,
log_network: bool = False,
) -> None:
self._profile = profile
self._db = db
self._welcome = welcome
self._commands = commands or []
self._confirm_migrations = confirm_migrations
self._opts = {
"create_address": create_address,
"update_address": update_address,
"update_profile": update_profile,
"auto_accept": auto_accept,
"business_address": business_address,
"allow_files": allow_files,
"use_bot_profile": use_bot_profile,
"log_contacts": log_contacts,
"log_network": log_network,
}
self._api: ChatApi | None = None
self._serving = False
self._stop_event = asyncio.Event()
self._message_handlers: list[tuple[Callable[[Message[Any]], bool], MessageHandler]] = []
self._command_handlers: list[
tuple[tuple[str, ...], Callable[[Message[Any]], bool], CommandHandler]
] = []
self._event_handlers: dict[str, list[EventHandler]] = {}
self._middleware: list[Middleware] = []
# Track default-handler registration so __aenter__ on a re-used bot
# doesn't accumulate duplicate log/error handlers.
self._defaults_registered = False
@property
def api(self) -> ChatApi:
if self._api is None:
raise RuntimeError("Bot not initialized — call bot.run() or use `async with bot:`")
return self._api
# ------------------------------------------------------------------ #
# Decorators
# ------------------------------------------------------------------ #
@overload
def on_message(
self, *, content_type: Literal["text"], **rest: Any
) -> Callable[
[Callable[[TextMessage], Awaitable[None]]],
Callable[[TextMessage], Awaitable[None]],
]: ...
@overload
def on_message(
self, *, content_type: Literal["link"], **rest: Any
) -> Callable[
[Callable[[LinkMessage], Awaitable[None]]],
Callable[[LinkMessage], Awaitable[None]],
]: ...
@overload
def on_message(
self, *, content_type: Literal["image"], **rest: Any
) -> Callable[
[Callable[[ImageMessage], Awaitable[None]]],
Callable[[ImageMessage], Awaitable[None]],
]: ...
@overload
def on_message(
self, *, content_type: Literal["video"], **rest: Any
) -> Callable[
[Callable[[VideoMessage], Awaitable[None]]],
Callable[[VideoMessage], Awaitable[None]],
]: ...
@overload
def on_message(
self, *, content_type: Literal["voice"], **rest: Any
) -> Callable[
[Callable[[VoiceMessage], Awaitable[None]]],
Callable[[VoiceMessage], Awaitable[None]],
]: ...
@overload
def on_message(
self, *, content_type: Literal["file"], **rest: Any
) -> Callable[
[Callable[[FileMessage], Awaitable[None]]],
Callable[[FileMessage], Awaitable[None]],
]: ...
@overload
def on_message(
self, *, content_type: Literal["report"], **rest: Any
) -> Callable[
[Callable[[ReportMessage], Awaitable[None]]],
Callable[[ReportMessage], Awaitable[None]],
]: ...
@overload
def on_message(
self, *, content_type: Literal["chat"], **rest: Any
) -> Callable[
[Callable[[ChatMessage], Awaitable[None]]],
Callable[[ChatMessage], Awaitable[None]],
]: ...
@overload
def on_message(
self, *, content_type: Literal["unknown"], **rest: Any
) -> Callable[
[Callable[[UnknownMessage], Awaitable[None]]],
Callable[[UnknownMessage], Awaitable[None]],
]: ...
@overload
def on_message(self, **rest: Any) -> Callable[[MessageHandler], MessageHandler]: ...
def on_message(self, **filter_kw: Any) -> Callable[[MessageHandler], MessageHandler]:
predicate = compile_message_filter(filter_kw)
def deco(fn: MessageHandler) -> MessageHandler:
self._message_handlers.append((predicate, fn))
return fn
return deco
def on_command(
self, name: str | tuple[str, ...], **filter_kw: Any
) -> Callable[[CommandHandler], CommandHandler]:
names = (name,) if isinstance(name, str) else tuple(name)
predicate = compile_message_filter(filter_kw)
def deco(fn: CommandHandler) -> CommandHandler:
self._command_handlers.append((names, predicate, fn))
return fn
return deco
def on_event(self, event: CEvt.ChatEvent_Tag, /) -> Callable[[EventHandler], EventHandler]:
def deco(fn: EventHandler) -> EventHandler:
self._event_handlers.setdefault(event, []).append(fn)
return fn
return deco
def use(self, middleware: Middleware) -> None:
self._middleware.append(middleware)
# ------------------------------------------------------------------ #
# Lifecycle
# ------------------------------------------------------------------ #
async def __aenter__(self) -> "Bot":
# Order matters: libsimplex `/_start` requires an active user, so
# ensure (or create) the user first, THEN start the chat, THEN
# do address + profile sync. Mirrors Node bot.ts:48-64.
self._api = await ChatApi.init(self._db, self._confirm_migrations)
user = await self._ensure_active_user()
await self._api.start_chat()
await self._sync_address_and_profile(user)
self._register_log_handlers()
return self
async def __aexit__(self, *exc_info: object) -> None:
self.stop()
if self._api is not None:
try:
await self._api.stop_chat()
finally:
await self._api.close()
self._api = None
def run(self) -> None:
"""Blocking entry: runs serve_forever() with SIGINT/SIGTERM handlers installed.
Configures `logging.basicConfig(level=INFO)` if the root logger has no
handlers yet, so the bot's startup messages and the announced address
are visible without callers having to set up logging. Embedders that
manage logging themselves are unaffected (basicConfig is a no-op when
handlers already exist).
"""
if not logging.getLogger().handlers:
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s %(levelname)s %(name)s %(message)s",
)
async def _main() -> None:
async with self:
loop = asyncio.get_running_loop()
# First Ctrl+C → graceful stop (~500ms, bounded by the
# receive-loop poll interval). Second Ctrl+C → force-exit
# immediately (in case stop_chat / close hang on a wedged
# FFI call). Standard CLI UX (jupyter, ipython, …).
sigint_count = 0
def on_interrupt() -> None:
nonlocal sigint_count
sigint_count += 1
if sigint_count == 1:
log.info("stopping bot... (press Ctrl+C again to force exit)")
self.stop()
else:
os._exit(130) # 128 + SIGINT
if hasattr(_signal, "SIGINT"):
try:
loop.add_signal_handler(_signal.SIGINT, on_interrupt)
loop.add_signal_handler(_signal.SIGTERM, self.stop)
except NotImplementedError: # Windows
_signal.signal(_signal.SIGINT, lambda *_: on_interrupt())
await self.serve_forever()
asyncio.run(_main())
async def serve_forever(self) -> None:
if self._serving:
raise RuntimeError("already serving")
self._serving = True
self._stop_event.clear()
try:
await self._receive_loop()
finally:
self._serving = False
def stop(self) -> None:
self._stop_event.set()
async def _receive_loop(self) -> None:
# Catch broad Exception so a single malformed event or transient
# native error doesn't crash the whole bot. CancelledError must
# always re-raise so `bot.stop()` and asyncio cancellation work.
# `wait_us=500_000` (500ms) bounds the worst-case Ctrl+C latency:
# the C call blocks the worker thread until timeout, and the loop
# only checks `_stop_event` between polls.
while not self._stop_event.is_set():
try:
event = await self.api.recv_chat_event(wait_us=500_000)
except asyncio.CancelledError:
raise
except ChatAPIError as e:
# Async chat errors emitted via the Haskell `eToView` path —
# routine soft errors (stale connections after a peer deletes
# a chat, file cleanup failures, etc.) intermixed with
# CRITICAL agent failures the operator must see. Mirror the
# desktop policy in SimpleXAPI.kt:3332-3340: escalate
# CRITICAL agent errors, keep everything else at debug.
chat_err: Any = e.chat_error or {}
agent_err: Any = (
chat_err.get("agentError", {}) if chat_err.get("type") == "errorAgent" else {}
)
if agent_err.get("type") == "CRITICAL":
log.error(
"chat agent CRITICAL: %s (offerRestart=%s)",
agent_err.get("criticalErr"),
agent_err.get("offerRestart"),
)
else:
log.debug("chat event error: %s", chat_err.get("type"))
continue
except Exception:
log.exception("recv_chat_event failed")
# Bound the spin rate when the FFI is wedged on a persistent
# error (vs the timeout path, which already paces itself).
await asyncio.sleep(0.5)
continue
if event is None:
continue
try:
await self._dispatch_event(event)
except asyncio.CancelledError:
raise
except Exception:
log.exception("dispatch_event failed for tag=%s", event.get("type"))
# ------------------------------------------------------------------ #
# Dispatch
# ------------------------------------------------------------------ #
async def _dispatch_event(self, event: CEvt.ChatEvent) -> None:
tag = event["type"]
for h in self._event_handlers.get(tag, []):
try:
await h(event)
except Exception:
log.exception("on_event handler failed")
if tag == "newChatItems":
evt: CEvt.NewChatItems = event # type: ignore[assignment]
for ci in evt["chatItems"]:
content = ci["chatItem"]["content"]
if content["type"] != "rcvMsgContent":
continue
msg_content = content["msgContent"] # type: ignore[index]
msg: Message[T.MsgContent] = Message(chat_item=ci, content=msg_content, bot=self)
await self._dispatch_message(msg)
async def _dispatch_message(self, msg: Message[Any]) -> None:
# First-match-wins. The squaring bot's `@on_message(text=NUMBER_RE)`
# and catch-all `@on_message(content_type="text")` both match a number
# like "1"; we want only the first to fire. Registration order is the
# priority order — register the most-specific filters first.
#
# Slash-commands are tried first against command handlers; if no
# command handler matches, fall through to message handlers (so
# `@on_message` can still catch unknown slash-commands).
cmd = self._parse_command(msg)
if cmd is not None:
for names, predicate, handler in self._command_handlers:
if cmd.keyword in names and predicate(msg):
await self._invoke_command_with_middleware(handler, msg, cmd)
return
for predicate, handler in self._message_handlers:
if predicate(msg):
await self._invoke_with_middleware(handler, msg)
return
async def _invoke_with_middleware(self, handler: MessageHandler, message: Message[Any]) -> None:
# Fast path: most bots register no middleware. Skip the closure-chain
# construction and the empty-data dict on every dispatch.
if not self._middleware:
try:
await handler(message)
except Exception:
log.exception("message handler failed")
return
async def call(m: Message[Any], _data: dict[str, object]) -> None:
await handler(m)
chain: Callable[[Message[Any], dict[str, object]], Awaitable[None]] = call
for mw in reversed(self._middleware):
inner = chain
async def _wrapped(
m: Message[Any],
d: dict[str, object],
mw: Middleware = mw,
inner: Callable[[Message[Any], dict[str, object]], Awaitable[None]] = inner,
) -> None:
await mw(inner, m, d)
chain = _wrapped
try:
await chain(message, {})
except Exception:
log.exception("message handler failed")
async def _invoke_command_with_middleware(
self, handler: CommandHandler, message: Message[Any], cmd: ParsedCommand
) -> None:
if not self._middleware:
try:
await handler(message, cmd)
except Exception:
log.exception("command handler failed")
return
async def call(m: Message[Any], _data: dict[str, object]) -> None:
await handler(m, cmd)
chain: Callable[[Message[Any], dict[str, object]], Awaitable[None]] = call
for mw in reversed(self._middleware):
inner = chain
async def _wrapped(
m: Message[Any],
d: dict[str, object],
mw: Middleware = mw,
inner: Callable[[Message[Any], dict[str, object]], Awaitable[None]] = inner,
) -> None:
await mw(inner, m, d)
chain = _wrapped
try:
await chain(message, {})
except Exception:
log.exception("command handler failed")
@staticmethod
def _parse_command(msg: Message[Any]) -> ParsedCommand | None:
parsed = util.ci_bot_command(msg.chat_item["chatItem"])
if parsed is None:
return None
keyword, args = parsed
return ParsedCommand(keyword=keyword, args=args)
# ------------------------------------------------------------------ #
# Profile + address sync
# ------------------------------------------------------------------ #
async def _ensure_active_user(self) -> T.User:
"""Get or create the active user. Must run before `start_chat`.
Mirrors Node `createBotUser` (bot.ts:158-166). The chat controller
won't accept `/_start` without a user, so this phase has to land
before lifecycle proceeds.
"""
api = self.api
user = await api.api_get_active_user()
if user is None:
log.info("No active user in database, creating...")
user = await api.api_create_active_user(self._bot_profile_to_wire())
log.info("Bot user: %s", user["profile"]["displayName"])
return user
async def _sync_address_and_profile(self, user: T.User) -> None:
"""Address + profile sync. Runs after `start_chat` (mirrors bot.ts:57-63)."""
api = self.api
user_id = user["userId"]
# 2. Address (numbered to match bot.ts comments — phase 1 was user creation).
address = await api.api_get_user_address(user_id)
if address is None:
if self._opts["create_address"]:
log.info("Bot has no address, creating...")
await api.api_create_user_address(user_id)
address = await api.api_get_user_address(user_id)
if address is None:
raise RuntimeError("Failed reading newly created user address")
else:
log.warning("Bot has no address")
# Always announce the address — matches Node bot.ts:60.
link: str | None = None
if address is not None:
link = util.contact_address_str(address["connLinkContact"])
log.info("Bot address: %s", link)
# 3. Address settings (auto-accept + welcome message). Mirrors bot.ts:185-194.
# autoAccept present → accept; absent → no auto-accept (mirrors Node bot.ts).
if address is not None and self._opts["update_address"]:
desired: T.AddressSettings = {"businessAddress": self._opts["business_address"]}
if self._opts["auto_accept"]:
desired["autoAccept"] = {"acceptIncognito": False}
if self._welcome is not None:
desired["autoReply"] = (
{"type": "text", "text": self._welcome}
if isinstance(self._welcome, str)
else self._welcome
)
if address["addressSettings"] != desired:
log.info("Bot address settings changed, updating...")
await api.api_set_address_settings(user_id, desired)
# 4. Profile update. Mirrors Node `updateBotUserProfile` (bot.ts:199-214).
# Field-by-field comparison: user["profile"] is LocalProfile (has extra
# fields profileId, localAlias, preferences, peerType) so a full-dict
# equality would always differ.
new_profile = self._bot_profile_to_wire()
if link is not None and self._opts["use_bot_profile"]:
# Mirrors bot.ts:62 — embed the connection link in the bot's profile
# so contacts that resolve the bot via stored profile data see the
# current address.
new_profile["contactLink"] = link
cur = user["profile"]
changed = (
cur["displayName"] != new_profile["displayName"]
or cur.get("fullName", "") != new_profile.get("fullName", "")
or cur.get("shortDescr") != new_profile.get("shortDescr")
or cur.get("image") != new_profile.get("image")
or cur.get("preferences") != new_profile.get("preferences")
or cur.get("peerType") != new_profile.get("peerType")
or cur.get("contactLink") != new_profile.get("contactLink")
)
if changed and self._opts["update_profile"]:
log.info("Bot profile changed, updating...")
await api.api_update_profile(user_id, new_profile)
def _bot_profile_to_wire(self) -> T.Profile:
"""Construct wire-format Profile, applying bot conventions when use_bot_profile=True.
Mirrors Node mkBotProfile (bot.ts:88-102): bots get peerType="bot",
calls/voice prefs disabled, files gated on `allow_files`, and any
registered `commands` embedded in the profile preferences.
"""
p: T.Profile = {
"displayName": self._profile.display_name,
"fullName": self._profile.full_name,
}
if self._profile.short_descr is not None:
p["shortDescr"] = self._profile.short_descr
if self._profile.image is not None:
p["image"] = self._profile.image
if self._opts["use_bot_profile"]:
prefs: T.Preferences = {
"calls": {"allow": "no"},
"voice": {"allow": "no"},
"files": {"allow": "yes" if self._opts["allow_files"] else "no"},
}
if self._commands:
prefs["commands"] = [
{"type": "command", "keyword": c.keyword, "label": c.label}
for c in self._commands
]
p["preferences"] = prefs
p["peerType"] = "bot"
elif self._commands:
raise ValueError(
"use_bot_profile=False but commands were passed; commands are "
"only sent when use_bot_profile=True (they're embedded in the "
"user profile preferences)."
)
return p
# ------------------------------------------------------------------ #
# Log subscriptions (mirror Node subscribeLogEvents bot.ts:142-156)
# ------------------------------------------------------------------ #
def _register_log_handlers(self) -> None:
# Idempotent: a Bot reused across multiple `__aenter__` cycles must
# not stack duplicate log handlers. Always-on error handlers run
# regardless of log_contacts/log_network so messageError/chatError/
# chatErrors don't disappear into the void.
if self._defaults_registered:
return
self._defaults_registered = True
self._event_handlers.setdefault("messageError", []).append(self._log_message_error)
self._event_handlers.setdefault("chatError", []).append(self._log_chat_error)
self._event_handlers.setdefault("chatErrors", []).append(self._log_chat_errors)
if self._opts["log_contacts"]:
self._event_handlers.setdefault("contactConnected", []).append(
self._log_contact_connected
)
self._event_handlers.setdefault("contactDeletedByContact", []).append(
self._log_contact_deleted
)
if self._opts["log_network"]:
self._event_handlers.setdefault("hostConnected", []).append(self._log_host_connected)
self._event_handlers.setdefault("hostDisconnected", []).append(
self._log_host_disconnected
)
self._event_handlers.setdefault("subscriptionStatus", []).append(
self._log_subscription_status
)
@staticmethod
async def _log_contact_connected(evt: CEvt.ChatEvent) -> None:
log.info("%s connected", evt["contact"]["profile"]["displayName"]) # type: ignore[index]
@staticmethod
async def _log_contact_deleted(evt: CEvt.ChatEvent) -> None:
log.info(
"%s deleted connection with bot",
evt["contact"]["profile"]["displayName"], # type: ignore[index]
)
@staticmethod
async def _log_host_connected(evt: CEvt.ChatEvent) -> None:
log.info("connected server %s", evt["transportHost"]) # type: ignore[index]
@staticmethod
async def _log_host_disconnected(evt: CEvt.ChatEvent) -> None:
log.info("disconnected server %s", evt["transportHost"]) # type: ignore[index]
@staticmethod
async def _log_subscription_status(evt: CEvt.ChatEvent) -> None:
log.info(
"%d subscription(s) %s",
len(evt["connections"]), # type: ignore[index]
evt["subscriptionStatus"]["type"], # type: ignore[index]
)
@staticmethod
async def _log_message_error(evt: CEvt.ChatEvent) -> None:
log.warning("messageError: %s", evt.get("severity", "?")) # type: ignore[union-attr]
@staticmethod
async def _log_chat_error(evt: CEvt.ChatEvent) -> None:
err = evt.get("chatError") # type: ignore[union-attr]
log.error("chatError: %s", err.get("type") if isinstance(err, dict) else err)
@staticmethod
async def _log_chat_errors(evt: CEvt.ChatEvent) -> None:
errs = evt.get("chatErrors") or [] # type: ignore[union-attr]
log.error("chatErrors: %d errors", len(errs))
# Suppress unused-import warnings for re-exported names used only at type-check time.
__all__ = [
"Bot",
"BotCommand",
"BotProfile",
"ChatMessage",
"FileMessage",
"ImageMessage",
"LinkMessage",
"Message",
"MessageHandler",
"CommandHandler",
"EventHandler",
"Middleware",
"ParsedCommand",
"ReportMessage",
"TextMessage",
"UnknownMessage",
"VideoMessage",
"VoiceMessage",
]
packages/simplex-chat-python/src/simplex_chat/core.py
+200
View File
@@ -0,0 +1,200 @@
"""Internal typed async wrapper around libsimplex's 8 C ABI functions.
Users interact with `Bot` / `ChatApi`. This module is exposed as
`simplex_chat.core` for tests and the api.ChatApi class only.
"""
from __future__ import annotations
import asyncio
import ctypes
import json
from enum import StrEnum
from typing import Any, TypedDict
from . import _native
from .types import T, CR, CEvt
class ChatAPIError(Exception):
"""Raised when chat_send_cmd / chat_recv_msg_wait returns a chat error."""
def __init__(self, message: str, chat_error: T.ChatError | None = None):
super().__init__(message)
self.chat_error = chat_error
class ChatInitError(Exception):
"""Raised when chat_migrate_init returns a DBMigrationResult error."""
def __init__(self, message: str, db_migration_error: dict[str, Any]):
super().__init__(message)
self.db_migration_error = db_migration_error
class MigrationConfirmation(StrEnum):
YES_UP = "yesUp"
YES_UP_DOWN = "yesUpDown"
CONSOLE = "console"
ERROR = "error"
class CryptoArgs(TypedDict): # wire-format JSON; camelCase fields
fileKey: str
fileNonce: str
def _read_and_free(ptr: int | None) -> str:
"""Copy a Haskell-allocated null-terminated UTF-8 string and free its buffer.
Mirrors HandleCResult in packages/simplex-chat-nodejs/cpp/simplex.cc:157-165.
"""
if not ptr:
raise RuntimeError("null pointer returned from libsimplex")
try:
return ctypes.string_at(ptr).decode("utf-8")
finally:
_native.libc().free(ctypes.c_void_p(ptr))
async def chat_send_cmd(ctrl: int, cmd: str) -> CR.ChatResponse:
def _call() -> str:
ptr = _native.lib().chat_send_cmd(ctrl, cmd.encode("utf-8"))
return _read_and_free(ptr)
raw = await asyncio.to_thread(_call)
parsed = json.loads(raw)
if "result" in parsed and isinstance(parsed["result"], dict):
return parsed["result"] # type: ignore[return-value]
err = parsed.get("error")
if isinstance(err, dict):
raise ChatAPIError(f"chat command error: {err.get('type')}", err) # type: ignore[arg-type]
raise ChatAPIError(f"invalid chat command result: {raw[:200]}")
async def chat_recv_msg_wait(ctrl: int, wait_us: int = 500_000) -> CEvt.ChatEvent | None:
def _call() -> str:
# On timeout, the C side returns a non-NULL pointer to a single NUL byte
# (see Mobile.hs `fromMaybe ""`), so `_read_and_free` returns "" — no
# NULL-pointer guard is needed here.
ptr = _native.lib().chat_recv_msg_wait(ctrl, wait_us)
return _read_and_free(ptr)
raw = await asyncio.to_thread(_call)
if not raw:
return None
parsed = json.loads(raw)
if "result" in parsed and isinstance(parsed["result"], dict):
return parsed["result"] # type: ignore[return-value]
err = parsed.get("error")
if isinstance(err, dict):
raise ChatAPIError(f"chat event error: {err.get('type')}", err) # type: ignore[arg-type]
raise ChatAPIError(f"invalid chat event: {raw[:200]}")
async def chat_migrate_init(db_path: str, db_key: str, confirm: MigrationConfirmation) -> int:
"""Initialize chat controller. Returns opaque ctrl pointer as Python int."""
def _call() -> tuple[int, str]:
ctrl = ctypes.c_void_p()
ptr = _native.lib().chat_migrate_init(
db_path.encode("utf-8"),
db_key.encode("utf-8"),
confirm.encode("utf-8"),
ctypes.byref(ctrl),
)
return (ctrl.value or 0, _read_and_free(ptr))
ctrl_val, raw = await asyncio.to_thread(_call)
parsed = json.loads(raw)
if parsed.get("type") == "ok":
if not ctrl_val:
# ABI invariant: type=="ok" → out-param written. Defensive guard so a
# broken libsimplex doesn't hand us a NULL controller that would only
# crash on first use much later.
raise RuntimeError("chat_migrate_init returned ok but did not set ctrl pointer")
return ctrl_val
raise ChatInitError(
"Database or migration error (see db_migration_error)",
parsed,
)
async def chat_close_store(ctrl: int) -> None:
def _call() -> str:
ptr = _native.lib().chat_close_store(ctrl)
return _read_and_free(ptr)
res = await asyncio.to_thread(_call)
if res:
raise RuntimeError(res)
async def chat_write_file(ctrl: int, path: str, data: bytes) -> CryptoArgs:
def _call() -> str:
ptr = _native.lib().chat_write_file(ctrl, path.encode("utf-8"), data, len(data))
return _read_and_free(ptr)
raw = await asyncio.to_thread(_call)
return _crypto_args_result(raw)
async def chat_read_file(path: str, args: CryptoArgs) -> bytes:
def _call() -> bytes:
ptr = _native.lib().chat_read_file(
path.encode("utf-8"),
args["fileKey"].encode("utf-8"),
args["fileNonce"].encode("utf-8"),
)
if not ptr:
raise RuntimeError("chat_read_file returned null")
addr = ctypes.cast(ptr, ctypes.c_void_p).value
assert addr is not None # `if not ptr` above already filtered NULL
try:
status = ctypes.cast(addr, ctypes.POINTER(ctypes.c_uint8))[0]
if status == 1:
msg = ctypes.string_at(addr + 1).decode("utf-8")
raise RuntimeError(msg)
if status != 0:
raise RuntimeError(f"unexpected status {status} from chat_read_file")
# `addr + 1` is unaligned for a uint32 read. On the supported platforms
# (linux-x86_64, linux-aarch64, macos-aarch64, windows-x86_64) this is
# silently handled; matches the Node.js binding (cpp/simplex.cc:344).
length = ctypes.cast(addr + 1, ctypes.POINTER(ctypes.c_uint32))[0]
return ctypes.string_at(addr + 5, length)
finally:
_native.libc().free(ctypes.c_void_p(addr))
return await asyncio.to_thread(_call)
async def chat_encrypt_file(ctrl: int, src: str, dst: str) -> CryptoArgs:
def _call() -> str:
ptr = _native.lib().chat_encrypt_file(ctrl, src.encode("utf-8"), dst.encode("utf-8"))
return _read_and_free(ptr)
return _crypto_args_result(await asyncio.to_thread(_call))
async def chat_decrypt_file(src: str, args: CryptoArgs, dst: str) -> None:
def _call() -> str:
ptr = _native.lib().chat_decrypt_file(
src.encode("utf-8"),
args["fileKey"].encode("utf-8"),
args["fileNonce"].encode("utf-8"),
dst.encode("utf-8"),
)
return _read_and_free(ptr)
res = await asyncio.to_thread(_call)
if res:
raise RuntimeError(res)
def _crypto_args_result(raw: str) -> CryptoArgs:
parsed = json.loads(raw)
if parsed.get("type") == "result":
return parsed["cryptoArgs"]
if parsed.get("type") == "error":
raise RuntimeError(parsed.get("writeError", "unknown write error"))
raise RuntimeError(f"unexpected result: {raw[:200]}")
packages/simplex-chat-python/src/simplex_chat/filters.py
+45
View File
@@ -0,0 +1,45 @@
"""Compile kwarg-based message filters into a single predicate."""
from __future__ import annotations
import re
from typing import Any, Callable
def compile_message_filter(kw: dict[str, Any]) -> Callable[[Any], bool]:
"""Compile filter kwargs into a single predicate function.
Multiple kwargs combine with AND; tuples within a kwarg combine with OR.
`when` is the last predicate evaluated.
"""
predicates: list[Callable[[Any], bool]] = []
if (ct := kw.get("content_type")) is not None:
ct_set = (ct,) if isinstance(ct, str) else tuple(ct)
predicates.append(lambda m: m.content.get("type") in ct_set)
if (t := kw.get("text")) is not None:
if isinstance(t, re.Pattern):
predicates.append(lambda m: bool(t.search(m.content.get("text", "") or "")))
else:
predicates.append(lambda m: m.content.get("text") == t)
if (cht := kw.get("chat_type")) is not None:
cht_set = (cht,) if isinstance(cht, str) else tuple(cht)
predicates.append(lambda m: m.chat_item["chatInfo"]["type"] in cht_set)
if (gid := kw.get("group_id")) is not None:
gid_set: tuple[int, ...] = (gid,) if isinstance(gid, int) else tuple(gid)
def gid_match(m: Any) -> bool:
ci = m.chat_item["chatInfo"]
return ci["type"] == "group" and ci["groupInfo"]["groupId"] in gid_set
predicates.append(gid_match)
if (when := kw.get("when")) is not None:
predicates.append(when)
if not predicates:
return lambda _m: True
return lambda m: all(p(m) for p in predicates)
packages/simplex-chat-python/src/simplex_chat/py.typed
View File
packages/simplex-chat-python/src/simplex_chat/types/__init__.py
+16
View File
@@ -0,0 +1,16 @@
"""SimpleX Chat wire types — auto-generated from Haskell.
Re-exports the four generated modules as namespaces:
- ``T`` — :mod:`._types` (records, enums, discriminated unions)
- ``CC`` — :mod:`._commands` (command TypedDicts + ``<Cmd>_cmd_string`` helpers)
- ``CR`` — :mod:`._responses` (``ChatResponse`` and member TypedDicts)
- ``CEvt`` — :mod:`._events` (``ChatEvent`` and member TypedDicts)
"""
from . import _commands as CC
from . import _events as CEvt
from . import _responses as CR
from . import _types as T
__all__ = ["T", "CC", "CR", "CEvt"]
packages/simplex-chat-python/src/simplex_chat/types/_commands.py
+705
View File
@@ -0,0 +1,705 @@
# API Commands
# This file is generated automatically.
from __future__ import annotations
import json
from typing import NotRequired, TypedDict
from . import _types as T
from . import _responses as CR
# Address commands
# Bots can use these commands to automatically check and create address when initialized
# Create bot address.
# Network usage: interactive.
class APICreateMyAddress(TypedDict):
userId: int # int64
def APICreateMyAddress_cmd_string(self: APICreateMyAddress) -> str:
return '/_address ' + str(self['userId'])
APICreateMyAddress_Response = CR.UserContactLinkCreated | CR.ChatCmdError
# Delete bot address.
# Network usage: background.
class APIDeleteMyAddress(TypedDict):
userId: int # int64
def APIDeleteMyAddress_cmd_string(self: APIDeleteMyAddress) -> str:
return '/_delete_address ' + str(self['userId'])
APIDeleteMyAddress_Response = CR.UserContactLinkDeleted | CR.ChatCmdError
# Get bot address and settings.
# Network usage: no.
class APIShowMyAddress(TypedDict):
userId: int # int64
def APIShowMyAddress_cmd_string(self: APIShowMyAddress) -> str:
return '/_show_address ' + str(self['userId'])
APIShowMyAddress_Response = CR.UserContactLink | CR.ChatCmdError
# Add address to bot profile.
# Network usage: interactive.
class APISetProfileAddress(TypedDict):
userId: int # int64
enable: bool
def APISetProfileAddress_cmd_string(self: APISetProfileAddress) -> str:
return '/_profile_address ' + str(self['userId']) + ' ' + ('on' if self['enable'] else 'off')
APISetProfileAddress_Response = CR.UserProfileUpdated | CR.ChatCmdError
# Set bot address settings.
# Network usage: interactive.
class APISetAddressSettings(TypedDict):
userId: int # int64
settings: "T.AddressSettings"
def APISetAddressSettings_cmd_string(self: APISetAddressSettings) -> str:
return '/_address_settings ' + str(self['userId']) + ' ' + json.dumps(self['settings'])
APISetAddressSettings_Response = CR.UserContactLinkUpdated | CR.ChatCmdError
# Message commands
# Commands to send, update, delete, moderate messages and set message reactions
# Send messages.
# Network usage: background.
class APISendMessages(TypedDict):
sendRef: "T.ChatRef"
liveMessage: bool
ttl: NotRequired[int] # int
composedMessages: list["T.ComposedMessage"] # non-empty
def APISendMessages_cmd_string(self: APISendMessages) -> str:
return '/_send ' + T.ChatRef_cmd_string(self['sendRef']) + (' live=on' if self['liveMessage'] else '') + ((' ttl=' + str(self.get('ttl'))) if self.get('ttl') is not None else '') + ' json ' + json.dumps(self['composedMessages'])
APISendMessages_Response = CR.NewChatItems | CR.ChatCmdError
# Update message.
# Network usage: background.
class APIUpdateChatItem(TypedDict):
chatRef: "T.ChatRef"
chatItemId: int # int64
liveMessage: bool
updatedMessage: "T.UpdatedMessage"
def APIUpdateChatItem_cmd_string(self: APIUpdateChatItem) -> str:
return '/_update item ' + T.ChatRef_cmd_string(self['chatRef']) + ' ' + str(self['chatItemId']) + (' live=on' if self['liveMessage'] else '') + ' json ' + json.dumps(self['updatedMessage'])
APIUpdateChatItem_Response = CR.ChatItemUpdated | CR.ChatItemNotChanged | CR.ChatCmdError
# Delete message.
# Network usage: background.
class APIDeleteChatItem(TypedDict):
chatRef: "T.ChatRef"
chatItemIds: list[int] # int64, non-empty
deleteMode: "T.CIDeleteMode"
def APIDeleteChatItem_cmd_string(self: APIDeleteChatItem) -> str:
return '/_delete item ' + T.ChatRef_cmd_string(self['chatRef']) + ' ' + ','.join(map(str, self['chatItemIds'])) + ' ' + str(self['deleteMode'])
APIDeleteChatItem_Response = CR.ChatItemsDeleted | CR.ChatCmdError
# Moderate message. Requires Moderator role (and higher than message author's).
# Network usage: background.
class APIDeleteMemberChatItem(TypedDict):
groupId: int # int64
chatItemIds: list[int] # int64, non-empty
def APIDeleteMemberChatItem_cmd_string(self: APIDeleteMemberChatItem) -> str:
return '/_delete member item #' + str(self['groupId']) + ' ' + ','.join(map(str, self['chatItemIds']))
APIDeleteMemberChatItem_Response = CR.ChatItemsDeleted | CR.ChatCmdError
# Add/remove message reaction.
# Network usage: background.
class APIChatItemReaction(TypedDict):
chatRef: "T.ChatRef"
chatItemId: int # int64
add: bool
reaction: "T.MsgReaction"
def APIChatItemReaction_cmd_string(self: APIChatItemReaction) -> str:
return '/_reaction ' + T.ChatRef_cmd_string(self['chatRef']) + ' ' + str(self['chatItemId']) + ' ' + ('on' if self['add'] else 'off') + ' ' + json.dumps(self['reaction'])
APIChatItemReaction_Response = CR.ChatItemReaction | CR.ChatCmdError
# File commands
# Commands to receive and to cancel files. Files are sent as part of the message, there are no separate commands to send files.
# Receive file.
# Network usage: no.
class ReceiveFile(TypedDict):
fileId: int # int64
userApprovedRelays: bool
storeEncrypted: NotRequired[bool]
fileInline: NotRequired[bool]
filePath: NotRequired[str]
def ReceiveFile_cmd_string(self: ReceiveFile) -> str:
return '/freceive ' + str(self['fileId']) + (' approved_relays=on' if self['userApprovedRelays'] else '') + ((' encrypt=' + ('on' if self.get('storeEncrypted') else 'off')) if self.get('storeEncrypted') is not None else '') + ((' inline=' + ('on' if self.get('fileInline') else 'off')) if self.get('fileInline') is not None else '') + ((' ' + self.get('filePath')) if self.get('filePath') is not None else '')
ReceiveFile_Response = CR.RcvFileAccepted | CR.RcvFileAcceptedSndCancelled | CR.ChatCmdError
# Cancel file.
# Network usage: background.
class CancelFile(TypedDict):
fileId: int # int64
def CancelFile_cmd_string(self: CancelFile) -> str:
return '/fcancel ' + str(self['fileId'])
CancelFile_Response = CR.SndFileCancelled | CR.RcvFileCancelled | CR.ChatCmdError
# Group commands
# Commands to manage and moderate groups. These commands can be used with business chats as well - they are groups. E.g., a common scenario would be to add human agents to business chat with the customer who connected via business address.
# Add contact to group. Requires bot to have Admin role.
# Network usage: interactive.
class APIAddMember(TypedDict):
groupId: int # int64
contactId: int # int64
memberRole: "T.GroupMemberRole"
def APIAddMember_cmd_string(self: APIAddMember) -> str:
return '/_add #' + str(self['groupId']) + ' ' + str(self['contactId']) + ' ' + str(self['memberRole'])
APIAddMember_Response = CR.SentGroupInvitation | CR.ChatCmdError
# Join group.
# Network usage: interactive.
class APIJoinGroup(TypedDict):
groupId: int # int64
def APIJoinGroup_cmd_string(self: APIJoinGroup) -> str:
return '/_join #' + str(self['groupId'])
APIJoinGroup_Response = CR.UserAcceptedGroupSent | CR.ChatCmdError
# Accept group member. Requires Admin role.
# Network usage: background.
class APIAcceptMember(TypedDict):
groupId: int # int64
groupMemberId: int # int64
memberRole: "T.GroupMemberRole"
def APIAcceptMember_cmd_string(self: APIAcceptMember) -> str:
return '/_accept member #' + str(self['groupId']) + ' ' + str(self['groupMemberId']) + ' ' + str(self['memberRole'])
APIAcceptMember_Response = CR.MemberAccepted | CR.ChatCmdError
# Set members role. Requires Admin role.
# Network usage: background.
class APIMembersRole(TypedDict):
groupId: int # int64
groupMemberIds: list[int] # int64, non-empty
memberRole: "T.GroupMemberRole"
def APIMembersRole_cmd_string(self: APIMembersRole) -> str:
return '/_member role #' + str(self['groupId']) + ' ' + ','.join(map(str, self['groupMemberIds'])) + ' ' + str(self['memberRole'])
APIMembersRole_Response = CR.MembersRoleUser | CR.ChatCmdError
# Block members. Requires Moderator role.
# Network usage: background.
class APIBlockMembersForAll(TypedDict):
groupId: int # int64
groupMemberIds: list[int] # int64, non-empty
blocked: bool
def APIBlockMembersForAll_cmd_string(self: APIBlockMembersForAll) -> str:
return '/_block #' + str(self['groupId']) + ' ' + ','.join(map(str, self['groupMemberIds'])) + ' blocked=' + ('on' if self['blocked'] else 'off')
APIBlockMembersForAll_Response = CR.MembersBlockedForAllUser | CR.ChatCmdError
# Remove members. Requires Admin role.
# Network usage: background.
class APIRemoveMembers(TypedDict):
groupId: int # int64
groupMemberIds: list[int] # int64, non-empty
withMessages: bool
def APIRemoveMembers_cmd_string(self: APIRemoveMembers) -> str:
return '/_remove #' + str(self['groupId']) + ' ' + ','.join(map(str, self['groupMemberIds'])) + (' messages=on' if self['withMessages'] else '')
APIRemoveMembers_Response = CR.UserDeletedMembers | CR.ChatCmdError
# Leave group.
# Network usage: background.
class APILeaveGroup(TypedDict):
groupId: int # int64
def APILeaveGroup_cmd_string(self: APILeaveGroup) -> str:
return '/_leave #' + str(self['groupId'])
APILeaveGroup_Response = CR.LeftMemberUser | CR.ChatCmdError
# Get group members.
# Network usage: no.
class APIListMembers(TypedDict):
groupId: int # int64
def APIListMembers_cmd_string(self: APIListMembers) -> str:
return '/_members #' + str(self['groupId'])
APIListMembers_Response = CR.GroupMembers | CR.ChatCmdError
# Create group.
# Network usage: no.
class APINewGroup(TypedDict):
userId: int # int64
incognito: bool
groupProfile: "T.GroupProfile"
def APINewGroup_cmd_string(self: APINewGroup) -> str:
return '/_group ' + str(self['userId']) + (' incognito=on' if self['incognito'] else '') + ' ' + json.dumps(self['groupProfile'])
APINewGroup_Response = CR.GroupCreated | CR.ChatCmdError
# Create public group.
# Network usage: interactive.
class APINewPublicGroup(TypedDict):
userId: int # int64
incognito: bool
relayIds: list[int] # int64, non-empty
groupProfile: "T.GroupProfile"
def APINewPublicGroup_cmd_string(self: APINewPublicGroup) -> str:
return '/_public group ' + str(self['userId']) + (' incognito=on' if self['incognito'] else '') + ' ' + ','.join(map(str, self['relayIds'])) + ' ' + json.dumps(self['groupProfile'])
APINewPublicGroup_Response = CR.PublicGroupCreated | CR.PublicGroupCreationFailed | CR.ChatCmdError
# Get group relays.
# Network usage: no.
class APIGetGroupRelays(TypedDict):
groupId: int # int64
def APIGetGroupRelays_cmd_string(self: APIGetGroupRelays) -> str:
return '/_get relays #' + str(self['groupId'])
APIGetGroupRelays_Response = CR.GroupRelays | CR.ChatCmdError
# Add relays to group.
# Network usage: interactive.
class APIAddGroupRelays(TypedDict):
groupId: int # int64
relayIds: list[int] # int64, non-empty
def APIAddGroupRelays_cmd_string(self: APIAddGroupRelays) -> str:
return '/_add relays #' + str(self['groupId']) + ' ' + ','.join(map(str, self['relayIds']))
APIAddGroupRelays_Response = CR.GroupRelaysAdded | CR.GroupRelaysAddFailed | CR.ChatCmdError
# Update group profile.
# Network usage: background.
class APIUpdateGroupProfile(TypedDict):
groupId: int # int64
groupProfile: "T.GroupProfile"
def APIUpdateGroupProfile_cmd_string(self: APIUpdateGroupProfile) -> str:
return '/_group_profile #' + str(self['groupId']) + ' ' + json.dumps(self['groupProfile'])
APIUpdateGroupProfile_Response = CR.GroupUpdated | CR.ChatCmdError
# Group link commands
# These commands can be used by bots that manage multiple public groups
# Create group link.
# Network usage: interactive.
class APICreateGroupLink(TypedDict):
groupId: int # int64
memberRole: "T.GroupMemberRole"
def APICreateGroupLink_cmd_string(self: APICreateGroupLink) -> str:
return '/_create link #' + str(self['groupId']) + ' ' + str(self['memberRole'])
APICreateGroupLink_Response = CR.GroupLinkCreated | CR.ChatCmdError
# Set member role for group link.
# Network usage: no.
class APIGroupLinkMemberRole(TypedDict):
groupId: int # int64
memberRole: "T.GroupMemberRole"
def APIGroupLinkMemberRole_cmd_string(self: APIGroupLinkMemberRole) -> str:
return '/_set link role #' + str(self['groupId']) + ' ' + str(self['memberRole'])
APIGroupLinkMemberRole_Response = CR.GroupLink | CR.ChatCmdError
# Delete group link.
# Network usage: background.
class APIDeleteGroupLink(TypedDict):
groupId: int # int64
def APIDeleteGroupLink_cmd_string(self: APIDeleteGroupLink) -> str:
return '/_delete link #' + str(self['groupId'])
APIDeleteGroupLink_Response = CR.GroupLinkDeleted | CR.ChatCmdError
# Get group link.
# Network usage: no.
class APIGetGroupLink(TypedDict):
groupId: int # int64
def APIGetGroupLink_cmd_string(self: APIGetGroupLink) -> str:
return '/_get link #' + str(self['groupId'])
APIGetGroupLink_Response = CR.GroupLink | CR.ChatCmdError
# Connection commands
# These commands may be used to create connections. Most bots do not need to use them - bot users will connect via bot address with auto-accept enabled.
# Create 1-time invitation link.
# Network usage: interactive.
class APIAddContact(TypedDict):
userId: int # int64
incognito: bool
def APIAddContact_cmd_string(self: APIAddContact) -> str:
return '/_connect ' + str(self['userId']) + (' incognito=on' if self['incognito'] else '')
APIAddContact_Response = CR.Invitation | CR.ChatCmdError
# Determine SimpleX link type and if the bot is already connected via this link.
# Network usage: interactive.
class APIConnectPlan(TypedDict):
userId: int # int64
connectionLink: NotRequired[str]
resolveKnown: bool
linkOwnerSig: NotRequired["T.LinkOwnerSig"]
def APIConnectPlan_cmd_string(self: APIConnectPlan) -> str:
return '/_connect plan ' + str(self['userId']) + ' ' + self.get('connectionLink')
APIConnectPlan_Response = CR.ConnectionPlan | CR.ChatCmdError
# Connect via prepared SimpleX link. The link can be 1-time invitation link, contact address or group link.
# Network usage: interactive.
class APIConnect(TypedDict):
userId: int # int64
incognito: bool
preparedLink_: NotRequired["T.CreatedConnLink"]
def APIConnect_cmd_string(self: APIConnect) -> str:
return '/_connect ' + str(self['userId']) + ((' ' + T.CreatedConnLink_cmd_string(self.get('preparedLink_'))) if self.get('preparedLink_') is not None else '')
APIConnect_Response = CR.SentConfirmation | CR.ContactAlreadyExists | CR.SentInvitation | CR.ChatCmdError
# Connect via SimpleX link as string in the active user profile.
# Network usage: interactive.
class Connect(TypedDict):
incognito: bool
connLink_: NotRequired[str]
def Connect_cmd_string(self: Connect) -> str:
return '/connect' + ((' ' + self.get('connLink_')) if self.get('connLink_') is not None else '')
Connect_Response = CR.SentConfirmation | CR.ContactAlreadyExists | CR.SentInvitation | CR.ChatCmdError
# Accept contact request.
# Network usage: interactive.
class APIAcceptContact(TypedDict):
contactReqId: int # int64
def APIAcceptContact_cmd_string(self: APIAcceptContact) -> str:
return '/_accept ' + str(self['contactReqId'])
APIAcceptContact_Response = CR.AcceptingContactRequest | CR.ChatCmdError
# Reject contact request. The user who sent the request is **not notified**.
# Network usage: no.
class APIRejectContact(TypedDict):
contactReqId: int # int64
def APIRejectContact_cmd_string(self: APIRejectContact) -> str:
return '/_reject ' + str(self['contactReqId'])
APIRejectContact_Response = CR.ContactRequestRejected | CR.ChatCmdError
# Chat commands
# Commands to list and delete conversations.
# Get contacts.
# Network usage: no.
class APIListContacts(TypedDict):
userId: int # int64
def APIListContacts_cmd_string(self: APIListContacts) -> str:
return '/_contacts ' + str(self['userId'])
APIListContacts_Response = CR.ContactsList | CR.ChatCmdError
# Get groups.
# Network usage: no.
class APIListGroups(TypedDict):
userId: int # int64
contactId_: NotRequired[int] # int64
search: NotRequired[str]
def APIListGroups_cmd_string(self: APIListGroups) -> str:
return '/_groups ' + str(self['userId']) + ((' @' + str(self.get('contactId_'))) if self.get('contactId_') is not None else '') + ((' ' + self.get('search')) if self.get('search') is not None else '')
APIListGroups_Response = CR.GroupsList | CR.ChatCmdError
# Get chat previews. Supports time-based pagination — use this instead of APIListContacts / APIListGroups when scanning at scale (those load every record into memory and fail on large databases).
# Network usage: no.
class APIGetChats(TypedDict):
userId: int # int64
pendingConnections: bool
pagination: "T.PaginationByTime"
query: "T.ChatListQuery"
def APIGetChats_cmd_string(self: APIGetChats) -> str:
return '/_get chats ' + str(self['userId']) + (' pcc=on' if self['pendingConnections'] else '') + ' ' + T.PaginationByTime_cmd_string(self['pagination']) + ' ' + json.dumps(self['query'])
APIGetChats_Response = CR.ApiChats | CR.ChatCmdError
# Delete chat.
# Network usage: background.
class APIDeleteChat(TypedDict):
chatRef: "T.ChatRef"
chatDeleteMode: "T.ChatDeleteMode"
def APIDeleteChat_cmd_string(self: APIDeleteChat) -> str:
return '/_delete ' + T.ChatRef_cmd_string(self['chatRef']) + ' ' + T.ChatDeleteMode_cmd_string(self['chatDeleteMode'])
APIDeleteChat_Response = CR.ContactDeleted | CR.ContactConnectionDeleted | CR.GroupDeletedUser | CR.ChatCmdError
# Set group custom data.
# Network usage: no.
class APISetGroupCustomData(TypedDict):
groupId: int # int64
customData: NotRequired[dict[str, object]]
def APISetGroupCustomData_cmd_string(self: APISetGroupCustomData) -> str:
return '/_set custom #' + str(self['groupId']) + ((' ' + json.dumps(self.get('customData'))) if self.get('customData') is not None else '')
APISetGroupCustomData_Response = CR.CmdOk | CR.ChatCmdError
# Set contact custom data.
# Network usage: no.
class APISetContactCustomData(TypedDict):
contactId: int # int64
customData: NotRequired[dict[str, object]]
def APISetContactCustomData_cmd_string(self: APISetContactCustomData) -> str:
return '/_set custom @' + str(self['contactId']) + ((' ' + json.dumps(self.get('customData'))) if self.get('customData') is not None else '')
APISetContactCustomData_Response = CR.CmdOk | CR.ChatCmdError
# Set auto-accept member contacts.
# Network usage: no.
class APISetUserAutoAcceptMemberContacts(TypedDict):
userId: int # int64
onOff: bool
def APISetUserAutoAcceptMemberContacts_cmd_string(self: APISetUserAutoAcceptMemberContacts) -> str:
return '/_set accept member contacts ' + str(self['userId']) + ' ' + ('on' if self['onOff'] else 'off')
APISetUserAutoAcceptMemberContacts_Response = CR.CmdOk | CR.ChatCmdError
# User profile commands
# Most bots don't need to use these commands, as bot profile can be configured manually via CLI or desktop client. These commands can be used by bots that need to manage multiple user profiles (e.g., the profiles of support agents).
# Get active user profile.
# Network usage: no.
class ShowActiveUser(TypedDict):
pass
def ShowActiveUser_cmd_string(self: ShowActiveUser) -> str:
return '/user'
ShowActiveUser_Response = CR.ActiveUser | CR.ChatCmdError
# Create new user profile.
# Network usage: no.
class CreateActiveUser(TypedDict):
newUser: "T.NewUser"
def CreateActiveUser_cmd_string(self: CreateActiveUser) -> str:
return '/_create user ' + json.dumps(self['newUser'])
CreateActiveUser_Response = CR.ActiveUser | CR.ChatCmdError
# Get all user profiles.
# Network usage: no.
class ListUsers(TypedDict):
pass
def ListUsers_cmd_string(self: ListUsers) -> str:
return '/users'
ListUsers_Response = CR.UsersList | CR.ChatCmdError
# Set active user profile.
# Network usage: no.
class APISetActiveUser(TypedDict):
userId: int # int64
viewPwd: NotRequired[str]
def APISetActiveUser_cmd_string(self: APISetActiveUser) -> str:
return '/_user ' + str(self['userId']) + ((' ' + json.dumps(self.get('viewPwd'))) if self.get('viewPwd') is not None else '')
APISetActiveUser_Response = CR.ActiveUser | CR.ChatCmdError
# Delete user profile.
# Network usage: background.
class APIDeleteUser(TypedDict):
userId: int # int64
delSMPQueues: bool
viewPwd: NotRequired[str]
def APIDeleteUser_cmd_string(self: APIDeleteUser) -> str:
return '/_delete user ' + str(self['userId']) + ' del_smp=' + ('on' if self['delSMPQueues'] else 'off') + ((' ' + json.dumps(self.get('viewPwd'))) if self.get('viewPwd') is not None else '')
APIDeleteUser_Response = CR.CmdOk | CR.ChatCmdError
# Update user profile.
# Network usage: background.
class APIUpdateProfile(TypedDict):
userId: int # int64
profile: "T.Profile"
def APIUpdateProfile_cmd_string(self: APIUpdateProfile) -> str:
return '/_profile ' + str(self['userId']) + ' ' + json.dumps(self['profile'])
APIUpdateProfile_Response = CR.UserProfileUpdated | CR.UserProfileNoChange | CR.ChatCmdError
# Configure chat preference overrides for the contact.
# Network usage: background.
class APISetContactPrefs(TypedDict):
contactId: int # int64
preferences: "T.Preferences"
def APISetContactPrefs_cmd_string(self: APISetContactPrefs) -> str:
return '/_set prefs @' + str(self['contactId']) + ' ' + json.dumps(self['preferences'])
APISetContactPrefs_Response = CR.ContactPrefsUpdated | CR.ChatCmdError
# Chat management
# These commands should not be used with CLI-based bots
# Start chat controller.
# Network usage: no.
class StartChat(TypedDict):
mainApp: bool
enableSndFiles: bool
def StartChat_cmd_string(self: StartChat) -> str:
return '/_start'
StartChat_Response = CR.ChatStarted | CR.ChatRunning
# Stop chat controller.
# Network usage: no.
class APIStopChat(TypedDict):
pass
def APIStopChat_cmd_string(self: APIStopChat) -> str:
return '/_stop'
APIStopChat_Response = CR.ChatStopped
packages/simplex-chat-python/src/simplex_chat/types/_events.py
+379
View File
@@ -0,0 +1,379 @@
# API Events
# This file is generated automatically.
from __future__ import annotations
from typing import Literal, NotRequired, TypedDict
from . import _types as T
class ContactConnected(TypedDict):
type: Literal["contactConnected"]
user: "T.User"
contact: "T.Contact"
userCustomProfile: NotRequired["T.Profile"]
class ContactUpdated(TypedDict):
type: Literal["contactUpdated"]
user: "T.User"
fromContact: "T.Contact"
toContact: "T.Contact"
class ContactDeletedByContact(TypedDict):
type: Literal["contactDeletedByContact"]
user: "T.User"
contact: "T.Contact"
class ReceivedContactRequest(TypedDict):
type: Literal["receivedContactRequest"]
user: "T.User"
contactRequest: "T.UserContactRequest"
chat_: NotRequired["T.AChat"]
class NewMemberContactReceivedInv(TypedDict):
type: Literal["newMemberContactReceivedInv"]
user: "T.User"
contact: "T.Contact"
groupInfo: "T.GroupInfo"
member: "T.GroupMember"
class ContactSndReady(TypedDict):
type: Literal["contactSndReady"]
user: "T.User"
contact: "T.Contact"
class NewChatItems(TypedDict):
type: Literal["newChatItems"]
user: "T.User"
chatItems: list["T.AChatItem"]
class ChatItemReaction(TypedDict):
type: Literal["chatItemReaction"]
user: "T.User"
added: bool
reaction: "T.ACIReaction"
class ChatItemsDeleted(TypedDict):
type: Literal["chatItemsDeleted"]
user: "T.User"
chatItemDeletions: list["T.ChatItemDeletion"]
byUser: bool
timed: bool
class ChatItemUpdated(TypedDict):
type: Literal["chatItemUpdated"]
user: "T.User"
chatItem: "T.AChatItem"
class GroupChatItemsDeleted(TypedDict):
type: Literal["groupChatItemsDeleted"]
user: "T.User"
groupInfo: "T.GroupInfo"
chatItemIDs: list[int] # int64
byUser: bool
member_: NotRequired["T.GroupMember"]
class ChatItemsStatusesUpdated(TypedDict):
type: Literal["chatItemsStatusesUpdated"]
user: "T.User"
chatItems: list["T.AChatItem"]
class ReceivedGroupInvitation(TypedDict):
type: Literal["receivedGroupInvitation"]
user: "T.User"
groupInfo: "T.GroupInfo"
contact: "T.Contact"
fromMemberRole: "T.GroupMemberRole"
memberRole: "T.GroupMemberRole"
class UserJoinedGroup(TypedDict):
type: Literal["userJoinedGroup"]
user: "T.User"
groupInfo: "T.GroupInfo"
hostMember: "T.GroupMember"
class GroupUpdated(TypedDict):
type: Literal["groupUpdated"]
user: "T.User"
fromGroup: "T.GroupInfo"
toGroup: "T.GroupInfo"
member_: NotRequired["T.GroupMember"]
msgSigned: NotRequired["T.MsgSigStatus"]
class JoinedGroupMember(TypedDict):
type: Literal["joinedGroupMember"]
user: "T.User"
groupInfo: "T.GroupInfo"
member: "T.GroupMember"
class MemberRole(TypedDict):
type: Literal["memberRole"]
user: "T.User"
groupInfo: "T.GroupInfo"
byMember: "T.GroupMember"
member: "T.GroupMember"
fromRole: "T.GroupMemberRole"
toRole: "T.GroupMemberRole"
msgSigned: NotRequired["T.MsgSigStatus"]
class DeletedMember(TypedDict):
type: Literal["deletedMember"]
user: "T.User"
groupInfo: "T.GroupInfo"
byMember: "T.GroupMember"
deletedMember: "T.GroupMember"
withMessages: bool
msgSigned: NotRequired["T.MsgSigStatus"]
class LeftMember(TypedDict):
type: Literal["leftMember"]
user: "T.User"
groupInfo: "T.GroupInfo"
member: "T.GroupMember"
msgSigned: NotRequired["T.MsgSigStatus"]
class DeletedMemberUser(TypedDict):
type: Literal["deletedMemberUser"]
user: "T.User"
groupInfo: "T.GroupInfo"
member: "T.GroupMember"
withMessages: bool
msgSigned: NotRequired["T.MsgSigStatus"]
class GroupDeleted(TypedDict):
type: Literal["groupDeleted"]
user: "T.User"
groupInfo: "T.GroupInfo"
member: "T.GroupMember"
msgSigned: NotRequired["T.MsgSigStatus"]
class ConnectedToGroupMember(TypedDict):
type: Literal["connectedToGroupMember"]
user: "T.User"
groupInfo: "T.GroupInfo"
member: "T.GroupMember"
memberContact: NotRequired["T.Contact"]
class MemberAcceptedByOther(TypedDict):
type: Literal["memberAcceptedByOther"]
user: "T.User"
groupInfo: "T.GroupInfo"
acceptingMember: "T.GroupMember"
member: "T.GroupMember"
class MemberBlockedForAll(TypedDict):
type: Literal["memberBlockedForAll"]
user: "T.User"
groupInfo: "T.GroupInfo"
byMember: "T.GroupMember"
member: "T.GroupMember"
blocked: bool
msgSigned: NotRequired["T.MsgSigStatus"]
class GroupMemberUpdated(TypedDict):
type: Literal["groupMemberUpdated"]
user: "T.User"
groupInfo: "T.GroupInfo"
fromMember: "T.GroupMember"
toMember: "T.GroupMember"
class GroupLinkDataUpdated(TypedDict):
type: Literal["groupLinkDataUpdated"]
user: "T.User"
groupInfo: "T.GroupInfo"
groupLink: "T.GroupLink"
groupRelays: list["T.GroupRelay"]
relaysChanged: bool
class GroupRelayUpdated(TypedDict):
type: Literal["groupRelayUpdated"]
user: "T.User"
groupInfo: "T.GroupInfo"
member: "T.GroupMember"
groupRelay: "T.GroupRelay"
class RcvFileDescrReady(TypedDict):
type: Literal["rcvFileDescrReady"]
user: "T.User"
chatItem: "T.AChatItem"
rcvFileTransfer: "T.RcvFileTransfer"
rcvFileDescr: "T.RcvFileDescr"
class RcvFileComplete(TypedDict):
type: Literal["rcvFileComplete"]
user: "T.User"
chatItem: "T.AChatItem"
class SndFileCompleteXFTP(TypedDict):
type: Literal["sndFileCompleteXFTP"]
user: "T.User"
chatItem: "T.AChatItem"
fileTransferMeta: "T.FileTransferMeta"
class RcvFileStart(TypedDict):
type: Literal["rcvFileStart"]
user: "T.User"
chatItem: "T.AChatItem"
class RcvFileSndCancelled(TypedDict):
type: Literal["rcvFileSndCancelled"]
user: "T.User"
chatItem: "T.AChatItem"
rcvFileTransfer: "T.RcvFileTransfer"
class RcvFileAccepted(TypedDict):
type: Literal["rcvFileAccepted"]
user: "T.User"
chatItem: "T.AChatItem"
class RcvFileError(TypedDict):
type: Literal["rcvFileError"]
user: "T.User"
chatItem_: NotRequired["T.AChatItem"]
agentError: "T.AgentErrorType"
rcvFileTransfer: "T.RcvFileTransfer"
class RcvFileWarning(TypedDict):
type: Literal["rcvFileWarning"]
user: "T.User"
chatItem_: NotRequired["T.AChatItem"]
agentError: "T.AgentErrorType"
rcvFileTransfer: "T.RcvFileTransfer"
class SndFileError(TypedDict):
type: Literal["sndFileError"]
user: "T.User"
chatItem_: NotRequired["T.AChatItem"]
fileTransferMeta: "T.FileTransferMeta"
errorMessage: str
class SndFileWarning(TypedDict):
type: Literal["sndFileWarning"]
user: "T.User"
chatItem_: NotRequired["T.AChatItem"]
fileTransferMeta: "T.FileTransferMeta"
errorMessage: str
class AcceptingContactRequest(TypedDict):
type: Literal["acceptingContactRequest"]
user: "T.User"
contact: "T.Contact"
class AcceptingBusinessRequest(TypedDict):
type: Literal["acceptingBusinessRequest"]
user: "T.User"
groupInfo: "T.GroupInfo"
class ContactConnecting(TypedDict):
type: Literal["contactConnecting"]
user: "T.User"
contact: "T.Contact"
class BusinessLinkConnecting(TypedDict):
type: Literal["businessLinkConnecting"]
user: "T.User"
groupInfo: "T.GroupInfo"
hostMember: "T.GroupMember"
fromContact: "T.Contact"
class JoinedGroupMemberConnecting(TypedDict):
type: Literal["joinedGroupMemberConnecting"]
user: "T.User"
groupInfo: "T.GroupInfo"
hostMember: "T.GroupMember"
member: "T.GroupMember"
class SentGroupInvitation(TypedDict):
type: Literal["sentGroupInvitation"]
user: "T.User"
groupInfo: "T.GroupInfo"
contact: "T.Contact"
member: "T.GroupMember"
class GroupLinkConnecting(TypedDict):
type: Literal["groupLinkConnecting"]
user: "T.User"
groupInfo: "T.GroupInfo"
hostMember: "T.GroupMember"
class HostConnected(TypedDict):
type: Literal["hostConnected"]
protocol: str
transportHost: str
class HostDisconnected(TypedDict):
type: Literal["hostDisconnected"]
protocol: str
transportHost: str
class SubscriptionStatus(TypedDict):
type: Literal["subscriptionStatus"]
server: str
subscriptionStatus: "T.SubscriptionStatus"
connections: list[str]
class MessageError(TypedDict):
type: Literal["messageError"]
user: "T.User"
severity: str
errorMessage: str
class ChatError(TypedDict):
type: Literal["chatError"]
chatError: "T.ChatError"
class ChatErrors(TypedDict):
type: Literal["chatErrors"]
chatErrors: list["T.ChatError"]
ChatEvent = (
ContactConnected
| ContactUpdated
| ContactDeletedByContact
| ReceivedContactRequest
| NewMemberContactReceivedInv
| ContactSndReady
| NewChatItems
| ChatItemReaction
| ChatItemsDeleted
| ChatItemUpdated
| GroupChatItemsDeleted
| ChatItemsStatusesUpdated
| ReceivedGroupInvitation
| UserJoinedGroup
| GroupUpdated
| JoinedGroupMember
| MemberRole
| DeletedMember
| LeftMember
| DeletedMemberUser
| GroupDeleted
| ConnectedToGroupMember
| MemberAcceptedByOther
| MemberBlockedForAll
| GroupMemberUpdated
| GroupLinkDataUpdated
| GroupRelayUpdated
| RcvFileDescrReady
| RcvFileComplete
| SndFileCompleteXFTP
| RcvFileStart
| RcvFileSndCancelled
| RcvFileAccepted
| RcvFileError
| RcvFileWarning
| SndFileError
| SndFileWarning
| AcceptingContactRequest
| AcceptingBusinessRequest
| ContactConnecting
| BusinessLinkConnecting
| JoinedGroupMemberConnecting
| SentGroupInvitation
| GroupLinkConnecting
| HostConnected
| HostDisconnected
| SubscriptionStatus
| MessageError
| ChatError
| ChatErrors
)
ChatEvent_Tag = Literal["contactConnected", "contactUpdated", "contactDeletedByContact", "receivedContactRequest", "newMemberContactReceivedInv", "contactSndReady", "newChatItems", "chatItemReaction", "chatItemsDeleted", "chatItemUpdated", "groupChatItemsDeleted", "chatItemsStatusesUpdated", "receivedGroupInvitation", "userJoinedGroup", "groupUpdated", "joinedGroupMember", "memberRole", "deletedMember", "leftMember", "deletedMemberUser", "groupDeleted", "connectedToGroupMember", "memberAcceptedByOther", "memberBlockedForAll", "groupMemberUpdated", "groupLinkDataUpdated", "groupRelayUpdated", "rcvFileDescrReady", "rcvFileComplete", "sndFileCompleteXFTP", "rcvFileStart", "rcvFileSndCancelled", "rcvFileAccepted", "rcvFileError", "rcvFileWarning", "sndFileError", "sndFileWarning", "acceptingContactRequest", "acceptingBusinessRequest", "contactConnecting", "businessLinkConnecting", "joinedGroupMemberConnecting", "sentGroupInvitation", "groupLinkConnecting", "hostConnected", "hostDisconnected", "subscriptionStatus", "messageError", "chatError", "chatErrors"]
packages/simplex-chat-python/src/simplex_chat/types/_responses.py
+360
View File
@@ -0,0 +1,360 @@
# API Responses
# This file is generated automatically.
from __future__ import annotations
from typing import Literal, NotRequired, TypedDict
from . import _types as T
class AcceptingContactRequest(TypedDict):
type: Literal["acceptingContactRequest"]
user: "T.User"
contact: "T.Contact"
class ActiveUser(TypedDict):
type: Literal["activeUser"]
user: "T.User"
class ChatItemNotChanged(TypedDict):
type: Literal["chatItemNotChanged"]
user: "T.User"
chatItem: "T.AChatItem"
class ChatItemReaction(TypedDict):
type: Literal["chatItemReaction"]
user: "T.User"
added: bool
reaction: "T.ACIReaction"
class ChatItemUpdated(TypedDict):
type: Literal["chatItemUpdated"]
user: "T.User"
chatItem: "T.AChatItem"
class ChatItemsDeleted(TypedDict):
type: Literal["chatItemsDeleted"]
user: "T.User"
chatItemDeletions: list["T.ChatItemDeletion"]
byUser: bool
timed: bool
class ChatRunning(TypedDict):
type: Literal["chatRunning"]
class ChatStarted(TypedDict):
type: Literal["chatStarted"]
class ChatStopped(TypedDict):
type: Literal["chatStopped"]
class CmdOk(TypedDict):
type: Literal["cmdOk"]
user_: NotRequired["T.User"]
class ChatCmdError(TypedDict):
type: Literal["chatCmdError"]
chatError: "T.ChatError"
class ConnectionPlan(TypedDict):
type: Literal["connectionPlan"]
user: "T.User"
connLink: "T.CreatedConnLink"
connectionPlan: "T.ConnectionPlan"
class ContactAlreadyExists(TypedDict):
type: Literal["contactAlreadyExists"]
user: "T.User"
contact: "T.Contact"
class ContactConnectionDeleted(TypedDict):
type: Literal["contactConnectionDeleted"]
user: "T.User"
connection: "T.PendingContactConnection"
class ContactDeleted(TypedDict):
type: Literal["contactDeleted"]
user: "T.User"
contact: "T.Contact"
class ContactPrefsUpdated(TypedDict):
type: Literal["contactPrefsUpdated"]
user: "T.User"
fromContact: "T.Contact"
toContact: "T.Contact"
class ContactRequestRejected(TypedDict):
type: Literal["contactRequestRejected"]
user: "T.User"
contactRequest: "T.UserContactRequest"
contact_: NotRequired["T.Contact"]
class ContactsList(TypedDict):
type: Literal["contactsList"]
user: "T.User"
contacts: list["T.Contact"]
class GroupDeletedUser(TypedDict):
type: Literal["groupDeletedUser"]
user: "T.User"
groupInfo: "T.GroupInfo"
msgSigned: bool
class GroupLink(TypedDict):
type: Literal["groupLink"]
user: "T.User"
groupInfo: "T.GroupInfo"
groupLink: "T.GroupLink"
class GroupLinkCreated(TypedDict):
type: Literal["groupLinkCreated"]
user: "T.User"
groupInfo: "T.GroupInfo"
groupLink: "T.GroupLink"
class GroupLinkDeleted(TypedDict):
type: Literal["groupLinkDeleted"]
user: "T.User"
groupInfo: "T.GroupInfo"
class GroupCreated(TypedDict):
type: Literal["groupCreated"]
user: "T.User"
groupInfo: "T.GroupInfo"
class PublicGroupCreated(TypedDict):
type: Literal["publicGroupCreated"]
user: "T.User"
groupInfo: "T.GroupInfo"
groupLink: "T.GroupLink"
groupRelays: list["T.GroupRelay"]
class PublicGroupCreationFailed(TypedDict):
type: Literal["publicGroupCreationFailed"]
user: "T.User"
addRelayResults: list["T.AddRelayResult"]
class GroupRelays(TypedDict):
type: Literal["groupRelays"]
user: "T.User"
groupInfo: "T.GroupInfo"
groupRelays: list["T.GroupRelay"]
class GroupRelaysAdded(TypedDict):
type: Literal["groupRelaysAdded"]
user: "T.User"
groupInfo: "T.GroupInfo"
groupLink: "T.GroupLink"
groupRelays: list["T.GroupRelay"]
class GroupRelaysAddFailed(TypedDict):
type: Literal["groupRelaysAddFailed"]
user: "T.User"
addRelayResults: list["T.AddRelayResult"]
class GroupMembers(TypedDict):
type: Literal["groupMembers"]
user: "T.User"
group: "T.Group"
class GroupUpdated(TypedDict):
type: Literal["groupUpdated"]
user: "T.User"
fromGroup: "T.GroupInfo"
toGroup: "T.GroupInfo"
member_: NotRequired["T.GroupMember"]
msgSigned: bool
class GroupsList(TypedDict):
type: Literal["groupsList"]
user: "T.User"
groups: list["T.GroupInfo"]
class Invitation(TypedDict):
type: Literal["invitation"]
user: "T.User"
connLinkInvitation: "T.CreatedConnLink"
connection: "T.PendingContactConnection"
class LeftMemberUser(TypedDict):
type: Literal["leftMemberUser"]
user: "T.User"
groupInfo: "T.GroupInfo"
class MemberAccepted(TypedDict):
type: Literal["memberAccepted"]
user: "T.User"
groupInfo: "T.GroupInfo"
member: "T.GroupMember"
class MembersBlockedForAllUser(TypedDict):
type: Literal["membersBlockedForAllUser"]
user: "T.User"
groupInfo: "T.GroupInfo"
members: list["T.GroupMember"]
blocked: bool
msgSigned: bool
class MembersRoleUser(TypedDict):
type: Literal["membersRoleUser"]
user: "T.User"
groupInfo: "T.GroupInfo"
members: list["T.GroupMember"]
toRole: "T.GroupMemberRole"
msgSigned: bool
class NewChatItems(TypedDict):
type: Literal["newChatItems"]
user: "T.User"
chatItems: list["T.AChatItem"]
class RcvFileAccepted(TypedDict):
type: Literal["rcvFileAccepted"]
user: "T.User"
chatItem: "T.AChatItem"
class RcvFileAcceptedSndCancelled(TypedDict):
type: Literal["rcvFileAcceptedSndCancelled"]
user: "T.User"
rcvFileTransfer: "T.RcvFileTransfer"
class RcvFileCancelled(TypedDict):
type: Literal["rcvFileCancelled"]
user: "T.User"
chatItem_: NotRequired["T.AChatItem"]
rcvFileTransfer: "T.RcvFileTransfer"
class SentConfirmation(TypedDict):
type: Literal["sentConfirmation"]
user: "T.User"
connection: "T.PendingContactConnection"
customUserProfile: NotRequired["T.Profile"]
class SentGroupInvitation(TypedDict):
type: Literal["sentGroupInvitation"]
user: "T.User"
groupInfo: "T.GroupInfo"
contact: "T.Contact"
member: "T.GroupMember"
class SentInvitation(TypedDict):
type: Literal["sentInvitation"]
user: "T.User"
connection: "T.PendingContactConnection"
customUserProfile: NotRequired["T.Profile"]
class SndFileCancelled(TypedDict):
type: Literal["sndFileCancelled"]
user: "T.User"
chatItem_: NotRequired["T.AChatItem"]
fileTransferMeta: "T.FileTransferMeta"
sndFileTransfers: list["T.SndFileTransfer"]
class UserAcceptedGroupSent(TypedDict):
type: Literal["userAcceptedGroupSent"]
user: "T.User"
groupInfo: "T.GroupInfo"
hostContact: NotRequired["T.Contact"]
class UserContactLink(TypedDict):
type: Literal["userContactLink"]
user: "T.User"
contactLink: "T.UserContactLink"
class UserContactLinkCreated(TypedDict):
type: Literal["userContactLinkCreated"]
user: "T.User"
connLinkContact: "T.CreatedConnLink"
class UserContactLinkDeleted(TypedDict):
type: Literal["userContactLinkDeleted"]
user: "T.User"
class UserContactLinkUpdated(TypedDict):
type: Literal["userContactLinkUpdated"]
user: "T.User"
contactLink: "T.UserContactLink"
class UserDeletedMembers(TypedDict):
type: Literal["userDeletedMembers"]
user: "T.User"
groupInfo: "T.GroupInfo"
members: list["T.GroupMember"]
withMessages: bool
msgSigned: bool
class UserProfileUpdated(TypedDict):
type: Literal["userProfileUpdated"]
user: "T.User"
fromProfile: "T.Profile"
toProfile: "T.Profile"
updateSummary: "T.UserProfileUpdateSummary"
class UserProfileNoChange(TypedDict):
type: Literal["userProfileNoChange"]
user: "T.User"
class UsersList(TypedDict):
type: Literal["usersList"]
users: list["T.UserInfo"]
class ApiChats(TypedDict):
type: Literal["apiChats"]
user: "T.User"
chats: list["T.AChat"]
ChatResponse = (
AcceptingContactRequest
| ActiveUser
| ChatItemNotChanged
| ChatItemReaction
| ChatItemUpdated
| ChatItemsDeleted
| ChatRunning
| ChatStarted
| ChatStopped
| CmdOk
| ChatCmdError
| ConnectionPlan
| ContactAlreadyExists
| ContactConnectionDeleted
| ContactDeleted
| ContactPrefsUpdated
| ContactRequestRejected
| ContactsList
| GroupDeletedUser
| GroupLink
| GroupLinkCreated
| GroupLinkDeleted
| GroupCreated
| PublicGroupCreated
| PublicGroupCreationFailed
| GroupRelays
| GroupRelaysAdded
| GroupRelaysAddFailed
| GroupMembers
| GroupUpdated
| GroupsList
| Invitation
| LeftMemberUser
| MemberAccepted
| MembersBlockedForAllUser
| MembersRoleUser
| NewChatItems
| RcvFileAccepted
| RcvFileAcceptedSndCancelled
| RcvFileCancelled
| SentConfirmation
| SentGroupInvitation
| SentInvitation
| SndFileCancelled
| UserAcceptedGroupSent
| UserContactLink
| UserContactLinkCreated
| UserContactLinkDeleted
| UserContactLinkUpdated
| UserDeletedMembers
| UserProfileUpdated
| UserProfileNoChange
| UsersList
| ApiChats
)
ChatResponse_Tag = Literal["acceptingContactRequest", "activeUser", "chatItemNotChanged", "chatItemReaction", "chatItemUpdated", "chatItemsDeleted", "chatRunning", "chatStarted", "chatStopped", "cmdOk", "chatCmdError", "connectionPlan", "contactAlreadyExists", "contactConnectionDeleted", "contactDeleted", "contactPrefsUpdated", "contactRequestRejected", "contactsList", "groupDeletedUser", "groupLink", "groupLinkCreated", "groupLinkDeleted", "groupCreated", "publicGroupCreated", "publicGroupCreationFailed", "groupRelays", "groupRelaysAdded", "groupRelaysAddFailed", "groupMembers", "groupUpdated", "groupsList", "invitation", "leftMemberUser", "memberAccepted", "membersBlockedForAllUser", "membersRoleUser", "newChatItems", "rcvFileAccepted", "rcvFileAcceptedSndCancelled", "rcvFileCancelled", "sentConfirmation", "sentGroupInvitation", "sentInvitation", "sndFileCancelled", "userAcceptedGroupSent", "userContactLink", "userContactLinkCreated", "userContactLinkDeleted", "userContactLinkUpdated", "userDeletedMembers", "userProfileUpdated", "userProfileNoChange", "usersList", "apiChats"]
packages/simplex-chat-python/src/simplex_chat/types/_types.py
+3506
View File
File diff suppressed because it is too large Load Diff
packages/simplex-chat-python/src/simplex_chat/util.py
+128
View File
@@ -0,0 +1,128 @@
"""Reusable helpers for working with chat events, types, and message content.
Mirrors the Node `util.ts` exports — provides the same primitives bot
authors typically reach for: command parsing, sender display strings,
message-content extraction, profile field cleanup, and ChatRef extraction
from a ChatInfo (handy when echoing into a different chat).
"""
from __future__ import annotations
import re
from typing import Any
from .types import T
def chat_info_ref(c_info: T.ChatInfo) -> T.ChatRef | None:
"""Extract a wire-format `ChatRef` from a `ChatInfo`.
Returns `None` for non-chat infos (contactRequest, contactConnection)
that can't be the target of `api_send_messages`. For groups, the
`memberSupport` scope is forwarded so messages land in the right
thread; other scopes are dropped (matches Node `util.chatInfoRef`).
"""
t = c_info["type"]
if t == "direct":
return {"chatType": "direct", "chatId": c_info["contact"]["contactId"]} # type: ignore[index]
if t == "group":
ref: T.ChatRef = {"chatType": "group", "chatId": c_info["groupInfo"]["groupId"]} # type: ignore[index]
scope = c_info.get("groupChatScope") # type: ignore[union-attr]
if scope and scope.get("type") == "memberSupport":
member = scope.get("groupMember_")
ms_scope: T.GroupChatScope_memberSupport = {"type": "memberSupport"}
if member is not None:
ms_scope["groupMemberId_"] = member["groupMemberId"]
ref["chatScope"] = ms_scope
return ref
return None
def chat_info_name(c_info: T.ChatInfo) -> str:
"""Display string for a chat: `@Alice`, `#GroupName`, `private notes`, etc."""
t = c_info["type"]
if t == "direct":
return f"@{c_info['contact']['profile']['displayName']}" # type: ignore[index]
if t == "group":
scope = c_info.get("groupChatScope") # type: ignore[union-attr]
if scope and scope.get("type") == "memberSupport":
member = scope.get("groupMember_")
scope_name = f" {member['memberProfile']['displayName']}" if member else ""
return f"#{c_info['groupInfo']['groupProfile']['displayName']}(support{scope_name})" # type: ignore[index]
return f"#{c_info['groupInfo']['groupProfile']['displayName']}" # type: ignore[index]
if t == "local":
return "private notes"
if t == "contactRequest":
return f"request from @{c_info['contactRequest']['profile']['displayName']}" # type: ignore[index]
if t == "contactConnection":
alias = c_info["contactConnection"].get("localAlias") # type: ignore[index]
return f"pending connection ({alias})" if alias else "pending connection"
return f"<{t}>"
def sender_name(c_info: T.ChatInfo, chat_dir: T.CIDirection) -> str:
"""Sender display: chat name plus group sender suffix when applicable."""
base = chat_info_name(c_info)
if chat_dir["type"] == "groupRcv":
sender = chat_dir["groupMember"]["memberProfile"]["displayName"] # type: ignore[index]
return f"{base} @{sender}"
return base
def contact_address_str(link: T.CreatedConnLink) -> str:
"""Prefer the short link, fall back to the full link."""
return link.get("connShortLink") or link["connFullLink"]
def from_local_profile(local: T.LocalProfile) -> T.Profile:
"""Strip extra LocalProfile fields (profileId, localAlias) and undefined values."""
p: dict[str, Any] = {}
for key in (
"displayName",
"fullName",
"shortDescr",
"image",
"contactLink",
"preferences",
"peerType",
):
v = local.get(key) # type: ignore[misc]
if v is not None:
p[key] = v
return p # type: ignore[return-value]
def ci_content_text(chat_item: T.ChatItem) -> str | None:
"""Extract the message text from a sent or received message item, if any."""
content = chat_item["content"]
if content["type"] in ("sndMsgContent", "rcvMsgContent"):
msg = content.get("msgContent", {}) # type: ignore[union-attr]
return msg.get("text")
return None
_BOT_COMMAND_RE = re.compile(r"^/([^\s]+)(.*)$")
def ci_bot_command(chat_item: T.ChatItem) -> tuple[str, str] | None:
"""Parse a `/keyword args...` slash-command from a chat item.
Returns `(keyword, trimmed_params)` or `None` if the message isn't a
slash command. Mirrors Node `util.ciBotCommand` semantics.
"""
text = ci_content_text(chat_item)
if not text:
return None
text = text.strip()
m = _BOT_COMMAND_RE.match(text)
if not m:
return None
return m.group(1), m.group(2).strip()
def reaction_text(reaction: T.ACIReaction) -> str:
"""Format an `ACIReaction` as the emoji character or tag string."""
r = reaction["chatReaction"]["reaction"] # type: ignore[index]
if r["type"] == "emoji":
return r["emoji"] # type: ignore[index]
return r.get("tag", "") # type: ignore[union-attr]
packages/simplex-chat-python/tests/test_bot_registration.py
+357
View File
@@ -0,0 +1,357 @@
import pytest
from simplex_chat import Bot, BotCommand, BotProfile, Middleware, SqliteDb
from simplex_chat.api import ChatApi
def _bot() -> Bot:
return Bot(profile=BotProfile(display_name="x"), db=SqliteDb(file_prefix="/tmp/test"))
def test_decorator_registers_message_handler():
bot = _bot()
@bot.on_message(content_type="text")
async def h(msg):
pass
assert len(bot._message_handlers) == 1
def test_decorator_registers_command_handler():
bot = _bot()
@bot.on_command("ping")
async def h(msg, cmd):
pass
assert len(bot._command_handlers) == 1
assert bot._command_handlers[0][0] == ("ping",)
def test_decorator_registers_event_handler():
bot = _bot()
@bot.on_event("newChatItems")
async def h(evt):
pass
assert "newChatItems" in bot._event_handlers
assert len(bot._event_handlers["newChatItems"]) == 1
def test_api_property_raises_before_init():
bot = _bot()
with pytest.raises(RuntimeError, match="not initialized"):
_ = bot.api
def test_command_keyword_tuple():
bot = _bot()
@bot.on_command(("p", "ping"))
async def h(msg, cmd):
pass
assert bot._command_handlers[0][0] == ("p", "ping")
def test_bot_profile_to_wire_default():
"""use_bot_profile=True (default) sets peerType=bot and disables calls/voice."""
bot = _bot()
p = bot._bot_profile_to_wire()
assert p["displayName"] == "x"
assert p.get("peerType") == "bot"
prefs = p.get("preferences") or {}
assert prefs.get("calls", {}).get("allow") == "no"
assert prefs.get("voice", {}).get("allow") == "no"
assert prefs.get("files", {}).get("allow") == "no" # allow_files defaults to False
def test_bot_profile_to_wire_allow_files():
bot = Bot(
profile=BotProfile(display_name="x"),
db=SqliteDb(file_prefix="/tmp/test"),
allow_files=True,
)
prefs = bot._bot_profile_to_wire().get("preferences") or {}
assert prefs.get("files", {}).get("allow") == "yes"
def test_bot_profile_to_wire_with_commands():
bot = Bot(
profile=BotProfile(display_name="x"),
db=SqliteDb(file_prefix="/tmp/test"),
commands=[BotCommand(keyword="ping", label="Ping bot"), BotCommand("help", "Show help")],
)
cmds = bot._bot_profile_to_wire().get("preferences", {}).get("commands") or []
assert len(cmds) == 2
assert cmds[0] == {"type": "command", "keyword": "ping", "label": "Ping bot"}
assert cmds[1] == {"type": "command", "keyword": "help", "label": "Show help"}
def test_bot_profile_to_wire_no_bot_profile():
bot = Bot(
profile=BotProfile(display_name="x"),
db=SqliteDb(file_prefix="/tmp/test"),
use_bot_profile=False,
)
p = bot._bot_profile_to_wire()
assert "peerType" not in p
assert "preferences" not in p
def test_commands_without_bot_profile_raises():
bot = Bot(
profile=BotProfile(display_name="x"),
db=SqliteDb(file_prefix="/tmp/test"),
use_bot_profile=False,
commands=[BotCommand("ping", "Ping bot")],
)
with pytest.raises(ValueError, match="use_bot_profile=False"):
bot._bot_profile_to_wire()
def test_dispatch_message_first_match_wins():
"""Two matching message handlers — only the first registered fires."""
import asyncio
import re
bot = _bot()
calls: list[str] = []
@bot.on_message(content_type="text", text=re.compile(r"^\d+$"))
async def number(_msg):
calls.append("number")
@bot.on_message(content_type="text")
async def fallback(_msg):
calls.append("fallback")
class M:
pass
m = M()
m.content = {"type": "text", "text": "42"}
m.chat_item = {
"chatItem": {
"content": {"type": "rcvMsgContent", "msgContent": {"type": "text", "text": "42"}}
},
"chatInfo": {"type": "direct"},
}
m.text = "42"
asyncio.run(bot._dispatch_message(m)) # type: ignore[arg-type]
assert calls == ["number"], f"expected only 'number' for '42', got {calls}"
def test_dispatch_message_falls_to_second_when_first_doesnt_match():
"""If the first handler's filter doesn't match, the second one fires."""
import asyncio
import re
bot = _bot()
calls: list[str] = []
@bot.on_message(content_type="text", text=re.compile(r"^\d+$"))
async def number(_msg):
calls.append("number")
@bot.on_message(content_type="text")
async def fallback(_msg):
calls.append("fallback")
class M:
pass
m = M()
m.content = {"type": "text", "text": "hello"}
m.chat_item = {
"chatItem": {
"content": {"type": "rcvMsgContent", "msgContent": {"type": "text", "text": "hello"}}
},
"chatInfo": {"type": "direct"},
}
m.text = "hello"
asyncio.run(bot._dispatch_message(m)) # type: ignore[arg-type]
assert calls == ["fallback"], f"expected 'fallback' for 'hello', got {calls}"
def test_register_log_handlers_idempotent():
"""Calling _register_log_handlers twice doesn't duplicate handlers."""
bot = Bot(
profile=BotProfile(display_name="x"),
db=SqliteDb(file_prefix="/tmp/test"),
log_contacts=True,
log_network=True,
)
bot._register_log_handlers()
counts1 = {tag: len(hs) for tag, hs in bot._event_handlers.items()}
bot._register_log_handlers()
counts2 = {tag: len(hs) for tag, hs in bot._event_handlers.items()}
assert counts1 == counts2, f"handler count changed across calls: {counts1} -> {counts2}"
def test_default_error_handlers_always_registered():
"""messageError/chatError/chatErrors get default loggers regardless of opts."""
bot = Bot(
profile=BotProfile(display_name="x"),
db=SqliteDb(file_prefix="/tmp/test"),
log_contacts=False,
log_network=False,
)
bot._register_log_handlers()
assert "messageError" in bot._event_handlers
assert "chatError" in bot._event_handlers
assert "chatErrors" in bot._event_handlers
def test_dispatch_command_suppresses_matching_message_handlers():
"""A `/help` message routed to a command handler must NOT also fire the
generic on_message text handler."""
import asyncio
bot = _bot()
calls: list[str] = []
@bot.on_message(content_type="text")
async def fallback(_msg):
calls.append("message")
@bot.on_command("help")
async def help_cmd(_msg, _cmd):
calls.append("command")
# Build a minimal Message-shaped object (handlers only inspect chat_item / text).
class M:
pass
m = M()
m.content = {"type": "text", "text": "/help"}
m.chat_item = {
"chatItem": {
"content": {
"type": "rcvMsgContent",
"msgContent": {"type": "text", "text": "/help"},
}
},
"chatInfo": {"type": "direct"},
}
m.text = "/help"
asyncio.run(bot._dispatch_message(m)) # type: ignore[arg-type]
assert calls == ["command"], f"expected only 'command' to fire for /help, got {calls}"
def test_dispatch_unknown_command_falls_through_to_message_handlers():
"""A `/unknown` slash-command with no handler should still fire on_message."""
import asyncio
bot = _bot()
calls: list[str] = []
@bot.on_message(content_type="text")
async def fallback(_msg):
calls.append("message")
@bot.on_command("help")
async def help_cmd(_msg, _cmd):
calls.append("command")
class M:
pass
m = M()
m.content = {"type": "text", "text": "/unknown"}
m.chat_item = {
"chatItem": {
"content": {
"type": "rcvMsgContent",
"msgContent": {"type": "text", "text": "/unknown"},
}
},
"chatInfo": {"type": "direct"},
}
m.text = "/unknown"
asyncio.run(bot._dispatch_message(m)) # type: ignore[arg-type]
assert calls == ["message"], f"expected message fallback to fire for /unknown, got {calls}"
def test_chat_api_status_properties():
"""`initialized` and `started` reflect lifecycle state without invoking the FFI."""
api = ChatApi(ctrl=12345)
assert api.initialized is True
assert api.started is False
assert api.ctrl == 12345
# Simulate close: ctrl wiped, both properties false.
api._ctrl = None
api._started = False
assert api.initialized is False
assert api.started is False
with pytest.raises(RuntimeError, match="not initialized"):
_ = api.ctrl
def test_log_contacts_registers_handlers():
bot = Bot(
profile=BotProfile(display_name="x"),
db=SqliteDb(file_prefix="/tmp/test"),
log_contacts=True,
log_network=False,
)
bot._register_log_handlers()
assert "contactConnected" in bot._event_handlers
assert "contactDeletedByContact" in bot._event_handlers
assert "hostConnected" not in bot._event_handlers
def test_log_network_registers_handlers():
bot = Bot(
profile=BotProfile(display_name="x"),
db=SqliteDb(file_prefix="/tmp/test"),
log_contacts=False,
log_network=True,
)
bot._register_log_handlers()
assert "hostConnected" in bot._event_handlers
assert "hostDisconnected" in bot._event_handlers
assert "subscriptionStatus" in bot._event_handlers
assert "contactConnected" not in bot._event_handlers
def test_middleware_registration_and_invocation_order():
"""Middleware registered first wraps middleware registered later (outer first)."""
bot = _bot()
calls: list[str] = []
class Outer(Middleware):
async def __call__(self, handler, message, data):
calls.append("outer-before")
await handler(message, data)
calls.append("outer-after")
class Inner(Middleware):
async def __call__(self, handler, message, data):
calls.append("inner-before")
await handler(message, data)
calls.append("inner-after")
bot.use(Outer())
bot.use(Inner())
assert len(bot._middleware) == 2
async def handler(msg):
calls.append("handler")
import asyncio
asyncio.run(bot._invoke_with_middleware(handler, message=object())) # type: ignore[arg-type]
assert calls == [
"outer-before",
"inner-before",
"handler",
"inner-after",
"outer-after",
]
packages/simplex-chat-python/tests/test_codegen.py
+41
View File
@@ -0,0 +1,41 @@
"""Sanity checks on auto-generated wire types — catches generator regressions."""
import typing
from simplex_chat.types import CC, CEvt, CR, T
def test_types_module_imports():
"""Every generated module imports cleanly with no SyntaxError."""
assert T is not None and CC is not None and CR is not None and CEvt is not None
def test_chat_type_is_literal_enum():
"""ChatType should be a Literal of expected member set."""
args = typing.get_args(T.ChatType)
assert "direct" in args
assert "group" in args
assert "local" in args
def test_known_command_has_cmd_string():
s = CC.APICreateMyAddress_cmd_string({"userId": 1})
assert s == "/_address 1"
def test_chat_response_tag_alias_present():
"""ChatResponse_Tag union of literals exists."""
assert hasattr(CR, "ChatResponse_Tag")
def test_chat_event_tag_alias_present():
"""ChatEvent_Tag exists; covers the on_event Literal annotation."""
assert hasattr(CEvt, "ChatEvent_Tag")
args = typing.get_args(CEvt.ChatEvent_Tag)
assert "newChatItems" in args
def test_chat_ref_cmd_string_direct():
"""Sanity check the codegen fix for ChatRef-bearing commands."""
assert T.ChatRef_cmd_string({"chatType": "direct", "chatId": 7}) == "@7"
assert T.ChatRef_cmd_string({"chatType": "group", "chatId": 42}) == "#42"
packages/simplex-chat-python/tests/test_filters.py
+83
View File
@@ -0,0 +1,83 @@
import re
from simplex_chat.filters import compile_message_filter
def _msg(content_type="text", text=None, chat_type="direct", group_id=None):
"""Build a minimal mock Message-like object for filter testing."""
class M:
pass
m = M()
m.content = {"type": content_type, "text": text} if text is not None else {"type": content_type}
m.chat_item = {
"chatInfo": {
"type": chat_type,
**({"groupInfo": {"groupId": group_id}} if chat_type == "group" else {}),
}
}
return m
def test_no_filters_matches_all():
f = compile_message_filter({})
assert f(_msg(content_type="text"))
assert f(_msg(content_type="image"))
def test_content_type_singular():
f = compile_message_filter({"content_type": "text"})
assert f(_msg(content_type="text"))
assert not f(_msg(content_type="image"))
def test_content_type_tuple_or():
f = compile_message_filter({"content_type": ("text", "image")})
assert f(_msg(content_type="text"))
assert f(_msg(content_type="image"))
assert not f(_msg(content_type="voice"))
def test_text_exact():
f = compile_message_filter({"text": "hello"})
assert f(_msg(text="hello"))
assert not f(_msg(text="world"))
def test_text_regex():
f = compile_message_filter({"text": re.compile(r"^\d+$")})
assert f(_msg(text="123"))
assert not f(_msg(text="abc"))
def test_when_callable():
f = compile_message_filter({"when": lambda m: m.content["type"] == "voice"})
assert f(_msg(content_type="voice"))
assert not f(_msg(content_type="text"))
def test_combined_and():
f = compile_message_filter({"content_type": "text", "text": re.compile(r"\d")})
assert f(_msg(content_type="text", text="abc123"))
assert not f(_msg(content_type="text", text="abc"))
assert not f(_msg(content_type="image"))
def test_chat_type_filter():
f = compile_message_filter({"chat_type": "group"})
assert f(_msg(chat_type="group", group_id=1))
assert not f(_msg(chat_type="direct"))
def test_group_id_filter():
f = compile_message_filter({"group_id": 42})
assert f(_msg(chat_type="group", group_id=42))
assert not f(_msg(chat_type="group", group_id=99))
assert not f(_msg(chat_type="direct"))
def test_group_id_tuple_or():
f = compile_message_filter({"group_id": (1, 2, 3)})
assert f(_msg(chat_type="group", group_id=2))
assert not f(_msg(chat_type="group", group_id=99))
packages/simplex-chat-python/tests/test_native_cache.py
+92
View File
@@ -0,0 +1,92 @@
import zipfile
from pathlib import Path
import pytest
from simplex_chat._native import _cache_root, _resolve_libs_dir, _download
def test_cache_root_linux(tmp_path, monkeypatch):
monkeypatch.setenv("XDG_CACHE_HOME", str(tmp_path))
monkeypatch.setattr("sys.platform", "linux")
assert _cache_root() == tmp_path / "simplex-chat"
def test_cache_root_macos(tmp_path, monkeypatch):
monkeypatch.setattr("sys.platform", "darwin")
monkeypatch.setattr("pathlib.Path.home", lambda: tmp_path)
assert _cache_root() == tmp_path / "Library" / "Caches" / "simplex-chat"
def test_override_via_env(tmp_path, monkeypatch):
# _resolve_libs_dir intentionally does not validate the override directory —
# it returns it verbatim; the eventual ctypes.CDLL call surfaces any mistake.
monkeypatch.setenv("SIMPLEX_LIBS_DIR", str(tmp_path))
monkeypatch.setattr("sys.platform", "linux")
assert _resolve_libs_dir("sqlite") == tmp_path
def test_resolve_downloads_when_missing(tmp_path, monkeypatch):
monkeypatch.setenv("XDG_CACHE_HOME", str(tmp_path))
monkeypatch.setattr("sys.platform", "linux")
monkeypatch.setattr("simplex_chat._native._platform_tag", lambda: "linux-x86_64")
called = {}
def fake_download(target_root: Path, backend: str) -> None:
called["target"] = target_root
called["backend"] = backend
target_root.mkdir(parents=True, exist_ok=True)
(target_root / "libsimplex.so").touch()
monkeypatch.setattr("simplex_chat._native._download", fake_download)
libs_dir = _resolve_libs_dir("sqlite")
assert libs_dir == tmp_path / "simplex-chat" / "v6.5.1" / "sqlite"
assert called["backend"] == "sqlite"
assert (libs_dir / "libsimplex.so").exists()
def test_resolve_uses_cache_on_second_call(tmp_path, monkeypatch):
monkeypatch.setenv("XDG_CACHE_HOME", str(tmp_path))
monkeypatch.setattr("sys.platform", "linux")
cached = tmp_path / "simplex-chat" / "v6.5.1" / "sqlite"
cached.mkdir(parents=True)
(cached / "libsimplex.so").touch()
# Should NOT call _download — use the cached file.
monkeypatch.setattr(
"simplex_chat._native._download", lambda *a: pytest.fail("download should not be called")
)
assert _resolve_libs_dir("sqlite") == cached
def test_postgres_on_macos_rejected(monkeypatch):
monkeypatch.setattr("sys.platform", "darwin")
monkeypatch.setattr("simplex_chat._native._platform_tag", lambda: "macos-aarch64")
with pytest.raises(RuntimeError, match="postgres.*linux-x86_64"):
_resolve_libs_dir("postgres")
def test_atomic_install(tmp_path, monkeypatch):
"""Build a fake libs zip, mock _stream_to_file, verify extraction + atomic rename."""
# Build zip: libs/libsimplex.so + libs/libHS-stub.so
src = tmp_path / "src" / "libs"
src.mkdir(parents=True)
(src / "libsimplex.so").write_text("fake-so")
(src / "libHS-stub.so").write_text("fake-hs")
zip_path = tmp_path / "fake-libs.zip"
with zipfile.ZipFile(zip_path, "w") as zf:
for f in src.iterdir():
zf.write(f, f"libs/{f.name}")
def fake_stream(url, dest, *, timeout=60.0):
import shutil
shutil.copy(zip_path, dest)
monkeypatch.setattr("simplex_chat._native._stream_to_file", fake_stream)
monkeypatch.setattr("simplex_chat._native._platform_tag", lambda: "linux-x86_64")
target = tmp_path / "out"
_download(target, "sqlite")
assert (target / "libsimplex.so").read_text() == "fake-so"
assert (target / "libHS-stub.so").read_text() == "fake-hs"
packages/simplex-chat-python/tests/test_native_url.py
+55
View File
@@ -0,0 +1,55 @@
from unittest.mock import patch
import pytest
from simplex_chat._native import _platform_tag, _libs_url, _libname
@patch("sys.platform", "linux")
@patch("platform.machine", return_value="x86_64")
def test_platform_linux_x64(_):
assert _platform_tag() == "linux-x86_64"
@patch("sys.platform", "darwin")
@patch("platform.machine", return_value="arm64")
def test_platform_macos_arm64(_):
assert _platform_tag() == "macos-aarch64"
@patch("sys.platform", "win32")
@patch("platform.machine", return_value="AMD64")
def test_platform_windows_x64(_):
assert _platform_tag() == "windows-x86_64"
@patch("sys.platform", "freebsd")
@patch("platform.machine", return_value="x86_64")
def test_platform_unsupported(_):
with pytest.raises(RuntimeError, match="Unsupported"):
_platform_tag()
def test_libname_per_platform():
with patch("sys.platform", "linux"):
assert _libname() == "libsimplex.so"
with patch("sys.platform", "darwin"):
assert _libname() == "libsimplex.dylib"
with patch("sys.platform", "win32"):
assert _libname() == "libsimplex.dll"
@patch("simplex_chat._native._platform_tag", return_value="linux-x86_64")
def test_url_sqlite(_):
assert (
_libs_url("sqlite")
== "https://github.com/simplex-chat/simplex-chat-libs/releases/download/"
"v6.5.1/simplex-chat-libs-linux-x86_64.zip"
)
@patch("simplex_chat._native._platform_tag", return_value="linux-x86_64")
def test_url_postgres(_):
assert (
_libs_url("postgres")
== "https://github.com/simplex-chat/simplex-chat-libs/releases/download/"
"v6.5.1/simplex-chat-libs-linux-x86_64-postgres.zip"
)
packages/simplex-chat-python/tests/test_util.py
+175
View File
@@ -0,0 +1,175 @@
from simplex_chat import util
def test_chat_info_ref_direct():
ci = {"type": "direct", "contact": {"contactId": 7}}
assert util.chat_info_ref(ci) == {"chatType": "direct", "chatId": 7}
def test_chat_info_ref_group():
ci = {"type": "group", "groupInfo": {"groupId": 42}}
assert util.chat_info_ref(ci) == {"chatType": "group", "chatId": 42}
def test_chat_info_ref_group_with_member_support_scope():
ci = {
"type": "group",
"groupInfo": {"groupId": 42},
"groupChatScope": {"type": "memberSupport", "groupMember_": {"groupMemberId": 99}},
}
ref = util.chat_info_ref(ci)
assert ref == {
"chatType": "group",
"chatId": 42,
"chatScope": {"type": "memberSupport", "groupMemberId_": 99},
}
def test_chat_info_ref_group_with_member_support_scope_no_member():
ci = {
"type": "group",
"groupInfo": {"groupId": 42},
"groupChatScope": {"type": "memberSupport"},
}
ref = util.chat_info_ref(ci)
# No groupMember_ → no groupMemberId_ in the wire scope.
assert ref == {
"chatType": "group",
"chatId": 42,
"chatScope": {"type": "memberSupport"},
}
def test_chat_info_ref_returns_none_for_non_targets():
assert util.chat_info_ref({"type": "contactRequest"}) is None
assert util.chat_info_ref({"type": "contactConnection"}) is None
def test_chat_info_name_direct():
ci = {"type": "direct", "contact": {"profile": {"displayName": "Alice"}}}
assert util.chat_info_name(ci) == "@Alice"
def test_chat_info_name_group():
ci = {"type": "group", "groupInfo": {"groupProfile": {"displayName": "MyGroup"}}}
assert util.chat_info_name(ci) == "#MyGroup"
def test_chat_info_name_group_with_member_support():
ci = {
"type": "group",
"groupInfo": {"groupProfile": {"displayName": "MyGroup"}},
"groupChatScope": {
"type": "memberSupport",
"groupMember_": {"memberProfile": {"displayName": "Carol"}},
},
}
assert util.chat_info_name(ci) == "#MyGroup(support Carol)"
def test_chat_info_name_local():
assert util.chat_info_name({"type": "local"}) == "private notes"
def test_chat_info_name_contact_request():
ci = {"type": "contactRequest", "contactRequest": {"profile": {"displayName": "Eve"}}}
assert util.chat_info_name(ci) == "request from @Eve"
def test_chat_info_name_contact_connection():
assert util.chat_info_name({"type": "contactConnection", "contactConnection": {}}) == (
"pending connection"
)
assert (
util.chat_info_name({"type": "contactConnection", "contactConnection": {"localAlias": "X"}})
== "pending connection (X)"
)
def test_sender_name_direct_uses_chat_name():
ci = {"type": "direct", "contact": {"profile": {"displayName": "Alice"}}}
chat_dir = {"type": "directRcv"}
assert util.sender_name(ci, chat_dir) == "@Alice"
def test_sender_name_group_appends_member():
ci = {"type": "group", "groupInfo": {"groupProfile": {"displayName": "MyGroup"}}}
chat_dir = {"type": "groupRcv", "groupMember": {"memberProfile": {"displayName": "Bob"}}}
assert util.sender_name(ci, chat_dir) == "#MyGroup @Bob"
def test_contact_address_str_prefers_short():
assert util.contact_address_str({"connFullLink": "full", "connShortLink": "short"}) == "short"
def test_contact_address_str_falls_back_to_full():
assert util.contact_address_str({"connFullLink": "full"}) == "full"
def test_from_local_profile_strips_extras_and_undefined():
local = {
"displayName": "x",
"fullName": "X Y",
"shortDescr": None,
"image": "data:image/png;base64,...",
"contactLink": None,
"preferences": {},
"peerType": "bot",
"profileId": 99, # extra LocalProfile field
"localAlias": "alias", # extra LocalProfile field
}
p = util.from_local_profile(local)
assert p == {
"displayName": "x",
"fullName": "X Y",
"image": "data:image/png;base64,...",
"preferences": {},
"peerType": "bot",
}
def test_ci_content_text_rcv():
ci = {"content": {"type": "rcvMsgContent", "msgContent": {"type": "text", "text": "hello"}}}
assert util.ci_content_text(ci) == "hello"
def test_ci_content_text_snd():
ci = {"content": {"type": "sndMsgContent", "msgContent": {"type": "text", "text": "world"}}}
assert util.ci_content_text(ci) == "world"
def test_ci_content_text_other():
ci = {"content": {"type": "rcvGroupEvent"}}
assert util.ci_content_text(ci) is None
def test_ci_bot_command_match():
ci = {"content": {"type": "rcvMsgContent", "msgContent": {"type": "text", "text": "/ping"}}}
assert util.ci_bot_command(ci) == ("ping", "")
def test_ci_bot_command_with_args():
ci = {
"content": {"type": "rcvMsgContent", "msgContent": {"type": "text", "text": "/echo hi "}}
}
assert util.ci_bot_command(ci) == ("echo", "hi")
def test_ci_bot_command_not_a_command():
ci = {"content": {"type": "rcvMsgContent", "msgContent": {"type": "text", "text": "hello"}}}
assert util.ci_bot_command(ci) is None
def test_ci_bot_command_no_text():
ci = {"content": {"type": "rcvGroupEvent"}}
assert util.ci_bot_command(ci) is None
def test_reaction_text_emoji():
r = {"chatReaction": {"reaction": {"type": "emoji", "emoji": "🎉"}}}
assert util.reaction_text(r) == "🎉"
def test_reaction_text_tag():
r = {"chatReaction": {"reaction": {"type": "unknown", "tag": "thumbs_up"}}}
assert util.reaction_text(r) == "thumbs_up"

Some files were not shown because too many files have changed in this diff Show More