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

Aberta Para iniciantes
  • Algo errado?
#144 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
2/5
Tempo estimado
1-3 horas
Facilidade para iniciantes
85/100
Tipo de issue
Funcionalidade
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
typescript
Domínio
api

Direção de pesquisa

Trabalhe em packages/api-client; primeiro, inspecione o cliente gerado e os padrões existentes de testes unitários para encontrar o lugar certo para o parser. Adicione parseAuditExport(text: string): AuditEventDto[] para preservar a ordem das linhas, ignorar uma quebra de linha final e lançar um erro para linhas JSON inválidas. Adicione testes unitários e execute pnpm nx test api-client.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
TypeScript
Estrelas
2
Forks
1
Merge médio
7h 17min
PRs com merge (30d)
197

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de shipkeepdev/shipkeep

Todas as issues de shipkeepdev/shipkeep

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.