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

Ouverte Adaptée aux débutants
#144 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
85/100
Type d'issue
Fonctionnalité
Clarté
Clairement spécifiée
Activité
Active
Stack technique
typescript
Domaine
api

Piste de recherche

Travaille dans packages/api-client ; examine d’abord le client généré et les modèles de tests unitaires existants pour trouver l’emplacement approprié du parseur. Ajoute parseAuditExport(text: string): AuditEventDto[] afin de préserver l’ordre des lignes, d’ignorer un saut de ligne final et de lever une erreur en présence de lignes JSON invalides. Ajoute des tests unitaires et exécute pnpm nx test api-client.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.

Langage dominant
TypeScript
Étoiles
2
Forks
1
Merge moyen
7 h 17 min
PR mergées (30 j)
197

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de shipkeepdev/shipkeep

Toutes les issues de shipkeepdev/shipkeep

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.