api-client: typed helper to parse the audit JSON Lines export

Abierto Apto para principiantes
#144 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
85/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
typescript
Área
api

Línea de trabajo

Trabaja en packages/api-client; primero inspecciona el cliente generado y los patrones existentes de pruebas unitarias para encontrar el lugar adecuado para el parser. Añade parseAuditExport(text: string): AuditEventDto[] para que conserve el orden de las líneas, ignore un salto de línea final y lance un error si hay líneas JSON no válidas. Añade pruebas unitarias y ejecuta pnpm nx test api-client.

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

Descripción

enhancement good first issue priority:P3 track:web

The audit export (/audit-events/export) returns application/x-ndjson, one AuditEventDto per line, which the generated client does not parse.

Task

In packages/api-client:

  • add parseAuditExport(text: string): AuditEventDto[];
  • ignore a trailing newline, throw on invalid JSON lines, and keep the original order;
  • add unit tests.

Acceptance

pnpm nx test api-client passes. No new dependency.

Lenguaje dominante
TypeScript
Estrellas
2
Forks
1
Merge medio
7 h 17 min
PR fusionados (30 d)
197

Preparar el entorno

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 shipkeepdev/shipkeep

Todos los issues de shipkeepdev/shipkeep

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.