Use Cases of Editing Guestbook#456
Open
ChengShi-1 wants to merge 3 commits into
Open
Conversation
github-actions
Bot
added
the
FY26 Sprint 25
ChengShi-1
moved this from In Progress 💻
to Ready for Review ⏩
in IQSS Dataverse Project
Contributor
There was a problem hiding this comment.
Pull request overview
Adds support in the JavaScript Dataverse client for editing existing Guestbooks (including custom question updates/removals), aligning with Dataverse backend support for PUT /api/guestbooks/{id}.
Changes:
- Added
editGuestbookrepository method, use case, and module exports. - Introduced
EditGuestbookDTOand expandedGuestbookmodel types to allow optional IDs on nested question/option objects. - Added/updated unit + integration tests and updated docs/changelog entries.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| test/unit/guestbooks/GuestbooksRepository.test.ts | Adds unit coverage for inherited guestbook listing params and editGuestbook request behavior. |
| test/unit/guestbooks/EditGuestbook.test.ts | Adds unit tests for the new EditGuestbook use case behavior and error propagation. |
| test/integration/guestbooks/GuestbooksRepository.test.ts | Adds integration coverage for editing guestbooks, including custom question update/replace/remove scenarios. |
| src/guestbooks/infra/repositories/GuestbooksRepository.ts | Implements editGuestbook via PUT /guestbooks/{id} and supports includeInherited query param for listing. |
| src/guestbooks/index.ts | Wires and exports the new editGuestbook use case and DTO exports. |
| src/guestbooks/domain/useCases/EditGuestbook.ts | Adds the EditGuestbook use case wrapper over the repository method. |
| src/guestbooks/domain/repositories/IGuestbooksRepository.ts | Extends repository contract to include editGuestbook. |
| src/guestbooks/domain/models/Guestbook.ts | Makes nested id fields optional for custom questions/options. |
| src/guestbooks/domain/dtos/EditGuestbookDTO.ts | Introduces the DTO types for guestbook edit payloads. |
| docs/useCases.md | Documents includeInherited and adds an Edit a Guestbook use case section. |
| CHANGELOG.md | Adds an unreleased entry for the new editGuestbook use case. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+19
to
+29
| export interface EditGuestbookDTO { | ||
| id?: number | ||
| name: string | ||
| enabled: boolean | ||
| emailRequired: boolean | ||
| nameRequired: boolean | ||
| institutionRequired: boolean | ||
| positionRequired: boolean | ||
| createTime: string | ||
| customQuestions?: EditGuestbookCustomQuestionDTO[] | ||
| } |
Comment on lines
+3305
to
+3308
| const guestbookId = 123 | ||
| const guestbook: EditGuestbookDTO = { | ||
| name: 'new name' | ||
| } |
|
|
||
| ### Added | ||
|
|
||
| - Guestbooke: Added `editGuestbook` use case. |
Comment on lines
+28
to
+37
| public async editGuestbook(guestbookId: number, guestbook: EditGuestbookDTO): Promise<void> { | ||
| return this.doPut( | ||
| this.buildApiEndpoint(this.guestbooksResourceName, undefined, guestbookId), | ||
| guestbook | ||
| ) | ||
| .then(() => undefined) | ||
| .catch((error) => { | ||
| throw error | ||
| }) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This API allows the user to make edits to an existing Guestbook, including adding and removing Custom Guestbook Questions.
curl -PUT -H "X-Dataverse-key:$API_TOKEN" "$SERVER_URL/api/guestbooks/{ID}" -d "$JSON"When editing, the whole payload should be provided as json format
Which issue(s) this PR closes:
Related Dataverse PRs:
Special notes for your reviewer:
Suggestions on how to test this:
Is there a release notes or changelog update needed for this change?:
yes
Additional documentation: