IQSS / dataverse-client-javascript

A Dataverse client for JavaScript and TypeScript

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Modify the dataset type description to explicitly declare the citation metadata fields

MellyGray opened this issue · comments

Overview of the feature request

Modify the dataset type definition to explicitly declare the citation metadata fields

What inspired the request?

We'll be using some fields of the citation metadata for different behaviours of the SPA, it makes sense that the CitationMetadata fields are explicitly defined in the dataset type so the frontend developers can know what to expect from the citation. For example the dataset title it's a field that no matter the frontend, it will be handled with some specific UI logic, so it doesn't make sense to have this title hidden behind a generic MetadataField type without knowing the key of this field.

There are more cases like this one so we decided to make the citation block fields explicit in the definition of the dataset interface so any user of the js-dataverse module knows what keys to expect from the dataset citation metadata block.

What existing behavior do you want changed?

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

Add the specific keys of the citation metadata fields to the Dataset interface definition

Any open or closed issues related to this feature request?