Use Cases of Get and Delete a template by ChengShi-1 · Pull Request #406 · IQSS/dataverse-client-javascript

ChengShi-1 · 2026-01-07T20:52:27Z

What this PR does / why we need it:

Use Cases of GET and DELETE a template
Restructure existing template related uses cases to /template folder

Which issue(s) this PR closes:

Closes Use Cases of GET and DELETE a template #398

Related Dataverse PRs:

Depends on 11918 template apis dataverse#11969

Special notes for your reviewer:

Mainly check on Use Cases of Get a template and Delete a template, (get dataset templates and create template was implemented before)
I ignored some Copilot review now, Copilot has some comments about the naming confusion between Template and Dataset Template. I tried to keep it calling Template instead of Dataset Template, besides getDatasetTemplates use case

Suggestions on how to test this:

Is there a release notes or changelog update needed for this change?:

YES

Additional documentation:

Copilot

Pull request overview

This PR restructures template-related functionality into a dedicated /templates module and adds new use cases for getting and deleting templates. The changes move template operations from the datasets and collections modules to a more appropriate domain-specific location.

Key Changes:

Created new Templates module with dedicated use cases: CreateTemplate, GetTemplate, GetDatasetTemplates, and DeleteTemplate
Migrated template functionality from datasets and collections modules to the new templates module
Added comprehensive unit, integration, and functional tests for the new template operations

Reviewed changes

Copilot reviewed 30 out of 31 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
src/templates/domain/useCases/GetTemplate.ts	New use case for retrieving a single template by ID
src/templates/domain/useCases/DeleteTemplate.ts	New use case for deleting a template by ID
src/templates/domain/useCases/CreateTemplate.ts	Migrated and updated CreateTemplate use case from collections module
src/templates/domain/useCases/GetDatasetTemplates.ts	Migrated use case for getting templates by collection
src/templates/domain/repositories/ITemplatesRepository.ts	New repository interface defining template operations
src/templates/domain/models/Template.ts	Updated template model definitions (renamed from DatasetTemplate)
src/templates/infra/repositories/TemplatesRepository.ts	New repository implementation for template operations
src/templates/infra/repositories/transformers/templateTransformers.ts	Transformer logic migrated from datasets module
src/templates/infra/repositories/transformers/TemplatePayload.ts	Updated payload interface for templates
src/templates/index.ts	Module exports for templates domain
src/index.ts	Added templates module to main exports
test/unit/templates/*.test.ts	New unit tests for template use cases
test/integration/templates/TemplateRepository.test.ts	Comprehensive integration tests for template repository
test/functional/templates/createDatasetTemplate.test.ts	Updated functional test with new import paths
src/datasets/domain/useCases/GetDatasetTemplates.ts	Removed - migrated to templates module
src/datasets/infra/repositories/transformers/datasetTemplateTransformers.ts	Removed - migrated to templates module
src/collections/domain/useCases/CreateDatasetTemplate.ts	Removed - migrated to templates module
src/collections/infra/repositories/CollectionsRepository.ts	Removed createDatasetTemplate method
docs/useCases.md	Updated documentation with new Templates section and reorganized template use cases
CHANGELOG.md	Updated with new template use cases

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

src/templates/infra/repositories/TemplatesRepository.ts

test/unit/templates/getTemplate.test.ts

CHANGELOG.md

Copilot · 2026-01-08T00:24:09Z

src/templates/domain/repositories/ITemplatesRepository.ts

+import { Template } from '../models/Template'
+
+export interface ITemplatesRepository {
+  createDatasetTemplate(


Naming inconsistency: The repository method is named createDatasetTemplate but the domain model is just Template (not DatasetTemplate). For consistency with the new template domain naming (where the model is Template and the use case is CreateTemplate), consider renaming this method to createTemplate.

Suggested change

createDatasetTemplate(

createTemplate(

I think this suggested change from createDatasetTemplate() to createTemplate() makes sense, given that the object is a Template, and now that the other method has changed to getTemplatesByCollectionId(). What do you think?

docs/useCases.md

test/unit/templates/deleteTemplate.test.ts

test/unit/templates/CreateTemplate.test.ts

ekraffmiller

Looks good! I just have some suggestions about the naming conventions

ekraffmiller · 2026-01-09T20:26:25Z

src/templates/domain/repositories/ITemplatesRepository.ts

+    template: CreateDatasetTemplateDTO
+  ): Promise<void>
+  getTemplate(templateId: number): Promise<Template>
+  getDatasetTemplates(collectionIdOrAlias: number | string): Promise<Template[]>


The naming of the two get functions are a little confusing. At first glance, it seems like getDatasetTemplates() may be returning all Templates for a Dataset.
Instead of getDatasetTemplates(), can we change it to getTemplatesByCollectionId()? That way it is more clear what is being returned.

ekraffmiller · 2026-01-09T20:35:38Z

src/templates/domain/useCases/CreateTemplate.ts

-   * Creates a Dataset Template in the specified collection.
+   * Creates a template in the specified collection.
   *
   * @param {CreateDatasetTemplateDTO} template - Template definition payload.


Suggested change

* @param {CreateDatasetTemplateDTO} template - Template definition payload.

* @param {CreateTemplateDTO} template - Template definition payload.

src/templates/domain/dtos/CreateTemplateDTO.ts

ekraffmiller

Hi @ChengShi-1 , thanks for the updates, I have a couple more comments, let me know what you think :)

ekraffmiller · 2026-01-13T13:13:33Z

src/templates/domain/repositories/ITemplatesRepository.ts

+import { Template } from '../models/Template'
+
+export interface ITemplatesRepository {
+  createDatasetTemplate(


I think this suggested change from createDatasetTemplate() to createTemplate() makes sense, given that the object is a Template, and now that the other method has changed to getTemplatesByCollectionId(). What do you think?

ekraffmiller · 2026-01-13T13:14:17Z

docs/useCases.md

+- [Templates](#Templates)
+  - [Templates read use cases](#templates-read-use-cases)
+    - [Get a Template](#get-a-template)
+    - [Get Dataset Templates](#get-dataset-templates)


Need to update the useCase docs with the new function name

…sByCollectionId

ChengShi-1 · 2026-01-13T15:10:40Z

@ekraffmiller thanks for the suggestions, it makes sense to change to CreateTemplate, I’ve just updated it

ekraffmiller

looks good! approved

feat: restructure template

243eda1

ChengShi-1 linked an issue Jan 7, 2026 that may be closed by this pull request

Use Cases of GET and DELETE a template #398

Closed

ChengShi-1 added 3 commits January 7, 2026 16:37

feat: get and delete a single template by id

778f30c

chore: sync the naming to template fron DatasetTemplate

0d51b50

chore: a lint fix

0f7eab0

ChengShi-1 marked this pull request as ready for review January 8, 2026 00:18

Copilot AI review requested due to automatic review settings January 8, 2026 00:18

ChengShi-1 added this to IQSS Dataverse Project Jan 8, 2026

ChengShi-1 moved this to Ready for Review ⏩ in IQSS Dataverse Project Jan 8, 2026

Copilot started reviewing on behalf of ChengShi-1 January 8, 2026 00:19 View session

ChengShi-1 added Size: 10 A percentage of a sprint. 7 hours. Original size: 10 labels Jan 8, 2026

ChengShi-1 changed the title ~~Use Cases of Add and Delete a template~~ Use Cases of Get and Delete a template Jan 8, 2026

Copilot AI reviewed Jan 8, 2026

View reviewed changes

IQSS deleted a comment from Copilot AI Jan 8, 2026

ChengShi-1 mentioned this pull request Jan 8, 2026

GET and DELETE a template Use Case and Restructure IQSS/dataverse-frontend#905

Open

ekraffmiller self-assigned this Jan 9, 2026

ekraffmiller moved this from Ready for Review ⏩ to In Review 🔎 in IQSS Dataverse Project Jan 9, 2026

ekraffmiller reviewed Jan 12, 2026

View reviewed changes

Naming Convention update

5b57f4c

ChengShi-1 self-assigned this Jan 12, 2026

ekraffmiller reviewed Jan 13, 2026

View reviewed changes

ekraffmiller removed their assignment Jan 13, 2026

rename createDatasetTemplate to createTemplate, and clean GetTemplate…

cbbff32

…sByCollectionId

chore: use case clean

31ac368

ChengShi-1 assigned ekraffmiller Jan 13, 2026

ekraffmiller approved these changes Jan 13, 2026

View reviewed changes

github-project-automation bot moved this from In Review 🔎 to Ready for QA ⏩ in IQSS Dataverse Project Jan 13, 2026

ekraffmiller unassigned ekraffmiller and ChengShi-1 Jan 13, 2026

jp-tosca self-assigned this Jan 15, 2026

jp-tosca moved this from Ready for QA ⏩ to QA ✅ in IQSS Dataverse Project Jan 15, 2026

Merge Conflict

355ac27

jp-tosca merged commit 9c7e9d8 into develop Jan 15, 2026
5 checks passed

github-project-automation bot moved this from QA ✅ to Merged 🚀 in IQSS Dataverse Project Jan 15, 2026

jp-tosca removed their assignment Jan 15, 2026

cmbz moved this from Merged 🚀 to Done 🧹 in IQSS Dataverse Project Jan 15, 2026

cmbz mentioned this pull request Feb 4, 2026

Epic: GREI - Dataverse Rearchitecture IQSS/dataverse-pm#123

Open

	* @param {CreateDatasetTemplateDTO} template - Template definition payload.
	* @param {CreateTemplateDTO} template - Template definition payload.

Conversation

ChengShi-1 commented Jan 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What this PR does / why we need it:

Which issue(s) this PR closes:

Related Dataverse PRs:

Special notes for your reviewer:

Suggestions on how to test this:

Is there a release notes or changelog update needed for this change?:

Additional documentation:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Jan 8, 2026

Choose a reason for hiding this comment

Uh oh!

ekraffmiller Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ekraffmiller left a comment

Choose a reason for hiding this comment

Uh oh!

ekraffmiller Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

ekraffmiller Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ekraffmiller left a comment

Choose a reason for hiding this comment

Uh oh!

ekraffmiller Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ekraffmiller Jan 13, 2026

Choose a reason for hiding this comment

Uh oh!

ChengShi-1 commented Jan 13, 2026

Uh oh!

ekraffmiller left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ChengShi-1 commented Jan 7, 2026 •

edited

Loading

ekraffmiller Jan 13, 2026 •

edited

Loading

ekraffmiller Jan 13, 2026 •

edited

Loading