Refactor API: Remove 'any' from EmbeddedChatApi and improve payload typing
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 72/100
- issue の種類
- リファクタリング
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
- 技術スタック
- typescript
調査の方向性
packages/api/src/EmbeddedChatApi.ts から始め、connect()、callback のシグネチャ、autoLogin、sendMessage、handleUiKitInteraction を読みます。明示的な any を型付き入力とガードされたストリームアクセスに置き換えながら、packages/api の build と lint/type チェックを実行します。明示的な any が残らず、パッケージが新しいエラーなしでビルドできれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Summary
packages/api/src/EmbeddedChatApi.ts currently relies on multiple explicit any types across callback signatures, stream payload handling, auth inputs, and message APIs. This reduces type safety and makes it easier to accidentally access unsafe or undefined fields, especially when working with dynamic DDP payloads.
Problem
- Explicit
anyappeared in:- message listeners
- action/ui interaction listeners
autoLogincredentials- DDP stream callbacks (
onStreamData) sendMessageinputhandleUiKitInteractioninput
- Stream payloads were accessed without defensive narrowing (
fields,eventName,args). - SDK callback types are broad, so local guards are needed to keep runtime behavior while improving static safety.
Acceptance Criteria
- No explicit
anyremains inpackages/api/src/EmbeddedChatApi.ts. connect()stream handling uses guarded/narrowed access.sendMessageandhandleUiKitInteractionuse typed inputs.packages/apibuilds successfully.- No lint/type errors introduced.
Impact
- Better type safety and editor intelligence.
- Lower risk of runtime errors from malformed DDP payloads.
- No intended behavior changes at runtime.
- 主要言語
- JavaScript
- スター
- 165
- フォーク
- 381
- 平均マージ
- 1日 2時間
- マージ済み PR（30日）
- 1
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
RocketChat/EmbeddedChat のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
RocketChat/EmbeddedChat#1373 ·
-
enhancement
難易度 1/5 1時間未満 初心者へのやさしさ 84/100
RocketChat/EmbeddedChat#1360 · コメント 1 件 ·
-
Permissions change-detection in useFetchChatData is dead — applyPermissions re-runs on every call オープン
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
RocketChat/EmbeddedChat#1317 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
RocketChat/EmbeddedChat#1315 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
RocketChat/EmbeddedChat#1313 ·
RocketChat/EmbeddedChat の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
docToolchain/docToolchain#1705 ·
-
Timezone select lists one option per character; duplicate "Failed" reason; shared tracker popover id オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
nightscout/nocturne#1414 ·
-
bug v2
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
modelcontextprotocol/inspector#2458 · コメント 1 件 ·
-
Mend: dependency security vulnerability status: needs triage 🕵️♀️
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
carbon-design-system/ibm-products#9907 ·