feat: add GetMyDataCollectionItems use case

Author: ekraffmiller

src/collections/domain/models/CollectionItemSubset.ts

@@ -8,14 +8,20 @@ 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
   friendlyName: string
   labels: CollectionItemsFacetLabel[]
 }
 
-interface CollectionItemsFacetLabel {
+export interface CollectionItemsFacetLabel {
   name: string
   count: number
 }

src/collections/domain/models/CollectionPreview.ts

@@ -12,4 +12,5 @@ export interface CollectionPreview {
   publicationStatuses: PublicationStatus[]
   releaseOrCreateDate: Date
   imageUrl?: string
+  userRoles?: string[]
 }

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -3,9 +3,11 @@ import { CollectionFeaturedItemsDTO } from '../dtos/CollectionFeaturedItemsDTO'
 import { Collection } from '../models/Collection'
 import { CollectionFacet } from '../models/CollectionFacet'
 import { CollectionFeaturedItem } from '../models/CollectionFeaturedItem'
-import { CollectionItemSubset } from '../models/CollectionItemSubset'
+import { CollectionItemSubset, MyDataCollectionItemSubset } from '../models/CollectionItemSubset'
 import { CollectionSearchCriteria } from '../models/CollectionSearchCriteria'
 import { CollectionUserPermissions } from '../models/CollectionUserPermissions'
+import { CollectionItemType } from '../../../../dist'
+import { PublicationStatus } from '../../../../dist/core/domain/models/PublicationStatus'
 
 export interface ICollectionsRepository {
   getCollection(collectionIdOrAlias: number | string): Promise<Collection>
@@ -25,6 +27,15 @@ export interface ICollectionsRepository {
     offset?: number,
     collectionSearchCriteria?: CollectionSearchCriteria
   ): Promise<CollectionItemSubset>
+  getMyDataCollectionItems(
+    roleIds: number[],
+    collectionItemTypes: CollectionItemType[],
+    publicationStatuses: PublicationStatus[],
+    limit?: number,
+    page?: number,
+    searchText?: string,
+    otherUserName?: string
+  ): Promise<MyDataCollectionItemSubset>
   updateCollection(
     collectionIdOrAlias: number | string,
     updatedCollection: CollectionDTO

src/collections/domain/useCases/GetMyDataCollectionItems.ts

@@ -0,0 +1,43 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { MyDataCollectionItemSubset } from '../models/CollectionItemSubset'
+import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
+import { CollectionItemType } from '../../../../dist'
+import { PublicationStatus } from '../../../../dist/core/domain/models/PublicationStatus'
+
+export class GetMyDataCollectionItems implements UseCase<MyDataCollectionItemSubset> {
+  private collectionsRepository: ICollectionsRepository
+
+  constructor(collectionsRepository: ICollectionsRepository) {
+    this.collectionsRepository = collectionsRepository
+  }
+
+  /**
+   * Returns an instance of  MyDataCollectionItemSubset that contains the items for which the user has the specified role or roles
+   *
+   * @param {number[]} [roleIds] - the ids of the roles to filter the items by.
+   * @param {CollectionItemType[]} [collectionItemTypes] - the types of items to filter by.
+   * @param {number} [limit] - Limit for pagination (optional).
+   * @param {number} [offset] - Offset for pagination (optional).
+   * @param {string} [searchText] - filter by searching for this text in the results
+   * * @returns {Promise<CollectionItemSubset>}
+   */
+  async execute(
+    roleIds: number[],
+    collectionItemTypes: CollectionItemType[],
+    publicationStatuses: PublicationStatus[],
+    limit?: number,
+    offset?: number,
+    searchText?: string,
+    otherUserName?: string
+  ): Promise<MyDataCollectionItemSubset> {
+    return await this.collectionsRepository.getMyDataCollectionItems(
+      roleIds,
+      collectionItemTypes,
+      publicationStatuses,
+      limit,
+      offset,
+      searchText,
+      otherUserName
+    )
+  }
+}

src/collections/infra/repositories/CollectionsRepository.ts

@@ -3,14 +3,18 @@ import { ICollectionsRepository } from '../../domain/repositories/ICollectionsRe
 import {
   transformCollectionFacetsResponseToCollectionFacets,
   transformCollectionItemsResponseToCollectionItemSubset,
-  transformCollectionResponseToCollection
+  transformCollectionResponseToCollection,
+  transformMyDataResponseToCollectionItemSubset
 } from './transformers/collectionTransformers'
 import { Collection, ROOT_COLLECTION_ID } from '../../domain/models/Collection'
 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 } from '../../domain/models/CollectionItemSubset'
+import {
+  CollectionItemSubset,
+  MyDataCollectionItemSubset
+} from '../../domain/models/CollectionItemSubset'
 import {
   CollectionSearchCriteria,
   OrderType,
@@ -21,6 +25,7 @@ import { CollectionFeaturedItem } from '../../domain/models/CollectionFeaturedIt
 import { transformCollectionFeaturedItemsPayloadToCollectionFeaturedItems } from './transformers/collectionFeaturedItemsTransformer'
 import { CollectionFeaturedItemsDTO } from '../../domain/dtos/CollectionFeaturedItemsDTO'
 import { ApiConstants } from '../../../core/infra/repositories/ApiConstants'
+import { PublicationStatus } from '../../../../dist/core/domain/models/PublicationStatus'
 
 export interface NewCollectionRequestPayload {
   alias: string
@@ -63,6 +68,17 @@ export enum GetCollectionItemsQueryParams {
   SHOW_TYPE_COUNTS = 'show_type_counts'
 }
 
+export enum GetMyDataCollectionItemsQueryParams {
+  QUERY = 'q',
+  PER_PAGE = 'per_page',
+  SELECTED_PAGE = 'selected_page',
+  ROLE_ID = 'role_ids',
+  TYPE = 'dvobject_types',
+  PUBLISHED_STATES = 'published_states',
+  USER_IDENTIFIER = 'userIdentifier',
+  SHOW_TYPE_COUNTS = 'show_type_counts'
+}
+
 export class CollectionsRepository extends ApiRepository implements ICollectionsRepository {
   private readonly collectionsResourceName: string = 'dataverses'
 
@@ -188,6 +204,67 @@ export class CollectionsRepository extends ApiRepository implements ICollections
       })
   }
 
+  public async getMyDataCollectionItems(
+    roleIds: number[],
+    collectionItemTypes: CollectionItemType[],
+    publicationStatuses: PublicationStatus[],
+    limit?: number,
+    page?: number,
+    searchText?: string,
+    userIdentifier?: string
+  ): Promise<MyDataCollectionItemSubset> {
+    const queryParams = new URLSearchParams()
+
+    if (limit) {
+      queryParams.set(GetMyDataCollectionItemsQueryParams.PER_PAGE, limit.toString())
+    }
+
+    if (page) {
+      queryParams.set(GetMyDataCollectionItemsQueryParams.SELECTED_PAGE, page.toString())
+    }
+
+    if (searchText) {
+      queryParams.set(GetMyDataCollectionItemsQueryParams.QUERY, encodeURIComponent(searchText))
+    }
+
+    roleIds.forEach((roleId) => {
+      queryParams.append(GetMyDataCollectionItemsQueryParams.ROLE_ID, roleId.toString())
+    })
+    if (userIdentifier) {
+      queryParams.set(GetMyDataCollectionItemsQueryParams.USER_IDENTIFIER, userIdentifier)
+    }
+
+    collectionItemTypes.forEach((itemType) => {
+      let mappedItemType: string
+
+      switch (itemType) {
+        case CollectionItemType.COLLECTION:
+          mappedItemType = 'Dataverse'
+          break
+        case CollectionItemType.DATASET:
+          mappedItemType = 'Dataset'
+          break
+        case CollectionItemType.FILE:
+          mappedItemType = 'DataFile'
+          break
+      }
+      queryParams.append(GetMyDataCollectionItemsQueryParams.TYPE, mappedItemType)
+    })
+
+    publicationStatuses.forEach((publicationStatus) => {
+      queryParams.append(
+        GetMyDataCollectionItemsQueryParams.PUBLISHED_STATES,
+        publicationStatus.toString()
+      )
+    })
+
+    return this.doGet('/retrieve', true, queryParams)
+      .then((response) => transformMyDataResponseToCollectionItemSubset(response))
+      .catch((error) => {
+        throw error
+      })
+  }
+
   private createCreateOrUpdateRequestBody(
     collectionDTO: CollectionDTO
   ): NewCollectionRequestPayload {

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

@@ -0,0 +1,14 @@
+export interface MyDataCollectionPreviewPayload {
+  name: string
+  parentDataverseName: string
+  identifier: string
+  parentDataverseIdentifier: string
+  url: string
+  image_url: string
+  description: string
+  type?: string
+  publicationStatuses: string[]
+  affiliation: string
+  published_at: string
+  user_roles: string[]
+}

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

@@ -0,0 +1,5 @@
+export interface MyDataCountPerObjectTypePayload {
+  dataverses_count: number
+  datasets_count: number
+  files_count: number
+}

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

@@ -0,0 +1,7 @@
+export interface MyDataPublicationStatusCountsPayload {
+  deaccessioned_count: number
+  draft_count: number
+  in_review_count: number
+  published_count: number
+  unpublished_count: number
+}

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

@@ -2,6 +2,7 @@ import { PublicationStatus } from '../../../../core/domain/models/PublicationSta
 import { CollectionItemType } from '../../../../collections/domain/models/CollectionItemType'
 import { CollectionPreview } from '../../../domain/models/CollectionPreview'
 import { CollectionPreviewPayload } from './CollectionPreviewPayload'
+import { MyDataCollectionPreviewPayload } from './MyDataCollectionPreviewPayload'
 
 export const transformCollectionPreviewPayloadToCollectionPreview = (
   collectionPreviewPayload: CollectionPreviewPayload
@@ -25,3 +26,27 @@ export const transformCollectionPreviewPayloadToCollectionPreview = (
     releaseOrCreateDate: new Date(collectionPreviewPayload.published_at)
   }
 }
+
+export const transformMyDataCollectionPreviewPayloadToCollectionPreview = (
+  collectionPreviewPayload: MyDataCollectionPreviewPayload
+): CollectionPreview => {
+  const publicationStatuses: PublicationStatus[] = []
+  collectionPreviewPayload.publicationStatuses.forEach((element) => {
+    publicationStatuses.push(element as unknown as PublicationStatus)
+  })
+  return {
+    type: CollectionItemType.COLLECTION,
+    name: collectionPreviewPayload.name,
+    parentName: collectionPreviewPayload.parentDataverseName,
+    alias: collectionPreviewPayload.identifier,
+    parentAlias: collectionPreviewPayload.parentDataverseIdentifier,
+    description: collectionPreviewPayload.description,
+    publicationStatuses: publicationStatuses,
+    affiliation: collectionPreviewPayload.affiliation,
+    ...(collectionPreviewPayload.image_url && {
+      imageUrl: collectionPreviewPayload.image_url
+    }),
+    releaseOrCreateDate: new Date(collectionPreviewPayload.published_at),
+    userRoles: collectionPreviewPayload.user_roles
+  }
+}

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

@@ -10,21 +10,37 @@ import { CollectionFacet } from '../../../domain/models/CollectionFacet'
 import { CollectionFacetPayload } from './CollectionFacetPayload'
 import {
   CollectionItemsFacet,
-  CollectionItemSubset
+  CollectionItemsFacetLabel,
+  CollectionItemSubset,
+  MyDataCollectionItemSubset
 } from '../../../domain/models/CollectionItemSubset'
 import { DatasetPreview } from '../../../../datasets'
 import { FilePreview } from '../../../../files'
 import { DatasetPreviewPayload } from '../../../../datasets/infra/repositories/transformers/DatasetPreviewPayload'
 import { FilePreviewPayload } from '../../../../files/infra/repositories/transformers/FilePreviewPayload'
-import { transformDatasetPreviewPayloadToDatasetPreview } from '../../../../datasets/infra/repositories/transformers/datasetPreviewsTransformers'
-import { transformFilePreviewPayloadToFilePreview } from '../../../../files/infra/repositories/transformers/filePreviewTransformers'
-import { transformCollectionPreviewPayloadToCollectionPreview } from './collectionPreviewsTransformers'
+import {
+  transformDatasetPreviewPayloadToDatasetPreview,
+  transformMyDataDatasetPreviewPayloadToDatasetPreview
+} from '../../../../datasets/infra/repositories/transformers/datasetPreviewsTransformers'
+import {
+  transformFilePreviewPayloadToFilePreview,
+  transformMyDataFilePreviewPayloadToFilePreview
+} from '../../../../files/infra/repositories/transformers/filePreviewTransformers'
+import {
+  transformCollectionPreviewPayloadToCollectionPreview,
+  transformMyDataCollectionPreviewPayloadToCollectionPreview
+} from './collectionPreviewsTransformers'
 import { CollectionPreviewPayload } from './CollectionPreviewPayload'
 import { CollectionPreview } from '../../../domain/models/CollectionPreview'
 import { CollectionContact } from '../../../domain/models/CollectionContact'
 import { CollectionType } from '../../../domain/models/CollectionType'
 import { CollectionItemsFacetPayload } from './CollectionItemsFacetsPayload'
 import { CollectionItemsCountPerObjectTypePayload } from './CollectionItemsCountPerObjectTypePayload'
+import { MyDataFilePreviewPayload } from '../../../../files/infra/repositories/transformers/MyDataFilePreviewPayload'
+import { MyDataDatasetPreviewPayload } from '../../../../datasets/infra/repositories/transformers/MyDataDatasetPreviewPayload'
+import { MyDataCollectionPreviewPayload } from './MyDataCollectionPreviewPayload'
+import { MyDataCountPerObjectTypePayload } from './MyDataCountPerObjectTypePayload'
+import { MyDataPublicationStatusCountsPayload } from './MyDataPublicationStatusCountsPayload'
 
 export const transformCollectionResponseToCollection = (response: AxiosResponse): Collection => {
   const collectionPayload = response.data.data
@@ -132,6 +148,59 @@ export const transformCollectionItemsResponseToCollectionItemSubset = (
   }
 }
 
+export const transformMyDataResponseToCollectionItemSubset = (
+  response: AxiosResponse
+): MyDataCollectionItemSubset => {
+  const responseDataPayload = response.data.data
+  const itemsPayload = responseDataPayload.items
+  const countPerObjectTypePayload = responseDataPayload[
+    'dvobject_counts'
+  ] as MyDataCountPerObjectTypePayload
+
+  const items: (DatasetPreview | FilePreview | CollectionPreview)[] = []
+
+  itemsPayload.forEach(function (
+    itemPayload:
+      | MyDataCollectionPreviewPayload
+      | MyDataDatasetPreviewPayload
+      | MyDataFilePreviewPayload
+  ) {
+    if (itemPayload.type === 'file') {
+      items.push(
+        transformMyDataFilePreviewPayloadToFilePreview(itemPayload as MyDataFilePreviewPayload)
+      )
+    } else if (itemPayload.type === 'dataset') {
+      items.push(
+        transformMyDataDatasetPreviewPayloadToDatasetPreview(
+          itemPayload as MyDataDatasetPreviewPayload
+        )
+      )
+    } else if (itemPayload.type === 'dataverse') {
+      items.push(
+        transformMyDataCollectionPreviewPayloadToCollectionPreview(
+          itemPayload as unknown as MyDataCollectionPreviewPayload
+        )
+      )
+    }
+  })
+
+  const countPerObjectType = {
+    dataverses: countPerObjectTypePayload['dataverses_count'],
+    datasets: countPerObjectTypePayload['datasets_count'],
+    files: countPerObjectTypePayload['files_count']
+  }
+  const publishingFacet: CollectionItemsFacetLabel[] = transformPublicationStatusResponseToLabels(
+    responseDataPayload.pubstatus_counts as MyDataPublicationStatusCountsPayload
+  )
+
+  return {
+    items,
+    publishingFacet,
+    totalItemCount: responseDataPayload.pagination.numResults,
+    countPerObjectType
+  }
+}
+
 const transformContactsPayloadToContacts = (
   contactsPayload: CollectionContactPayload[]
 ): CollectionContact[] => {
@@ -140,3 +209,15 @@ const transformContactsPayloadToContacts = (
     displayOrder: contactPayload.displayOrder
   }))
 }
+
+const transformPublicationStatusResponseToLabels = (
+  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
+}