Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Add use cases for dataset curation status and submit for review

Aberta
  • Algo errado?
#493 0 comentários 0 reações 1 responsável Ver no GitHub

@ChengShi-1 já está trabalhando nisso.

Desde 8/10/2026.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
72/100
Tipo de issue
Funcionalidade
Clareza
Claramente especificada
Status de atividade
Ativa
Stack de tecnologia
typescript
Domínio
api, developer-experience

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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:

Linguagem predominante
TypeScript
Estrelas
20
Forks
11
Merge médio
4d 9h
PRs com merge (30d)
3

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de IQSS/dataverse-client-javascript

Todas as issues de IQSS/dataverse-client-javascript

Issues semelhantes

Mais issues de TypeScript

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.