use CollectionItemSubset.ts as return type

Author: ekraffmiller

docs/useCases.md

@@ -14,6 +14,7 @@ The different use cases currently available in the package are classified below,
     - [Get Collection Facets](#get-collection-facets)
     - [Get User Permissions on a Collection](#get-user-permissions-on-a-collection)
     - [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)
   - [Collections write use cases](#collections-write-use-cases)
     - [Create a Collection](#create-a-collection)
@@ -217,7 +218,7 @@ This use case supports the following optional parameters depending on the search
 
 #### List My Data Collection Items
 
-Returns an instance of [MyDataCollectionItemSubset](../src/collections/domain/models/CollectionItemSubset.ts) that contains reduced information for each collection item for which the calling user has a role.
+Returns an instance of [CollectionItemSubset](../src/collections/domain/models/CollectionItemSubset.ts) that contains reduced information for each collection item for which the calling user has a role.
 
 ##### Example call:
 
@@ -248,7 +249,7 @@ getMyDataCollectionItems
     searchText,
     otherUserName
   )
-  .then((subset: MyDataCollectionItemSubset) => {
+  .then((subset: CollectionItemSubset) => {
     /* ... */
   })
 
@@ -271,8 +272,8 @@ The `MyDataCollectionItemSubset`returned instance contains a property called `to
 
 This use case supports the following optional parameters depending on the search goals:
 
-- **limit**: (number) Limit for pagination.
-- **offset**: (number) Offset for pagination.
+- **limit**: (number) Limit of items per page for pagination. (default is 10)
+- **selectedPage**: (number) the page of results to be returned. (default is 1)
 
 #### Get Collection Featured Items
 

src/collections/domain/models/CollectionItemSubset.ts

@@ -8,12 +8,6 @@ export interface CollectionItemSubset {
   totalItemCount: number
   countPerObjectType: CountPerObjectType
 }
-export interface MyDataCollectionItemSubset {
-  items: (CollectionPreview | DatasetPreview | FilePreview)[]
-  publishingFacet: CollectionItemsFacetLabel[]
-  totalItemCount: number
-  countPerObjectType: CountPerObjectType
-}
 
 export interface CollectionItemsFacet {
   name: string

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -3,7 +3,7 @@ import { CollectionFeaturedItemsDTO } from '../dtos/CollectionFeaturedItemsDTO'
 import { Collection } from '../models/Collection'
 import { CollectionFacet } from '../models/CollectionFacet'
 import { CollectionFeaturedItem } from '../models/CollectionFeaturedItem'
-import { CollectionItemSubset, MyDataCollectionItemSubset } from '../models/CollectionItemSubset'
+import { CollectionItemSubset } from '../models/CollectionItemSubset'
 import { CollectionSearchCriteria } from '../models/CollectionSearchCriteria'
 import { CollectionUserPermissions } from '../models/CollectionUserPermissions'
 import { PublicationStatus } from '../../../../src/core/domain/models/PublicationStatus'
@@ -35,7 +35,7 @@ export interface ICollectionsRepository {
     selectedPage?: number,
     searchText?: string,
     otherUserName?: string
-  ): Promise<MyDataCollectionItemSubset>
+  ): Promise<CollectionItemSubset>
   updateCollection(
     collectionIdOrAlias: number | string,
     updatedCollection: CollectionDTO

src/collections/domain/useCases/GetMyDataCollectionItems.ts

@@ -1,10 +1,10 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
-import { MyDataCollectionItemSubset } from '../models/CollectionItemSubset'
+import { CollectionItemSubset } from '../models/CollectionItemSubset'
 import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
 import { CollectionItemType } from '../../../../src/collections/domain/models/CollectionItemType'
 import { PublicationStatus } from '../../../../src/core/domain/models/PublicationStatus'
 
-export class GetMyDataCollectionItems implements UseCase<MyDataCollectionItemSubset> {
+export class GetMyDataCollectionItems implements UseCase<CollectionItemSubset> {
   private collectionsRepository: ICollectionsRepository
 
   constructor(collectionsRepository: ICollectionsRepository) {
@@ -18,7 +18,7 @@ export class GetMyDataCollectionItems implements UseCase<MyDataCollectionItemSub
    * @param {CollectionItemType[]} [collectionItemTypes] - the types of items to filter by.
    * @param {PublicationStatus[]} [publicationStatuses] - the publication statuses to filter by.
    * @param {number} [limit] - Limit number of items to return for pagination (optional).
-   * @param {number} [offset] - Offset (starting point) for pagination (optional).
+   * @param {number} [selected] - Offset (starting point) for pagination (optional).
    * @param {string} [searchText] - filter by searching for this text in the results (optional).
    * * @returns {Promise<MyDataCollectionItemSubset>}
    */
@@ -27,16 +27,16 @@ export class GetMyDataCollectionItems implements UseCase<MyDataCollectionItemSub
     collectionItemTypes: CollectionItemType[],
     publicationStatuses: PublicationStatus[],
     limit?: number,
-    offset?: number,
+    selectedPage?: number,
     searchText?: string,
     otherUserName?: string
-  ): Promise<MyDataCollectionItemSubset> {
+  ): Promise<CollectionItemSubset> {
     return await this.collectionsRepository.getMyDataCollectionItems(
       roleIds,
       collectionItemTypes,
       publicationStatuses,
       limit,
-      offset,
+      selectedPage,
       searchText,
       otherUserName
     )

src/collections/infra/repositories/CollectionsRepository.ts

@@ -11,10 +11,7 @@ import { CollectionDTO } from '../../domain/dtos/CollectionDTO'
 import { CollectionFacet } from '../../domain/models/CollectionFacet'
 import { CollectionUserPermissions } from '../../domain/models/CollectionUserPermissions'
 import { transformCollectionUserPermissionsResponseToCollectionUserPermissions } from './transformers/collectionUserPermissionsTransformers'
-import {
-  CollectionItemSubset,
-  MyDataCollectionItemSubset
-} from '../../domain/models/CollectionItemSubset'
+import { CollectionItemSubset } from '../../domain/models/CollectionItemSubset'
 import {
   CollectionSearchCriteria,
   OrderType,
@@ -212,7 +209,7 @@ export class CollectionsRepository extends ApiRepository implements ICollections
     selectedPage?: number,
     searchText?: string,
     userIdentifier?: string
-  ): Promise<MyDataCollectionItemSubset> {
+  ): Promise<CollectionItemSubset> {
     const queryParams = new URLSearchParams()
 
     if (limit) {

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

@@ -11,8 +11,7 @@ import { CollectionFacetPayload } from './CollectionFacetPayload'
 import {
   CollectionItemsFacet,
   CollectionItemsFacetLabel,
-  CollectionItemSubset,
-  MyDataCollectionItemSubset
+  CollectionItemSubset
 } from '../../../domain/models/CollectionItemSubset'
 import { DatasetPreview } from '../../../../datasets'
 import { FilePreview } from '../../../../files'
@@ -150,7 +149,7 @@ export const transformCollectionItemsResponseToCollectionItemSubset = (
 
 export const transformMyDataResponseToCollectionItemSubset = (
   response: AxiosResponse
-): MyDataCollectionItemSubset => {
+): CollectionItemSubset => {
   const responseDataPayload = response.data.data
   const itemsPayload = responseDataPayload.items
   const countPerObjectTypePayload = responseDataPayload[
@@ -189,13 +188,14 @@ export const transformMyDataResponseToCollectionItemSubset = (
     datasets: countPerObjectTypePayload['datasets_count'],
     files: countPerObjectTypePayload['files_count']
   }
-  const publishingFacet: CollectionItemsFacetLabel[] = transformPublicationStatusResponseToLabels(
+  const publishingFacet: CollectionItemsFacet = transformPublicationStatusResponseToFacet(
     responseDataPayload.pubstatus_counts as MyDataPublicationStatusCountsPayload
   )
+  const facets: CollectionItemsFacet[] = [publishingFacet]
 
   return {
     items,
-    publishingFacet,
+    facets,
     totalItemCount: responseDataPayload.pagination.numResults,
     countPerObjectType
   }
@@ -210,14 +210,19 @@ const transformContactsPayloadToContacts = (
   }))
 }
 
-const transformPublicationStatusResponseToLabels = (
+const transformPublicationStatusResponseToFacet = (
   publicationStatusCounts: MyDataPublicationStatusCountsPayload
-): CollectionItemsFacetLabel[] => {
-  const labels: CollectionItemsFacetLabel[] = []
-  labels.push({ name: 'Published', count: publicationStatusCounts.published_count })
-  labels.push({ name: 'Unpublished', count: publicationStatusCounts.unpublished_count })
-  labels.push({ name: 'Draft', count: publicationStatusCounts.draft_count })
-  labels.push({ name: 'In Review', count: publicationStatusCounts.in_review_count })
-  labels.push({ name: 'Deaccessioned', count: publicationStatusCounts.deaccessioned_count })
-  return labels
+): CollectionItemsFacet => {
+  const labels: CollectionItemsFacetLabel[] = [
+    { name: 'Published', count: publicationStatusCounts.published_count },
+    { name: 'Unpublished', count: publicationStatusCounts.unpublished_count },
+    { name: 'Draft', count: publicationStatusCounts.draft_count },
+    { name: 'In Review', count: publicationStatusCounts.in_review_count },
+    { name: 'Deaccessioned', count: publicationStatusCounts.deaccessioned_count }
+  ]
+  return {
+    name: 'publicationStatus',
+    friendlyName: 'Publication Status',
+    labels
+  }
 }

test/functional/collections/GetMyDataCollectionItems.test.ts

@@ -106,26 +106,32 @@ describe('execute', () => {
         expect(actualCollectionPreview.alias).toBe(testCollectionAlias)
 
         expect(actual.totalItemCount).toBe(1)
-        expect(actual.publishingFacet).toEqual([
+        expect(actual.facets).toEqual([
           {
-            name: 'Published',
-            count: 0
-          },
-          {
-            name: 'Unpublished',
-            count: 1
-          },
-          {
-            name: 'Draft',
-            count: 0
-          },
-          {
-            name: 'In Review',
-            count: 0
-          },
-          {
-            name: 'Deaccessioned',
-            count: 0
+            name: 'publicationStatus',
+            friendlyName: 'Publication Status',
+            labels: [
+              {
+                name: 'Published',
+                count: 0
+              },
+              {
+                name: 'Unpublished',
+                count: 1
+              },
+              {
+                name: 'Draft',
+                count: 0
+              },
+              {
+                name: 'In Review',
+                count: 0
+              },
+              {
+                name: 'Deaccessioned',
+                count: 0
+              }
+            ]
           }
         ])
         expect(actual.countPerObjectType).toEqual({

test/unit/collections/GetMyDataCollectionItems.test.ts

@@ -5,12 +5,9 @@ import { CollectionItemType } from '../../../src/collections/domain/models/Colle
 import { createDatasetPreviewModel } from '../../testHelpers/datasets/datasetPreviewHelper'
 import { createFilePreviewModel } from '../../testHelpers/files/filePreviewHelper'
 import { createCollectionPreviewModel } from '../../testHelpers/collections/collectionPreviewHelper'
-import {
-  CollectionItemsFacetLabel,
-  MyDataCollectionItemSubset
-} from '../../../src/collections/domain/models/CollectionItemSubset'
+import { CollectionItemsFacet } from '../../../src/collections/domain/models/CollectionItemSubset'
 import { PublicationStatus } from '../../../src/core/domain/models/PublicationStatus'
-
+import { CollectionItemSubset } from '../../../src/collections/domain/models/CollectionItemSubset'
 describe('GetMyDataCollectionItems', () => {
   let collectionRepositoryStub: ICollectionsRepository
   let testGetMyDataCollectionItems: GetMyDataCollectionItems
@@ -27,27 +24,33 @@ describe('GetMyDataCollectionItems', () => {
   const testSearchText = 'test'
   const testOtherUserName = 'testUser'
   const testItems = [
+    createCollectionPreviewModel(),
     createDatasetPreviewModel(),
-    createFilePreviewModel(),
-    createCollectionPreviewModel()
+    createFilePreviewModel()
   ]
   const testFacets = [
     {
-      name: 'Published',
-      count: 10
-    },
-    {
-      name: 'Draft',
-      count: 5
-    },
-    {
-      name: 'Unpublished',
-      count: 15
+      name: 'publicationStatus',
+      friendlyName: 'Publication Status',
+      labels: [
+        {
+          name: 'Published',
+          count: 10
+        },
+        {
+          name: 'Draft',
+          count: 5
+        },
+        {
+          name: 'Unpublished',
+          count: 15
+        }
+      ]
     }
-  ] as CollectionItemsFacetLabel[]
-  const testItemSubset: MyDataCollectionItemSubset = {
+  ] as CollectionItemsFacet[]
+  const testItemSubset: CollectionItemSubset = {
     items: testItems,
-    publishingFacet: testFacets,
+    facets: testFacets,
     totalItemCount: 30,
     countPerObjectType: { collections: 10, datasets: 15, files: 5 }
   }