chore: renaming dto and revise changelog

Author: ChengShi-1

CHANGELOG.md

@@ -9,7 +9,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 ### Added
 
 - New Use Case: [Get Collections For Linking Use Case](./docs/useCases.md#get-collections-for-linking).
-- New Use Case: [Create a Template](./docs/useCases.md#create-a-template) under Collections.
+- New Use Case: [Create a Dataset Template](./docs/useCases.md#create-a-dataset-template) under Collections.
 
 ### Changed
 

…ections/domain/dtos/TemplateCreateDTO.ts …/domain/dtos/CreateDatasetTemplateDTO.tssrc/collections/domain/dtos/TemplateCreateDTO.ts renamed to src/collections/domain/dtos/CreateDatasetTemplateDTO.ts src/collections/domain/dtos/TemplateCreateDTO.ts renamed to src/collections/domain/dtos/CreateDatasetTemplateDTO.ts

@@ -1,6 +1,6 @@
 import { MetadataFieldTypeClass } from '../../../metadataBlocks/domain/models/MetadataBlock'
 
-export interface TemplateCreateDTO {
+export interface CreateDatasetTemplateDTO {
   name: string
   isDefault?: boolean
   fields?: TemplateFieldDTO[]

src/collections/domain/repositories/ICollectionsRepository.ts

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

src/collections/domain/useCases/CreateDatasetTemplate.ts

@@ -1,7 +1,7 @@
 import { ROOT_COLLECTION_ID } from '../models/Collection'
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
-import { TemplateCreateDTO } from '../dtos/TemplateCreateDTO'
+import { CreateDatasetTemplateDTO } from '../dtos/CreateDatasetTemplateDTO'
 
 export class CreateDatasetTemplate implements UseCase<void> {
   private collectionsRepository: ICollectionsRepository
@@ -13,13 +13,13 @@ export class CreateDatasetTemplate implements UseCase<void> {
   /**
    * Creates a Dataset Template in the specified collection.
    *
-   * @param {TemplateCreateDTO} template - Template definition payload.
+   * @param {CreateDatasetTemplateDTO} template - Template definition payload.
    * @param {number | string} [collectionIdOrAlias = ':root'] - A generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId)
    * If this parameter is not set, the default value is: ':root'.
    * @returns {Promise<void>}
    */
   async execute(
-    template: TemplateCreateDTO,
+    template: CreateDatasetTemplateDTO,
     collectionIdOrAlias: number | string = ROOT_COLLECTION_ID
   ): Promise<void> {
     return await this.collectionsRepository.createDatasetTemplate(collectionIdOrAlias, template)

src/collections/infra/repositories/CollectionsRepository.ts

@@ -40,7 +40,7 @@ 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 { TemplateCreateDTO } from '../../domain/dtos/TemplateCreateDTO'
+import { CreateDatasetTemplateDTO } from '../../domain/dtos/CreateDatasetTemplateDTO'
 
 export interface NewCollectionRequestPayload {
   alias: string
@@ -532,7 +532,7 @@ export class CollectionsRepository extends ApiRepository implements ICollections
 
   public async createDatasetTemplate(
     collectionIdOrAlias: number | string,
-    template: TemplateCreateDTO
+    template: CreateDatasetTemplateDTO
   ): Promise<void> {
     return this.doPost(
       `/${this.collectionsResourceName}/${collectionIdOrAlias}/templates`,

test/functional/collections/createDatasetTemplate.test.ts

@@ -2,7 +2,7 @@ import { ApiConfig } from '../../../src'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { getDatasetTemplates } from '../../../src/datasets'
-import { TemplateCreateDTO } from '../../../src/collections/domain/dtos/TemplateCreateDTO'
+import { CreateDatasetTemplateDTO } from '../../../src/collections/domain/dtos/CreateDatasetTemplateDTO'
 import { createDatasetTemplate } from '../../../src/collections'
 import { MetadataFieldTypeClass } from '../../../src/metadataBlocks/domain/models/MetadataBlock'
 import { deleteDatasetTemplateViaApi } from '../../testHelpers/datasets/datasetTemplatesHelper'
@@ -17,7 +17,7 @@ describe('CreateTemplate.execute', () => {
   })
 
   test('should create a template in :root with provided JSON', async () => {
-    const templateDto: TemplateCreateDTO = {
+    const templateDto: CreateDatasetTemplateDTO = {
       name: 'TestDataverse template',
       isDefault: true,
       fields: [

test/integration/collections/CollectionsRepository.test.ts

@@ -60,7 +60,7 @@ import {
   DvObjectFeaturedItemDTO,
   FeaturedItemsDTO
 } from '../../../src/collections/domain/dtos/FeaturedItemsDTO'
-import { TemplateCreateDTO } from '../../../src/collections/domain/dtos/TemplateCreateDTO'
+import { CreateDatasetTemplateDTO } from '../../../src/collections/domain/dtos/CreateDatasetTemplateDTO'
 import { getDatasetTemplates } from '../../../src/datasets'
 import { deleteDatasetTemplateViaApi } from '../../testHelpers/datasets/datasetTemplatesHelper'
 
@@ -2150,7 +2150,7 @@ describe('CollectionsRepository', () => {
   })
 
   describe('createDatasetTemplate', () => {
-    const templateDto: TemplateCreateDTO = {
+    const templateDto: CreateDatasetTemplateDTO = {
       name: 'CollectionsRepository template',
       isDefault: true,
       fields: [

test/unit/collections/createDatasetTemplate.ts

@@ -1,10 +1,10 @@
 import { CreateDatasetTemplate } from '../../../src/collections/domain/useCases/CreateDatasetTemplate'
 import { ICollectionsRepository } from '../../../src/collections/domain/repositories/ICollectionsRepository'
-import { TemplateCreateDTO } from '../../../src/collections/domain/dtos/TemplateCreateDTO'
+import { CreateDatasetTemplateDTO } from '../../../src/collections/domain/dtos/CreateDatasetTemplateDTO'
 import { WriteError } from '../../../src'
 
 describe('execute', () => {
-  const testTemplateDTO = { name: 't' } as TemplateCreateDTO
+  const testTemplateDTO = { name: 't' } as CreateDatasetTemplateDTO
   const testCollectionId = 1
 
   test('should return undefined when repository call is successful', async () => {