You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+48-2Lines changed: 48 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,15 +9,61 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
9
9
### Added
10
10
11
11
- Datasets: Added `updateDatasetLicense` use case and repository method to support Dataverse endpoint `PUT /datasets/{id}/license`, for updating dataset license or custom terms
12
+
- New Use Case: [Get Collections For Linking Use Case](./docs/useCases.md#get-collections-for-linking).
13
+
- New Use Case: [Create a Dataset Template](./docs/useCases.md#create-a-dataset-template) under Collections.
12
14
13
15
### Changed
14
16
15
17
### Fixed
16
18
17
19
### Removed
18
20
21
+
- 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.
Copy file name to clipboardExpand all lines: docs/making-releases.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,8 +41,6 @@ npm version 3.5.0 --no-git-tag-version
41
41
42
42
This command will update the version in the `package.json` and `package-lock.json`.
43
43
44
-
If everything looks good, you can push the changes to the repository.
45
-
46
44
## Update the changelog
47
45
48
46
**Note**: Contributors should have already added their changes to the `[Unreleased]` section as part of their pull requests (see [CONTRIBUTING.md](../.github/CONTRIBUTING.md#changelog-guidelines) for details).
@@ -86,8 +84,9 @@ Before releasing, ensure the changelog is properly prepared:
86
84
### Removed
87
85
```
88
86
89
-
4.**Update the version links** at the bottom of the changelog files
90
-
5.**Commit the changelog updates** as part of the release preparation
87
+
4.**Commit the changelog updates** as part of the release preparation
88
+
89
+
If everything looks good, you can push the changes to the repository.
Copy file name to clipboardExpand all lines: docs/useCases.md
+104-2Lines changed: 104 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@ The different use cases currently available in the package are classified below,
16
16
-[List All Collection Items](#list-all-collection-items)
17
17
-[List My Data Collection Items](#list-my-data-collection-items)
18
18
-[Get Collection Featured Items](#get-collection-featured-items)
19
+
-[Get Collections for Linking](#get-collections-for-linking)
19
20
-[Collections write use cases](#collections-write-use-cases)
20
21
-[Create a Collection](#create-a-collection)
21
22
-[Update a Collection](#update-a-collection)
@@ -24,6 +25,7 @@ The different use cases currently available in the package are classified below,
24
25
-[Update Collection Featured Items](#update-collection-featured-items)
25
26
-[Delete Collection Featured Items](#delete-collection-featured-items)
26
27
-[Delete a Collection Featured Item](#delete-a-collection-featured-item)
28
+
-[Create a Dataset Template](#create-a-dataset-template)
27
29
-[Datasets](#Datasets)
28
30
-[Datasets read use cases](#datasets-read-use-cases)
29
31
-[Get a Dataset](#get-a-dataset)
@@ -337,6 +339,69 @@ The `collectionIdOrAlias` is a generic collection identifier, which can be eithe
337
339
338
340
If no collection identifier is specified, the default collection identifier; `:root` will be used. If you want to search for a different collection, you must add the collection identifier as a parameter in the use case call.
339
341
342
+
#### Get Collections for Linking
343
+
344
+
Returns an array of [CollectionSummary](../src/collections/domain/models/CollectionSummary.ts) (id, alias, displayName) representing the Dataverse collections to which a given Dataverse collection or Dataset may be linked.
345
+
346
+
This use case supports an optional `searchTerm` to filter by collection name.
Creates a new Dataset in a collection, given a [DatasetDTO](../src/datasets/domain/dtos/DatasetDTO.ts) object and an optional collection identifier, which defaults to `:root`.
964
+
Creates a new Dataset in a collection, given a [DatasetDTO](../src/datasets/domain/dtos/DatasetDTO.ts) object, an optional collection identifier, which defaults to `:root`, and an optional dataset type.
865
965
866
966
This use case validates the submitted fields of each metadata block and can return errors of type [ResourceValidationError](../src/core/domain/useCases/validators/errors/ResourceValidationError.ts), which include sufficient information to determine which field value is invalid and why.
The above example creates the new dataset in the root collection since no collection identifier is specified. If you want to create the dataset in a different collection, you must add the collection identifier as a second parameter in the use case call.
1019
+
The above example creates the new dataset in the root collection since no collection identifier is specified. If you want to create the dataset in a different collection, you must add the collection identifier as a second parameter in the use case call. If you want the dataset type to be anything other than dataset, first [check available dataset types](#get-dataset-available-dataset-types) and then add the name of the dataset type as the third parameter.
920
1020
921
1021
The use case returns a [CreatedDatasetIdentifiers](../src/datasets/domain/models/CreatedDatasetIdentifiers.ts) object, which includes the persistent and numeric identifiers of the created dataset.
922
1022
@@ -2050,6 +2150,8 @@ The `collectionIdOrAlias` is a generic collection identifier, which can be eithe
2050
2150
2051
2151
There is a second optional parameter called `onlyDisplayedOnCreate` which indicates whether or not to return only the metadata blocks that are displayed on dataset creation. The default value is false.
2052
2152
2153
+
There is a third optional parameter called `datasetType` which will include additional fields from metadata blocks linked to the provided type, if any. Before using this parameter, you will probably want to [list available dataset types](#get-dataset-available-dataset-types) for your installation.
0 commit comments