Naming Convention update

Author: ChengShi-1

CHANGELOG.md

@@ -8,21 +8,17 @@ 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 `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 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 `getDatasetTemplates` repository method to `getTemplatesByCollectionId`.
 
 ### Fixed
 

docs/useCases.md

@@ -624,10 +624,10 @@ Creates a template for a given Dataverse collection id or alias.
 
 ```typescript
 import { createTemplate } from '@iqss/dataverse-client-javascript'
-import { CreateDatasetTemplateDTO } from '@iqss/dataverse-client-javascript'
+import { CreateTemplateDTO } from '@iqss/dataverse-client-javascript'
 
 const collectionAlias = ':root'
-const template: CreateDatasetTemplateDTO = {
+const template: CreateTemplateDTO = {
   name: 'Dataverse template',
   isDefault: true,
   fields: [

…/domain/dtos/CreateDatasetTemplateDTO.ts …mplates/domain/dtos/CreateTemplateDTO.tssrc/templates/domain/dtos/CreateDatasetTemplateDTO.ts renamed to src/templates/domain/dtos/CreateTemplateDTO.ts src/templates/domain/dtos/CreateDatasetTemplateDTO.ts renamed to src/templates/domain/dtos/CreateTemplateDTO.ts

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

src/templates/domain/repositories/ITemplatesRepository.ts

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

src/templates/domain/useCases/CreateTemplate.ts

@@ -1,6 +1,6 @@
 import { ROOT_COLLECTION_ID } from '../../../collections/domain/models/Collection'
 import { UseCase } from '../../../core/domain/useCases/UseCase'
-import { CreateDatasetTemplateDTO } from '../dtos/CreateDatasetTemplateDTO'
+import { CreateTemplateDTO } from '../dtos/CreateTemplateDTO'
 import { ITemplatesRepository } from '../repositories/ITemplatesRepository'
 
 export class CreateTemplate implements UseCase<void> {
@@ -13,13 +13,13 @@ export class CreateTemplate implements UseCase<void> {
   /**
    * Creates a template in the specified collection.
    *
-   * @param {CreateDatasetTemplateDTO} template - Template definition payload.
+   * @param {CreateTemplateDTO} 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: CreateDatasetTemplateDTO,
+    template: CreateTemplateDTO,
     collectionIdOrAlias: number | string = ROOT_COLLECTION_ID
   ): Promise<void> {
     return await this.templatesRepository.createDatasetTemplate(collectionIdOrAlias, template)

src/templates/domain/useCases/GetDatasetTemplates.ts

@@ -18,6 +18,6 @@ export class GetDatasetTemplates implements UseCase<Template[]> {
    * @returns {Promise<Template[]>}
    */
   async execute(collectionIdOrAlias: number | string = ROOT_COLLECTION_ID): Promise<Template[]> {
-    return await this.templatesRepository.getDatasetTemplates(collectionIdOrAlias)
+    return await this.templatesRepository.getTemplatesByCollectionId(collectionIdOrAlias)
   }
 }

src/templates/index.ts

@@ -13,12 +13,12 @@ const getTemplate = new GetTemplate(templatesRepository)
 
 export { createTemplate, deleteTemplate, getDatasetTemplates, getTemplate }
 export {
-  CreateDatasetTemplateDTO,
+  CreateTemplateDTO,
   TemplateFieldDTO,
   TemplateFieldValueDTO,
   TemplateFieldValuePrimitiveDTO,
   TemplateFieldValueCompoundDTO,
   TemplateFieldValueControlledVocabularyDTO,
   TemplateInstructionDTO
-} from './domain/dtos/CreateDatasetTemplateDTO'
+} from './domain/dtos/CreateTemplateDTO'
 export { Template, TemplateInstruction } from './domain/models/Template'

src/templates/infra/repositories/TemplatesRepository.ts

@@ -1,6 +1,6 @@
 import { AxiosResponse } from 'axios'
 import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
-import { CreateDatasetTemplateDTO } from '../../domain/dtos/CreateDatasetTemplateDTO'
+import { CreateTemplateDTO } from '../../domain/dtos/CreateTemplateDTO'
 import { Template } from '../../domain/models/Template'
 import { ITemplatesRepository } from '../../domain/repositories/ITemplatesRepository'
 import { TemplatePayload } from './transformers/TemplatePayload'
@@ -14,7 +14,7 @@ export class TemplatesRepository extends ApiRepository implements ITemplatesRepo
 
   public async createDatasetTemplate(
     collectionIdOrAlias: number | string,
-    template: CreateDatasetTemplateDTO
+    template: CreateTemplateDTO
   ): Promise<void> {
     return this.doPost(
       `/${this.collectionsResourceName}/${collectionIdOrAlias}/templates`,
@@ -36,7 +36,9 @@ export class TemplatesRepository extends ApiRepository implements ITemplatesRepo
       })
   }
 
-  public async getDatasetTemplates(collectionIdOrAlias: number | string): Promise<Template[]> {
+  public async getTemplatesByCollectionId(
+    collectionIdOrAlias: number | string
+  ): Promise<Template[]> {
     return this.doGet(`/${this.collectionsResourceName}/${collectionIdOrAlias}/templates`, true)
       .then((response: AxiosResponse<{ data: TemplatePayload[] }>) =>
         transformTemplatePayloadsToTemplates(response.data.data)

test/functional/templates/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 { createTemplate, getDatasetTemplates } from '../../../src/templates'
-import { CreateDatasetTemplateDTO } from '../../../src/templates/domain/dtos/CreateDatasetTemplateDTO'
+import { CreateTemplateDTO } from '../../../src/templates/domain/dtos/CreateTemplateDTO'
 import { MetadataFieldTypeClass } from '../../../src/metadataBlocks/domain/models/MetadataBlock'
 import { deleteDatasetTemplateViaApi } from '../../testHelpers/datasets/datasetTemplatesHelper'
 
@@ -16,7 +16,7 @@ describe('CreateTemplate.execute', () => {
   })
 
   test('should create a template in :root with provided JSON', async () => {
-    const templateDto: CreateDatasetTemplateDTO = {
+    const templateDto: CreateTemplateDTO = {
       name: 'TestDataverse template',
       isDefault: true,
       fields: [

test/integration/templates/TemplateRepository.test.ts

@@ -1,6 +1,6 @@
 import { ApiConfig, MetadataFieldTypeClass, WriteError } from '../../../src'
 import { createTemplate, getDatasetTemplates } from '../../../src/templates'
-import { CreateDatasetTemplateDTO } from '../../../src/templates/domain/dtos/CreateDatasetTemplateDTO'
+import { CreateTemplateDTO } from '../../../src/templates/domain/dtos/CreateTemplateDTO'
 import { TemplatesRepository } from '../../../src/templates/infra/repositories/TemplatesRepository'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 import { TestConstants } from '../../testHelpers/TestConstants'
@@ -28,7 +28,7 @@ describe('TemplatesRepository', () => {
   })
 
   describe('createTemplate', () => {
-    const templateDto: CreateDatasetTemplateDTO = {
+    const templateDto: CreateTemplateDTO = {
       name: 'CollectionsRepository template',
       isDefault: false,
       fields: [
@@ -85,7 +85,7 @@ describe('TemplatesRepository', () => {
 
   describe('getDatasetTemplates', () => {
     test('should return empty templates', async () => {
-      const actual = await sut.getDatasetTemplates(testCollectionAlias)
+      const actual = await sut.getTemplatesByCollectionId(testCollectionAlias)
 
       expect(actual.length).toBe(0)
     })
@@ -126,7 +126,7 @@ describe('TemplatesRepository', () => {
         testCollectionAlias
       )
 
-      const actual = await sut.getDatasetTemplates(testCollectionAlias)
+      const actual = await sut.getTemplatesByCollectionId(testCollectionAlias)
 
       expect(actual.length).toBe(1)