Merge pull request #430 from IQSS/427-edit-template-use-cases

add use cases for editing template to TemplatesRepository.ts

Author: ChengShi-1

.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
@@ -35,12 +35,13 @@ jobs:
         run: npm run test:integration
 
   test-functional:
+    needs: [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
@@ -54,10 +55,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
@@ -32,12 +32,13 @@ jobs:
         run: npm run test:integration
 
   test-functional:
+    needs: [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
@@ -52,10 +53,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

CHANGELOG.md

@@ -25,6 +25,9 @@ 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.
+- New Use Case: [Update Template Metadata](./docs/useCases.md#update-template-metadata) under Templates.
+- New Use Case: [Update Template License Terms](./docs/useCases.md#update-template-license-terms) under Templates.
+- New Use Case: [Update Template Terms Of Access](./docs/useCases.md#update-template-terms-of-access) under Templates.
 - 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).

docs/useCases.md

@@ -36,6 +36,9 @@ 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)
+    - [Update Template Metadata](#update-template-metadata)
+    - [Update Template License Terms](#update-template-license-terms)
+    - [Update Template Terms Of Access](#update-template-terms-of-access)
     - [Set Template As Default](#set-template-as-default)
     - [Unset Template As Default](#unset-template-as-default)
 - [Datasets](#Datasets)
@@ -838,6 +841,84 @@ await unsetTemplateAsDefault.execute(collectionIdOrAlias)
 
 _See [use case](../src/templates/domain/useCases/UnsetTemplateAsDefault.ts)_ definition.
 
+#### Update Template Metadata
+
+Updates template metadata fields and instructions for a template id.
+
+##### Example call:
+
+```typescript
+import { updateTemplateMetadata } from '@iqss/dataverse-client-javascript'
+import { UpdateTemplateMetadataDTO } from '@iqss/dataverse-client-javascript'
+
+const templateId = 12345
+const replace = true
+
+const payload: UpdateTemplateMetadataDTO = {
+  name: 'Dataverse template updated',
+  fields: [
+    {
+      typeName: 'author',
+      typeClass: 'compound',
+      multiple: true,
+      value: [
+        {
+          authorName: { typeName: 'authorName', value: 'Belicheck, Bill' },
+          authorAffiliation: { typeName: 'authorIdentifierScheme', value: 'ORCID' }
+        }
+      ]
+    }
+  ],
+  instructions: [{ instructionField: 'author', instructionText: 'Updated instructions' }]
+}
+
+await updateTemplateMetadata.execute(templateId, payload, replace)
+```
+
+_See [use case](../src/templates/domain/useCases/UpdateTemplateMetadata.ts) definition_.
+
+#### Update Template License Terms
+
+Updates either the license name or custom terms of use for a template id.
+
+##### Example call:
+
+```typescript
+import { updateTemplateLicenseTerms } from '@iqss/dataverse-client-javascript'
+import { UpdateTemplateLicenseTermsDTO } from '@iqss/dataverse-client-javascript'
+
+const templateId = 12345
+
+const payload: UpdateTemplateLicenseTermsDTO = {
+  customTerms: {
+    termsOfUse: 'Updated template terms of use'
+  }
+}
+
+await updateTemplateLicenseTerms.execute(templateId, payload)
+```
+
+_See [use case](../src/templates/domain/useCases/UpdateTemplateLicenseTerms.ts) definitition_.
+
+#### Update Template Terms Of Access
+
+Updates terms of access for a template id.
+
+##### Example call:
+
+```typescript
+import { updateTemplateTermsOfAccess } from '@iqss/dataverse-client-javascript'
+
+const templateId = 12345
+
+await updateTemplateTermsOfAccess.execute(templateId, {
+  fileAccessRequest: true,
+  termsOfAccessForRestrictedFiles: 'Restricted access only'
+})
+```
+
+_See [use case](../src/templates/domain/useCases/UpdateTemplateTermsOfAccess.ts) definition_.
+
 ## Datasets
 
 ### Datasets Read Use Cases

package.json

@@ -10,11 +10,16 @@
   "scripts": {
     "build": "tsc",
     "test": "jest -c jest.config.ts",
+    "test:no-teardown": "TESTCONTAINERS_RYUK_DISABLED=true jest -c jest.config.ts",
     "test:unit": "jest -c jest.config.unit.ts",
     "test:integration": "jest -c jest.config.integration.ts",
+    "test:integration:no-teardown": "TESTCONTAINERS_RYUK_DISABLED=true jest -c jest.config.integration.ts",
     "test:functional": "jest -c jest.config.functional.ts",
+    "test:functional:no-teardown": "TESTCONTAINERS_RYUK_DISABLED=true jest -c jest.config.functional.ts",
     "test:coverage": "jest --coverage -c jest.config.ts",
+    "test:coverage:no-teardown": "TESTCONTAINERS_RYUK_DISABLED=true jest --coverage -c jest.config.ts",
     "test:coverage:check": "jest --coverage --ci --config jest.config.ts",
+    "test:coverage:check:no-teardown": "TESTCONTAINERS_RYUK_DISABLED=true jest --coverage --ci --config jest.config.ts",
     "lint": "npm run lint:eslint && npm run lint:prettier",
     "lint:fix": "eslint --fix --ext .ts ./src --ignore-path .gitignore .",
     "lint:eslint": "eslint --ignore-path .gitignore .",

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,22 @@
+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
+  }
+
+  /**
+   * Updates the license terms for a template with the given identifier.
+   *
+   * @param {number} templateId - The unique identifier of the template to update.
+   * @param {UpdateTemplateLicenseTermsDTO} payload - The license terms data to apply to the template.
+   * @returns {Promise<void>} A promise that resolves when the license terms have been updated.
+   */
+  async execute(templateId: number, payload: UpdateTemplateLicenseTermsDTO): Promise<void> {
+    return await this.templatesRepository.updateTemplateLicenseTerms(templateId, payload)
+  }
+}