Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
155 commits
Select commit Hold shift + click to select a range
f9e7389
feat: use case set dataset license
ChengShi-1 Sep 24, 2025
0448714
add changelog
ChengShi-1 Sep 24, 2025
d74bab3
Revert "Revert "Get Collections For Linking Use Case""
g-saracca Sep 25, 2025
0c54f47
Apply suggestions from code review
ChengShi-1 Sep 25, 2025
14d7990
fix: change lastUpdateTime type to string in DatasetVersionInfo and r…
g-saracca Sep 25, 2025
85e1b87
refactor: update internalVersionNumber to sourceLastUpdateTime in dat…
g-saracca Sep 25, 2025
866ce06
test: update integration test
g-saracca Sep 25, 2025
9366f9b
fixes
g-saracca Sep 25, 2025
09a4048
feat: add sourceLastUpdateTime argument to update dataset metadata us…
g-saracca Sep 26, 2025
e76e9d9
fix: unit test
g-saracca Sep 26, 2025
a1cef4b
feat: add jsdoc about lastUpdateTime
g-saracca Sep 26, 2025
0f1fd84
remove unused
g-saracca Sep 29, 2025
e70cc4c
Merge pull request #384 from IQSS/main
g-saracca Sep 29, 2025
686ff79
refactor: remove date format validation logic and associated error ha…
g-saracca Oct 2, 2025
def5724
Merge branch 'develop' into fix/date-validation-remove
g-saracca Oct 2, 2025
565bcd5
docs: add to changelog
g-saracca Oct 2, 2025
bb9affc
test: fix test after change in the backend
g-saracca Oct 2, 2025
0931fa8
Merge pull request #379 from IQSS/343-extend-to-use-sourceLastUpdateTime
ofahimIQSS Oct 3, 2025
1421988
Merge pull request #385 from IQSS/fix/date-validation-remove
ofahimIQSS Oct 3, 2025
fb44eaf
Merge branch 'develop' into revert-377-revert-367-feat/345-get-collec…
g-saracca Oct 3, 2025
93da193
docs: add to changelog
g-saracca Oct 3, 2025
cfe34ea
feat: add pagination
ChengShi-1 Oct 3, 2025
967a016
update GetAllNotificationsByUser use case
ekraffmiller Oct 6, 2025
40189c8
add integration tests
ekraffmiller Oct 6, 2025
2ebd8af
add changelog entry
ekraffmiller Oct 8, 2025
b0929de
feat: feat: add use case to edit terms of access
ChengShi-1 Oct 14, 2025
cad29c2
Revert "feat: add pagination"
ChengShi-1 Oct 14, 2025
e9423cd
revert test environment variables
g-saracca Oct 14, 2025
ce80856
Merge pull request #378 from IQSS/revert-377-revert-367-feat/345-get-…
ofahimIQSS Oct 14, 2025
843482b
feat: create use case for collection template
ChengShi-1 Oct 17, 2025
8a0c632
feat: introduce DatasetTypeDTO and remove optional from id property i…
g-saracca Oct 20, 2025
406416c
Merge pull request #392 from IQSS/dataset-type-id
g-saracca Oct 20, 2025
7e86b76
feat: add totalCount to results
ekraffmiller Oct 21, 2025
fdaa4a6
fix: making changes based on reviews
ChengShi-1 Oct 22, 2025
a4206dd
chore: move the line in usecase.md
ChengShi-1 Oct 22, 2025
7c9a7cb
chore: renaming dto and revise changelog
ChengShi-1 Oct 22, 2025
8d571f3
fix tests and remove logs
ekraffmiller Oct 23, 2025
43e283a
resolve merge conflicts
ekraffmiller Oct 23, 2025
4ca712f
add pagination query para
ChengShi-1 Oct 23, 2025
2637a2a
Update test/integration/datasets/DatasetsRepository.test.ts
ChengShi-1 Oct 23, 2025
aa68c68
Merge Conflict
ChengShi-1 Oct 23, 2025
47bf814
Merge branch 'updateTermsOfAccess' of https://github.com/IQSS/dataver…
ChengShi-1 Oct 23, 2025
935338a
fix: termsOfAccess as TermsOfAccess & { termsOfAccess?: string }
ChengShi-1 Oct 23, 2025
2349c6a
remove the unused type add changelog
ChengShi-1 Oct 24, 2025
3407247
Merge pull request #391 from IQSS/CreateCollectionTemplate
ofahimIQSS Oct 24, 2025
7543635
changes on para
ChengShi-1 Oct 26, 2025
050a268
fix: test failing
ChengShi-1 Oct 27, 2025
3b8e6ab
Merge branch 'develop' into 394-add-pagination-query-parameters-to-da…
ChengShi-1 Oct 27, 2025
55dcbd5
fix: notficiation and changelog
ChengShi-1 Oct 27, 2025
8c22c5b
fix: notficiation test result
ChengShi-1 Oct 27, 2025
ad571e5
fix: add totalCount to version summaries
ChengShi-1 Oct 29, 2025
4b27c58
fix: test errors
ChengShi-1 Oct 29, 2025
061ad8e
fix: remove a console.log
ChengShi-1 Oct 29, 2025
a0c2e75
Merge branch 'develop' into 386-update-notifications-use-case
ekraffmiller Oct 31, 2025
421af81
Merge pull request #395 from IQSS/394-add-pagination-query-parameters…
ofahimIQSS Oct 31, 2025
77f854a
Merge Conflicts
ChengShi-1 Oct 31, 2025
cb113c5
Merge branch 'develop' into updateTermsOfAccess
ChengShi-1 Oct 31, 2025
b6d3825
chore: remove console.log
ChengShi-1 Oct 31, 2025
25bb338
chore: remove unused line
ChengShi-1 Oct 31, 2025
205715c
Merge pull request #376 from IQSS/365-set-dataset-license-and-custom-…
ChengShi-1 Nov 5, 2025
ec2282b
Merge Conflict
ChengShi-1 Nov 5, 2025
a937365
Merge pull request #389 from IQSS/updateTermsOfAccess
ChengShi-1 Nov 7, 2025
a6284c6
Initial plan
Copilot Nov 14, 2025
d6fb902
docs: change absolute GitHub blob links to relative links in README.md
Copilot Nov 14, 2025
df6436a
resolve merge conflicts
ekraffmiller Dec 2, 2025
341f655
fix NotificationsRepository.test.ts: use persistentId to test the cor…
ekraffmiller Dec 2, 2025
10460ef
update .env: change DATAVERSE_IMAGE_TAG to unstable
jp-tosca Dec 4, 2025
8b77e8f
update .env: change DATAVERSE_IMAGE_TAG to 11852-notifs-api-paginatio…
jp-tosca Dec 4, 2025
29e036a
update .env: change DATAVERSE_IMAGE_REGISTRY to docker.io and reset D…
jp-tosca Dec 4, 2025
2a1a04c
fix CollectionsRepository.test.ts: use persistentId to test the corre…
ekraffmiller Dec 4, 2025
2c0d6c5
Merge branch '386-update-notifications-use-case' of https://github.co…
ekraffmiller Dec 4, 2025
83d52ae
fix CollectionsRepository.test.ts: remove test of datasetCitation fro…
ekraffmiller Dec 5, 2025
160d58b
fix CollectionsRepository.test.ts: remove additional test of datasetC…
ekraffmiller Dec 5, 2025
6eba2d8
fix CollectionsRepository.test.ts: comment out tests that are affecte…
ekraffmiller Dec 5, 2025
36b189f
get storage driver use case
ChengShi-1 Dec 10, 2025
295b6f0
Merge pull request #387 from IQSS/386-update-notifications-use-case
jp-tosca Dec 10, 2025
8c3d8c4
Merge branch 'develop' into getStorageDriver
ChengShi-1 Dec 11, 2025
e20c2cc
Export storagedriver
ChengShi-1 Dec 13, 2025
fcdb9e4
Merge branch 'develop' into copilot/update-readme-absolute-links
ChengShi-1 Jan 5, 2026
801aa2c
Merge pull request #399 from IQSS/copilot/update-readme-absolute-links
ChengShi-1 Jan 5, 2026
243eda1
feat: restructure template
ChengShi-1 Jan 7, 2026
778f30c
feat: get and delete a single template by id
ChengShi-1 Jan 7, 2026
0d51b50
chore: sync the naming to template fron DatasetTemplate
ChengShi-1 Jan 8, 2026
0f7eab0
chore: a lint fix
ChengShi-1 Jan 8, 2026
5b57f4c
Naming Convention update
ChengShi-1 Jan 12, 2026
cbbff32
rename createDatasetTemplate to createTemplate, and clean GetTemplate…
ChengShi-1 Jan 13, 2026
31ac368
chore: use case clean
ChengShi-1 Jan 13, 2026
2b54d0a
Merge pull request #404 from IQSS/getStorageDriver
jp-tosca Jan 15, 2026
355ac27
Merge Conflict
ChengShi-1 Jan 15, 2026
9c7e9d8
Merge pull request #406 from IQSS/398-use-cases-of-adding-and-deletin…
jp-tosca Jan 15, 2026
34b9d2f
Feat: set/unset default template, and its tests
ChengShi-1 Jan 22, 2026
61c23f2
chore: remove description in README
ChengShi-1 Jan 22, 2026
a25f6ad
chore: rename use cases
ChengShi-1 Jan 22, 2026
ab00b04
chore: lint error on renaming
ChengShi-1 Jan 22, 2026
d4104c5
chore: remover docker.yml
ChengShi-1 Jan 22, 2026
44ac744
fix: depends on reviews
ChengShi-1 Jan 22, 2026
f48695f
feat: use case of dataset uploadlimit
ChengShi-1 Feb 5, 2026
468e3f4
feat: add more tests
ChengShi-1 Feb 5, 2026
6d795bb
chore: copilot review
ChengShi-1 Feb 5, 2026
448cb00
Add use cases for new settings
ekraffmiller Feb 5, 2026
5067542
Add documentation and unit tests
ekraffmiller Feb 6, 2026
a4b6fd4
update CHANGELOG.md
ekraffmiller Feb 6, 2026
77b6888
Update docs/useCases.md
ekraffmiller Feb 6, 2026
e191ba4
fix instantiation of getPublishDatasetDisclaimerText
ekraffmiller Feb 6, 2026
1631011
Merge branch '407-add-use-cases-for-publish-dataset-settings' of http…
ekraffmiller Feb 6, 2026
c023fd5
feat: Add Guestbook and Access Repository, and their use cases accord…
ChengShi-1 Feb 19, 2026
1f61ab1
use other image tag for test
ChengShi-1 Feb 19, 2026
812dd22
fix: test failing
ChengShi-1 Feb 19, 2026
c3f76f8
fix: copilot reviews
ChengShi-1 Feb 19, 2026
bba1993
fix: update collectionId to Uppercase
ChengShi-1 Feb 19, 2026
4dd5c4c
feat: update use cases of guestbook and access
ChengShi-1 Feb 26, 2026
88fb521
chore: update usecases.md
ChengShi-1 Feb 26, 2026
1aa3e31
feat: add guestId to dataset
ChengShi-1 Feb 26, 2026
f4e6bd4
chore: changelog
ChengShi-1 Feb 26, 2026
3fe127d
fix: update usecases
ChengShi-1 Mar 10, 2026
2fb1ccc
fix: remove consolelog
ChengShi-1 Mar 10, 2026
a4fe19a
fix: update datasetType model
ChengShi-1 Mar 11, 2026
63ce2d8
fix: update changelog and usecase md
ChengShi-1 Mar 11, 2026
67cc8f6
fix: update datasetType model
ChengShi-1 Mar 11, 2026
c9963aa
changelog update
ChengShi-1 Mar 12, 2026
86e9bf2
Update CHANGELOG.md
ChengShi-1 Mar 12, 2026
67721ee
Merge pull request #432 from IQSS/DatasetTypeModelUpdate
jp-tosca Mar 12, 2026
92f65b3
fix: tests and createGuestbookDTO
ChengShi-1 Mar 17, 2026
26163fe
fix: createGuestbook returns ID
ChengShi-1 Mar 17, 2026
d6e8ca8
Merge branch 'develop' into 424-use-cases-to-support-download-terms-o…
ChengShi-1 Mar 17, 2026
cbf44c0
fix: unit test
ChengShi-1 Mar 17, 2026
bc7726b
Merge branch '424-use-cases-to-support-download-terms-of-use-and-gues…
ChengShi-1 Mar 17, 2026
5f5cdd2
fix: unit test
ChengShi-1 Mar 17, 2026
199cf25
update env
ChengShi-1 Mar 17, 2026
dfc608d
Merge remote-tracking branch 'origin/develop' into 409-create-use-cas…
jp-tosca Mar 19, 2026
af1ab54
fix: update package dependencies for dataverse-client-javascript
jp-tosca Mar 19, 2026
12810ed
Merge branch 'develop' into 407-add-use-cases-for-publish-dataset-set…
ChengShi-1 Mar 19, 2026
1681f53
Merge pull request #421 from IQSS/409-create-use-case-for-getting-sto…
jp-tosca Mar 19, 2026
b3bb1e5
Merge remote-tracking branch 'origin/develop' into 424-use-cases-to-s…
jp-tosca Mar 19, 2026
554dbe0
Merge pull request #429 from IQSS/424-use-cases-to-support-download-t…
jp-tosca Mar 20, 2026
0379774
Merge remote-tracking branch 'origin/develop' into 407-add-use-cases-…
jp-tosca Mar 20, 2026
6042b29
Merge pull request #422 from IQSS/407-add-use-cases-for-publish-datas…
jp-tosca Mar 20, 2026
228424e
fix client package self-reference and alpha publish workflow
ekraffmiller Mar 20, 2026
69b8a3c
Merge pull request #433 from IQSS/fix-package-dependencies
ekraffmiller Mar 21, 2026
304d2c1
add format as an optional param to submitGuestbook for download use c…
ekraffmiller Mar 24, 2026
19b28df
fix test description, update use case documentation
ekraffmiller Mar 24, 2026
0c8eb79
added JSDoc @param for fomat in use cases
ekraffmiller Mar 24, 2026
e137f48
Merge pull request #435 from IQSS/434-format-option-for-download-usec…
jp-tosca Mar 26, 2026
8380bf3
Merge branch 'develop' into 408-use-case-to-set-default-template
ChengShi-1 Mar 31, 2026
62748a8
update AccessRepository.ts so it omits credentials if using Bearer To…
ekraffmiller Mar 31, 2026
a619488
fix: resolved a flaky test in notification
ChengShi-1 Mar 31, 2026
9562e61
Merge pull request #414 from IQSS/408-use-case-to-set-default-template
sekmiller Mar 31, 2026
5be90ea
add test that the signedUrl download works
ekraffmiller Apr 3, 2026
d497b2b
Merge branch 'develop' into 437-access-repository-omit-credentials
ekraffmiller Apr 3, 2026
a4458ff
throw WriteError if signedUrl is missing, reset fetch method in test
ekraffmiller Apr 3, 2026
636aa9c
Merge pull request #438 from IQSS/437-access-repository-omit-credentials
sekmiller Apr 10, 2026
f865ec4
skip
jp-tosca Apr 20, 2026
4f7d4b5
Revert "skip"
jp-tosca Apr 20, 2026
fb3730e
new release
ChengShi-1 Apr 24, 2026
6737107
fix
ChengShi-1 Apr 24, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions .github/workflows/deploy_alpha.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,17 +71,19 @@ jobs:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
echo "//npm.pkg.github.com/:_authToken=${{ secrets.GITHUB_TOKEN }}" > ~/.npmrc
CURRENT_PACKAGE_VERSION=$(jq -r '.version' package.json)
BASE_VERSION=${CURRENT_PACKAGE_VERSION%%-alpha.*}

LATEST_VERSION=$(npm show @IQSS/dataverse-client-javascript versions --registry=https://npm.pkg.github.com/ --json | jq -r '.[]' | grep "^2.0.0-alpha." | sort -V | tail -n 1)
LATEST_VERSION=$(npm show @iqss/dataverse-client-javascript versions --registry=https://npm.pkg.github.com/ --json | jq -r '.[]' | grep "^${BASE_VERSION}-alpha\\." | sort -V | tail -n 1)

if [ -z "$LATEST_VERSION" ]; then
NEW_INCREMENTAL_NUMBER=1
else
CURRENT_INCREMENTAL_NUMBER=$(echo $LATEST_VERSION | sed 's/2.0.0-alpha.//')
CURRENT_INCREMENTAL_NUMBER=$(echo "$LATEST_VERSION" | sed "s/^${BASE_VERSION}-alpha\\.//")
NEW_INCREMENTAL_NUMBER=$((CURRENT_INCREMENTAL_NUMBER + 1))
fi

NEW_VERSION="2.0.0-alpha.${NEW_INCREMENTAL_NUMBER}"
NEW_VERSION="${BASE_VERSION}-alpha.${NEW_INCREMENTAL_NUMBER}"

echo "Latest version: $LATEST_VERSION"
echo "New version: $NEW_VERSION"
Expand All @@ -92,7 +94,6 @@ jobs:
- name: Publish package
run: |
echo "$(jq '.publishConfig.registry = "https://npm.pkg.github.com"' package.json)" > package.json
echo "$( jq '.name = "@IQSS/dataverse-client-javascript"' package.json )" > package.json
npm publish --@IQSS:registry=https://npm.pkg.github.com
npm publish --@iqss:registry=https://npm.pkg.github.com
env:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
3 changes: 1 addition & 2 deletions .github/workflows/deploy_pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ jobs:
- name: Publish package
run: |
echo "$(jq '.publishConfig.registry = "https://npm.pkg.github.com"' package.json)" > package.json
echo "$( jq '.name = "@IQSS/dataverse-client-javascript"' package.json )" > package.json
npm publish --@IQSS:registry=https://npm.pkg.github.com
npm publish --@iqss:registry=https://npm.pkg.github.com
env:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
42 changes: 40 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,45 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel

### Removed

[Unreleased]: https://github.com/IQSS/dataverse-client-javascript/compare/v2.1.0...develop
## [v2.2.0] -- 2026-04-24

### Added

- Datasets: Added `updateDatasetLicense` use case and repository method to support Dataverse endpoint `PUT /datasets/{id}/license`, for updating dataset license or custom terms.
- Datasets: Added `getDatasetStorageDriver` use case and repository method to support Dataverse endpoint `GET /datasets/{identifier}/storageDriver`, for retrieving dataset storage driver configuration with properties: name, type, label, directUpload, directDownload, and uploadOutOfBand.
- Datasets: Added `getDatasetUploadLimits` use case and repository method to support Dataverse endpoint `GET /datasets/{id}/uploadlimits`, for retrieving remaining storage upload quotas, if present.
- New Use Case: [Get Collections For Linking Use Case](./docs/useCases.md#get-collections-for-linking).
- New Use Case: [Create a Template](./docs/useCases.md#create-a-template) under Templates.
- New Use Case: [Get a Template](./docs/useCases.md#get-a-template) under Templates.
- New Use Case: [Delete a Template](./docs/useCases.md#delete-a-template) under Templates.
- Templates: Added `setTemplateAsDefault` use case and repository method to support Dataverse endpoint `POST /dataverses/{id}/template/default/{templateId}`.
- Templates: Added `unsetTemplateAsDefault` use case and repository method to support Dataverse endpoint `DELETE /dataverses/{id}/template/default`.
- New Use Case: [Update Terms of Access](./docs/useCases.md#update-terms-of-access).
- Guestbooks: Added use cases and repository support for guestbook creation, listing, and enabling/disabling.
- Guestbooks: Added dataset-level guestbook assignment and removal support via `assignDatasetGuestbook` (`PUT /api/datasets/{identifier}/guestbook`) and `removeDatasetGuestbook` (`DELETE /api/datasets/{identifier}/guestbook`).
- Datasets/Guestbooks: Added `guestbookId` in `getDataset` responses.
- Access: Added`access` module for guestbook-at-request and download terms/guestbook submission endpoints.
- New Use Case: [Get Publish Dataset Disclaimer Text](./docs/useCases.md#get-publish-dataset-disclaimer-text).
- New Use Case: [Get Dataset Publish Popup Custom Text](./docs/useCases.md#get-dataset-publish-popup-custom-text).
- DatasetType: Updated datasetType data model. Added two more fields: description and displayName.

### Changed

- Add pagination query parameters to Dataset Version Summeries and File Version Summaries use cases.
- Templates: Rename `CreateDatasetTemplateDTO` to `CreateTemplateDTO`.
- Templates: Rename `createDatasetTemplate` repository method to `createTemplate`.
- Templates: Rename `getDatasetTemplates` repository method to `getTemplatesByCollectionId`.

### Fixed

- In GetAllNotificationsByUser use case, additionalInfo field is returned as an object instead of a string.
- In GetAllNotificationsByUser use case, added support for filtering unread messages and pagination.

### Removed

- Removed date fields validations in create and update dataset use cases, since validation is already handled in the backend and SPA frontend (other clients should perform client side validation also). This avoids duplicated logic and keeps the package focused on its core responsibility.

[Unreleased]: https://github.com/IQSS/dataverse-client-javascript/compare/v2.2.0...develop

---

Expand All @@ -38,7 +76,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel

- Use cases for External Tools: GetExternalTools, GetDatasetExternalToolResolved, GetFileExternalToolResolved.

- Use case: GetDatasetTemplates.
- Use case: GetTemplatesByCollectionId.

- Use case: GetAvailableStandardLicenses.

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@ getDataset.execute(datasetIdentifier, datasetVersion).then((dataset: Dataset) =>
/* ... */
```

For detailed information about available use cases see [Use Cases Docs](https://github.com/IQSS/dataverse-client-javascript/blob/main/docs/useCases.md).
For detailed information about available use cases see [Use Cases Docs](docs/useCases.md).

For detailed information about usage see [Usage Docs](https://github.com/IQSS/dataverse-client-javascript/blob/main/docs/usage.md).
For detailed information about usage see [Usage Docs](docs/usage.md).

## Changelog

See [CHANGELOG.md](https://github.com/IQSS/dataverse-client-javascript/blob/main/CHANGELOG.md) for a detailed history of changes to this project.
See [CHANGELOG.md](CHANGELOG.md) for a detailed history of changes to this project.

## Contributing

Want to add a new use case or improve an existing one? Please check the [Contributing](https://github.com/IQSS/dataverse-client-javascript/blob/main/CONTRIBUTING.md) section.
Want to add a new use case or improve an existing one? Please check the [Contributing](CONTRIBUTING.md) section.

## License

This project is open source and available under the [MIT License](https://github.com/IQSS/dataverse-client-javascript/blob/main/LICENSE).
This project is open source and available under the [MIT License](LICENSE).
Loading
Loading