fix: making changes based on reviews

Author: ChengShi-1

docs/useCases.md

@@ -18,7 +18,7 @@ The different use cases currently available in the package are classified below,
     - [Get Collection Featured Items](#get-collection-featured-items)
     - [Get Collections for Linking](#get-collections-for-linking)
   - [Collections write use cases](#collections-write-use-cases)
-    - [Create a Template](#create-a-template)
+    - [Create a Dataset Template](#create-a-dataset-template)
     - [Create a Collection](#create-a-collection)
     - [Update a Collection](#update-a-collection)
     - [Publish a Collection](#publish-a-collection)
@@ -568,14 +568,14 @@ deleteCollectionFeaturedItem.execute(featuredItemId)
 
 _See [use case](../src/collections/domain/useCases/DeleteCollectionFeaturedItem.ts)_ definition.
 
-#### Create a Template
+#### Create a Dataset Template
 
-Creates a template for a given Dataverse collection id or alias.
+Creates a dataset template for a given Dataverse collection id or alias.
 
 ##### Example call:
 
 ```typescript
-import { createTemplate } from '@iqss/dataverse-client-javascript'
+import { createDatasetTemplate } from '@iqss/dataverse-client-javascript'
 import { TemplateCreateDTO } from '@iqss/dataverse-client-javascript'
 
 const collectionAlias = ':root'
@@ -598,10 +598,10 @@ const template: TemplateCreateDTO = {
   instructions: [{ instructionField: 'author', instructionText: 'The author data' }]
 }
 
-await createTemplate.execute(template, collectionAlias)
+await createDatasetTemplate.execute(template, collectionAlias)
 ```
 
-_See [use case](../src/collections/domain/useCases/CreateTemplate.ts) implementation_.
+_See [use case](../src/collections/domain/useCases/CreateDatasetTemplate.ts) implementation_.
 
 ## Datasets
 

src/collections/domain/dtos/TemplateCreateDTO.ts

@@ -2,16 +2,16 @@ import { MetadataFieldTypeClass } from '../../../metadataBlocks/domain/models/Me
 
 export interface TemplateCreateDTO {
   name: string
-  isDefault: boolean | false // defaults to false if not provided
+  isDefault?: boolean
   fields?: TemplateFieldDTO[]
   instructions?: TemplateInstructionDTO[]
 }
 
 export interface TemplateFieldDTO {
   typeName: string
   multiple: boolean
-  typeClass: MetadataFieldTypeClass
-  value: TemplateFieldValueDTO[]
+  typeClass?: MetadataFieldTypeClass
+  value?: TemplateFieldValueDTO[]
 }
 
 export interface TemplateFieldValueDTO {

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -69,5 +69,8 @@ export interface ICollectionsRepository {
     searchTerm: string,
     alreadyLinked: boolean
   ): Promise<CollectionSummary[]>
-  createTemplate(collectionIdOrAlias: number | string, template: TemplateCreateDTO): Promise<void>
+  createDatasetTemplate(
+    collectionIdOrAlias: number | string,
+    template: TemplateCreateDTO
+  ): Promise<void>
 }

…ctions/domain/useCases/CreateTemplate.ts …domain/useCases/CreateDatasetTemplate.tssrc/collections/domain/useCases/CreateTemplate.ts renamed to src/collections/domain/useCases/CreateDatasetTemplate.ts src/collections/domain/useCases/CreateTemplate.ts renamed to src/collections/domain/useCases/CreateDatasetTemplate.ts

@@ -3,7 +3,7 @@ import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
 import { TemplateCreateDTO } from '../dtos/TemplateCreateDTO'
 
-export class CreateTemplate implements UseCase<void> {
+export class CreateDatasetTemplate implements UseCase<void> {
   private collectionsRepository: ICollectionsRepository
 
   constructor(collectionsRepository: ICollectionsRepository) {
@@ -14,13 +14,14 @@ export class CreateTemplate implements UseCase<void> {
    * Creates a Dataset Template in the specified collection.
    *
    * @param {TemplateCreateDTO} template - Template definition payload.
-   * @param {number | string} [collectionIdOrAlias = ':root'] - Target collection id 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<void>}
    */
   async execute(
     template: TemplateCreateDTO,
     collectionIdOrAlias: number | string = ROOT_COLLECTION_ID
   ): Promise<void> {
-    return await this.collectionsRepository.createTemplate(collectionIdOrAlias, template)
+    return await this.collectionsRepository.createDatasetTemplate(collectionIdOrAlias, template)
   }
 }

src/collections/index.ts

@@ -16,7 +16,7 @@ import { LinkCollection } from './domain/useCases/LinkCollection'
 import { UnlinkCollection } from './domain/useCases/UnlinkCollection'
 import { GetCollectionLinks } from './domain/useCases/GetCollectionLinks'
 import { GetCollectionsForLinking } from './domain/useCases/GetCollectionsForLinking'
-import { CreateTemplate } from './domain/useCases/CreateTemplate'
+import { CreateDatasetTemplate } from './domain/useCases/CreateDatasetTemplate'
 
 const collectionsRepository = new CollectionsRepository()
 
@@ -37,7 +37,7 @@ const linkCollection = new LinkCollection(collectionsRepository)
 const unlinkCollection = new UnlinkCollection(collectionsRepository)
 const getCollectionLinks = new GetCollectionLinks(collectionsRepository)
 const getCollectionsForLinking = new GetCollectionsForLinking(collectionsRepository)
-const createTemplate = new CreateTemplate(collectionsRepository)
+const createDatasetTemplate = new CreateDatasetTemplate(collectionsRepository)
 
 export {
   getCollection,
@@ -57,7 +57,7 @@ export {
   unlinkCollection,
   getCollectionLinks,
   getCollectionsForLinking,
-  createTemplate
+  createDatasetTemplate
 }
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
 export { CollectionFacet } from './domain/models/CollectionFacet'

src/collections/infra/repositories/CollectionsRepository.ts

@@ -530,7 +530,7 @@ export class CollectionsRepository extends ApiRepository implements ICollections
       })
   }
 
-  public async createTemplate(
+  public async createDatasetTemplate(
     collectionIdOrAlias: number | string,
     template: TemplateCreateDTO
   ): Promise<void> {

…ional/collections/CreateTemplate.test.ts …ollections/createDatasetTemplate.test.tstest/functional/collections/CreateTemplate.test.ts renamed to test/functional/collections/createDatasetTemplate.test.ts test/functional/collections/CreateTemplate.test.ts renamed to test/functional/collections/createDatasetTemplate.test.ts

@@ -3,7 +3,7 @@ import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { getDatasetTemplates } from '../../../src/datasets'
 import { TemplateCreateDTO } from '../../../src/collections/domain/dtos/TemplateCreateDTO'
-import { createTemplate } from '../../../src/collections'
+import { createDatasetTemplate } from '../../../src/collections'
 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)
+    await createDatasetTemplate.execute(templateDto)
     const templates = await getDatasetTemplates.execute(':root')
 
     expect(templates[templates.length - 1].name).toBe(templateDto.name)

test/integration/collections/CollectionsRepository.test.ts

@@ -17,7 +17,7 @@ import {
   restrictFile,
   deleteFile,
   linkDataset,
-  createTemplate,
+  createDatasetTemplate,
   MetadataFieldTypeClass
 } from '../../../src'
 import { ApiConfig } from '../../../src'
@@ -2149,7 +2149,7 @@ describe('CollectionsRepository', () => {
     })
   })
 
-  describe('createTemplate', () => {
+  describe('createDatasetTemplate', () => {
     const templateDto: TemplateCreateDTO = {
       name: 'CollectionsRepository template',
       isDefault: true,
@@ -2182,7 +2182,7 @@ describe('CollectionsRepository', () => {
       ]
     }
     test('should create a template in :root with provided JSON', async () => {
-      await createTemplate.execute(templateDto)
+      await createDatasetTemplate.execute(templateDto)
       const templates = await getDatasetTemplates.execute(':root')
 
       expect(templates[templates.length - 1].name).toBe(templateDto.name)
@@ -2198,9 +2198,9 @@ describe('CollectionsRepository', () => {
       const expectedError = new WriteError(
         `[404] Can't find dataverse with identifier='invalidCollectionAlias'`
       )
-      await expect(createTemplate.execute(templateDto, 'invalidCollectionAlias')).rejects.toThrow(
-        expectedError
-      )
+      await expect(
+        createDatasetTemplate.execute(templateDto, 'invalidCollectionAlias')
+      ).rejects.toThrow(expectedError)
     })
   })
 })

…/unit/collections/CreateTemplate.test.ts …nit/collections/createDatasetTemplate.tstest/unit/collections/CreateTemplate.test.ts renamed to test/unit/collections/createDatasetTemplate.ts test/unit/collections/CreateTemplate.test.ts renamed to test/unit/collections/createDatasetTemplate.ts

@@ -1,4 +1,4 @@
-import { CreateTemplate } from '../../../src/collections/domain/useCases/CreateTemplate'
+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 { WriteError } from '../../../src'
@@ -9,23 +9,26 @@ describe('execute', () => {
 
   test('should return undefined when repository call is successful', async () => {
     const collectionRepositoryStub: ICollectionsRepository = {} as ICollectionsRepository
-    collectionRepositoryStub.createTemplate = jest.fn().mockResolvedValue(testCollectionId)
-    const sut = new CreateTemplate(collectionRepositoryStub)
+    collectionRepositoryStub.createDatasetTemplate = jest.fn().mockResolvedValue(testCollectionId)
+    const sut = new CreateDatasetTemplate(collectionRepositoryStub)
 
     const actual = await sut.execute(testTemplateDTO)
 
-    expect(collectionRepositoryStub.createTemplate).toHaveBeenCalledWith(':root', testTemplateDTO)
+    expect(collectionRepositoryStub.createDatasetTemplate).toHaveBeenCalledWith(
+      ':root',
+      testTemplateDTO
+    )
     expect(actual).toEqual(testCollectionId)
   })
 
   test('should call repository with provided collection id/alias', async () => {
     const collectionRepositoryStub: ICollectionsRepository = {} as ICollectionsRepository
-    collectionRepositoryStub.createTemplate = jest.fn().mockResolvedValue(testCollectionId)
+    collectionRepositoryStub.createDatasetTemplate = jest.fn().mockResolvedValue(testCollectionId)
 
-    const sut = new CreateTemplate(collectionRepositoryStub)
+    const sut = new CreateDatasetTemplate(collectionRepositoryStub)
     const actual = await sut.execute(testTemplateDTO, 'alias123')
 
-    expect(collectionRepositoryStub.createTemplate).toHaveBeenCalledWith(
+    expect(collectionRepositoryStub.createDatasetTemplate).toHaveBeenCalledWith(
       'alias123',
       testTemplateDTO
     )
@@ -35,8 +38,8 @@ describe('execute', () => {
 
   test('should return error result on repository error', async () => {
     const collectionRepositoryStub: ICollectionsRepository = {} as ICollectionsRepository
-    collectionRepositoryStub.createTemplate = jest.fn().mockRejectedValue(new WriteError())
-    const testCreateTemplate = new CreateTemplate(collectionRepositoryStub)
+    collectionRepositoryStub.createDatasetTemplate = jest.fn().mockRejectedValue(new WriteError())
+    const testCreateTemplate = new CreateDatasetTemplate(collectionRepositoryStub)
 
     await expect(testCreateTemplate.execute(testTemplateDTO)).rejects.toThrow(WriteError)
   })