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

未关闭 适合新手
#144 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
85/100
Issue 类型
功能
描述清晰度
描述清楚
活跃度
活跃
技术栈
typescript
领域
api

调研方向

在 packages/api-client 中工作;先检查生成的客户端和现有的单元测试模式,找到适合放置解析器的位置。添加 parseAuditExport(text: string): AuditEventDto[],使其保留行顺序、忽略末尾换行,并在 JSON 行无效时抛出错误。添加单元测试并运行 pnpm nx test api-client。

由索引模型根据 Issue 内容生成。

描述

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.

主要语言
TypeScript
星标
2
派生
1
平均合并
7 小时 17 分钟
30 天内合并 PR
197

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

shipkeepdev/shipkeep 的其他 Issue

查看 shipkeepdev/shipkeep 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。