chore: sync the naming to template fron DatasetTemplate

ChengShi-1 · ChengShi-1 · commit 0d51b50c6114 · 2026-01-07T19:01:26.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,7 +12,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 
 - 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 Templates.
+- 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.
 
diff --git a/docs/useCases.md b/docs/useCases.md
@@ -30,7 +30,7 @@ The different use cases currently available in the package are classified below,
     - [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)
+    - [Create a Template](#create-a-template)
     - [Delete a Template](#delete-a-template)
 - [Datasets](#Datasets)
   - [Datasets read use cases](#datasets-read-use-cases)
@@ -580,7 +580,7 @@ _See [use case](../src/collections/domain/useCases/DeleteCollectionFeaturedItem.
 
 #### Get a Template
 
-Returns a [DatasetTemplate](../src/template/domain/models/DatasetTemplate.ts) by its template id.
+Returns a [Template](../src/templates/domain/models/Template.ts) by its template id.
 
 ##### Example call:
 
@@ -589,16 +589,16 @@ import { getTemplate } from '@iqss/dataverse-client-javascript'
 
 const templateId = 12345
 
-getTemplate.execute(templateId).then((template: DatasetTemplate) => {
+getTemplate.execute(templateId).then((template: Template) => {
   /* ... */
 })
 ```
 
-_See [use case](../src/template/domain/useCases/GetTemplate.ts)_ definition.
+_See [use case](../src/templates/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.
+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:
 
@@ -607,23 +607,23 @@ import { getDatasetTemplates } from '@iqss/dataverse-client-javascript'
 
 const collectionIdOrAlias = 12345
 
-getDatasetTemplates.execute(collectionIdOrAlias).then((datasetTemplates: DatasetTemplate[]) => {
+getDatasetTemplates.execute(collectionIdOrAlias).then((datasetTemplates: Template[]) => {
   /* ... */
 })
 ```
 
-_See [use case](../src/template/domain/useCases/GetDatasetTemplates.ts)_ definition.
+_See [use case](../src/templates/domain/useCases/GetDatasetTemplates.ts)_ definition.
 
 ### Templates Write Use Cases
 
-#### Create a Dataset Template
+#### Create a Template
 
-Creates a dataset template for a given Dataverse collection id or alias.
+Creates a template for a given Dataverse collection id or alias.
 
 ##### Example call:
 
 ```typescript
-import { createDatasetTemplate } from '@iqss/dataverse-client-javascript'
+import { createTemplate } from '@iqss/dataverse-client-javascript'
 import { CreateDatasetTemplateDTO } from '@iqss/dataverse-client-javascript'
 
 const collectionAlias = ':root'
@@ -646,14 +646,14 @@ const template: CreateDatasetTemplateDTO = {
   instructions: [{ instructionField: 'author', instructionText: 'The author data' }]
 }
 
-await createDatasetTemplate.execute(template, collectionAlias)
+await createTemplate.execute(template, collectionAlias)
 ```
 
-_See [use case](../src/template/domain/useCases/CreateDatasetTemplate.ts) implementation_.
+_See [use case](../src/templates/domain/useCases/CreateTemplate.ts) implementation_.
 
 #### Delete a Template
 
-Deletes a dataset template by its template id.
+Deletes a template by its template id.
 
 ##### Example call:
 
@@ -665,7 +665,7 @@ const templateId = 12345
 await deleteTemplate.execute(templateId)
 ```
 
-_See [use case](../src/template/domain/useCases/DeleteTemplate.ts)_ definition.
+_See [use case](../src/templates/domain/useCases/DeleteTemplate.ts)_ definition.
 
 ## Datasets
 
diff --git a/src/index.ts b/src/index.ts
@@ -12,4 +12,4 @@ export * from './notifications'
 export * from './search'
 export * from './licenses'
 export * from './externalTools'
-export * from './template'
+export * from './templates'
diff --git a/src/templates/domain/dtos/CreateDatasetTemplateDTO.ts b/src/templates/domain/dtos/CreateDatasetTemplateDTO.ts
diff --git a/src/templates/domain/models/Template.ts b/src/templates/domain/models/Template.ts
@@ -1,7 +1,7 @@
 import { DatasetMetadataBlock, TermsOfUse } from '../../../datasets/domain/models/Dataset'
 import { License } from '../../../licenses/domain/models/License'
 
-export interface DatasetTemplate {
+export interface Template {
   id: number
   name: string
   collectionAlias: string
@@ -11,13 +11,13 @@ export interface DatasetTemplate {
   createDate: string
   // 👇 From Edit Template Metadata
   datasetMetadataBlocks: DatasetMetadataBlock[]
-  instructions: DatasetTemplateInstruction[]
+  instructions: TemplateInstruction[]
   // 👇 From Edit Template Terms
   termsOfUse: TermsOfUse
   license?: License // This license property is going to be present if not custom terms are added in the UI
 }
 
-export interface DatasetTemplateInstruction {
+export interface TemplateInstruction {
   instructionField: string
   instructionText: string
 }
diff --git a/src/templates/domain/repositories/ITemplatesRepository.ts b/src/templates/domain/repositories/ITemplatesRepository.ts
@@ -1,12 +1,12 @@
 import { CreateDatasetTemplateDTO } from '../dtos/CreateDatasetTemplateDTO'
-import { DatasetTemplate } from '../models/DatasetTemplate'
+import { Template } from '../models/Template'
 
 export interface ITemplatesRepository {
   createDatasetTemplate(
     collectionIdOrAlias: number | string,
     template: CreateDatasetTemplateDTO
   ): Promise<void>
-  getTemplate(templateId: number): Promise<DatasetTemplate>
-  getDatasetTemplates(collectionIdOrAlias: number | string): Promise<DatasetTemplate[]>
+  getTemplate(templateId: number): Promise<Template>
+  getDatasetTemplates(collectionIdOrAlias: number | string): Promise<Template[]>
   deleteTemplate(templateId: number): Promise<void>
 }
diff --git a/src/templates/domain/useCases/CreateTemplate.ts b/src/templates/domain/useCases/CreateTemplate.ts
@@ -3,15 +3,15 @@ import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { CreateDatasetTemplateDTO } from '../dtos/CreateDatasetTemplateDTO'
 import { ITemplatesRepository } from '../repositories/ITemplatesRepository'
 
-export class CreateDatasetTemplate implements UseCase<void> {
+export class CreateTemplate implements UseCase<void> {
   private templatesRepository: ITemplatesRepository
 
   constructor(templatesRepository: ITemplatesRepository) {
     this.templatesRepository = templatesRepository
   }
 
   /**
-   * Creates a Dataset Template in the specified collection.
+   * Creates a template in the specified collection.
    *
    * @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)
diff --git a/src/templates/domain/useCases/DeleteTemplate.ts b/src/templates/domain/useCases/DeleteTemplate.ts
@@ -9,9 +9,9 @@ export class DeleteTemplate implements UseCase<void> {
   }
 
   /**
-   * Deletes a dataset template by its template id.
+   * Deletes a template by its template id.
    *
-   * @param {number} templateId - Dataset template id.
+   * @param {number} templateId - Template id.
    */
   async execute(templateId: number): Promise<void> {
     return await this.templatesRepository.deleteTemplate(templateId)
diff --git a/src/templates/domain/useCases/GetDatasetTemplates.ts b/src/templates/domain/useCases/GetDatasetTemplates.ts
@@ -1,25 +1,23 @@
 import { ROOT_COLLECTION_ID } from '../../../collections/domain/models/Collection'
 import { UseCase } from '../../../core/domain/useCases/UseCase'
-import { DatasetTemplate } from '../models/DatasetTemplate'
+import { Template } from '../models/Template'
 import { ITemplatesRepository } from '../repositories/ITemplatesRepository'
 
-export class GetDatasetTemplates implements UseCase<DatasetTemplate[]> {
+export class GetDatasetTemplates implements UseCase<Template[]> {
   private templatesRepository: ITemplatesRepository
 
   constructor(templatesRepository: ITemplatesRepository) {
     this.templatesRepository = templatesRepository
   }
 
   /**
-   * Returns a DatasetTemplate array containing the dataset templates of the requested collection, given the collection identifier or alias.
+   * Returns a Template array containing the templates of the requested collection, given the collection identifier or alias.
    *
    * @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<DatasetTemplate[]>}
+   * @returns {Promise<Template[]>}
    */
-  async execute(
-    collectionIdOrAlias: number | string = ROOT_COLLECTION_ID
-  ): Promise<DatasetTemplate[]> {
+  async execute(collectionIdOrAlias: number | string = ROOT_COLLECTION_ID): Promise<Template[]> {
     return await this.templatesRepository.getDatasetTemplates(collectionIdOrAlias)
   }
 }
diff --git a/src/templates/domain/useCases/GetTemplate.ts b/src/templates/domain/useCases/GetTemplate.ts
@@ -1,21 +1,21 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
-import { DatasetTemplate } from '../models/DatasetTemplate'
+import { Template } from '../models/Template'
 import { ITemplatesRepository } from '../repositories/ITemplatesRepository'
 
-export class GetTemplate implements UseCase<DatasetTemplate> {
+export class GetTemplate implements UseCase<Template> {
   private templatesRepository: ITemplatesRepository
 
   constructor(templatesRepository: ITemplatesRepository) {
     this.templatesRepository = templatesRepository
   }
 
   /**
-   * Returns a dataset template by its template id.
+   * Returns a template by its template id.
    *
-   * @param {number} templateId - Dataset template id.
-   * @returns {Promise<DatasetTemplate>}
+   * @param {number} templateId - Template id.
+   * @returns {Promise<Template>}
    */
-  async execute(templateId: number): Promise<DatasetTemplate> {
+  async execute(templateId: number): Promise<Template> {
     return await this.templatesRepository.getTemplate(templateId)
   }
 }
diff --git a/src/templates/index.ts b/src/templates/index.ts
@@ -1,17 +1,17 @@
 import { TemplatesRepository } from './infra/repositories/TemplatesRepository'
-import { CreateDatasetTemplate } from './domain/useCases/CreateDatasetTemplate'
+import { CreateTemplate } from './domain/useCases/CreateTemplate'
 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 createTemplate = new CreateTemplate(templatesRepository)
 const deleteTemplate = new DeleteTemplate(templatesRepository)
 const getDatasetTemplates = new GetDatasetTemplates(templatesRepository)
 const getTemplate = new GetTemplate(templatesRepository)
 
-export { createDatasetTemplate, deleteTemplate, getDatasetTemplates, getTemplate }
+export { createTemplate, deleteTemplate, getDatasetTemplates, getTemplate }
 export {
   CreateDatasetTemplateDTO,
   TemplateFieldDTO,
@@ -21,4 +21,4 @@ export {
   TemplateFieldValueControlledVocabularyDTO,
   TemplateInstructionDTO
 } from './domain/dtos/CreateDatasetTemplateDTO'
-export { DatasetTemplate, DatasetTemplateInstruction } from './domain/models/DatasetTemplate'
+export { Template, TemplateInstruction } from './domain/models/Template'
diff --git a/src/templates/infra/repositories/TemplatesRepository.ts b/src/templates/infra/repositories/TemplatesRepository.ts
@@ -1,13 +1,13 @@
 import { AxiosResponse } from 'axios'
 import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { CreateDatasetTemplateDTO } from '../../domain/dtos/CreateDatasetTemplateDTO'
-import { DatasetTemplate } from '../../domain/models/DatasetTemplate'
+import { Template } from '../../domain/models/Template'
 import { ITemplatesRepository } from '../../domain/repositories/ITemplatesRepository'
-import { DatasetTemplatePayload } from './transformers/DatasetTemplatePayload'
+import { TemplatePayload } from './transformers/TemplatePayload'
 import {
   transformTemplatePayloadToTemplate,
   transformTemplatePayloadsToTemplates
-} from './transformers/datasetTemplateTransformers'
+} from './transformers/templateTransformers'
 
 export class TemplatesRepository extends ApiRepository implements ITemplatesRepository {
   private readonly collectionsResourceName: string = 'dataverses'
@@ -26,21 +26,19 @@ export class TemplatesRepository extends ApiRepository implements ITemplatesRepo
       })
   }
 
-  public async getTemplate(templateId: number): Promise<DatasetTemplate> {
+  public async getTemplate(templateId: number): Promise<Template> {
     return this.doGet(`/dataverses/${templateId}/template`, true)
-      .then((response: AxiosResponse<{ data: DatasetTemplatePayload }>) =>
+      .then((response: AxiosResponse<{ data: TemplatePayload }>) =>
         transformTemplatePayloadToTemplate(response.data.data)
       )
       .catch((error) => {
         throw error
       })
   }
 
-  public async getDatasetTemplates(
-    collectionIdOrAlias: number | string
-  ): Promise<DatasetTemplate[]> {
+  public async getDatasetTemplates(collectionIdOrAlias: number | string): Promise<Template[]> {
     return this.doGet(`/${this.collectionsResourceName}/${collectionIdOrAlias}/templates`, true)
-      .then((response: AxiosResponse<{ data: DatasetTemplatePayload[] }>) =>
+      .then((response: AxiosResponse<{ data: TemplatePayload[] }>) =>
         transformTemplatePayloadsToTemplates(response.data.data)
       )
       .catch((error) => {
diff --git a/src/templates/infra/repositories/transformers/TemplatePayload.ts b/src/templates/infra/repositories/transformers/TemplatePayload.ts
@@ -1,7 +1,7 @@
 import { LicensePayload } from '../../../../licenses/domain/repositories/transformers/LicensePayload'
 import { MetadataFieldPayload } from '../../../../datasets/infra/repositories/transformers/DatasetPayload'
 
-export interface DatasetTemplatePayload {
+export interface TemplatePayload {
   id: number
   name: string
   dataverseAlias: string
diff --git a/src/templates/infra/repositories/transformers/templateTransformers.ts b/src/templates/infra/repositories/transformers/templateTransformers.ts
@@ -1,12 +1,12 @@
 import { transformPayloadLicenseToLicense } from '../../../../licenses/domain/repositories/transformers/licenseTransformers'
-import { DatasetTemplate } from '../../../domain/models/DatasetTemplate'
-import { DatasetTemplatePayload } from './DatasetTemplatePayload'
+import { Template } from '../../../domain/models/Template'
+import { TemplatePayload } from './TemplatePayload'
 import { transformPayloadToDatasetMetadataBlocks } from '../../../../datasets/infra/repositories/transformers/datasetTransformers'
 
 export const transformTemplatePayloadToTemplate = (
-  collectionDatasetTemplatePayload: DatasetTemplatePayload
-): DatasetTemplate => {
-  const datasetTemplate: DatasetTemplate = {
+  collectionDatasetTemplatePayload: TemplatePayload
+): Template => {
+  const template: Template = {
     id: collectionDatasetTemplatePayload.id,
     name: collectionDatasetTemplatePayload.name,
     collectionAlias: collectionDatasetTemplatePayload.dataverseAlias,
@@ -38,11 +38,11 @@ export const transformTemplatePayloadToTemplate = (
   }
 
   if (collectionDatasetTemplatePayload.termsOfUseAndAccess.license) {
-    datasetTemplate.license = transformPayloadLicenseToLicense(
+    template.license = transformPayloadLicenseToLicense(
       collectionDatasetTemplatePayload.termsOfUseAndAccess.license
     )
   } else {
-    datasetTemplate.termsOfUse.customTerms = {
+    template.termsOfUse.customTerms = {
       termsOfUse: collectionDatasetTemplatePayload.termsOfUseAndAccess.termsOfUse as string,
       confidentialityDeclaration: collectionDatasetTemplatePayload.termsOfUseAndAccess
         .confidentialityDeclaration as string,
@@ -58,11 +58,11 @@ export const transformTemplatePayloadToTemplate = (
     }
   }
 
-  return datasetTemplate
+  return template
 }
 
 export const transformTemplatePayloadsToTemplates = (
-  datasetTemplatePayloads: DatasetTemplatePayload[]
-): DatasetTemplate[] => {
+  datasetTemplatePayloads: TemplatePayload[]
+): Template[] => {
   return datasetTemplatePayloads.map((payload) => transformTemplatePayloadToTemplate(payload))
 }
diff --git a/test/functional/templates/createDatasetTemplate.test.ts b/test/functional/templates/createDatasetTemplate.test.ts
@@ -1,8 +1,8 @@
 import { ApiConfig } from '../../../src'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 import { TestConstants } from '../../testHelpers/TestConstants'
-import { createDatasetTemplate, getDatasetTemplates } from '../../../src/template'
-import { CreateDatasetTemplateDTO } from '../../../src/template/domain/dtos/CreateDatasetTemplateDTO'
+import { createTemplate, getDatasetTemplates } from '../../../src/templates'
+import { CreateDatasetTemplateDTO } from '../../../src/templates/domain/dtos/CreateDatasetTemplateDTO'
 import { MetadataFieldTypeClass } from '../../../src/metadataBlocks/domain/models/MetadataBlock'
 import { deleteDatasetTemplateViaApi } from '../../testHelpers/datasets/datasetTemplatesHelper'
 
@@ -47,7 +47,7 @@ describe('CreateTemplate.execute', () => {
         }
       ]
     }
-    await createDatasetTemplate.execute(templateDto)
+    await createTemplate.execute(templateDto)
     const templates = await getDatasetTemplates.execute(':root')
 
     expect(templates[templates.length - 1].name).toBe(templateDto.name)
diff --git a/test/integration/templates/TemplateRepository.test.ts b/test/integration/templates/TemplateRepository.test.ts
diff --git a/test/testHelpers/datasets/datasetTemplatesHelper.ts b/test/testHelpers/datasets/datasetTemplatesHelper.ts
diff --git a/test/unit/templates/createDatasetTemplate.test.ts b/test/unit/templates/createDatasetTemplate.test.ts
diff --git a/test/unit/templates/deleteTemplate.test.ts b/test/unit/templates/deleteTemplate.test.ts
diff --git a/test/unit/templates/getTemplate.test.ts b/test/unit/templates/getTemplate.test.ts

Original file line number	Diff line number	Diff line change
`@@ -9,9 +9,9 @@ export class DeleteTemplate implements UseCase<void> {`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`/**`
`12`		`- * Deletes a dataset template by its template id.`
	`12`	`+ * Deletes a template by its template id.`
`13`	`13`	`*`
`14`		`- * @param {number} templateId - Dataset template id.`
	`14`	`+ * @param {number} templateId - Template id.`
`15`	`15`	`*/`
`16`	`16`	`async execute(templateId: number): Promise<void> {`
`17`	`17`	`return await this.templatesRepository.deleteTemplate(templateId)`