feat(getCollection use case): add global constant ROOT_COLLECTION_ALIAS

Author: MellyGray

src/collections/domain/models/Collection.ts

@@ -7,3 +7,5 @@ export interface Collection {
   description?: string
   isPartOf: DvObjectOwnerNode
 }
+
+export const ROOT_COLLECTION_ALIAS = 'root'

src/collections/domain/useCases/GetCollection.ts

@@ -1,6 +1,6 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
-import { Collection } from '../models/Collection'
+import { Collection, ROOT_COLLECTION_ALIAS } from '../models/Collection'
 
 export class GetCollection implements UseCase<Collection> {
   private collectionsRepository: ICollectionsRepository
@@ -16,7 +16,7 @@ export class GetCollection implements UseCase<Collection> {
    * If this parameter is not set, the default value is: 'root'
    * @returns {Promise<Collection>}
    */
-  async execute(collectionIdOrAlias: number | string = 'root'): Promise<Collection> {
+  async execute(collectionIdOrAlias: number | string = ROOT_COLLECTION_ALIAS): Promise<Collection> {
     return await this.collectionsRepository.getCollection(collectionIdOrAlias)
   }
 }

src/collections/infra/repositories/CollectionsRepository.ts

@@ -1,12 +1,14 @@
 import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
 import { ICollectionsRepository } from '../../domain/repositories/ICollectionsRepository'
 import { transformCollectionResponseToCollection } from './transformers/collectionTransformers'
-import { Collection } from '../../domain/models/Collection'
+import { Collection, ROOT_COLLECTION_ALIAS } from '../../domain/models/Collection'
 export class CollectionsRepository extends ApiRepository implements ICollectionsRepository {
   private readonly collectionsResourceName: string = 'dataverses'
   private readonly collectionsDefaultOperationType: string = 'get'
 
-  public async getCollection(collectionIdOrAlias: number | string = 'root'): Promise<Collection> {
+  public async getCollection(
+    collectionIdOrAlias: number | string = ROOT_COLLECTION_ALIAS
+  ): Promise<Collection> {
     return this.doGet(
       this.buildApiEndpoint(
         this.collectionsResourceName,

src/datasets/domain/useCases/CreateDataset.ts

@@ -5,6 +5,7 @@ import { NewResourceValidator } from '../../../core/domain/useCases/validators/N
 import { IMetadataBlocksRepository } from '../../../metadataBlocks/domain/repositories/IMetadataBlocksRepository'
 import { MetadataBlock } from '../../../metadataBlocks'
 import { CreatedDatasetIdentifiers } from '../models/CreatedDatasetIdentifiers'
+import { ROOT_COLLECTION_ALIAS } from '../../../collections/domain/models/Collection'
 
 export class CreateDataset implements UseCase<CreatedDatasetIdentifiers> {
   private datasetsRepository: IDatasetsRepository
@@ -33,7 +34,7 @@ export class CreateDataset implements UseCase<CreatedDatasetIdentifiers> {
    */
   async execute(
     newDataset: NewDatasetDTO,
-    collectionId = 'root'
+    collectionId = ROOT_COLLECTION_ALIAS
   ): Promise<CreatedDatasetIdentifiers> {
     const metadataBlocks = await this.getNewDatasetMetadataBlocks(newDataset)
 

test/environment/setup.ts

@@ -6,6 +6,7 @@ import datasetJson1 from '../testHelpers/datasets/test-dataset-1.json'
 import datasetJson2 from '../testHelpers/datasets/test-dataset-2.json'
 import datasetJson3 from '../testHelpers/datasets/test-dataset-3.json'
 import collectionJson from '../testHelpers/collections/test-collection-1.json'
+import { ROOT_COLLECTION_ALIAS } from '../../src/collections/domain/models/Collection'
 
 const COMPOSE_FILE = 'docker-compose.yml'
 
@@ -86,7 +87,10 @@ async function createCollectionViaApi(collectionJson: any): Promise<any> {
 }
 
 /* eslint-disable @typescript-eslint/no-explicit-any */
-async function createDatasetViaApi(datasetJson: any, collectionId = 'root'): Promise<any> {
+async function createDatasetViaApi(
+  datasetJson: any,
+  collectionId = ROOT_COLLECTION_ALIAS
+): Promise<any> {
   return await axios.post(
     `${TestConstants.TEST_API_URL}/dataverses/${collectionId}/datasets`,
     datasetJson,

test/integration/datasets/DatasetsRepository.test.ts

@@ -20,6 +20,7 @@ import {
   DatasetContact,
   DatasetDescription
 } from '../../../src/datasets/domain/models/Dataset'
+import { ROOT_COLLECTION_ALIAS } from '../../../src/collections/domain/models/Collection'
 
 describe('DatasetsRepository', () => {
   const sut: DatasetsRepository = new DatasetsRepository()
@@ -336,7 +337,7 @@ describe('DatasetsRepository', () => {
       const createdDataset = await sut.createDataset(
         testNewDataset,
         [citationMetadataBlock],
-        'root'
+        ROOT_COLLECTION_ALIAS
       )
       const actualCreatedDataset = await sut.getDataset(
         createdDataset.numericId,

test/testHelpers/TestConstants.ts

@@ -1,3 +1,5 @@
+import { ROOT_COLLECTION_ALIAS } from '../../src/collections/domain/models/Collection'
+
 export class TestConstants {
   static readonly TEST_API_URL = 'http://localhost:8080/api/v1'
   static readonly TEST_DUMMY_API_KEY = 'dummyApiKey'
@@ -50,5 +52,5 @@ export class TestConstants {
   static readonly TEST_DUMMY_COLLECTION_ALIAS = 'dummyCollectionId'
   static readonly TEST_CREATED_COLLECTION_1_ID = 4
   static readonly TEST_CREATED_COLLECTION_1_ALIAS = 'firstCollection'
-  static readonly TEST_CREATED_COLLECTION_1_ROOT = 'root'
+  static readonly TEST_CREATED_COLLECTION_1_ROOT = ROOT_COLLECTION_ALIAS
 }

test/unit/datasets/CreateDataset.test.ts

@@ -9,6 +9,7 @@ import {
 import { ResourceValidationError } from '../../../src/core/domain/useCases/validators/errors/ResourceValidationError'
 import { WriteError, ReadError } from '../../../src'
 import { IMetadataBlocksRepository } from '../../../src/metadataBlocks/domain/repositories/IMetadataBlocksRepository'
+import { ROOT_COLLECTION_ALIAS } from '../../../src/collections/domain/models/Collection'
 
 describe('execute', () => {
   const testDataset = createNewDatasetDTO()
@@ -50,7 +51,7 @@ describe('execute', () => {
     expect(datasetsRepositoryStub.createDataset).toHaveBeenCalledWith(
       testDataset,
       testMetadataBlocks,
-      'root'
+      ROOT_COLLECTION_ALIAS
     )
   })
 
@@ -110,7 +111,7 @@ describe('execute', () => {
     expect(datasetsRepositoryStub.createDataset).toHaveBeenCalledWith(
       testDataset,
       testMetadataBlocks,
-      'root'
+      ROOT_COLLECTION_ALIAS
     )
   })