refactor: move use case to datasets repository

Author: g-saracca

docs/useCases.md

@@ -16,7 +16,6 @@ The different use cases currently available in the package are classified below,
     - [List All Collection Items](#list-all-collection-items)
     - [List My Data Collection Items](#list-my-data-collection-items)
     - [Get Collection Featured Items](#get-collection-featured-items)
-    - [Get Collection Dataset Templates](#get-collection-dataset-templates)
   - [Collections write use cases](#collections-write-use-cases)
     - [Create a Collection](#create-a-collection)
     - [Update a Collection](#update-a-collection)
@@ -39,6 +38,7 @@ The different use cases currently available in the package are classified below,
     - [Get Dataset Versions Summaries](#get-dataset-versions-summaries)
     - [Get Dataset Linked Collections](#get-dataset-linked-collections)
     - [Get Dataset Available Categories](#get-dataset-available-categories)
+    - [Get Dataset Templates](#get-dataset-templates)
   - [Datasets write use cases](#datasets-write-use-cases)
     - [Create a Dataset](#create-a-dataset)
     - [Update a Dataset](#update-a-dataset)
@@ -322,26 +322,6 @@ The `collectionIdOrAlias` is a generic collection identifier, which can be eithe
 
 If no collection identifier is specified, the default collection identifier; `:root` will be used. If you want to search for a different collection, you must add the collection identifier as a parameter in the use case call.
 
-#### Get Collection Dataset Templates
-
-Returns a [CollectionDatasetTemplate](../src/collections/domain/models/CollectionDatasetTemplate.ts) array containing the dataset templates of the requested collection, given the collection identifier or alias.
-
-##### Example call:
-
-```typescript
-import { getCollectionDatasetTemplates } from '@iqss/dataverse-client-javascript'
-
-const collectionIdOrAlias = 12345
-
-getCollectionDatasetTemplates
-  .execute(collectionIdOrAlias)
-  .then((datasetTemplates: CollectionDatasetTemplate[]) => {
-    /* ... */
-  })
-```
-
-_See [use case](../src/collections/domain/useCases/GetCollectionDatasetTemplates.ts)_ definition.
-
 ### Collections Write Use Cases
 
 #### Create a Collection
@@ -1131,6 +1111,24 @@ _See [use case](../src/datasets/domain/useCases/GetDatasetAvailableCategories.ts
 
 The `datasetId` parameter is a number for numeric identifiers or string for persistent identifiers.
 
+#### Get Dataset Templates
+
+Returns a [DatasetTemplate](../src/datasets/domain/models/DatasetTemplate.ts) array containing the dataset templates of the requested collection, given the collection identifier or alias.
+
+##### Example call:
+
+```typescript
+import { getDatasetTemplates } from '@iqss/dataverse-client-javascript'
+
+const collectionIdOrAlias = 12345
+
+getDatasetTemplates.execute(collectionIdOrAlias).then((datasetTemplates: DatasetTemplate[]) => {
+  /* ... */
+})
+```
+
+_See [use case](../src/datasets/domain/useCases/GetDatasetTemplates.ts)_ definition.
+
 ## Files
 
 ### Files read use cases

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -10,7 +10,6 @@ import { CollectionUserPermissions } from '../models/CollectionUserPermissions'
 import { PublicationStatus } from '../../../core/domain/models/PublicationStatus'
 import { CollectionItemType } from '../../../collections/domain/models/CollectionItemType'
 import { CollectionLinks } from '../models/CollectionLinks'
-import { CollectionDatasetTemplate } from '../models/CollectionDatasetTemplate'
 
 export interface ICollectionsRepository {
   getCollection(collectionIdOrAlias: number | string): Promise<Collection>
@@ -61,7 +60,4 @@ export interface ICollectionsRepository {
     linkingCollectionIdOrAlias: number | string
   ): Promise<void>
   getCollectionLinks(collectionIdOrAlias: number | string): Promise<CollectionLinks>
-  getCollectionDatasetTemplates(
-    collectionIdOrAlias: number | string
-  ): Promise<CollectionDatasetTemplate[]>
 }

src/collections/domain/useCases/GetCollectionDatasetTemplates.ts

@@ -15,7 +15,6 @@ import { DeleteCollectionFeaturedItem } from './domain/useCases/DeleteCollection
 import { LinkCollection } from './domain/useCases/LinkCollection'
 import { UnlinkCollection } from './domain/useCases/UnlinkCollection'
 import { GetCollectionLinks } from './domain/useCases/GetCollectionLinks'
-import { GetCollectionDatasetTemplates } from './domain/useCases/GetCollectionDatasetTemplates'
 
 const collectionsRepository = new CollectionsRepository()
 
@@ -35,7 +34,6 @@ const deleteCollectionFeaturedItem = new DeleteCollectionFeaturedItem(collection
 const linkCollection = new LinkCollection(collectionsRepository)
 const unlinkCollection = new UnlinkCollection(collectionsRepository)
 const getCollectionLinks = new GetCollectionLinks(collectionsRepository)
-const getCollectionDatasetTemplates = new GetCollectionDatasetTemplates(collectionsRepository)
 
 export {
   getCollection,
@@ -53,8 +51,7 @@ export {
   deleteCollectionFeaturedItem,
   linkCollection,
   unlinkCollection,
-  getCollectionLinks,
-  getCollectionDatasetTemplates
+  getCollectionLinks
 }
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
 export { CollectionFacet } from './domain/models/CollectionFacet'

src/collections/index.ts

@@ -1,4 +1,3 @@
-import { AxiosResponse } from 'axios'
 import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { ICollectionsRepository } from '../../domain/repositories/ICollectionsRepository'
 import {
@@ -39,9 +38,6 @@ import { ApiConstants } from '../../../core/infra/repositories/ApiConstants'
 import { PublicationStatus } from '../../../core/domain/models/PublicationStatus'
 import { ReadError } from '../../../core/domain/repositories/ReadError'
 import { CollectionLinks } from '../../domain/models/CollectionLinks'
-import { CollectionDatasetTemplatePayload } from './transformers/CollectionDatasetTemplatePayload'
-import { transformCollectionDatasetTemplatePayloadToCollectionDatasetTemplate } from './transformers/collectionDatasetTemplateTransformer'
-import { CollectionDatasetTemplate } from '../../domain/models/CollectionDatasetTemplate'
 
 export interface NewCollectionRequestPayload {
   alias: string
@@ -492,16 +488,4 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
-
-  public async getCollectionDatasetTemplates(
-    collectionIdOrAlias: number | string
-  ): Promise<CollectionDatasetTemplate[]> {
-    return this.doGet(`/${this.collectionsResourceName}/${collectionIdOrAlias}/templates`, true)
-      .then((response: AxiosResponse<{ data: CollectionDatasetTemplatePayload[] }>) =>
-        transformCollectionDatasetTemplatePayloadToCollectionDatasetTemplate(response.data.data)
-      )
-      .catch((error) => {
-        throw error
-      })
-  }
 }

src/collections/infra/repositories/CollectionsRepository.ts

@@ -1,6 +1,6 @@
-import { DatasetLicense, DatasetMetadataFieldValue, TermsOfUse } from '../../../datasets'
+import { DatasetLicense, DatasetMetadataFieldValue, TermsOfUse } from './Dataset'
 
-export interface CollectionDatasetTemplate {
+export interface DatasetTemplate {
   id: number
   name: string
   alias: string

…main/models/CollectionDatasetTemplate.ts …atasets/domain/models/DatasetTemplate.tssrc/collections/domain/models/CollectionDatasetTemplate.ts renamed to src/datasets/domain/models/DatasetTemplate.ts src/collections/domain/models/CollectionDatasetTemplate.ts renamed to src/datasets/domain/models/DatasetTemplate.ts

@@ -12,6 +12,7 @@ import { DatasetVersionSummaryInfo } from '../models/DatasetVersionSummaryInfo'
 import { DatasetLinkedCollection } from '../models/DatasetLinkedCollection'
 import { CitationFormat } from '../models/CitationFormat'
 import { FormattedCitation } from '../models/FormattedCitation'
+import { DatasetTemplate } from '../models/DatasetTemplate'
 
 export interface IDatasetsRepository {
   getDataset(
@@ -74,4 +75,5 @@ export interface IDatasetsRepository {
     format: CitationFormat,
     includeDeaccessioned?: boolean
   ): Promise<FormattedCitation>
+  getDatasetTemplates(collectionIdOrAlias: number | string): Promise<DatasetTemplate[]>
 }

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -0,0 +1,25 @@
+import { ROOT_COLLECTION_ID } from '../../../collections/domain/models/Collection'
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { DatasetTemplate } from '../models/DatasetTemplate'
+import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
+
+export class GetDatasetTemplates implements UseCase<DatasetTemplate[]> {
+  private datasetsRepository: IDatasetsRepository
+
+  constructor(datasetsRepository: IDatasetsRepository) {
+    this.datasetsRepository = datasetsRepository
+  }
+
+  /**
+   * Returns a DatasetTemplate array containing the dataset templates of the requested collection, given the collection identifier 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<DatasetTemplate[]>}
+   */
+  async execute(
+    collectionIdOrAlias: number | string = ROOT_COLLECTION_ID
+  ): Promise<DatasetTemplate[]> {
+    return await this.datasetsRepository.getDatasetTemplates(collectionIdOrAlias)
+  }
+}

src/datasets/domain/useCases/GetDatasetTemplates.ts

@@ -25,6 +25,7 @@ import { UnlinkDataset } from './domain/useCases/UnlinkDataset'
 import { GetDatasetLinkedCollections } from './domain/useCases/GetDatasetLinkedCollections'
 import { GetDatasetAvailableCategories } from './domain/useCases/GetDatasetAvailableCategories'
 import { GetDatasetCitationInOtherFormats } from './domain/useCases/GetDatasetCitationInOtherFormats'
+import { GetDatasetTemplates } from './domain/useCases/GetDatasetTemplates'
 
 const datasetsRepository = new DatasetsRepository()
 
@@ -64,6 +65,7 @@ const unlinkDataset = new UnlinkDataset(datasetsRepository)
 const getDatasetLinkedCollections = new GetDatasetLinkedCollections(datasetsRepository)
 const getDatasetAvailableCategories = new GetDatasetAvailableCategories(datasetsRepository)
 const getDatasetCitationInOtherFormats = new GetDatasetCitationInOtherFormats(datasetsRepository)
+const getDatasetTemplates = new GetDatasetTemplates(datasetsRepository)
 
 export {
   getDataset,
@@ -86,7 +88,8 @@ export {
   unlinkDataset,
   getDatasetLinkedCollections,
   getDatasetAvailableCategories,
-  getDatasetCitationInOtherFormats
+  getDatasetCitationInOtherFormats,
+  getDatasetTemplates
 }
 export { DatasetNotNumberedVersion } from './domain/models/DatasetNotNumberedVersion'
 export { DatasetUserPermissions } from './domain/models/DatasetUserPermissions'

src/datasets/index.ts

@@ -1,3 +1,4 @@
+import { AxiosResponse } from 'axios'
 import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { IDatasetsRepository } from '../../domain/repositories/IDatasetsRepository'
 import { Dataset, VersionUpdateType } from '../../domain/models/Dataset'
@@ -24,6 +25,9 @@ import { DatasetLinkedCollection } from '../../domain/models/DatasetLinkedCollec
 import { CitationFormat } from '../../domain/models/CitationFormat'
 import { transformDatasetLinkedCollectionsResponseToDatasetLinkedCollection } from './transformers/datasetLinkedCollectionsTransformers'
 import { FormattedCitation } from '../../domain/models/FormattedCitation'
+import { DatasetTemplate } from '../../domain/models/DatasetTemplate'
+import { DatasetTemplatePayload } from './transformers/DatasetTemplatePayload'
+import { transformDatasetTemplatePayloadToDatasetTemplate } from './transformers/datasetTemplateTransformers'
 
 export interface GetAllDatasetPreviewsQueryParams {
   per_page?: number
@@ -357,4 +361,16 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
         throw error
       })
   }
+
+  public async getDatasetTemplates(
+    collectionIdOrAlias: number | string
+  ): Promise<DatasetTemplate[]> {
+    return this.doGet(`/dataverses/${collectionIdOrAlias}/templates`, true)
+      .then((response: AxiosResponse<{ data: DatasetTemplatePayload[] }>) =>
+        transformDatasetTemplatePayloadToDatasetTemplate(response.data.data)
+      )
+      .catch((error) => {
+        throw error
+      })
+  }
 }