chore: rename use cases

Author: ChengShi-1

CHANGELOG.md

@@ -15,8 +15,8 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 - 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.
-- Templates: Added `setDefaultTemplate` use case and repository method to support Dataverse endpoint `POST /dataverses/{id}/template/default/{templateId}`.
-- Templates: Added `removeDefaultTemplate` use case and repository method to support Dataverse endpoint `DELETE /dataverses/{id}/template/default`.
+- Templates: Added `setTemplateAsDefault` use case and repository method to support Dataverse endpoint `POST /dataverses/{id}/template/default/{templateId}`.
+- Templates: Added `unsetTemplateAsDefault` use case and repository method to support Dataverse endpoint `DELETE /dataverses/{id}/template/default`.
 - New Use Case: [Update Terms of Access](./docs/useCases.md#update-terms-of-access).
 
 ### Changed

docs/useCases.md

@@ -32,8 +32,8 @@ The different use cases currently available in the package are classified below,
   - [Templates write use cases](#templates-write-use-cases)
     - [Create a Template](#create-a-template)
     - [Delete a Template](#delete-a-template)
-    - [Set Default Template](#set-default-template)
-    - [Remove Default Template](#remove-default-template)
+    - [Set Template As Default](#set-template-as-default)
+    - [Unset Template As Default](#unset-template-as-default)
 - [Datasets](#Datasets)
   - [Datasets read use cases](#datasets-read-use-cases)
     - [Get a Dataset](#get-a-dataset)
@@ -671,7 +671,7 @@ await deleteTemplate.execute(templateId)
 
 _See [use case](../src/templates/domain/useCases/DeleteTemplate.ts)_ definition.
 
-#### Set Default Template
+#### Set Template As Default
 
 Sets the default template for a given Dataverse collection.
 
@@ -680,17 +680,17 @@ You must have edit permissions on the collection in order to use this endpoint.
 ##### Example call:
 
 ```typescript
-import { setDefaultTemplate } from '@iqss/dataverse-client-javascript'
+import { setTemplateAsDefault } from '@iqss/dataverse-client-javascript'
 
 const collectionIdOrAlias = ':root'
 const templateId = 12345
 
-await setDefaultTemplate.execute(templateId, collectionIdOrAlias)
+await setTemplateAsDefault.execute(templateId, collectionIdOrAlias)
 ```
 
-_See [use case](../src/templates/domain/useCases/SetDefaultTemplate.ts)_ definition.
+_See [use case](../src/templates/domain/useCases/SetTemplateAsDefault.ts)_ definition.
 
-#### Remove Default Template
+#### Unset Template As Default
 
 Removes the default template from a given Dataverse collection.
 
@@ -699,14 +699,14 @@ You must have edit permissions on the collection in order to use this endpoint.
 ##### Example call:
 
 ```typescript
-import { removeDefaultTemplate } from '@iqss/dataverse-client-javascript'
+import { unsetTemplateAsDefault } from '@iqss/dataverse-client-javascript'
 
 const collectionIdOrAlias = ':root'
 
-await removeDefaultTemplate.execute(collectionIdOrAlias)
+await unsetTemplateAsDefault.execute(collectionIdOrAlias)
 ```
 
-_See [use case](../src/templates/domain/useCases/RemoveDefaultTemplate.ts)_ definition.
+_See [use case](../src/templates/domain/useCases/UnsetTemplateAsDefault.ts)_ definition.
 
 ## Datasets
 

src/templates/domain/repositories/ITemplatesRepository.ts

@@ -6,6 +6,6 @@ export interface ITemplatesRepository {
   getTemplate(templateId: number): Promise<Template>
   getTemplatesByCollectionId(collectionIdOrAlias: number | string): Promise<Template[]>
   deleteTemplate(templateId: number): Promise<void>
-  setDefaultTemplate(collectionIdOrAlias: number | string, templateId: number): Promise<void>
-  unsetDefaultTemplate(collectionIdOrAlias: number | string): Promise<void>
+  setTemplateAsDefault(collectionIdOrAlias: number | string, templateId: number): Promise<void>
+  unsetTemplateAsDefault(collectionIdOrAlias: number | string): Promise<void>
 }

…es/domain/useCases/SetDefaultTemplate.ts …/domain/useCases/SetTemplateAsDefault.tssrc/templates/domain/useCases/SetDefaultTemplate.ts renamed to src/templates/domain/useCases/SetTemplateAsDefault.ts src/templates/domain/useCases/SetDefaultTemplate.ts renamed to src/templates/domain/useCases/SetTemplateAsDefault.ts

@@ -2,7 +2,7 @@ import { ROOT_COLLECTION_ID } from '../../../collections/domain/models/Collectio
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { ITemplatesRepository } from '../repositories/ITemplatesRepository'
 
-export class SetDefaultTemplate implements UseCase<void> {
+export class SetTemplateAsDefault implements UseCase<void> {
   private templatesRepository: ITemplatesRepository
 
   constructor(templatesRepository: ITemplatesRepository) {

…domain/useCases/RemoveDefaultTemplate.ts …omain/useCases/UnsetTemplateAsDefault.tssrc/templates/domain/useCases/RemoveDefaultTemplate.ts renamed to src/templates/domain/useCases/UnsetTemplateAsDefault.ts src/templates/domain/useCases/RemoveDefaultTemplate.ts renamed to src/templates/domain/useCases/UnsetTemplateAsDefault.ts

@@ -2,7 +2,7 @@ import { ROOT_COLLECTION_ID } from '../../../collections/domain/models/Collectio
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { ITemplatesRepository } from '../repositories/ITemplatesRepository'
 
-export class RemoveDefaultTemplate implements UseCase<void> {
+export class UnsetTemplateAsDefault implements UseCase<void> {
   private templatesRepository: ITemplatesRepository
 
   constructor(templatesRepository: ITemplatesRepository) {

src/templates/index.ts

@@ -3,25 +3,25 @@ import { CreateTemplate } from './domain/useCases/CreateTemplate'
 import { DeleteTemplate } from './domain/useCases/DeleteTemplate'
 import { GetTemplatesByCollectionId } from './domain/useCases/GetTemplatesByCollectionId'
 import { GetTemplate } from './domain/useCases/GetTemplate'
-import { SetDefaultTemplate } from './domain/useCases/SetDefaultTemplate'
-import { RemoveDefaultTemplate } from './domain/useCases/RemoveDefaultTemplate'
+import { SetTemplateAsDefault } from './domain/useCases/SetTemplateAsDefault'
+import { UnsetTemplateAsDefault } from './domain/useCases/UnsetTemplateAsDefault'
 
 const templatesRepository = new TemplatesRepository()
 
 const createTemplate = new CreateTemplate(templatesRepository)
 const deleteTemplate = new DeleteTemplate(templatesRepository)
 const getTemplatesByCollectionId = new GetTemplatesByCollectionId(templatesRepository)
 const getTemplate = new GetTemplate(templatesRepository)
-const setDefaultTemplate = new SetDefaultTemplate(templatesRepository)
-const removeDefaultTemplate = new RemoveDefaultTemplate(templatesRepository)
+const setTemplateAsDefault = new SetTemplateAsDefault(templatesRepository)
+const unsetTemplateAsDefault = new UnsetTemplateAsDefault(templatesRepository)
 
 export {
   createTemplate,
   deleteTemplate,
   getTemplatesByCollectionId,
   getTemplate,
-  setDefaultTemplate,
-  removeDefaultTemplate
+  setTemplateAsDefault,
+  unsetTemplateAsDefault
 }
 export {
   CreateTemplateDTO,

src/templates/infra/repositories/TemplatesRepository.ts

@@ -56,7 +56,7 @@ export class TemplatesRepository extends ApiRepository implements ITemplatesRepo
       })
   }
 
-  public async setDefaultTemplate(
+  public async setTemplateAsDefault(
     collectionIdOrAlias: number | string,
     templateId: number
   ): Promise<void> {
@@ -70,7 +70,7 @@ export class TemplatesRepository extends ApiRepository implements ITemplatesRepo
       })
   }
 
-  public async unsetDefaultTemplate(collectionIdOrAlias: number | string): Promise<void> {
+  public async unsetTemplateAsDefault(collectionIdOrAlias: number | string): Promise<void> {
     return this.doDelete(`/${this.collectionsResourceName}/${collectionIdOrAlias}/template/default`)
       .then(() => undefined)
       .catch((error) => {

…nal/templates/SetDefaultTemplate.test.ts …l/templates/SetTemplateAsDefault.test.tstest/functional/templates/SetDefaultTemplate.test.ts renamed to test/functional/templates/SetTemplateAsDefault.test.ts test/functional/templates/SetDefaultTemplate.test.ts renamed to test/functional/templates/SetTemplateAsDefault.test.ts

@@ -4,14 +4,14 @@ import { TestConstants } from '../../testHelpers/TestConstants'
 import {
   createTemplate,
   getTemplatesByCollectionId,
-  setDefaultTemplate,
-  removeDefaultTemplate
+  setTemplateAsDefault,
+  unsetTemplateAsDefault
 } 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'
 
-describe('SetDefaultTemplate.execute', () => {
+describe('SetTemplateAsDefault.execute', () => {
   const collectionIdOrAlias = ':root'
 
   beforeEach(async () => {
@@ -68,17 +68,17 @@ describe('SetDefaultTemplate.execute', () => {
       throw new Error('Created template was not found in collection templates.')
     }
 
-    await setDefaultTemplate.execute(createdTemplate.id, collectionIdOrAlias)
+    await setTemplateAsDefault.execute(createdTemplate.id, collectionIdOrAlias)
 
     const templatesAfterSet = await getTemplatesByCollectionId.execute(collectionIdOrAlias)
     const updatedTemplate = templatesAfterSet.find((template) => template.id === createdTemplate.id)
 
     expect(updatedTemplate?.isDefault).toBe(true)
 
     if (originalDefaultTemplateId && originalDefaultTemplateId !== createdTemplate.id) {
-      await setDefaultTemplate.execute(originalDefaultTemplateId, collectionIdOrAlias)
+      await setTemplateAsDefault.execute(originalDefaultTemplateId, collectionIdOrAlias)
     } else if (!originalDefaultTemplateId) {
-      await removeDefaultTemplate.execute(collectionIdOrAlias)
+      await unsetTemplateAsDefault.execute(collectionIdOrAlias)
     }
 
     await deleteDatasetTemplateViaApi(createdTemplate.id)

…/templates/RemoveDefaultTemplate.test.ts …templates/UnsetTemplateAsDefault.test.tstest/functional/templates/RemoveDefaultTemplate.test.ts renamed to test/functional/templates/UnsetTemplateAsDefault.test.ts test/functional/templates/RemoveDefaultTemplate.test.ts renamed to test/functional/templates/UnsetTemplateAsDefault.test.ts

@@ -4,14 +4,14 @@ import { TestConstants } from '../../testHelpers/TestConstants'
 import {
   createTemplate,
   getTemplatesByCollectionId,
-  setDefaultTemplate,
-  removeDefaultTemplate
+  setTemplateAsDefault,
+  unsetTemplateAsDefault
 } 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'
 
-describe('RemoveDefaultTemplate.execute', () => {
+describe('UnsetTemplateAsDefault.execute', () => {
   const collectionIdOrAlias = ':root'
 
   beforeEach(async () => {
@@ -23,7 +23,7 @@ describe('RemoveDefaultTemplate.execute', () => {
   })
 
   test('should remove the default template from a collection', async () => {
-    const templateName = `TestRemoveDefaultTemplate-${Date.now()}`
+    const templateName = `TestUnsetTemplateAsDefault-${Date.now()}`
     const templateDto: CreateTemplateDTO = {
       name: templateName,
       isDefault: false,
@@ -68,16 +68,16 @@ describe('RemoveDefaultTemplate.execute', () => {
       throw new Error('Created template was not found in collection templates.')
     }
 
-    await setDefaultTemplate.execute(createdTemplate.id, collectionIdOrAlias)
-    await removeDefaultTemplate.execute(collectionIdOrAlias)
+    await setTemplateAsDefault.execute(createdTemplate.id, collectionIdOrAlias)
+    await unsetTemplateAsDefault.execute(collectionIdOrAlias)
 
     const templatesAfterRemove = await getTemplatesByCollectionId.execute(collectionIdOrAlias)
     const hasDefaultTemplate = templatesAfterRemove.some((template) => template.isDefault)
 
     expect(hasDefaultTemplate).toBe(false)
 
     if (originalDefaultTemplateId && originalDefaultTemplateId !== createdTemplate.id) {
-      await setDefaultTemplate.execute(originalDefaultTemplateId, collectionIdOrAlias)
+      await setTemplateAsDefault.execute(originalDefaultTemplateId, collectionIdOrAlias)
     }
 
     await deleteDatasetTemplateViaApi(createdTemplate.id)

test/integration/templates/TemplateRepository.test.ts

@@ -247,11 +247,11 @@ describe('TemplatesRepository', () => {
     })
   })
 
-  describe('setDefaultTemplate', () => {
+  describe('setTemplateAsDefault', () => {
     test('should set a template as default for a collection', async () => {
       await createTemplate.execute(
         {
-          name: 'Template for SetDefaultTemplate',
+          name: 'Template for setTemplateAsDefault',
           isDefault: false,
           fields: [
             {
@@ -287,7 +287,7 @@ describe('TemplatesRepository', () => {
       const templates = await getTemplatesByCollectionId.execute(testCollectionAlias)
       const templateId = templates[templates.length - 1].id
 
-      await sut.setDefaultTemplate(testCollectionAlias, templateId)
+      await sut.setTemplateAsDefault(testCollectionAlias, templateId)
 
       const templatesAfter = await getTemplatesByCollectionId.execute(testCollectionAlias)
       const updatedTemplate = templatesAfter.find((template) => template.id === templateId)
@@ -298,15 +298,15 @@ describe('TemplatesRepository', () => {
     })
 
     test('should return error when template does not exist', async () => {
-      await expect(sut.setDefaultTemplate(testCollectionAlias, 999999)).rejects.toThrow()
+      await expect(sut.setTemplateAsDefault(testCollectionAlias, 999999)).rejects.toThrow()
     })
   })
 
-  describe('unsetDefaultTemplate', () => {
+  describe('unsetTemplateAsDefault', () => {
     test('should remove the default template from a collection', async () => {
       await createTemplate.execute(
         {
-          name: 'Template for UnsetDefaultTemplate',
+          name: 'Template for unsetTemplateAsDefault',
           isDefault: false,
           fields: [
             {
@@ -342,8 +342,8 @@ describe('TemplatesRepository', () => {
       const templates = await getTemplatesByCollectionId.execute(testCollectionAlias)
       const templateId = templates[templates.length - 1].id
 
-      await sut.setDefaultTemplate(testCollectionAlias, templateId)
-      await sut.unsetDefaultTemplate(testCollectionAlias)
+      await sut.setTemplateAsDefault(testCollectionAlias, templateId)
+      await sut.unsetTemplateAsDefault(testCollectionAlias)
 
       const templatesAfter = await getTemplatesByCollectionId.execute(testCollectionAlias)
       const hasDefaultTemplate = templatesAfter.some((template) => template.isDefault)
@@ -354,7 +354,7 @@ describe('TemplatesRepository', () => {
     })
 
     test('should return error when collection does not exist', async () => {
-      await expect(sut.unsetDefaultTemplate('invalidCollectionAlias')).rejects.toThrow()
+      await expect(sut.unsetTemplateAsDefault('invalidCollectionAlias')).rejects.toThrow()
     })
   })
 })