feat: get and delete a single template by id

Author: ChengShi-1

CHANGELOG.md

@@ -9,8 +9,14 @@ 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
+
 - 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 Dataset Template](./docs/useCases.md#create-a-dataset-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).
 

docs/useCases.md

@@ -27,9 +27,11 @@ The different use cases currently available in the package are classified below,
     - [Delete a Collection Featured Item](#delete-a-collection-featured-item)
 - [Templates](#Templates)
   - [Templates read use cases](#templates-read-use-cases)
+    - [Get a Template](#get-a-template)
     - [Get Dataset Templates](#get-dataset-templates)
   - [Templates write use cases](#templates-write-use-cases)
     - [Create a Dataset Template](#create-a-dataset-template)
+    - [Delete a Template](#delete-a-template)
 - [Datasets](#Datasets)
   - [Datasets read use cases](#datasets-read-use-cases)
     - [Get a Dataset](#get-a-dataset)
@@ -576,6 +578,24 @@ _See [use case](../src/collections/domain/useCases/DeleteCollectionFeaturedItem.
 
 ### Templates Read Use Cases
 
+#### Get a Template
+
+Returns a [DatasetTemplate](../src/template/domain/models/DatasetTemplate.ts) by its template id.
+
+##### Example call:
+
+```typescript
+import { getTemplate } from '@iqss/dataverse-client-javascript'
+
+const templateId = 12345
+
+getTemplate.execute(templateId).then((template: DatasetTemplate) => {
+  /* ... */
+})
+```
+
+_See [use case](../src/template/domain/useCases/GetTemplate.ts)_ definition.
+
 #### Get Dataset Templates
 
 Returns a [DatasetTemplate](../src/template/domain/models/DatasetTemplate.ts) array containing the dataset templates of the requested collection, given the collection identifier or alias.
@@ -631,6 +651,22 @@ await createDatasetTemplate.execute(template, collectionAlias)
 
 _See [use case](../src/template/domain/useCases/CreateDatasetTemplate.ts) implementation_.
 
+#### Delete a Template
+
+Deletes a dataset 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/template/domain/useCases/DeleteTemplate.ts)_ definition.
+
 ## Datasets
 
 ### Datasets Read Use Cases

src/template/domain/repositories/ITemplatesRepository.ts

@@ -6,5 +6,7 @@ export interface ITemplatesRepository {
     collectionIdOrAlias: number | string,
     template: CreateDatasetTemplateDTO
   ): Promise<void>
+  getTemplate(templateId: number): Promise<DatasetTemplate>
   getDatasetTemplates(collectionIdOrAlias: number | string): Promise<DatasetTemplate[]>
+  deleteTemplate(templateId: number): Promise<void>
 }

src/template/domain/useCases/DeleteTemplate.ts

@@ -0,0 +1,19 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { ITemplatesRepository } from '../repositories/ITemplatesRepository'
+
+export class DeleteTemplate implements UseCase<void> {
+  private templatesRepository: ITemplatesRepository
+
+  constructor(templatesRepository: ITemplatesRepository) {
+    this.templatesRepository = templatesRepository
+  }
+
+  /**
+   * Deletes a dataset template by its template id.
+   *
+   * @param {number} templateId - Dataset template id.
+   */
+  async execute(templateId: number): Promise<void> {
+    return await this.templatesRepository.deleteTemplate(templateId)
+  }
+}

src/template/domain/useCases/GetTemplate.ts

@@ -0,0 +1,21 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { DatasetTemplate } from '../models/DatasetTemplate'
+import { ITemplatesRepository } from '../repositories/ITemplatesRepository'
+
+export class GetTemplate implements UseCase<DatasetTemplate> {
+  private templatesRepository: ITemplatesRepository
+
+  constructor(templatesRepository: ITemplatesRepository) {
+    this.templatesRepository = templatesRepository
+  }
+
+  /**
+   * Returns a dataset template by its template id.
+   *
+   * @param {number} templateId - Dataset template id.
+   * @returns {Promise<DatasetTemplate>}
+   */
+  async execute(templateId: number): Promise<DatasetTemplate> {
+    return await this.templatesRepository.getTemplate(templateId)
+  }
+}

src/template/index.ts

@@ -1,13 +1,17 @@
 import { TemplatesRepository } from './infra/repositories/TemplatesRepository'
 import { CreateDatasetTemplate } from './domain/useCases/CreateDatasetTemplate'
+import { DeleteTemplate } from './domain/useCases/DeleteTemplate'
 import { GetDatasetTemplates } from './domain/useCases/GetDatasetTemplates'
+import { GetTemplate } from './domain/useCases/GetTemplate'
 
 const templatesRepository = new TemplatesRepository()
 
 const createDatasetTemplate = new CreateDatasetTemplate(templatesRepository)
+const deleteTemplate = new DeleteTemplate(templatesRepository)
 const getDatasetTemplates = new GetDatasetTemplates(templatesRepository)
+const getTemplate = new GetTemplate(templatesRepository)
 
-export { createDatasetTemplate, getDatasetTemplates }
+export { createDatasetTemplate, deleteTemplate, getDatasetTemplates, getTemplate }
 export {
   CreateDatasetTemplateDTO,
   TemplateFieldDTO,

src/template/infra/repositories/TemplatesRepository.ts

@@ -4,7 +4,10 @@ import { CreateDatasetTemplateDTO } from '../../domain/dtos/CreateDatasetTemplat
 import { DatasetTemplate } from '../../domain/models/DatasetTemplate'
 import { ITemplatesRepository } from '../../domain/repositories/ITemplatesRepository'
 import { DatasetTemplatePayload } from './transformers/DatasetTemplatePayload'
-import { transformDatasetTemplatePayloadToDatasetTemplate } from './transformers/datasetTemplateTransformers'
+import {
+  transformTemplatePayloadToTemplate,
+  transformTemplatePayloadsToTemplates
+} from './transformers/datasetTemplateTransformers'
 
 export class TemplatesRepository extends ApiRepository implements ITemplatesRepository {
   private readonly collectionsResourceName: string = 'dataverses'
@@ -23,15 +26,33 @@ export class TemplatesRepository extends ApiRepository implements ITemplatesRepo
       })
   }
 
+  public async getTemplate(templateId: number): Promise<DatasetTemplate> {
+    return this.doGet(`/dataverses/${templateId}/template`, true)
+      .then((response: AxiosResponse<{ data: DatasetTemplatePayload }>) =>
+        transformTemplatePayloadToTemplate(response.data.data)
+      )
+      .catch((error) => {
+        throw error
+      })
+  }
+
   public async getDatasetTemplates(
     collectionIdOrAlias: number | string
   ): Promise<DatasetTemplate[]> {
     return this.doGet(`/${this.collectionsResourceName}/${collectionIdOrAlias}/templates`, true)
       .then((response: AxiosResponse<{ data: DatasetTemplatePayload[] }>) =>
-        transformDatasetTemplatePayloadToDatasetTemplate(response.data.data)
+        transformTemplatePayloadsToTemplates(response.data.data)
       )
       .catch((error) => {
         throw error
       })
   }
+
+  public async deleteTemplate(templateId: number): Promise<void> {
+    return this.doDelete(`/dataverses/${templateId}/template`)
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
+  }
 }

src/template/infra/repositories/transformers/datasetTemplateTransformers.ts

@@ -3,55 +3,66 @@ import { DatasetTemplate } from '../../../domain/models/DatasetTemplate'
 import { DatasetTemplatePayload } from './DatasetTemplatePayload'
 import { transformPayloadToDatasetMetadataBlocks } from '../../../../datasets/infra/repositories/transformers/datasetTransformers'
 
-export const transformDatasetTemplatePayloadToDatasetTemplate = (
-  collectionDatasetTemplatePayload: DatasetTemplatePayload[]
-): DatasetTemplate[] => {
-  return collectionDatasetTemplatePayload.map((payload) => {
-    const datasetTemplate: DatasetTemplate = {
-      id: payload.id,
-      name: payload.name,
-      collectionAlias: payload.dataverseAlias,
-      isDefault: payload.isDefault,
-      usageCount: payload.usageCount,
-      createTime: payload.createTime,
-      createDate: payload.createDate,
-      datasetMetadataBlocks: transformPayloadToDatasetMetadataBlocks(payload.datasetFields, false),
-      instructions: payload.instructions.map((instruction) => ({
-        instructionField: instruction.instructionField,
-        instructionText: instruction.instructionText
-      })),
-      termsOfUse: {
-        termsOfAccess: {
-          fileAccessRequest: payload.termsOfUseAndAccess.fileAccessRequest,
-          termsOfAccessForRestrictedFiles: payload.termsOfUseAndAccess.termsOfAccess,
-          dataAccessPlace: payload.termsOfUseAndAccess.dataAccessPlace,
-          originalArchive: payload.termsOfUseAndAccess.originalArchive,
-          availabilityStatus: payload.termsOfUseAndAccess.availabilityStatus,
-          contactForAccess: payload.termsOfUseAndAccess.contactForAccess,
-          sizeOfCollection: payload.termsOfUseAndAccess.sizeOfCollection,
-          studyCompletion: payload.termsOfUseAndAccess.studyCompletion
-        }
+export const transformTemplatePayloadToTemplate = (
+  collectionDatasetTemplatePayload: DatasetTemplatePayload
+): DatasetTemplate => {
+  const datasetTemplate: DatasetTemplate = {
+    id: collectionDatasetTemplatePayload.id,
+    name: collectionDatasetTemplatePayload.name,
+    collectionAlias: collectionDatasetTemplatePayload.dataverseAlias,
+    isDefault: collectionDatasetTemplatePayload.isDefault,
+    usageCount: collectionDatasetTemplatePayload.usageCount,
+    createTime: collectionDatasetTemplatePayload.createTime,
+    createDate: collectionDatasetTemplatePayload.createDate,
+    datasetMetadataBlocks: transformPayloadToDatasetMetadataBlocks(
+      collectionDatasetTemplatePayload.datasetFields,
+      false
+    ),
+    instructions: collectionDatasetTemplatePayload.instructions.map((instruction) => ({
+      instructionField: instruction.instructionField,
+      instructionText: instruction.instructionText
+    })),
+    termsOfUse: {
+      termsOfAccess: {
+        fileAccessRequest: collectionDatasetTemplatePayload.termsOfUseAndAccess.fileAccessRequest,
+        termsOfAccessForRestrictedFiles:
+          collectionDatasetTemplatePayload.termsOfUseAndAccess.termsOfAccess,
+        dataAccessPlace: collectionDatasetTemplatePayload.termsOfUseAndAccess.dataAccessPlace,
+        originalArchive: collectionDatasetTemplatePayload.termsOfUseAndAccess.originalArchive,
+        availabilityStatus: collectionDatasetTemplatePayload.termsOfUseAndAccess.availabilityStatus,
+        contactForAccess: collectionDatasetTemplatePayload.termsOfUseAndAccess.contactForAccess,
+        sizeOfCollection: collectionDatasetTemplatePayload.termsOfUseAndAccess.sizeOfCollection,
+        studyCompletion: collectionDatasetTemplatePayload.termsOfUseAndAccess.studyCompletion
       }
     }
+  }
 
-    if (payload.termsOfUseAndAccess.license) {
-      datasetTemplate.license = transformPayloadLicenseToLicense(
-        payload.termsOfUseAndAccess.license
-      )
-    } else {
-      datasetTemplate.termsOfUse.customTerms = {
-        termsOfUse: payload.termsOfUseAndAccess.termsOfUse as string,
-        confidentialityDeclaration: payload.termsOfUseAndAccess
-          .confidentialityDeclaration as string,
-        specialPermissions: payload.termsOfUseAndAccess.specialPermissions as string,
-        restrictions: payload.termsOfUseAndAccess.restrictions as string,
-        citationRequirements: payload.termsOfUseAndAccess.citationRequirements as string,
-        depositorRequirements: payload.termsOfUseAndAccess.depositorRequirements as string,
-        conditions: payload.termsOfUseAndAccess.conditions as string,
-        disclaimer: payload.termsOfUseAndAccess.disclaimer as string
-      }
+  if (collectionDatasetTemplatePayload.termsOfUseAndAccess.license) {
+    datasetTemplate.license = transformPayloadLicenseToLicense(
+      collectionDatasetTemplatePayload.termsOfUseAndAccess.license
+    )
+  } else {
+    datasetTemplate.termsOfUse.customTerms = {
+      termsOfUse: collectionDatasetTemplatePayload.termsOfUseAndAccess.termsOfUse as string,
+      confidentialityDeclaration: collectionDatasetTemplatePayload.termsOfUseAndAccess
+        .confidentialityDeclaration as string,
+      specialPermissions: collectionDatasetTemplatePayload.termsOfUseAndAccess
+        .specialPermissions as string,
+      restrictions: collectionDatasetTemplatePayload.termsOfUseAndAccess.restrictions as string,
+      citationRequirements: collectionDatasetTemplatePayload.termsOfUseAndAccess
+        .citationRequirements as string,
+      depositorRequirements: collectionDatasetTemplatePayload.termsOfUseAndAccess
+        .depositorRequirements as string,
+      conditions: collectionDatasetTemplatePayload.termsOfUseAndAccess.conditions as string,
+      disclaimer: collectionDatasetTemplatePayload.termsOfUseAndAccess.disclaimer as string
     }
+  }
 
-    return datasetTemplate
-  })
+  return datasetTemplate
+}
+
+export const transformTemplatePayloadsToTemplates = (
+  datasetTemplatePayloads: DatasetTemplatePayload[]
+): DatasetTemplate[] => {
+  return datasetTemplatePayloads.map((payload) => transformTemplatePayloadToTemplate(payload))
 }