Get Citation In Other Format Use Case #340
Merged
Conversation
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
github-actions
bot
added
FY26 Sprint 2
ChengShi-1
removed
Size: 3
ChengShi-1
added
Size: 3
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new use case for retrieving dataset citations in various bibliographic formats (EndNote, RIS, BibTeX, CSLJson, Internal). The implementation follows the existing repository pattern and adds support for different content types including XML, plain text, JSON, and HTML formats.
- Adds
GetDatasetCitationInOtherFormatsuse case with support for 5 citation formats - Creates new domain models for citation formats and response structure
- Implements repository method with optional deaccessioned dataset inclusion
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
src/datasets/domain/models/CitationFormats.ts |
Defines enum for supported citation formats |
src/datasets/domain/models/CitationResponse.ts |
Type definition for citation response with content and content type |
src/datasets/domain/useCases/GetDatasetCitationInOtherFormats.ts |
Main use case implementation for retrieving citations |
src/datasets/domain/repositories/IDatasetsRepository.ts |
Interface update to include new citation method |
src/datasets/infra/repositories/DatasetsRepository.ts |
Repository implementation with API endpoint integration |
test/unit/datasets/GetDatasetCitationInOtherFormats.test.ts |
Unit tests for the new use case |
test/integration/datasets/DatasetsRepository.test.ts |
Integration tests covering all citation formats |
docs/useCases.md |
Documentation for the new use case |
test/testHelpers/roles/roleHelper.ts |
Removes deprecated 'LinkDataverse' and 'LinkDataset' permissions |
ekraffmiller
moved this from Ready for Review ⏩
to In Review 🔎
in IQSS Dataverse Project
Contributor
ekraffmiller
left a comment
ekraffmiller
left a comment
There was a problem hiding this comment.
Looks good! I just have suggestions for naming and the domain model.
Contributor
Author
|
@ekraffmiller Thanks for suggestions, Ellen! just fixed names and stringify json object |
ekraffmiller
previously approved these changes
Jul 31, 2025
Contributor
ekraffmiller
left a comment
ekraffmiller
left a comment
There was a problem hiding this comment.
looks good, approved!
github-project-automation
bot
moved this from In Review 🔎
to Ready for QA ⏩
in IQSS Dataverse Project
Contributor
Author
|
@ekraffmiller Hi Ellen, I add one commit for exporting this use case in |
ChengShi-1
moved this from Ready for QA ⏩
to Ready for Review ⏩
in IQSS Dataverse Project
ekraffmiller
approved these changes
Aug 6, 2025
Contributor
ekraffmiller
left a comment
ekraffmiller
left a comment
There was a problem hiding this comment.
looks good, approved 👍
github-project-automation
bot
moved this from Ready for Review ⏩
to Ready for QA ⏩
in IQSS Dataverse Project
Contributor
|
tests passing, merging |
github-project-automation
bot
moved this from Ready for QA ⏩
to Merged 🚀
in IQSS Dataverse Project
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:
Inspired by 2025 Q3 SPA proposal, we could add the citation in other formats use case. Native API works
The return results have different content types, include 'EndNote' (XML), 'RIS' (plain text), 'BibTeX' (plain text), 'CSLJson' (JSON), and 'Internal' (HTML).
Which issue(s) this PR closes:
Related Dataverse PRs:
Special notes for your reviewer:
The use case will be used for citation downloads(like the screenshot). The return type is still
Stringbut in different Content-Types, I think it makes more sense to have an use case to fetch the information here, and write a file to download by users in the front end repo?RoleHelper for testing changed because Revert "feat: "Link Dataset/Dataverse" permission"
Suggestions on how to test this:
Is there a release notes update needed for this change?:
Additional documentation: