Use Cases of Get and Delete a template #406
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
FY26 Sprint 12
ChengShi-1
changed the title
Contributor
There was a problem hiding this comment.
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.
ekraffmiller
moved this from Ready for Review ⏩
to In Review 🔎
in IQSS Dataverse Project
Contributor
ekraffmiller
left a comment
ekraffmiller
left a comment
There was a problem hiding this comment.
Looks good! I just have some suggestions about the naming conventions
| template: CreateDatasetTemplateDTO | ||
| ): Promise<void> | ||
| getTemplate(templateId: number): Promise<Template> | ||
| getDatasetTemplates(collectionIdOrAlias: number | string): Promise<Template[]> |
Contributor
There was a problem hiding this comment.
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.
| * Creates a Dataset Template in the specified collection. | ||
| * Creates a template in the specified collection. | ||
| * | ||
| * @param {CreateDatasetTemplateDTO} template - Template definition payload. |
Contributor
There was a problem hiding this comment.
Suggested change
| * @param {CreateDatasetTemplateDTO} template - Template definition payload. | |
| * @param {CreateTemplateDTO} template - Template definition payload. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
Which issue(s) this PR closes:
Related Dataverse PRs:
Special notes for your reviewer:
Templateinstead ofDataset Template, besidesgetDatasetTemplatesuse caseSuggestions on how to test this:
Is there a release notes or changelog update needed for this change?:
YES
Additional documentation: