Skip to content

Commit 722df10

Browse files
committed
fix: imports
1 parent 4b98fd4 commit 722df10

File tree

7 files changed

+68
-10
lines changed

7 files changed

+68
-10
lines changed

docs/useCases.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,6 +215,64 @@ This use case supports the following optional parameters depending on the search
215215
- **offset**: (number) Offset for pagination.
216216
- **collectionSearchCriteria**: ([CollectionSearchCriteria](../src/collections/domain/models/CollectionSearchCriteria.ts)) Supports filtering the collection items by different properties.
217217

218+
#### List My Data Collection Items
219+
220+
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.
221+
222+
##### Example call:
223+
224+
```typescript
225+
import { getMyDataCollectionItems } from '@iqss/dataverse-client-javascript'
226+
227+
/* ... */
228+
229+
const roleIds = [1, 2]
230+
const collectionItemTypes = [CollectionItemType.DATASET, CollectionItemType.FILE]
231+
const publishingStatuses = [
232+
PublicationStatus.Published,
233+
PublicationStatus.Draft,
234+
PublicationStatus.Unpublished
235+
]
236+
const limit = 10
237+
const offset = 20
238+
const searchText = 'search text'
239+
const otherUserName = 'otherUserName'
240+
241+
getCollectionItems
242+
.execute(
243+
roleIds,
244+
collectionItemTypes,
245+
publishingStatuses,
246+
limit,
247+
offset,
248+
searchText,
249+
otherUserName
250+
)
251+
.then((subset: MyDataCollectionItemSubset) => {
252+
/* ... */
253+
})
254+
255+
/* ... */
256+
```
257+
258+
_See [use case](../src/collections/domain/useCases/GetMyDataCollectionItems.ts) implementation_.
259+
260+
The `roleIds` parameter is an array of role identifiers that the user has in the collection items. At least one roleId must be specified.
261+
The `collectionItemTypes` parameter is an array of collection item types to filter the results. At least one collectionItemType must be specified.
262+
The `publishingStatuses` parameter is an array of publishing statuses to filter the results. At least one publishingStatus must be specified.
263+
264+
This use case supports the following optional parameters depending on the search goals:
265+
266+
The `searchText` parameter is an optional string to filter the results by.
267+
The `otherUserName` parameter is an optional string to return the collection items of another user. If not set, the calling user will be used. Only superusers can use this parameter.
268+
The `MyDataCollectionItemSubset`returned instance contains a property called `totalItemCount` which is necessary for pagination.
269+
270+
This use case supports the following optional parameters depending on the search goals:
271+
272+
- **limit**: (number) Limit for pagination.
273+
- **offset**: (number) Offset for pagination.
274+
- **collectionSearchCriteria**: ([CollectionSearchCriteria](../src/collections/domain/models/CollectionSearchCriteria.ts)) Supports filtering the collection items by different properties.
275+
218276
#### Get Collection Featured Items
219277

220278
Returns a [CollectionFeaturedItem](../src/collections/domain/models/CollectionFeaturedItem.ts) array containing the featured items of the requested collection, given the collection identifier or alias.

src/collections/domain/repositories/ICollectionsRepository.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import { CollectionFeaturedItem } from '../models/CollectionFeaturedItem'
66
import { CollectionItemSubset, MyDataCollectionItemSubset } from '../models/CollectionItemSubset'
77
import { CollectionSearchCriteria } from '../models/CollectionSearchCriteria'
88
import { CollectionUserPermissions } from '../models/CollectionUserPermissions'
9-
import { CollectionItemType } from '../../../../dist'
10-
import { PublicationStatus } from '../../../../dist/core/domain/models/PublicationStatus'
9+
import { PublicationStatus } from '../../../../src/core/domain/models/PublicationStatus'
10+
import { CollectionItemType } from '../../../../src/collections/domain/models/CollectionItemType'
1111

1212
export interface ICollectionsRepository {
1313
getCollection(collectionIdOrAlias: number | string): Promise<Collection>

src/collections/domain/useCases/GetMyDataCollectionItems.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import { UseCase } from '../../../core/domain/useCases/UseCase'
22
import { MyDataCollectionItemSubset } from '../models/CollectionItemSubset'
33
import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
4-
import { CollectionItemType } from '../../../../dist'
5-
import { PublicationStatus } from '../../../../dist/core/domain/models/PublicationStatus'
4+
import { CollectionItemType } from '../../../../src/collections/domain/models/CollectionItemType'
5+
import { PublicationStatus } from '../../../../src/core/domain/models/PublicationStatus'
66

77
export class GetMyDataCollectionItems implements UseCase<MyDataCollectionItemSubset> {
88
private collectionsRepository: ICollectionsRepository

src/collections/infra/repositories/CollectionsRepository.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import { CollectionFeaturedItem } from '../../domain/models/CollectionFeaturedIt
2525
import { transformCollectionFeaturedItemsPayloadToCollectionFeaturedItems } from './transformers/collectionFeaturedItemsTransformer'
2626
import { CollectionFeaturedItemsDTO } from '../../domain/dtos/CollectionFeaturedItemsDTO'
2727
import { ApiConstants } from '../../../core/infra/repositories/ApiConstants'
28-
import { PublicationStatus } from '../../../../dist/core/domain/models/PublicationStatus'
28+
import { PublicationStatus } from '../../../../src/core/domain/models/PublicationStatus'
2929
import { ReadError } from '../../../core/domain/repositories/ReadError'
3030

3131
export interface NewCollectionRequestPayload {

src/files/infra/repositories/transformers/MyDataFilePreviewPayload.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { FilePreviewChecksumPayload } from '../../../../../dist/files/infra/repositories/transformers/FilePreviewPayload'
1+
import { FilePreviewChecksumPayload } from '../../../../../src/files/infra/repositories/transformers/FilePreviewPayload'
22

33
export interface MyDataFilePreviewPayload {
44
name: string

test/functional/collections/GetMyDataCollectionItems.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ import {
1515
} from '../../testHelpers/collections/collectionHelper'
1616
import { uploadFileViaApi } from '../../testHelpers/files/filesHelper'
1717
import { deleteUnpublishedDatasetViaApi } from '../../testHelpers/datasets/datasetHelper'
18-
import { CollectionItemType } from '../../../dist'
19-
import { PublicationStatus } from '../../../dist/core/domain/models/PublicationStatus'
18+
import { CollectionItemType } from '../../../src/collections/domain/models/CollectionItemType'
19+
import { PublicationStatus } from '../../../src/core/domain/models/PublicationStatus'
2020

2121
const testRoleIds = [1, 2, 3, 4, 5, 6, 7, 8]
2222
const testCollectionItemTypes = [CollectionItemType.DATASET, CollectionItemType.FILE]

test/unit/collections/GetMyDataCollectionItems.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
import { ICollectionsRepository } from '../../../src/collections/domain/repositories/ICollectionsRepository'
22
import { GetMyDataCollectionItems } from '../../../src/collections/domain/useCases/GetMyDataCollectionItems'
33
import { ReadError } from '../../../src'
4-
import { CollectionItemType } from '../../../dist'
4+
import { CollectionItemType } from '../../../src/collections/domain/models/CollectionItemType'
55
import { createDatasetPreviewModel } from '../../testHelpers/datasets/datasetPreviewHelper'
66
import { createFilePreviewModel } from '../../testHelpers/files/filePreviewHelper'
77
import { createCollectionPreviewModel } from '../../testHelpers/collections/collectionPreviewHelper'
88
import {
99
CollectionItemsFacetLabel,
1010
MyDataCollectionItemSubset
1111
} from '../../../src/collections/domain/models/CollectionItemSubset'
12-
import { PublicationStatus } from '../../../dist/core/domain/models/PublicationStatus'
12+
import { PublicationStatus } from '../../../src/core/domain/models/PublicationStatus'
1313

1414
describe('GetMyDataCollectionItems', () => {
1515
let collectionRepositoryStub: ICollectionsRepository

0 commit comments

Comments
 (0)