Use Case for File Citation Formats#446
Merged
ekraffmiller merged 12 commits intoJun 9, 2026
Merged
Conversation
ChengShi-1
added
Size: 3
Contributor
There was a problem hiding this comment.
Pull request overview
Adds first-class support in the files domain for exporting a Dataverse file citation in multiple formats (EndNote, RIS, BibTeX, CSL, Internal) by introducing a new FileCitationFormat enum, a getFileCitationByFormat repository method, and a GetFileCitationByFormat use case, with accompanying docs and tests.
Changes:
- Introduce
FileCitationFormatenum andGetFileCitationByFormatuse case, and export them from the files module. - Implement
FilesRepository.getFileCitationByFormat()against/access/datafile/{id}/citation/{format}(stringifying JSON responses when needed). - Add unit/integration/functional coverage plus docs + changelog entry.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| test/unit/files/GetFileCitationByFormat.test.ts | Unit tests for the new use case behavior (success + error propagation). |
| test/unit/files/FilesRepository.test.ts | Unit tests for the new repository method endpoint + response handling. |
| test/integration/files/FilesRepository.test.ts | Integration coverage against a running Dataverse for each citation export format. |
| test/functional/files/GetFileCitationByFormat.test.ts | Functional (public API) coverage for fetching citations in each format. |
| test/environment/.env | Changes default Dataverse image registry/tag used by the test docker-compose environment. |
| src/files/infra/repositories/FilesRepository.ts | Adds getFileCitationByFormat() implementation. |
| src/files/index.ts | Wires the new use case and exports FileCitationFormat. |
| src/files/domain/useCases/GetFileCitationByFormat.ts | New use case delegating to repository. |
| src/files/domain/repositories/IFilesRepository.ts | Extends the repository interface with getFileCitationByFormat(). |
| src/files/domain/models/FileCitationFormat.ts | New enum defining supported export formats (API path values). |
| docs/useCases.md | Adds documentation section and example usage for the new use case. |
| CHANGELOG.md | Adds an “Added” entry describing the new feature. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ttps://github.com/IQSS/dataverse-client-javascript into 436-use-cases-of-get-file-citation-in-other-formats
This was referenced May 26, 2026
ChengShi-1
moved this from Ready for Review ⏩
to In Progress 💻
in IQSS Dataverse Project
ChengShi-1
moved this from In Progress 💻
to Ready for Review ⏩
in IQSS Dataverse Project
This reverts commit a787da9.
ekraffmiller
moved this from Ready for Review ⏩
to In Review 🔎
in IQSS Dataverse Project
ekraffmiller
reviewed
Jun 8, 2026
ekraffmiller
left a comment
ekraffmiller
left a comment
Contributor
There was a problem hiding this comment.
Looks good! Some comments about the tests. Also, can you resolve the merge conflicts?
| } | ||
| ) | ||
|
|
||
| test('should authenticate via session cookie when configured', async () => { |
Contributor
There was a problem hiding this comment.
I know we have these tests for session cookie auth in other places, but since we've switched from session cookies to Bearer tokens in the frontend, I don't think we need to keep adding these tests.
| }) | ||
| }) | ||
|
|
||
| describe('getFileCitationByFormat', () => { |
Contributor
There was a problem hiding this comment.
Since this use case takes a fileId or a persistentId, can you add a test that uses persistentId?
list enum values in documentation Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
ekraffmiller
approved these changes
Jun 9, 2026
ekraffmiller
left a comment
ekraffmiller
left a comment
Contributor
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
github-project-automation
Bot
moved this from Ready for QA ⏩
to Merged 🚀
in IQSS Dataverse Project
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:
Files: Added
getFileCitationByFormatuse case, repository method, andFileCitationFormatenum to support Dataverse file citation exports inEndNote,RIS,BibTeX,CSL, andInternalformats.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?:
Additional documentation: