rename createDatasetTemplate to createTemplate, and clean GetTemplatesByCollectionId

Author: ChengShi-1

CHANGELOG.md

@@ -18,6 +18,8 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 ### Changed
 
 - 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
@@ -53,7 +55,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

@@ -28,7 +28,7 @@ The different use cases currently available in the package are classified below,
 - [Templates](#Templates)
   - [Templates read use cases](#templates-read-use-cases)
     - [Get a Template](#get-a-template)
-    - [Get Dataset Templates](#get-dataset-templates)
+    - [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)
@@ -596,23 +596,24 @@ getTemplate.execute(templateId).then((template: Template) => {
 
 _See [use case](../src/templates/domain/useCases/GetTemplate.ts)_ definition.
 
-#### Get Dataset Templates
+#### 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 { getDatasetTemplates } from '@iqss/dataverse-client-javascript'
+import { getTemplatesByCollectionId } from '@iqss/dataverse-client-javascript'
 
 const collectionIdOrAlias = 12345
 
-getDatasetTemplates.execute(collectionIdOrAlias).then((datasetTemplates: Template[]) => {
+getTemplatesByCollectionId.execute(collectionIdOrAlias).then((template: Template[]) => {
   /* ... */
 })
 ```
 
-_See [use case](../src/templates/domain/useCases/GetDatasetTemplates.ts)_ definition.
+_See [use case](../src/templates/domain/useCases/GetTemplatesByCollectionId.ts)_ definition.
+Repository implementation uses `getTemplatesByCollectionId`.
 
 ### Templates Write Use Cases
 
@@ -650,6 +651,7 @@ await createTemplate.execute(template, collectionAlias)
 ```
 
 _See [use case](../src/templates/domain/useCases/CreateTemplate.ts) implementation_.
+Repository implementation uses `createTemplate`.
 
 #### Delete a Template
 

src/templates/domain/repositories/ITemplatesRepository.ts

@@ -2,10 +2,7 @@ import { CreateTemplateDTO } from '../dtos/CreateTemplateDTO'
 import { Template } from '../models/Template'
 
 export interface ITemplatesRepository {
-  createDatasetTemplate(
-    collectionIdOrAlias: number | string,
-    template: CreateTemplateDTO
-  ): Promise<void>
+  createTemplate(collectionIdOrAlias: number | string, template: CreateTemplateDTO): Promise<void>
   getTemplate(templateId: number): Promise<Template>
   getTemplatesByCollectionId(collectionIdOrAlias: number | string): Promise<Template[]>
   deleteTemplate(templateId: number): Promise<void>

src/templates/domain/useCases/CreateTemplate.ts

@@ -22,6 +22,6 @@ export class CreateTemplate implements UseCase<void> {
     template: CreateTemplateDTO,
     collectionIdOrAlias: number | string = ROOT_COLLECTION_ID
   ): Promise<void> {
-    return await this.templatesRepository.createDatasetTemplate(collectionIdOrAlias, template)
+    return await this.templatesRepository.createTemplate(collectionIdOrAlias, template)
   }
 }

…s/domain/useCases/GetDatasetTemplates.ts …n/useCases/GetTemplatesByCollectionId.tssrc/templates/domain/useCases/GetDatasetTemplates.ts renamed to src/templates/domain/useCases/GetTemplatesByCollectionId.ts src/templates/domain/useCases/GetDatasetTemplates.ts renamed to src/templates/domain/useCases/GetTemplatesByCollectionId.ts

@@ -3,7 +3,7 @@ import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { Template } from '../models/Template'
 import { ITemplatesRepository } from '../repositories/ITemplatesRepository'
 
-export class GetDatasetTemplates implements UseCase<Template[]> {
+export class GetTemplatesByCollectionId implements UseCase<Template[]> {
   private templatesRepository: ITemplatesRepository
 
   constructor(templatesRepository: ITemplatesRepository) {

src/templates/index.ts

@@ -1,17 +1,17 @@
 import { TemplatesRepository } from './infra/repositories/TemplatesRepository'
 import { CreateTemplate } from './domain/useCases/CreateTemplate'
 import { DeleteTemplate } from './domain/useCases/DeleteTemplate'
-import { GetDatasetTemplates } from './domain/useCases/GetDatasetTemplates'
+import { GetTemplatesByCollectionId } from './domain/useCases/GetTemplatesByCollectionId'
 import { GetTemplate } from './domain/useCases/GetTemplate'
 
 const templatesRepository = new TemplatesRepository()
 
 const createTemplate = new CreateTemplate(templatesRepository)
 const deleteTemplate = new DeleteTemplate(templatesRepository)
-const getDatasetTemplates = new GetDatasetTemplates(templatesRepository)
+const getTemplatesByCollectionId = new GetTemplatesByCollectionId(templatesRepository)
 const getTemplate = new GetTemplate(templatesRepository)
 
-export { createTemplate, deleteTemplate, getDatasetTemplates, getTemplate }
+export { createTemplate, deleteTemplate, getTemplatesByCollectionId, getTemplate }
 export {
   CreateTemplateDTO,
   TemplateFieldDTO,

src/templates/infra/repositories/TemplatesRepository.ts

@@ -12,7 +12,7 @@ import {
 export class TemplatesRepository extends ApiRepository implements ITemplatesRepository {
   private readonly collectionsResourceName: string = 'dataverses'
 
-  public async createDatasetTemplate(
+  public async createTemplate(
     collectionIdOrAlias: number | string,
     template: CreateTemplateDTO
   ): Promise<void> {

…/templates/createDatasetTemplate.test.ts …ctional/templates/createTemplate.test.tstest/functional/templates/createDatasetTemplate.test.ts renamed to test/functional/templates/createTemplate.test.ts test/functional/templates/createDatasetTemplate.test.ts renamed to test/functional/templates/createTemplate.test.ts

@@ -1,7 +1,7 @@
 import { ApiConfig } from '../../../src'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 import { TestConstants } from '../../testHelpers/TestConstants'
-import { createTemplate, getDatasetTemplates } from '../../../src/templates'
+import { createTemplate, getTemplatesByCollectionId } from '../../../src/templates'
 import { CreateTemplateDTO } from '../../../src/templates/domain/dtos/CreateTemplateDTO'
 import { MetadataFieldTypeClass } from '../../../src/metadataBlocks/domain/models/MetadataBlock'
 import { deleteDatasetTemplateViaApi } from '../../testHelpers/datasets/datasetTemplatesHelper'
@@ -48,7 +48,7 @@ describe('CreateTemplate.execute', () => {
       ]
     }
     await createTemplate.execute(templateDto)
-    const templates = await getDatasetTemplates.execute(':root')
+    const templates = await getTemplatesByCollectionId.execute(':root')
 
     expect(templates[templates.length - 1].name).toBe(templateDto.name)
     expect(templates[templates.length - 1].isDefault).toBe(templateDto.isDefault)

test/integration/templates/TemplateRepository.test.ts

@@ -1,5 +1,5 @@
 import { ApiConfig, MetadataFieldTypeClass, WriteError } from '../../../src'
-import { createTemplate, getDatasetTemplates } from '../../../src/templates'
+import { createTemplate, getTemplatesByCollectionId } from '../../../src/templates'
 import { CreateTemplateDTO } from '../../../src/templates/domain/dtos/CreateTemplateDTO'
 import { TemplatesRepository } from '../../../src/templates/infra/repositories/TemplatesRepository'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
@@ -12,7 +12,7 @@ import { deleteDatasetTemplateViaApi } from '../../testHelpers/datasets/datasetT
 
 describe('TemplatesRepository', () => {
   const sut: TemplatesRepository = new TemplatesRepository()
-  const testCollectionAlias = 'testGetDatasetTemplates'
+  const testCollectionAlias = 'testGetTemplatesByCollectionId'
 
   beforeAll(async () => {
     ApiConfig.init(
@@ -62,7 +62,7 @@ describe('TemplatesRepository', () => {
 
     test('should create a template in :root with provided JSON', async () => {
       await createTemplate.execute(templateDto)
-      const templates = await getDatasetTemplates.execute(':root')
+      const templates = await getTemplatesByCollectionId.execute(':root')
 
       expect(templates[templates.length - 1].name).toBe(templateDto.name)
       expect(templates[templates.length - 1].isDefault).toBe(templateDto.isDefault)
@@ -83,7 +83,7 @@ describe('TemplatesRepository', () => {
     })
   })
 
-  describe('getDatasetTemplates', () => {
+  describe('getTemplatesByCollectionId', () => {
     test('should return empty templates', async () => {
       const actual = await sut.getTemplatesByCollectionId(testCollectionAlias)
 
@@ -93,7 +93,7 @@ describe('TemplatesRepository', () => {
     test('should return templates for a collection', async () => {
       await createTemplate.execute(
         {
-          name: 'Template for GetDatasetTemplates',
+          name: 'Template for GetTemplatesByCollectionId',
           isDefault: false,
           fields: [
             {
@@ -130,7 +130,7 @@ describe('TemplatesRepository', () => {
 
       expect(actual.length).toBe(1)
 
-      expect(actual[0].name).toBe('Template for GetDatasetTemplates')
+      expect(actual[0].name).toBe('Template for GetTemplatesByCollectionId')
       expect(actual[0].isDefault).toBe(false)
       expect(actual[0].datasetMetadataBlocks.length).toBe(1)
       expect(actual[0].datasetMetadataBlocks[0].name).toBe('citation')
@@ -177,7 +177,7 @@ describe('TemplatesRepository', () => {
         },
         testCollectionAlias
       )
-      const templates = await getDatasetTemplates.execute(testCollectionAlias)
+      const templates = await getTemplatesByCollectionId.execute(testCollectionAlias)
       const templateId = templates[templates.length - 1].id
       const templateExpectedIsDefault = templates[templates.length - 1].isDefault
 
@@ -234,7 +234,7 @@ describe('TemplatesRepository', () => {
         },
         testCollectionAlias
       )
-      const templates = await getDatasetTemplates.execute(testCollectionAlias)
+      const templates = await getTemplatesByCollectionId.execute(testCollectionAlias)
       const templateId = templates[templates.length - 1].id
 
       await sut.deleteTemplate(templateId)

…/templates/createDatasetTemplate.test.ts …st/unit/templates/CreateTemplate.test.tstest/unit/templates/createDatasetTemplate.test.ts renamed to test/unit/templates/CreateTemplate.test.ts test/unit/templates/createDatasetTemplate.test.ts renamed to test/unit/templates/CreateTemplate.test.ts

@@ -7,36 +7,30 @@ describe('execute', () => {
   const testTemplateDTO = { name: 't' } as CreateTemplateDTO
   test('should return undefined when repository call is successful', async () => {
     const templatesRepositoryStub: ITemplatesRepository = {} as ITemplatesRepository
-    templatesRepositoryStub.createDatasetTemplate = jest.fn().mockResolvedValue(undefined)
+    templatesRepositoryStub.createTemplate = jest.fn().mockResolvedValue(undefined)
     const sut = new CreateTemplate(templatesRepositoryStub)
 
     const actual = await sut.execute(testTemplateDTO)
 
-    expect(templatesRepositoryStub.createDatasetTemplate).toHaveBeenCalledWith(
-      ':root',
-      testTemplateDTO
-    )
+    expect(templatesRepositoryStub.createTemplate).toHaveBeenCalledWith(':root', testTemplateDTO)
     expect(actual).toBeUndefined()
   })
 
   test('should call repository with provided collection id/alias', async () => {
     const templatesRepositoryStub: ITemplatesRepository = {} as ITemplatesRepository
-    templatesRepositoryStub.createDatasetTemplate = jest.fn().mockResolvedValue(undefined)
+    templatesRepositoryStub.createTemplate = jest.fn().mockResolvedValue(undefined)
 
     const sut = new CreateTemplate(templatesRepositoryStub)
     const actual = await sut.execute(testTemplateDTO, 'alias123')
 
-    expect(templatesRepositoryStub.createDatasetTemplate).toHaveBeenCalledWith(
-      'alias123',
-      testTemplateDTO
-    )
+    expect(templatesRepositoryStub.createTemplate).toHaveBeenCalledWith('alias123', testTemplateDTO)
 
     expect(actual).toBeUndefined()
   })
 
   test('should return error result on repository error', async () => {
     const templatesRepositoryStub: ITemplatesRepository = {} as ITemplatesRepository
-    templatesRepositoryStub.createDatasetTemplate = jest.fn().mockRejectedValue(new WriteError())
+    templatesRepositoryStub.createTemplate = jest.fn().mockRejectedValue(new WriteError())
     const testCreateTemplate = new CreateTemplate(templatesRepositoryStub)
 
     await expect(testCreateTemplate.execute(testTemplateDTO)).rejects.toThrow(WriteError)