Merge pull request #82 from IQSS/80-files-filters

Add filters to getDatasetFiles use case

Author: kcondon

src/core/infra/repositories/ApiRepository.ts

@@ -4,8 +4,6 @@ import { ReadError } from '../../domain/repositories/ReadError';
 import { WriteError } from '../../domain/repositories/WriteError';
 
 export abstract class ApiRepository {
-  DATASET_VERSION_LATEST = ':latest';
-
   public async doGet(apiEndpoint: string, authRequired = false, queryParams: object = {}): Promise<AxiosResponse> {
     return await axios
       .get(this.buildRequestUrl(apiEndpoint), this.buildRequestConfig(authRequired, queryParams))

src/datasets/domain/models/DatasetNotNumberedVersion.ts

@@ -0,0 +1,4 @@
+export enum DatasetNotNumberedVersion {
+  DRAFT = ':draft',
+  LATEST = ':latest',
+}

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -2,8 +2,8 @@ import { Dataset } from '../models/Dataset';
 
 export interface IDatasetsRepository {
   getDatasetSummaryFieldNames(): Promise<string[]>;
-  getDataset(datasetId: number | string, datasetVersionId?: string): Promise<Dataset>;
+  getDataset(datasetId: number | string, datasetVersionId: string): Promise<Dataset>;
   getPrivateUrlDataset(token: string): Promise<Dataset>;
-  getDatasetCitation(datasetId: number, datasetVersionId?: string): Promise<string>;
+  getDatasetCitation(datasetId: number, datasetVersionId: string): Promise<string>;
   getPrivateUrlDatasetCitation(token: string): Promise<string>;
 }

src/datasets/domain/useCases/GetDataset.ts

@@ -1,6 +1,7 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase';
 import { IDatasetsRepository } from '../repositories/IDatasetsRepository';
 import { Dataset } from '../models/Dataset';
+import { DatasetNotNumberedVersion } from '../models/DatasetNotNumberedVersion';
 
 export class GetDataset implements UseCase<Dataset> {
   private datasetsRepository: IDatasetsRepository;
@@ -9,7 +10,10 @@ export class GetDataset implements UseCase<Dataset> {
     this.datasetsRepository = datasetsRepository;
   }
 
-  async execute(datasetId: number | string, datasetVersionId?: string): Promise<Dataset> {
+  async execute(
+    datasetId: number | string,
+    datasetVersionId: string | DatasetNotNumberedVersion = DatasetNotNumberedVersion.LATEST,
+  ): Promise<Dataset> {
     return await this.datasetsRepository.getDataset(datasetId, datasetVersionId);
   }
 }

src/datasets/domain/useCases/GetDatasetCitation.ts

@@ -1,5 +1,6 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase';
 import { IDatasetsRepository } from '../repositories/IDatasetsRepository';
+import { DatasetNotNumberedVersion } from '../models/DatasetNotNumberedVersion';
 
 export class GetDatasetCitation implements UseCase<string> {
   private datasetsRepository: IDatasetsRepository;
@@ -8,7 +9,10 @@ export class GetDatasetCitation implements UseCase<string> {
     this.datasetsRepository = datasetsRepository;
   }
 
-  async execute(datasetId: number, datasetVersionId?: string): Promise<string> {
+  async execute(
+    datasetId: number,
+    datasetVersionId: string | DatasetNotNumberedVersion = DatasetNotNumberedVersion.LATEST,
+  ): Promise<string> {
     return await this.datasetsRepository.getDatasetCitation(datasetId, datasetVersionId);
   }
 }

src/datasets/index.ts

@@ -20,6 +20,7 @@ export {
   getDatasetCitation,
   getPrivateUrlDatasetCitation,
 };
+export { DatasetNotNumberedVersion } from './domain/models/DatasetNotNumberedVersion';
 export {
   Dataset,
   DatasetVersionInfo,

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -20,10 +20,7 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
       });
   }
 
-  public async getDataset(datasetId: number | string, datasetVersionId?: string): Promise<Dataset> {
-    if (datasetVersionId === undefined) {
-      datasetVersionId = this.DATASET_VERSION_LATEST;
-    }
+  public async getDataset(datasetId: number | string, datasetVersionId: string): Promise<Dataset> {
     let endpoint;
     if (typeof datasetId === 'number') {
       endpoint = `/datasets/${datasetId}/versions/${datasetVersionId}`;
@@ -37,10 +34,7 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
       });
   }
 
-  public async getDatasetCitation(datasetId: number, datasetVersionId?: string): Promise<string> {
-    if (datasetVersionId === undefined) {
-      datasetVersionId = this.DATASET_VERSION_LATEST;
-    }
+  public async getDatasetCitation(datasetId: number, datasetVersionId: string): Promise<string> {
     return this.doGet(`/datasets/${datasetId}/versions/${datasetVersionId}/citation`, true)
       .then((response) => response.data.data.message)
       .catch((error) => {

src/files/domain/models/File.ts

@@ -7,6 +7,7 @@ export interface File {
   version: number;
   description?: string;
   restricted: boolean;
+  latestRestricted: boolean;
   directoryLabel?: string;
   datasetVersionId?: number;
   categories?: string[];

src/files/domain/models/FileCriteria.ts

@@ -0,0 +1,45 @@
+export class FileCriteria {
+  constructor(
+    public readonly orderCriteria: FileOrderCriteria = FileOrderCriteria.NAME_AZ,
+    public readonly contentType?: string,
+    public readonly accessStatus?: FileAccessStatus,
+    public readonly categoryName?: string,
+    public readonly searchText?: string,
+  ) {}
+
+  withOrderCriteria(orderCriteria: FileOrderCriteria): FileCriteria {
+    return new FileCriteria(orderCriteria, this.contentType, this.accessStatus, this.categoryName);
+  }
+
+  withContentType(contentType: string | undefined): FileCriteria {
+    return new FileCriteria(this.orderCriteria, contentType, this.accessStatus, this.categoryName);
+  }
+
+  withAccessStatus(accessStatus: FileAccessStatus | undefined): FileCriteria {
+    return new FileCriteria(this.orderCriteria, this.contentType, accessStatus, this.categoryName);
+  }
+
+  withCategoryName(categoryName: string | undefined): FileCriteria {
+    return new FileCriteria(this.orderCriteria, this.contentType, this.accessStatus, categoryName);
+  }
+
+  withSearchText(searchText: string | undefined): FileCriteria {
+    return new FileCriteria(this.orderCriteria, this.contentType, this.accessStatus, this.categoryName, searchText);
+  }
+}
+
+export enum FileOrderCriteria {
+  NAME_AZ = 'NameAZ',
+  NAME_ZA = 'NameZA',
+  NEWEST = 'Newest',
+  OLDEST = 'Oldest',
+  SIZE = 'Size',
+  TYPE = 'Type',
+}
+
+export enum FileAccessStatus {
+  PUBLIC = 'Public',
+  RESTRICTED = 'Restricted',
+  EMBARGOED = 'EmbargoedThenRestricted',
+  EMBARGOED_RESTRICTED = 'EmbargoedThenPublic',
+}