Add Publish Collection use case and functional test

Author: ekraffmiller

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -9,6 +9,7 @@ export interface ICollectionsRepository {
     parentCollectionId: number | string
   ): Promise<number>
   getCollectionFacets(collectionIdOrAlias: number | string): Promise<string[]>
+  publishCollection(collectionId: number | string): Promise<void>
   getCollectionUserPermissions(
     collectionIdOrAlias: number | string
   ): Promise<CollectionUserPermissions>

src/collections/domain/useCases/PublishCollection.ts

@@ -0,0 +1,20 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { ICollectionsRepository } from '../repositories/ICollectionsRepository' // Assuming Axios for HTTP requests
+
+export class PublishCollection implements UseCase<void> {
+  private collectionsRepository: ICollectionsRepository
+
+  constructor(collectionsRepository: ICollectionsRepository) {
+    this.collectionsRepository = collectionsRepository
+  }
+
+  /**
+   * Publishes a collection, given its identifier and the type of version update type.
+   *
+   * @param {number | string} [collectionId] - The collection identifier, which can be a string (for collection alias), or a number (for numeric identifiers).
+   * @returns {Promise<void>} - This method does not return anything upon successful completion.
+   */
+  async execute(collectionId: number | string): Promise<void> {
+    return await this.collectionsRepository.publishCollection(collectionId)
+  }
+}

src/collections/index.ts

@@ -4,15 +4,23 @@ import { GetCollectionFacets } from './domain/useCases/GetCollectionFacets'
 import { GetCollectionUserPermissions } from './domain/useCases/GetCollectionUserPermissions'
 
 import { CollectionsRepository } from './infra/repositories/CollectionsRepository'
+import { PublishCollection } from './domain/useCases/PublishCollection'
 
 const collectionsRepository = new CollectionsRepository()
 
 const getCollection = new GetCollection(collectionsRepository)
 const createCollection = new CreateCollection(collectionsRepository)
 const getCollectionFacets = new GetCollectionFacets(collectionsRepository)
 const getCollectionUserPermissions = new GetCollectionUserPermissions(collectionsRepository)
+const publishCollection = new PublishCollection(collectionsRepository)
 
-export { getCollection, createCollection, getCollectionFacets, getCollectionUserPermissions }
+export {
+  getCollection,
+  createCollection,
+  getCollectionFacets,
+  getCollectionUserPermissions,
+  publishCollection
+}
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
 export { CollectionUserPermissions } from './domain/models/CollectionUserPermissions'
 export { CollectionDTO, CollectionInputLevelDTO } from './domain/dtos/CollectionDTO'

src/collections/infra/repositories/CollectionsRepository.ts

@@ -88,6 +88,16 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
+  public async publishCollection(collectionId: string | number): Promise<void> {
+    return this.doPost(
+      this.buildApiEndpoint(this.collectionsResourceName, `actions/:publish`, collectionId),
+      {}
+    )
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
+  }
 
   public async getCollectionUserPermissions(
     collectionIdOrAlias: number | string

test/functional/datasets/PublishCollection.test.ts

@@ -0,0 +1,39 @@
+import { ApiConfig, createCollection, publishCollection, WriteError } from '../../../src'
+import { TestConstants } from '../../testHelpers/TestConstants'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+import {
+  createCollectionDTO,
+  deleteCollectionViaApi
+} from '../../testHelpers/collections/collectionHelper'
+
+const testNewCollection = createCollectionDTO('test-publish-collection')
+
+describe('execute', () => {
+  beforeEach(async () => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+  })
+
+  test('should successfully publish a collection', async () => {
+    const createdCollectiontIdentifier = await createCollection.execute(testNewCollection)
+
+    const response = await publishCollection.execute(createdCollectiontIdentifier)
+
+    expect(response).toBeUndefined()
+    await deleteCollectionViaApi(testNewCollection.alias)
+  })
+
+  test('should throw an error when trying to publish a collection that does not exist', async () => {
+    const nonExistentTestCollectionId = 4567
+    const expectedError = new WriteError(
+      `[404] Can't find dataverse with identifier='${nonExistentTestCollectionId}'`
+    )
+
+    await expect(publishCollection.execute(nonExistentTestCollectionId)).rejects.toThrow(
+      expectedError
+    )
+  })
+})