Chat APIs
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 20/100
- issue の種類
- 機能追加
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- javascript
- 領域
- api
調査の方向性
The issue proposes chat namespaces, provider APIs, permissions, and manifest.json declarations, but names no source files, tests, or entry points. Start by reviewing the existing extension architecture and manifest.json, then determine which part of the proposal is in scope. The issue has no concrete completion criteria, so an agreed design and bounded implementation target are needed before work can be considered done.
索引モデルが issue の本文から書いたものです。
説明
There should be a namespace to interact with chat. The following is an old draft of mine of what that could look like:
APIs (ordered by namespaces)
- chat
- conversations
- Conversation
- id
- accountId
- muc
- name
- room
- buddyId
- unreadCount
- mentionCount
- lastReadMessage
- topic
- Participants: Array of Participant
- Participant
- id
- name
- conversationId
- avatar
- status
- statusText
- metaDetails
- mode (OP etc.)
- create
- accountId
- room?
- buddyId?
- update
- conversationId
- index?
- unread progress/state?
- selected?
- query
- selected?
- index?
- providerId?
- accountId?
- muc?
- conversationId?
- close
- conversationId
- getParticipants
- conversationId
- updateParticipant
- participantId
- updatedParticipant
- onCreated
- onUpdated
- onClosed
- onTooltip -> allows adding data to the tooltip
- Conversation
- buddies
- Buddy
- id
- accountId
- status
- statusText
- create
- accountId
- buddy login or whatever
- nickname
- update
- nickname
- query
- buddyId?
- nickname?
- accountId?
- providerId?
- remove
- buddyId
- onCreated
- onUpdated
- onRemoved
- Buddy
- providers
- Provider
- id
- name
- canMuc
- canBuddy
- canTopic etc.
- IRC
- onCAP
- onCommand
- onTag
- onISUPPORTs or whatever
- etc.
- XMPP
- I don't know XMPP, just that it has something similar to the CAP system.
- onStanza
- get
- onRegistered
- onUnregistered
- Provider
- accounts
- Account
- id
- providerId
- server
- nickname
- password
- autoJoinedRooms
- create
- update
- query
- remove
- onCreated
- onUpdated
- onRemoved
- Account
- presence
- Presence
- avatar
- status
- statusText
- get
- update
- onUpdated (with reasons like auto idle)
- Presence
- messages
- Message
- id (not sure)
- text
- rawText
- userName
- buddyId?
- participantId?
- incoming
- system
- timestamp
- conversationId
- create
- conversationId
- text?
- raw? (so you can send custom XMPP and IRC etc. payloads)
- query
- conversationId
- buddyId?
- onReceive
- allows filtering/changing a message
- onSend
- ditto
- onCommand
- or should commands be declarative in the manifest.json?
- Message
- menus
- add extra targets for messages, conversations, buddies and participants
- conversations
That's about it for APIs. But as you will notice, nothing about themes, emote sets or new providers in there. That's because that should be statically declared in the manifest.json:
- provider
- name
- icon
- entry_point -> html file that gets special APIs described later on
- capabilities
- topic
- buddy
- muc
- presences
- ?
- setup
- type (oauth vs. pw/login)
- fields
- username
- server
- password
- port
- TLS
- defaults
- defaults for fields -> set OAuth URL here?
- emote_set
- not sure how this'd look. Probably a key value map?
- theme
even less sure how that'd work. In Firefox themes have been abstracted far away from the "bare metal" to essentially CSS var tweaks, which is definitely way less than what chat themes have been able to do. Given the APIs above I think a theme should just be able to do everything themselves, they just provide the HTML file to load in the conversations frame and then there's some API for them to know what conversation they're in and that's about it. Requires it to be the last one to get the events, so probably needs a specific implementation for themes. - permissions
- accounts
- conversations
- messages
- buddies
- providers
- presence
- irc
- xmpp
The provider API
Provider pages would essentially get some additional APIs to either build on top of an existing provider or build their own (and since TCP sockets are not exposed to extensions atm some socket would have to be exposed...)
Not sure if some APIs should be restricted from here, so the socket part can run in its own thread and all the front-end stuff that doesn't actually need the socket would be forced to the classic extension background script and they could communicate by messaging.
The exposed socket things would be classes that could be extended? Not sure. All the events from the other APIs should only be sent for changes coming from outside the provider, so the provicer can use the create, update and remove methods for UI changes.
- providers
- IRC
- XMPP
- Socket
- conversations
- addParticipant
- removeParticipant
- messages
- create
- from
- create
- providerInstance
- setConnectionStatus
- onConnected (user/autoconnect)
- onDisconnected (user disconnect)
- ???? -> probably mostly event handlers -> many type specific handlers are already present in the API above, maybe add shortcuts that don't require filtering for providers
- 主要言語
- JavaScript
- スター
- 33
- フォーク
- 18
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
thunderbird/webext-experiments のほかの issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
-
Proposal: narrowly scoped account order API対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
thunderbird/webext-experiments#72 · コメント 3 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
thunderbird/webext-experiments#61 · コメント 2 件 ·
thunderbird/webext-experiments の issue をすべて見る
似ている issue
-
Edit: Hello Tasteオープンchannels:edit check:passed
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 2 日以内に返信
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
hiero-ledger/hiero-sdk-js#4793 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
addyosmani/agent-skills#802 ·
メンテナーはふだん 4 日以内に返信
-
26.04 bug dark-mode Easy Hack impress symptom: visual
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
CollaboraOnline/online#16421 · コメント 1 件 ·