add use cases for editing template to TemplatesRepository.ts

.github/workflows/deploy_alpha.yml

@@ -9,10 +9,10 @@ jobs:
   test-unit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 19
+          node-version: 22
 
       - name: Install npm dependencies
         run: npm ci
@@ -23,10 +23,10 @@ jobs:
   test-integration:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 19
+          node-version: 22
 
       - name: Install npm dependencies
         run: npm ci
@@ -37,10 +37,10 @@ jobs:
   test-functional:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 19
+          node-version: 22
 
       - name: Install npm dependencies
         run: npm ci
@@ -54,10 +54,10 @@ jobs:
     permissions:
       packages: write
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 19
+          node-version: 22
           registry-url: https://npm.pkg.github.com/
 
       - name: Install npm dependencies

.github/workflows/deploy_pr.yml

@@ -6,10 +6,10 @@ jobs:
   test-unit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 19
+          node-version: 22
 
       - name: Install npm dependencies
         run: npm ci
@@ -20,10 +20,10 @@ jobs:
   test-integration:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 19
+          node-version: 22
 
       - name: Install npm dependencies
         run: npm ci
@@ -34,10 +34,10 @@ jobs:
   test-functional:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 19
+          node-version: 22
 
       - name: Install npm dependencies
         run: npm ci
@@ -52,10 +52,10 @@ jobs:
       packages: write
       contents: read
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 19
+          node-version: 22
           registry-url: https://npm.pkg.github.com/
 
       - name: Install npm dependencies

.github/workflows/lint.yml

@@ -6,10 +6,10 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: 19
+          node-version: 22
 
       - name: Install npm dependencies
         run: npm ci

src/templates/domain/dtos/UpdateTemplateLicenseTermsDTO.ts

@@ -0,0 +1,6 @@
+import { CustomTerms } from '../../../datasets/domain/models/Dataset'
+
+export interface UpdateTemplateLicenseTermsDTO {
+  name?: string
+  customTerms?: CustomTerms
+}

src/templates/domain/dtos/UpdateTemplateMetadataDTO.ts

@@ -0,0 +1,7 @@
+import { TemplateFieldDTO, TemplateInstructionDTO } from './CreateTemplateDTO'
+
+export interface UpdateTemplateMetadataDTO {
+  name?: string
+  fields?: TemplateFieldDTO[]
+  instructions?: TemplateInstructionDTO[]
+}

src/templates/domain/repositories/ITemplatesRepository.ts

@@ -1,8 +1,21 @@
 import { CreateTemplateDTO } from '../dtos/CreateTemplateDTO'
+import { UpdateTemplateLicenseTermsDTO } from '../dtos/UpdateTemplateLicenseTermsDTO'
+import { UpdateTemplateMetadataDTO } from '../dtos/UpdateTemplateMetadataDTO'
 import { Template } from '../models/Template'
+import { TermsOfAccess } from '../../../datasets/domain/models/Dataset'
 
 export interface ITemplatesRepository {
   createTemplate(collectionIdOrAlias: number | string, template: CreateTemplateDTO): Promise<void>
+  updateTemplateMetadata(
+    templateId: number,
+    payload: UpdateTemplateMetadataDTO,
+    replace?: boolean
+  ): Promise<void>
+  updateTemplateLicenseTerms(
+    templateId: number,
+    payload: UpdateTemplateLicenseTermsDTO
+  ): Promise<void>
+  updateTemplateTermsOfAccess(templateId: number, termsOfAccess: TermsOfAccess): Promise<void>
   getTemplate(templateId: number): Promise<Template>
   getTemplatesByCollectionId(collectionIdOrAlias: number | string): Promise<Template[]>
   deleteTemplate(templateId: number): Promise<void>

src/templates/domain/useCases/UpdateTemplateLicenseTerms.ts

@@ -0,0 +1,15 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { UpdateTemplateLicenseTermsDTO } from '../dtos/UpdateTemplateLicenseTermsDTO'
+import { ITemplatesRepository } from '../repositories/ITemplatesRepository'
+
+export class UpdateTemplateLicenseTerms implements UseCase<void> {
+  private templatesRepository: ITemplatesRepository
+
+  constructor(templatesRepository: ITemplatesRepository) {
+    this.templatesRepository = templatesRepository
+  }
+
+  async execute(templateId: number, payload: UpdateTemplateLicenseTermsDTO): Promise<void> {
+    return await this.templatesRepository.updateTemplateLicenseTerms(templateId, payload)
+  }
+}

src/templates/domain/useCases/UpdateTemplateMetadata.ts

@@ -0,0 +1,19 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { UpdateTemplateMetadataDTO } from '../dtos/UpdateTemplateMetadataDTO'
+import { ITemplatesRepository } from '../repositories/ITemplatesRepository'
+
+export class UpdateTemplateMetadata implements UseCase<void> {
+  private templatesRepository: ITemplatesRepository
+
+  constructor(templatesRepository: ITemplatesRepository) {
+    this.templatesRepository = templatesRepository
+  }
+
+  async execute(
+    templateId: number,
+    payload: UpdateTemplateMetadataDTO,
+    replace = false
+  ): Promise<void> {
+    return await this.templatesRepository.updateTemplateMetadata(templateId, payload, replace)
+  }
+}

src/templates/domain/useCases/UpdateTemplateTermsOfAccess.ts

@@ -0,0 +1,15 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { TermsOfAccess } from '../../../datasets/domain/models/Dataset'
+import { ITemplatesRepository } from '../repositories/ITemplatesRepository'
+
+export class UpdateTemplateTermsOfAccess implements UseCase<void> {
+  private templatesRepository: ITemplatesRepository
+
+  constructor(templatesRepository: ITemplatesRepository) {
+    this.templatesRepository = templatesRepository
+  }
+
+  async execute(templateId: number, termsOfAccess: TermsOfAccess): Promise<void> {
+    return await this.templatesRepository.updateTemplateTermsOfAccess(templateId, termsOfAccess)
+  }
+}

src/templates/index.ts

@@ -3,15 +3,29 @@ 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 { UpdateTemplateMetadata } from './domain/useCases/UpdateTemplateMetadata'
+import { UpdateTemplateLicenseTerms } from './domain/useCases/UpdateTemplateLicenseTerms'
+import { UpdateTemplateTermsOfAccess } from './domain/useCases/UpdateTemplateTermsOfAccess'
 
 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 updateTemplateMetadata = new UpdateTemplateMetadata(templatesRepository)
+const updateTemplateLicenseTerms = new UpdateTemplateLicenseTerms(templatesRepository)
+const updateTemplateTermsOfAccess = new UpdateTemplateTermsOfAccess(templatesRepository)
 
-export { createTemplate, deleteTemplate, getTemplatesByCollectionId, getTemplate }
+export {
+  createTemplate,
+  deleteTemplate,
+  getTemplatesByCollectionId,
+  getTemplate,
+  updateTemplateMetadata,
+  updateTemplateLicenseTerms,
+  updateTemplateTermsOfAccess
+}
 export {
   CreateTemplateDTO,
   TemplateFieldDTO,
@@ -21,4 +35,6 @@ export {
   TemplateFieldValueControlledVocabularyDTO,
   TemplateInstructionDTO
 } from './domain/dtos/CreateTemplateDTO'
+export { UpdateTemplateMetadataDTO } from './domain/dtos/UpdateTemplateMetadataDTO'
+export { UpdateTemplateLicenseTermsDTO } from './domain/dtos/UpdateTemplateLicenseTermsDTO'
 export { Template, TemplateInstruction } from './domain/models/Template'

src/templates/infra/repositories/TemplatesRepository.ts

@@ -1,9 +1,13 @@
 import { AxiosResponse } from 'axios'
 import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
+import { TermsOfAccess } from '../../../datasets/domain/models/Dataset'
 import { CreateTemplateDTO } from '../../domain/dtos/CreateTemplateDTO'
+import { UpdateTemplateLicenseTermsDTO } from '../../domain/dtos/UpdateTemplateLicenseTermsDTO'
+import { UpdateTemplateMetadataDTO } from '../../domain/dtos/UpdateTemplateMetadataDTO'
 import { Template } from '../../domain/models/Template'
 import { ITemplatesRepository } from '../../domain/repositories/ITemplatesRepository'
 import { TemplatePayload } from './transformers/TemplatePayload'
+import { transformTemplateTermsOfAccessToUpdatePayload } from './transformers/templateTermsOfAccessTransformers'
 import {
   transformTemplatePayloadToTemplate,
   transformTemplatePayloadsToTemplates
@@ -26,6 +30,32 @@ export class TemplatesRepository extends ApiRepository implements ITemplatesRepo
       })
   }
 
+  public async updateTemplateMetadata(
+    templateId: number,
+    payload: UpdateTemplateMetadataDTO,
+    replace = false
+  ): Promise<void> {
+    return this.updateTemplate(templateId, 'metadata', payload, { replace })
+  }
+
+  public async updateTemplateLicenseTerms(
+    templateId: number,
+    payload: UpdateTemplateLicenseTermsDTO
+  ): Promise<void> {
+    return this.updateTemplate(templateId, 'licenseTerms', payload)
+  }
+
+  public async updateTemplateTermsOfAccess(
+    templateId: number,
+    termsOfAccess: TermsOfAccess
+  ): Promise<void> {
+    return this.updateTemplate(
+      templateId,
+      'access',
+      transformTemplateTermsOfAccessToUpdatePayload(termsOfAccess)
+    )
+  }
+
   public async getTemplate(templateId: number): Promise<Template> {
     return this.doGet(`/dataverses/${templateId}/template`, true)
       .then((response: AxiosResponse<{ data: TemplatePayload }>) =>
@@ -55,4 +85,17 @@ export class TemplatesRepository extends ApiRepository implements ITemplatesRepo
         throw error
       })
   }
+
+  private async updateTemplate(
+    templateId: number,
+    operation: 'metadata' | 'licenseTerms' | 'access',
+    payload: object,
+    queryParams: object = {}
+  ): Promise<void> {
+    return this.doPut(`/dataverses/${templateId}/${operation}`, payload, queryParams)
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
+  }
 }

src/templates/infra/repositories/transformers/templateTermsOfAccessTransformers.ts

@@ -0,0 +1,30 @@
+import { TermsOfAccess } from '../../../../datasets/domain/models/Dataset'
+
+export const transformTemplateTermsOfAccessToUpdatePayload = (
+  terms: TermsOfAccess & { termsOfAccess?: string }
+) => {
+  const {
+    fileAccessRequest,
+    dataAccessPlace,
+    originalArchive,
+    availabilityStatus,
+    contactForAccess,
+    sizeOfCollection,
+    studyCompletion
+  } = terms
+
+  const termsOfAccess = terms.termsOfAccess ?? terms.termsOfAccessForRestrictedFiles
+
+  return {
+    customTermsOfAccess: {
+      fileAccessRequest,
+      termsOfAccess,
+      dataAccessPlace,
+      originalArchive,
+      availabilityStatus,
+      contactForAccess,
+      sizeOfCollection,
+      studyCompletion
+    }
+  }
+}

test/environment/.env

@@ -1,6 +1,6 @@
 POSTGRES_VERSION=17
 DATAVERSE_DB_USER=dataverse
 SOLR_VERSION=9.8.0
-DATAVERSE_IMAGE_REGISTRY=docker.io
-DATAVERSE_IMAGE_TAG=unstable
+DATAVERSE_IMAGE_REGISTRY=ghcr.io
+DATAVERSE_IMAGE_TAG=11912-edit-template-api
 DATAVERSE_BOOTSTRAP_TIMEOUT=5m

test/functional/datasets/GetDatasetAvailableDatasetTypes.test.ts

@@ -14,16 +14,16 @@ describe('getDatasetAvailableDatasetTypes', () => {
 
     test('should return available dataset types', async () => {
       const actualDatasetTypes: DatasetType[] = await getDatasetAvailableDatasetTypes.execute()
-      const expectedDatasetTypes = [
-        {
-          id: 1,
-          name: 'dataset',
-          linkedMetadataBlocks: [],
-          availableLicenses: []
-        }
-      ]
+      const expectedDatasetTypes = {
+        id: 1,
+        name: 'dataset',
+        linkedMetadataBlocks: [],
+        availableLicenses: []
+      }
 
-      expect(actualDatasetTypes).toEqual(expectedDatasetTypes)
+      // check that the actual dataset types include the expected dataset types
+      // (without requiring an exact match, since other dataset types may be created by concurrent tests)
+      expect(actualDatasetTypes).toContainEqual(expectedDatasetTypes)
     })
   })
 })