feat(weekly-brief): add shared interfaces for weekly brief domain#775
feat(weekly-brief): add shared interfaces for weekly brief domain#775manishdixitlfx wants to merge 3 commits into
Conversation
Signed-off-by: Manish Dixit <mdixit@linuxfoundation.org>
Signed-off-by: Manish Dixit <mdixit@linuxfoundation.org>
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Pull request overview
Adds new Weekly Brief domain TypeScript interfaces to @lfx-one/shared so downstream apps/services (e.g., BFF) can share the committee-service-aligned shapes without remapping.
Changes:
- Introduced
WeeklyBrief*domain interfaces/types (state, entities, throttle, request/response shapes). - Exported the new Weekly Brief interfaces via the shared interfaces barrel.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| packages/shared/src/interfaces/weekly-brief.interface.ts | Adds Weekly Brief domain types/interfaces (state, entity, throttle, API shapes). |
| packages/shared/src/interfaces/index.ts | Re-exports the Weekly Brief interfaces from the shared interfaces barrel. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Introduce a closed `WeeklyBriefSourceType` union and use it on WeeklyBriefSourceRef.source_type instead of `string` with an inline comment listing the values (per copilot-pull-request-reviewer). Both the BFF and the Angular service consume this type, so widening it to a real union restores type-safety at every call site without runtime cost. Resolves 1 review thread. Signed-off-by: Manish Dixit <mdixit@linuxfoundation.org>
Review Feedback AddressedCommit: cc5c4af Changes Made (per copilot-pull-request-reviewer)
Threads Resolved1 of 1 unresolved threads addressed in this iteration. |
Introduce a closed `WeeklyBriefSourceType` union and use it on WeeklyBriefSourceRef.source_type instead of `string` with an inline comment listing the values (per copilot-pull-request-reviewer). Both the BFF and the Angular service consume this type, so widening it to a real union restores type-safety at every call site without runtime cost. Resolves 1 review thread. Signed-off-by: Manish Dixit <mdixit@linuxfoundation.org> Refs: LFXV2-1981 Signed-off-by: Manish Dixit <mdixit@linuxfoundation.org>
cc5c4af to
88e4d63
Compare
Tracking: LFXV2-1981 (part of Epic LFXV2-1976)
Summary
Adds the
@lfx-one/sharedTypeScript interfaces for the WG Weekly Brief feature. Pure type additions — no runtime code.What's new
packages/shared/src/interfaces/weekly-brief.interface.ts:WeeklyBriefStateunion (empty | generating | generated | edited | approved | error)WeeklyBriefSourceRef— claim_id + source provenance for citationsWeeklyBrief— full draft entity matching the committee-service domain shapeWeeklyBriefThrottle— per-committee/per-week generate + regenerate countersWeeklyBriefCurrentResponse, request/response shapespackages/shared/src/interfaces/index.tsexportsShapes mirror the committee-service Goa types so the BFF can pass through without remapping.
Stack
PR 1/4 on lfx-self-serve. Independent base =
main. PRs #6-8 stack on top.Test plan
yarn lint/yarn buildgreen (verified)