Merge pull request #406 from IQSS/398-use-cases-of-adding-and-deleting-a-new-template

Use Cases of Get and Delete a template

Author: jp-tosca

CHANGELOG.md

@@ -8,16 +8,21 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 
 ### 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 `updateDatasetLicense` use case and repository method to support Dataverse endpoint `PUT /datasets/{id}/license`, for updating dataset license or custom terms
 - New Use Case: [Get Collections For Linking Use Case](./docs/useCases.md#get-collections-for-linking).
-- New Use Case: [Create a Dataset Template](./docs/useCases.md#create-a-dataset-template) under Collections.
-
+- 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.
 - New Use Case: [Update Terms of Access](./docs/useCases.md#update-terms-of-access).
 
 ### Changed
 
-- Add pagination query parameters to Dataset Version Summeries and File Version Summaries use cases
+- 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
 
@@ -52,7 +57,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.
 

docs/useCases.md

@@ -25,7 +25,13 @@ The different use cases currently available in the package are classified below,
     - [Update Collection Featured Items](#update-collection-featured-items)
     - [Delete Collection Featured Items](#delete-collection-featured-items)
     - [Delete a Collection Featured Item](#delete-a-collection-featured-item)
-    - [Create a Dataset Template](#create-a-dataset-template)
+- [Templates](#Templates)
+  - [Templates read use cases](#templates-read-use-cases)
+    - [Get a Template](#get-a-template)
+    - [Get Templates By Collection Id](#get-templates-by-collection-id)
+  - [Templates write use cases](#templates-write-use-cases)
+    - [Create a Template](#create-a-template)
+    - [Delete a Template](#delete-a-template)
 - [Datasets](#Datasets)
   - [Datasets read use cases](#datasets-read-use-cases)
     - [Get a Dataset](#get-a-dataset)
@@ -570,18 +576,60 @@ deleteCollectionFeaturedItem.execute(featuredItemId)
 
 _See [use case](../src/collections/domain/useCases/DeleteCollectionFeaturedItem.ts)_ definition.
 
-#### Create a Dataset Template
+## Templates
 
-Creates a dataset template for a given Dataverse collection id or alias.
+### Templates Read Use Cases
+
+#### Get a Template
+
+Returns a [Template](../src/templates/domain/models/Template.ts) by its template id.
+
+##### Example call:
+
+```typescript
+import { getTemplate } from '@iqss/dataverse-client-javascript'
+
+const templateId = 12345
+
+getTemplate.execute(templateId).then((template: Template) => {
+  /* ... */
+})
+```
+
+_See [use case](../src/templates/domain/useCases/GetTemplate.ts)_ definition.
+
+#### Get Templates By Collection Id
+
+Returns a [Template](../src/templates/domain/models/Template.ts) array containing the templates of the requested collection, given the collection identifier or alias.
+
+##### Example call:
+
+```typescript
+import { getTemplatesByCollectionId } from '@iqss/dataverse-client-javascript'
+
+const collectionIdOrAlias = 12345
+
+getTemplatesByCollectionId.execute(collectionIdOrAlias).then((template: Template[]) => {
+  /* ... */
+})
+```
+
+_See [use case](../src/templates/domain/useCases/GetTemplatesByCollectionId.ts)_ definition.
+
+### Templates Write Use Cases
+
+#### Create a Template
+
+Creates a template for a given Dataverse collection id or alias.
 
 ##### Example call:
 
 ```typescript
-import { createDatasetTemplate } from '@iqss/dataverse-client-javascript'
-import { TemplateCreateDTO } from '@iqss/dataverse-client-javascript'
+import { createTemplate } from '@iqss/dataverse-client-javascript'
+import { CreateTemplateDTO } from '@iqss/dataverse-client-javascript'
 
 const collectionAlias = ':root'
-const template: TemplateCreateDTO = {
+const template: CreateTemplateDTO = {
   name: 'Dataverse template',
   isDefault: true,
   fields: [
@@ -600,10 +648,26 @@ const template: TemplateCreateDTO = {
   instructions: [{ instructionField: 'author', instructionText: 'The author data' }]
 }
 
-await createDatasetTemplate.execute(template, collectionAlias)
+await createTemplate.execute(template, collectionAlias)
+```
+
+_See [use case](../src/templates/domain/useCases/CreateTemplate.ts) implementation_.
+
+#### Delete a Template
+
+Deletes a template by its template id.
+
+##### Example call:
+
+```typescript
+import { deleteTemplate } from '@iqss/dataverse-client-javascript'
+
+const templateId = 12345
+
+await deleteTemplate.execute(templateId)
 ```
 
-_See [use case](../src/collections/domain/useCases/CreateDatasetTemplate.ts) implementation_.
+_See [use case](../src/templates/domain/useCases/DeleteTemplate.ts)_ definition.
 
 ## Datasets
 
@@ -1334,6 +1398,8 @@ _See [use case](../src/datasets/domain/useCases/GetDatasetAvailableCategories.ts
 
 The `datasetId` parameter is a number for numeric identifiers or string for persistent identifiers.
 
+# <<<<<<< HEAD
+
 #### Get Dataset Templates
 
 Returns a [DatasetTemplate](../src/datasets/domain/models/DatasetTemplate.ts) array containing the dataset templates of the requested collection, given the collection identifier or alias.
@@ -1376,6 +1442,8 @@ _See [use case](../src/datasets/domain/useCases/GetDatasetStorageDriver.ts) impl
 
 The `datasetId` parameter can be a string, for persistent identifiers, or a number, for numeric identifiers.
 
+> > > > > > > develop
+
 #### Add a Dataset Type
 
 Adds a dataset types that can be used at dataset creation.

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -12,7 +12,6 @@ import { CollectionItemType } from '../../../collections/domain/models/Collectio
 import { CollectionLinks } from '../models/CollectionLinks'
 import { CollectionSummary } from '../models/CollectionSummary'
 import { LinkingObjectType } from '../useCases/GetCollectionsForLinking'
-import { CreateDatasetTemplateDTO } from '../dtos/CreateDatasetTemplateDTO'
 
 export interface ICollectionsRepository {
   getCollection(collectionIdOrAlias: number | string): Promise<Collection>
@@ -69,8 +68,4 @@ export interface ICollectionsRepository {
     searchTerm: string,
     alreadyLinked: boolean
   ): Promise<CollectionSummary[]>
-  createDatasetTemplate(
-    collectionIdOrAlias: number | string,
-    template: CreateDatasetTemplateDTO
-  ): Promise<void>
 }

src/collections/domain/useCases/CreateDatasetTemplate.ts

@@ -16,7 +16,6 @@ import { LinkCollection } from './domain/useCases/LinkCollection'
 import { UnlinkCollection } from './domain/useCases/UnlinkCollection'
 import { GetCollectionLinks } from './domain/useCases/GetCollectionLinks'
 import { GetCollectionsForLinking } from './domain/useCases/GetCollectionsForLinking'
-import { CreateDatasetTemplate } from './domain/useCases/CreateDatasetTemplate'
 
 const collectionsRepository = new CollectionsRepository()
 
@@ -37,7 +36,6 @@ const linkCollection = new LinkCollection(collectionsRepository)
 const unlinkCollection = new UnlinkCollection(collectionsRepository)
 const getCollectionLinks = new GetCollectionLinks(collectionsRepository)
 const getCollectionsForLinking = new GetCollectionsForLinking(collectionsRepository)
-const createDatasetTemplate = new CreateDatasetTemplate(collectionsRepository)
 
 export {
   getCollection,
@@ -56,8 +54,7 @@ export {
   linkCollection,
   unlinkCollection,
   getCollectionLinks,
-  getCollectionsForLinking,
-  createDatasetTemplate
+  getCollectionsForLinking
 }
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
 export { CollectionFacet } from './domain/models/CollectionFacet'

src/collections/index.ts

@@ -40,7 +40,6 @@ import { ReadError } from '../../../core/domain/repositories/ReadError'
 import { CollectionLinks } from '../../domain/models/CollectionLinks'
 import { CollectionSummary } from '../../domain/models/CollectionSummary'
 import { LinkingObjectType } from '../../domain/useCases/GetCollectionsForLinking'
-import { CreateDatasetTemplateDTO } from '../../domain/dtos/CreateDatasetTemplateDTO'
 
 export interface NewCollectionRequestPayload {
   alias: string
@@ -529,18 +528,4 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
-
-  public async createDatasetTemplate(
-    collectionIdOrAlias: number | string,
-    template: CreateDatasetTemplateDTO
-  ): Promise<void> {
-    return this.doPost(
-      `/${this.collectionsResourceName}/${collectionIdOrAlias}/templates`,
-      template
-    )
-      .then(() => undefined)
-      .catch((error) => {
-        throw error
-      })
-  }
 }

src/collections/infra/repositories/CollectionsRepository.ts

@@ -12,7 +12,6 @@ import { DatasetVersionSummarySubset } from '../models/DatasetVersionSummaryInfo
 import { DatasetLinkedCollection } from '../models/DatasetLinkedCollection'
 import { CitationFormat } from '../models/CitationFormat'
 import { FormattedCitation } from '../models/FormattedCitation'
-import { DatasetTemplate } from '../models/DatasetTemplate'
 import { DatasetType } from '../models/DatasetType'
 import { TermsOfAccess } from '../models/Dataset'
 import { DatasetLicenseUpdateRequest } from '../dtos/DatasetLicenseUpdateRequest'
@@ -85,7 +84,6 @@ export interface IDatasetsRepository {
     format: CitationFormat,
     includeDeaccessioned?: boolean
   ): Promise<FormattedCitation>
-  getDatasetTemplates(collectionIdOrAlias: number | string): Promise<DatasetTemplate[]>
   getDatasetAvailableDatasetTypes(): Promise<DatasetType[]>
   getDatasetAvailableDatasetType(datasetTypeId: number | string): Promise<DatasetType>
   addDatasetType(datasetType: DatasetTypeDTO): Promise<DatasetType>

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -31,7 +31,6 @@ import { LinkDatasetTypeWithMetadataBlocks } from './domain/useCases/LinkDataset
 import { SetAvailableLicensesForDatasetType } from './domain/useCases/SetAvailableLicensesForDatasetType'
 import { DeleteDatasetType } from './domain/useCases/DeleteDatasetType'
 import { GetDatasetCitationInOtherFormats } from './domain/useCases/GetDatasetCitationInOtherFormats'
-import { GetDatasetTemplates } from './domain/useCases/GetDatasetTemplates'
 import { UpdateTermsOfAccess } from './domain/useCases/UpdateTermsOfAccess'
 import { UpdateDatasetLicense } from './domain/useCases/UpdateDatasetLicense'
 import { GetDatasetStorageDriver } from './domain/useCases/GetDatasetStorageDriver'
@@ -82,7 +81,6 @@ const setAvailableLicensesForDatasetType = new SetAvailableLicensesForDatasetTyp
 )
 const deleteDatasetType = new DeleteDatasetType(datasetsRepository)
 const getDatasetCitationInOtherFormats = new GetDatasetCitationInOtherFormats(datasetsRepository)
-const getDatasetTemplates = new GetDatasetTemplates(datasetsRepository)
 const updateTermsOfAccess = new UpdateTermsOfAccess(datasetsRepository)
 const updateDatasetLicense = new UpdateDatasetLicense(datasetsRepository)
 const getDatasetStorageDriver = new GetDatasetStorageDriver(datasetsRepository)
@@ -109,7 +107,6 @@ export {
   getDatasetLinkedCollections,
   getDatasetAvailableCategories,
   getDatasetCitationInOtherFormats,
-  getDatasetTemplates,
   updateTermsOfAccess,
   getDatasetAvailableDatasetTypes,
   getDatasetAvailableDatasetType,

src/datasets/domain/useCases/GetDatasetTemplates.ts

@@ -1,4 +1,3 @@
-import { AxiosResponse } from 'axios'
 import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { IDatasetsRepository } from '../../domain/repositories/IDatasetsRepository'
 import { Dataset, VersionUpdateType } from '../../domain/models/Dataset'
@@ -25,9 +24,6 @@ import { DatasetLinkedCollection } from '../../domain/models/DatasetLinkedCollec
 import { CitationFormat } from '../../domain/models/CitationFormat'
 import { transformDatasetLinkedCollectionsResponseToDatasetLinkedCollection } from './transformers/datasetLinkedCollectionsTransformers'
 import { FormattedCitation } from '../../domain/models/FormattedCitation'
-import { DatasetTemplate } from '../../domain/models/DatasetTemplate'
-import { DatasetTemplatePayload } from './transformers/DatasetTemplatePayload'
-import { transformDatasetTemplatePayloadToDatasetTemplate } from './transformers/datasetTemplateTransformers'
 import { DatasetType } from '../../domain/models/DatasetType'
 import { TermsOfAccess } from '../../domain/models/Dataset'
 import { transformTermsOfAccessToUpdatePayload } from './transformers/termsOfAccessTransformers'
@@ -403,18 +399,6 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
       })
   }
 
-  public async getDatasetTemplates(
-    collectionIdOrAlias: number | string
-  ): Promise<DatasetTemplate[]> {
-    return this.doGet(`/dataverses/${collectionIdOrAlias}/templates`, true)
-      .then((response: AxiosResponse<{ data: DatasetTemplatePayload[] }>) =>
-        transformDatasetTemplatePayloadToDatasetTemplate(response.data.data)
-      )
-      .catch((error) => {
-        throw error
-      })
-  }
-
   public async getDatasetAvailableDatasetTypes(): Promise<DatasetType[]> {
     return this.doGet(this.buildApiEndpoint(this.datasetsResourceName, 'datasetTypes'))
       .then((response) => response.data.data)