Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Refactor API: Remove 'any' from EmbeddedChatApi and improve payload typing

Abierto
#1,237 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
72/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
typescript
Área
api, developer-experience

Línea de trabajo

Comienza con packages/api/src/EmbeddedChatApi.ts, leyendo connect(), las firmas de los callbacks, autoLogin, sendMessage y handleUiKitInteraction. Ejecuta el build y las comprobaciones de lint/tipos de packages/api mientras reemplazas los any explícitos por entradas tipadas y acceso protegido al stream; se considera terminado cuando no quede ningún any explícito y el paquete se compile sin errores nuevos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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 any appeared in:
    • message listeners
    • action/ui interaction listeners
    • autoLogin credentials
    • DDP stream callbacks (onStreamData)
    • sendMessage input
    • handleUiKitInteraction input
  • 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 any remains in packages/api/src/EmbeddedChatApi.ts.
  • connect() stream handling uses guarded/narrowed access.
  • sendMessage and handleUiKitInteraction use typed inputs.
  • packages/api builds 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.
Lenguaje dominante
JavaScript
Estrellas
165
Forks
381
Merge medio
1 d 2 h
PR fusionados (30 d)
1

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de RocketChat/EmbeddedChat

Todos los issues de RocketChat/EmbeddedChat

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.