Add use case to get all datasets previews with pagination

src/datasets/domain/models/DatasetPreview.ts

@@ -0,0 +1,10 @@
+import { DatasetVersionInfo } from './Dataset';
+
+export interface DatasetPreview {
+  persistentId: string;
+  title: string;
+  versionId: number;
+  versionInfo: DatasetVersionInfo;
+  citation: string;
+  description: string;
+}

src/datasets/domain/models/DatasetPreviewSubset.ts

@@ -0,0 +1,6 @@
+import { DatasetPreview } from './DatasetPreview';
+
+export interface DatasetPreviewSubset {
+  datasetPreviews: DatasetPreview[];
+  totalDatasetCount: number;
+}

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -1,6 +1,7 @@
 import { Dataset } from '../models/Dataset';
 import { DatasetUserPermissions } from '../models/DatasetUserPermissions';
 import { DatasetLock } from '../models/DatasetLock';
+import { DatasetPreviewSubset } from '../models/DatasetPreviewSubset';
 
 export interface IDatasetsRepository {
   getDatasetSummaryFieldNames(): Promise<string[]>;
@@ -10,4 +11,5 @@ export interface IDatasetsRepository {
   getPrivateUrlDatasetCitation(token: string): Promise<string>;
   getDatasetUserPermissions(datasetId: number | string): Promise<DatasetUserPermissions>;
   getDatasetLocks(datasetId: number | string): Promise<DatasetLock[]>;
+  getAllDatasetPreviews(limit?: number, offset?: number): Promise<DatasetPreviewSubset>;
 }

src/datasets/domain/useCases/GetAllDatasetPreviews.ts

@@ -0,0 +1,15 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase';
+import { IDatasetsRepository } from '../repositories/IDatasetsRepository';
+import { DatasetPreviewSubset } from '../models/DatasetPreviewSubset';
+
+export class GetAllDatasetPreviews implements UseCase<DatasetPreviewSubset> {
+  private datasetsRepository: IDatasetsRepository;
+
+  constructor(datasetsRepository: IDatasetsRepository) {
+    this.datasetsRepository = datasetsRepository;
+  }
+
+  async execute(limit?: number, offset?: number): Promise<DatasetPreviewSubset> {
+    return await this.datasetsRepository.getAllDatasetPreviews(limit, offset);
+  }
+}

src/datasets/domain/useCases/GetDatasetCitation.ts

@@ -14,6 +14,6 @@ export class GetDatasetCitation implements UseCase<string> {
     datasetVersionId: string | DatasetNotNumberedVersion = DatasetNotNumberedVersion.LATEST,
     includeDeaccessioned: boolean = false,
   ): Promise<string> {
-    return await this.datasetsRepository.getDatasetCitation(datasetId, datasetVersionId, includeDeaccessioned)
+    return await this.datasetsRepository.getDatasetCitation(datasetId, datasetVersionId, includeDeaccessioned);
   }
 }

src/datasets/index.ts

@@ -6,6 +6,7 @@ import { GetDatasetCitation } from './domain/useCases/GetDatasetCitation';
 import { GetPrivateUrlDatasetCitation } from './domain/useCases/GetPrivateUrlDatasetCitation';
 import { GetDatasetUserPermissions } from './domain/useCases/GetDatasetUserPermissions';
 import { GetDatasetLocks } from './domain/useCases/GetDatasetLocks';
+import { GetAllDatasetPreviews } from './domain/useCases/GetAllDatasetPreviews';
 
 const datasetsRepository = new DatasetsRepository();
 
@@ -16,6 +17,7 @@ const getDatasetCitation = new GetDatasetCitation(datasetsRepository);
 const getPrivateUrlDatasetCitation = new GetPrivateUrlDatasetCitation(datasetsRepository);
 const getDatasetUserPermissions = new GetDatasetUserPermissions(datasetsRepository);
 const getDatasetLocks = new GetDatasetLocks(datasetsRepository);
+const getAllDatasetPreviews = new GetAllDatasetPreviews(datasetsRepository);
 
 export {
   getDatasetSummaryFieldNames,
@@ -25,6 +27,7 @@ export {
   getPrivateUrlDatasetCitation,
   getDatasetUserPermissions,
   getDatasetLocks,
+  getAllDatasetPreviews,
 };
 export { DatasetNotNumberedVersion } from './domain/models/DatasetNotNumberedVersion';
 export { DatasetUserPermissions } from './domain/models/DatasetUserPermissions';
@@ -40,3 +43,5 @@ export {
   DatasetMetadataFieldValue,
   DatasetMetadataSubField,
 } from './domain/models/Dataset';
+export { DatasetPreview } from './domain/models/DatasetPreview';
+export { DatasetPreviewSubset } from './domain/models/DatasetPreviewSubset';

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -6,7 +6,13 @@ import { DatasetUserPermissions } from '../../domain/models/DatasetUserPermissio
 import { transformDatasetUserPermissionsResponseToDatasetUserPermissions } from './transformers/datasetUserPermissionsTransformers';
 import { DatasetLock } from '../../domain/models/DatasetLock';
 import { transformDatasetLocksResponseToDatasetLocks } from './transformers/datasetLocksTransformers';
+import { transformDatasetPreviewsResponseToDatasetPreviewSubset } from './transformers/datasetPreviewsTransformers';
+import { DatasetPreviewSubset } from '../../domain/models/DatasetPreviewSubset';
 
+export interface GetAllDatasetPreviewsQueryParams {
+  per_page?: number;
+  start?: number;
+}
 
 export class DatasetsRepository extends ApiRepository implements IDatasetsRepository {
   private readonly datasetsResourceName: string = 'datasets';
@@ -37,7 +43,7 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
       true,
       {
         includeDeaccessioned: includeDeaccessioned,
-        includeFiles: false
+        includeFiles: false,
       },
     )
       .then((response) => transformVersionResponseToDataset(response))
@@ -46,14 +52,15 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
       });
   }
 
-
-
-  public async getDatasetCitation(datasetId: number, datasetVersionId: string,
-                                  includeDeaccessioned: boolean): Promise<string> {
-
+  public async getDatasetCitation(
+    datasetId: number,
+    datasetVersionId: string,
+    includeDeaccessioned: boolean,
+  ): Promise<string> {
     return this.doGet(
       this.buildApiEndpoint(this.datasetsResourceName, `versions/${datasetVersionId}/citation`, datasetId),
-      true, { includeDeaccessioned: includeDeaccessioned}
+      true,
+      { includeDeaccessioned: includeDeaccessioned },
     )
       .then((response) => response.data.data.message)
       .catch((error) => {
@@ -84,4 +91,19 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
         throw error;
       });
   }
+
+  public async getAllDatasetPreviews(limit?: number, offset?: number): Promise<DatasetPreviewSubset> {
+    const queryParams: GetAllDatasetPreviewsQueryParams = {};
+    if (limit !== undefined) {
+      queryParams.per_page = limit;
+    }
+    if (offset !== undefined) {
+      queryParams.start = offset;
+    }
+    return this.doGet('/search?q=*&type=dataset&sort=date&order=desc', true, queryParams)
+      .then((response) => transformDatasetPreviewsResponseToDatasetPreviewSubset(response))
+      .catch((error) => {
+        throw error;
+      });
+  }
 }

src/datasets/infra/repositories/transformers/datasetLocksTransformers.ts

@@ -1,18 +1,24 @@
 import { AxiosResponse } from 'axios';
 import { DatasetLock, DatasetLockType } from '../../../domain/models/DatasetLock';
 
+export interface DatasetLockPayload {
+  lockType: string;
+  date?: string;
+  user: string;
+  dataset: string;
+  message?: string;
+}
+
 export const transformDatasetLocksResponseToDatasetLocks = (response: AxiosResponse): DatasetLock[] => {
   const datasetLocks: DatasetLock[] = [];
   const datasetLocksPayload = response.data.data;
-  // eslint-disable-next-line  @typescript-eslint/no-explicit-any
-  datasetLocksPayload.forEach(function (datasetLockPayload: any) {
+  datasetLocksPayload.forEach(function (datasetLockPayload: DatasetLockPayload) {
     datasetLocks.push(transformDatasetLockPayloadToDatasetLock(datasetLockPayload));
   });
   return datasetLocks;
 };
 
-// eslint-disable-next-line  @typescript-eslint/no-explicit-any
-const transformDatasetLockPayloadToDatasetLock = (datasetLockPayload: any): DatasetLock => {
+const transformDatasetLockPayloadToDatasetLock = (datasetLockPayload: DatasetLockPayload): DatasetLock => {
   return {
     lockType: datasetLockPayload.lockType as DatasetLockType,
     ...(datasetLockPayload.date && { date: datasetLockPayload.date }),

src/datasets/infra/repositories/transformers/datasetPreviewsTransformers.ts

@@ -0,0 +1,53 @@
+import { AxiosResponse } from 'axios';
+import { DatasetPreview } from '../../../domain/models/DatasetPreview';
+import { DatasetVersionState } from '../../../domain/models/Dataset';
+import { DatasetPreviewSubset } from '../../../domain/models/DatasetPreviewSubset';
+
+export interface DatasetPreviewPayload {
+  global_id: string;
+  name: string;
+  versionId: number;
+  majorVersion: number;
+  minorVersion: number;
+  versionState: string;
+  createdAt: string;
+  updatedAt: string;
+  published_at?: string;
+  citation: string;
+  description: string;
+}
+
+export const transformDatasetPreviewsResponseToDatasetPreviewSubset = (
+  response: AxiosResponse,
+): DatasetPreviewSubset => {
+  const responseDataPayload = response.data.data;
+  const datasetPreviewsPayload = responseDataPayload.items;
+  const datasetPreviews: DatasetPreview[] = [];
+  datasetPreviewsPayload.forEach(function (datasetPreviewPayload: DatasetPreviewPayload) {
+    datasetPreviews.push(transformDatasetPreviewPayloadToDatasetPreview(datasetPreviewPayload));
+  });
+  return {
+    datasetPreviews: datasetPreviews,
+    totalDatasetCount: responseDataPayload.total_count,
+  };
+};
+
+const transformDatasetPreviewPayloadToDatasetPreview = (
+  datasetPreviewPayload: DatasetPreviewPayload,
+): DatasetPreview => {
+  return {
+    persistentId: datasetPreviewPayload.global_id,
+    title: datasetPreviewPayload.name,
+    versionId: datasetPreviewPayload.versionId,
+    versionInfo: {
+      majorNumber: datasetPreviewPayload.majorVersion,
+      minorNumber: datasetPreviewPayload.minorVersion,
+      state: datasetPreviewPayload.versionState as DatasetVersionState,
+      createTime: new Date(datasetPreviewPayload.createdAt),
+      lastUpdateTime: new Date(datasetPreviewPayload.updatedAt),
+      ...(datasetPreviewPayload.published_at && { releaseTime: new Date(datasetPreviewPayload.published_at) }),
+    },
+    citation: datasetPreviewPayload.citation,
+    description: datasetPreviewPayload.description,
+  };
+};