matrix-appservice-kakaotalk/ROADMAP.md

# Features & roadmap

* Matrix → KakaoTalk
  * [ ] Message content
    * [x] Text
    * [ ] Media
      * [x] Stickers
      * [x] Files
      * [x] Voice messages
      * [x] Videos
      * [x] Images
      * [ ] Locations
    * [x] Replies<sup>[1]</sup>
    * [x] Mentions<sup>[1]</sup>
    * [ ] Polls
  * [ ] Pinned messages
  * [x] Message redactions<sup>[2]</sup>
  * [ ] Message reactions
  * [x] Read receipts
  * [x] Power level<sup>[1]</sup>
  * [ ] Membership actions
    * [ ] Invite
    * [ ] Join
    * [x] Leave<sup>[3]</sup>
    * [ ] Ban<sup>[4]</sup>
    * [ ] Unban<sup>[4]</sup>
  * [ ] Room metadata changes
    * [x] Name
    * [x] Topic
    * [ ] Avatar
    * [ ] Per-room user nick
* KakaoTalk → Matrix
  * [ ] Message content
    * [x] Text
    * [ ] Media
      * [ ] Stickers
      * [x] Files
      * [x] Voice messages
      * [x] Videos
      * [x] Images
      * [ ] Locations
      * [ ] Links
    * [x] Replies
    * [x] Mentions
    * [ ] Polls
  * [ ] Posts
  * [x] Message deletion/hiding
  * [ ] Message reactions
  * [x] Message history
  * [x] Read receipts
  * [x] Admin status
  * [ ] Membership actions
    * [ ] Invite
    * [x] Join
    * [x] Leave
    * [ ] Self leave
      * [ ] On backfill
      * [x] On live event
    * [x] Kick<sup>[4]</sup>
    * [x] Unkick<sup>[4]</sup>
  * [x] Channel metadata
    * [x] Name
    * [x] Description
    * [x] Cover photo<sup>[5]</sup>
  * [ ] User metadata
    * [x] Name
    * [x] Avatar
    * [ ] Per-channel Open Profile
* Misc
  * [x] Multi-user support
  * [x] Shared group chat portals
  * [x] Automatic portal creation
    * [x] At startup
    * [x] When added to chat
    * [x] When receiving message
  * [x] Direct chat creation by inviting Matrix puppet of KakaoTalk user to new room
  * [ ] Open Chat creation by bot command
    * [ ] Group Chat
    * [ ] 1:1 Chat
  * [ ] Open Chat settings management
    * [ ] Public search
    * [ ] Max number of participants
    * [ ] Chatroom code
  * [x] Option to use own Matrix account for messages sent from other KakaoTalk clients
  * [ ] KakaoTalk friends list management
    * [x] List friends
    * [ ] Add friend
      * [x] By KakaoTalk ID
      * [x] By Matrix puppet of KakaoTalk user
      * [ ] By phone number
    * [x] Remove friend
    * [ ] Favourite friends
    * [ ] Hidden friends
    * [ ] Blocked users
  * [x] KakaoTalk ID management
    * [x] Set/Change ID
    * [x] Make ID searchable/hidden

<sup>[1]</sup> Sometimes fails with "Invalid body" error
<sup>[2]</sup> Only recently-sent KakaoTalk messages can be deleted
<sup>[3]</sup> To make your KakaoTalk account leave a channel, send the `leave` command in a Matrix portal room. Simply leaving a Matrix portal room will keep your KakaoTalk account in the channel.
<sup>[4]</sup> Kicks in KakaoTalk are equivalent to bans in Matrix
<sup>[5]</sup> Might not get synced on backfill or initial portal creation. Might get synced on live update to channel name/description
Add README and setup instructions 2022-03-13 00:57:45 -05:00			`# Features & roadmap`

			`* Matrix → KakaoTalk`
			`* [ ] Message content`
			`* [x] Text`
			`* [ ] Media`
Update roadmap 2022-03-28 03:40:32 -04:00			`* [x] Stickers`
			`* [x] Files`
			`* [x] Voice messages`
			`* [x] Videos`
			`* [x] Images`
Add README and setup instructions 2022-03-13 00:57:45 -05:00			`* [ ] Locations`
Update roadmap 2022-04-14 04:35:12 -04:00			`* [x] Replies<sup>[1]</sup>`
			`* [x] Mentions<sup>[1]</sup>`
Update roadmap with missing edge cases and KT message types 2022-04-12 04:38:13 -04:00			`* [ ] Polls`
Update roadmap 2022-04-28 03:34:40 -04:00			`* [ ] Pinned messages`
Update roadmap 2022-04-14 04:35:12 -04:00			`* [x] Message redactions<sup>[2]</sup>`
Add README and setup instructions 2022-03-13 00:57:45 -05:00			`* [ ] Message reactions`
Update roadmap 2022-04-10 04:34:15 -04:00			`* [x] Read receipts`
Update roadmap 2022-04-28 03:34:40 -04:00			`* [x] Power level<sup>[1]</sup>`
Update roadmap to remove claim about KT not supporting invites node-kakao supports sending invites, so KT must have them after all 2022-04-29 02:06:28 -04:00			`* [ ] Membership actions`
			`* [ ] Invite`
Update roadmap 2022-04-28 03:34:40 -04:00			`* [ ] Join`
Update roadmap to remove claim about KT not supporting invites node-kakao supports sending invites, so KT must have them after all 2022-04-29 02:06:28 -04:00			`* [x] Leave<sup>[3]</sup>`
			`* [ ] Ban<sup>[4]</sup>`
			`* [ ] Unban<sup>[4]</sup>`
Roadmap corrections 2022-05-09 03:27:48 -04:00			`* [ ] Room metadata changes`
Fixes to outbound channel name & topic setting - Use the correct API for open channels - Allow changing the name (title) of normal channels 2022-05-16 01:53:21 -04:00			`* [x] Name`
			`* [x] Topic`
Don't document that outbound portal avatars are supported Also comment-out its unused code 2022-05-12 03:44:57 -04:00			`* [ ] Avatar`
Add README and setup instructions 2022-03-13 00:57:45 -05:00			`* [ ] Per-room user nick`
			`* KakaoTalk → Matrix`
			`* [ ] Message content`
			`* [x] Text`
			`* [ ] Media`
			`* [ ] Stickers`
Update roadmap 2022-04-28 03:34:40 -04:00			`* [x] Files`
Update roadmap 2022-03-28 03:40:32 -04:00			`* [x] Voice messages`
			`* [x] Videos`
			`* [x] Images`
			`* [ ] Locations`
Update roadmap with missing edge cases and KT message types 2022-04-12 04:38:13 -04:00			`* [ ] Links`
Update roadmap 2022-04-08 05:22:35 -04:00			`* [x] Replies`
			`* [x] Mentions`
Update roadmap with missing edge cases and KT message types 2022-04-12 04:38:13 -04:00			`* [ ] Polls`
Update roadmap 2022-04-28 03:34:40 -04:00			`* [ ] Posts`
Update roadmap 2022-04-09 04:13:10 -04:00			`* [x] Message deletion/hiding`
Add README and setup instructions 2022-03-13 00:57:45 -05:00			`* [ ] Message reactions`
			`* [x] Message history`
Backfill inbound read receipts Also rename "chat" to "channel" for the Message DB, and make its primary key include channel IDs 2022-05-05 03:00:41 -04:00			`* [x] Read receipts`
Inbound permissions & outbound power levels Note that these only apply to OpenChannels 2022-04-13 01:12:56 -04:00			`* [x] Admin status`
Update roadmap 2022-04-28 03:34:40 -04:00			`* [ ] Membership actions`
Update roadmap to remove claim about KT not supporting invites node-kakao supports sending invites, so KT must have them after all 2022-04-29 02:06:28 -04:00			`* [ ] Invite`
Update roadmap 2022-04-28 03:34:40 -04:00			`* [x] Join`
Update roadmap 2022-04-10 04:34:15 -04:00			`* [x] Leave`
Update roadmap 2022-04-28 03:34:40 -04:00			`* [ ] Self leave`
			`* [ ] On backfill`
			`* [x] On live event`
Update roadmap to remove claim about KT not supporting invites node-kakao supports sending invites, so KT must have them after all 2022-04-29 02:06:28 -04:00			`* [x] Kick<sup>[4]</sup>`
			`* [x] Unkick<sup>[4]</sup>`
Roadmap corrections 2022-05-09 03:27:48 -04:00			`* [x] Channel metadata`
Update roadmap 2022-04-14 04:35:12 -04:00			`* [x] Name`
			`* [x] Description`
Update roadmap to remove claim about KT not supporting invites node-kakao supports sending invites, so KT must have them after all 2022-04-29 02:06:28 -04:00			`* [x] Cover photo<sup>[5]</sup>`
Update roadmap 2022-04-28 03:34:40 -04:00			`* [ ] User metadata`
Add README and setup instructions 2022-03-13 00:57:45 -05:00			`* [x] Name`
			`* [x] Avatar`
Update roadmap 2022-04-28 03:34:40 -04:00			`* [ ] Per-channel Open Profile`
Add README and setup instructions 2022-03-13 00:57:45 -05:00			`* Misc`
			`* [x] Multi-user support`
			`* [x] Shared group chat portals`
Update roadmap 2022-04-10 04:34:15 -04:00			`* [x] Automatic portal creation`
Add README and setup instructions 2022-03-13 00:57:45 -05:00			`* [x] At startup`
Update roadmap 2022-04-10 04:34:15 -04:00			`* [x] When added to chat`
Add README and setup instructions 2022-03-13 00:57:45 -05:00			`* [x] When receiving message`
Create new direct chat if necessary when creating new DM portal Might fail on first attempt, though 2022-05-06 04:25:08 -04:00			`* [x] Direct chat creation by inviting Matrix puppet of KakaoTalk user to new room`
Update roadmap with as-of-yet unsupported features 2022-05-16 03:02:45 -04:00			`* [ ] Open Chat creation by bot command`
			`* [ ] Group Chat`
			`* [ ] 1:1 Chat`
			`* [ ] Open Chat settings management`
			`* [ ] Public search`
			`* [ ] Max number of participants`
			`* [ ] Chatroom code`
Update roadmap 2022-04-08 05:22:35 -04:00			`* [x] Option to use own Matrix account for messages sent from other KakaoTalk clients`
Allow adding/removing KakaoTalk friends from Matrix 2022-05-06 00:57:01 -04:00			`* [ ] KakaoTalk friends list management`
			`* [x] List friends`
			`* [ ] Add friend`
			`* [x] By KakaoTalk ID`
			`* [x] By Matrix puppet of KakaoTalk user`
			`* [ ] By phone number`
			`* [x] Remove friend`
Update roadmap with as-of-yet unsupported features 2022-05-16 03:02:45 -04:00			`* [ ] Favourite friends`
			`* [ ] Hidden friends`
			`* [ ] Blocked users`
KakaoTalk ID management from Matrix Add commands to set ID and make it searchable/hidden. Also don't print stack traces of ProtocolErrors. 2022-05-06 02:45:00 -04:00			`* [x] KakaoTalk ID management`
			`* [x] Set/Change ID`
			`* [x] Make ID searchable/hidden`
Update roadmap 2022-04-09 04:13:10 -04:00
Update roadmap 2022-04-14 04:35:12 -04:00			`<sup>[1]</sup> Sometimes fails with "Invalid body" error`
Update roadmap 2022-04-28 03:34:40 -04:00			`<sup>[2]</sup> Only recently-sent KakaoTalk messages can be deleted`
Update roadmap to remove claim about KT not supporting invites node-kakao supports sending invites, so KT must have them after all 2022-04-29 02:06:28 -04:00			<sup>[3]</sup> To make your KakaoTalk account leave a channel, send the `leave` command in a Matrix portal room. Simply leaving a Matrix portal room will keep your KakaoTalk account in the channel.
			`<sup>[4]</sup> Kicks in KakaoTalk are equivalent to bans in Matrix`
Roadmap corrections 2022-05-09 03:27:48 -04:00			`<sup>[5]</sup> Might not get synced on backfill or initial portal creation. Might get synced on live update to channel name/description`