Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Add use cases for dataset curation status and submit for review

オープン
#493 コメント 0 件 リアクション 0 件 担当者 1 名 GitHub で見る

@ChengShi-1 がすでに取り組んでいます。

2026年10月8日 から。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
72/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
typescript

調査の方向性

Read the existing datasets use cases under the package's datasets domain folder (e.g. an existing Get* use case), then IDatasetsRepository and its DatasetsRepository HTTP implementation, to copy the use-case → interface → implementation pattern. Map the six endpoints from the table, export everything from the package's public entry point, and mirror existing unit tests (delegation, error propagation) plus integration tests for numeric/persistent IDs. Done means docs/useCases.md and the [Unreleased] changelog updated and build, type-check, lint, unit tests and integration tests pass.

索引モデルが issue の本文から書いたものです。

説明

FY27 Sprint 8 Size: 10 SPA

Overview of the feature request

Add public use cases for the existing Dataverse curation-status APIs so the SPA can support the same label selection, removal, and history functionality as JSF. Curation labels are configurable tracking values. Changing a label does not submit a dataset for review, return it to its author, or publish it.

Also, add an use case of Submit for Review for anonymous user to submit the dataset to review.

What inspired the request?

The frontend's ChangeCurationStatusMenu currently opens the not-implemented modal. Its allowed labels come from hard-coded values in DataverseInfoJSDataverseRepository.getExternalStatusesAllowed(). The frontend needs the effective labels for each dataset and reusable client methods for the real API operations.

What existing behavior do you want changed?

Expose these operations through the package's public API, following the existing use-case → repository interface → repository implementation pattern. Consumers should not need direct HTTP requests or imports from internal dist/ paths.

Any brand new behavior do you want to add to dataverse-client-javascript?

Proposed use cases (names can follow project conventions):

Use case Backend API
GetAllowedDatasetCurationLabels GET /api/datasets/{id}/allowedCurationLabels
GetDatasetCurationStatus GET /api/datasets/{id}/curationStatus
GetDatasetCurationStatusHistory GET /api/datasets/{id}/curationStatus?includeHistory=true
SetDatasetCurationStatus PUT /api/datasets/{id}/curationStatus?label={label}
DeleteDatasetCurationStatus DELETE /api/datasets/{id}/curationStatus
SubmitforReview POST /api/datasets/{id}/submitForReview
Acceptance criteria
  • Implement and publicly export all five use cases and their models.
  • Extend IDatasetsRepository and DatasetsRepository, with response mapping as needed.
  • Add unit tests for delegation, response normalization, history/removal records, and error propagation.
  • Add integration tests for numeric and persistent IDs, query encoding, allowed-label retrieval, set/read/change/remove/history, and forbidden or invalid operations.
  • Verify a status change does not change review locks or publication state.
  • Document required configuration (:AllowedCurationLabels and effective label-set selection), publisher permissions for mutations/allowed-label reads, and configurable visibility for status reads.
  • Update docs/useCases.md and the [Unreleased] changelog; pass build, type checking, lint, and relevant tests.

This issue covers client wrappers for existing curation-status APIs. Frontend components, administrator label-set configuration APIs, submit-for-review, and return-to-author use cases can be tracked separately.

Any open or closed issues related to this feature request?

No matching curation-status issue was found. #447 concerns linked review datasets, which are separate from curation labels and their history.

References:

主要言語
TypeScript
スター
20
フォーク
11
平均マージ
4日 9時間
マージ済み PR(30日)
3

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

IQSS/dataverse-client-javascript のほかの issue

IQSS/dataverse-client-javascript の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。