changed Collection attributes and renamed collection identifier

Author: Matt Mangan

docs/useCases.md

@@ -60,7 +60,7 @@ import { getCollection } from '@iqss/dataverse-client-javascript'
 
 /* ... */
 // Case 1: Fetch Collection by its numerical ID
-const collectionObjectParameter = 12345
+const collectionIdOrAlias = 12345
 
 getCollection
   .execute(collectionId)
@@ -74,7 +74,7 @@ getCollection
 /* ... */
 
 // Case 2: Fetch Collection by its alias
-const collectionObjectParameter = 'classicLiterature'
+const collectionIdOrAlias = 'classicLiterature'
 getCollection
   .execute(collectionAlias)
   .then((collection: Collection) => {
@@ -89,7 +89,7 @@ getCollection
 
 _See [use case](../src/collections/domain/useCases/GetCollection.ts)_ definition.
 
-The `collectionObjectParameter` is a generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId).
+The `collectionIdOrAlias` is a generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId).
 
 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.
 

src/collections/domain/models/Collection.ts

@@ -3,7 +3,7 @@ export interface Collection {
   id: number
   alias: string
   name: string
-  affiliation: string
-  description: string
+  affiliation?: string
+  description?: string
   isPartOf: DvObjectOwnerNode
 }

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -1,4 +1,4 @@
 import { Collection } from '../models/Collection'
 export interface ICollectionsRepository {
-  getCollection(collectionObjectParameter: number | string): Promise<Collection>
+  getCollection(collectionIdOrAlias: number | string): Promise<Collection>
 }

src/collections/domain/useCases/GetCollection.ts

@@ -12,11 +12,11 @@ export class GetCollection implements UseCase<Collection> {
   /**
    * Returns a Collection instance, given the search parameters to identify it.
    *
-   * @param {number | string} [collectionObjectParameter = 'root'] - A generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId)
+   * @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<Collection>}
    */
-  async execute(collectionObjectParameter: number | string = 'root'): Promise<Collection> {
-    return await this.collectionsRepository.getCollection(collectionObjectParameter)
+  async execute(collectionIdOrAlias: number | string = 'root'): Promise<Collection> {
+    return await this.collectionsRepository.getCollection(collectionIdOrAlias)
   }
 }

src/collections/infra/repositories/CollectionsRepository.ts

@@ -6,14 +6,12 @@ export class CollectionsRepository extends ApiRepository implements ICollections
   private readonly collectionsResourceName: string = 'dataverses'
   private readonly collectionsDefaultOperationType: string = 'get'
 
-  public async getCollection(
-    collectionObjectParameter: number | string = 'root'
-  ): Promise<Collection> {
+  public async getCollection(collectionIdOrAlias: number | string = 'root'): Promise<Collection> {
     return this.doGet(
       this.buildApiEndpoint(
         this.collectionsResourceName,
         this.collectionsDefaultOperationType,
-        collectionObjectParameter
+        collectionIdOrAlias
       ),
       true,
       { returnOwners: true }

src/collections/infra/repositories/transformers/CollectionPayload.ts

@@ -3,7 +3,7 @@ export interface CollectionPayload {
   id: number
   alias: string
   name: string
-  affiliation: string
-  description: string
+  affiliation?: string
+  description?: string
   isPartOf: OwnerNodePayload
 }

test/unit/collections/CollectionsRepository.test.ts

@@ -42,14 +42,10 @@ describe('CollectionsRepository', () => {
         const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/dataverses/${testCollectionModel.id}`
 
         // API Key auth
-        let actual = await sut.getCollection(testCollectionModel.id)
+        const actual = await sut.getCollection(testCollectionModel.id)
 
         expect(axios.get).toHaveBeenCalledWith(expectedApiEndpoint, expectedRequestConfigApiKey)
         expect(actual).toStrictEqual(testCollectionModel)
-
-        actual = await sut.getCollection(testCollectionModel.id)
-        expect(axios.get).toHaveBeenCalledWith(expectedApiEndpoint, expectedRequestConfigApiKey)
-        expect(actual).toStrictEqual(testCollectionModel)
       })
 
       test('should return error on repository read error', async () => {
@@ -69,12 +65,8 @@ describe('CollectionsRepository', () => {
         const expectedApiEndpoint = `${TestConstants.TEST_API_URL}/dataverses/${testCollectionModel.alias}`
 
         // API Key auth
-        let actual = await sut.getCollection(testCollectionModel.alias)
-
-        expect(axios.get).toHaveBeenCalledWith(expectedApiEndpoint, expectedRequestConfigApiKey)
-        expect(actual).toStrictEqual(testCollectionModel)
+        const actual = await sut.getCollection(testCollectionModel.alias)
 
-        actual = await sut.getCollection(testCollectionModel.alias)
         expect(axios.get).toHaveBeenCalledWith(expectedApiEndpoint, expectedRequestConfigApiKey)
         expect(actual).toStrictEqual(testCollectionModel)
       })