Collection Page Facets Filters

package.json

@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@faker-js/faker": "7.6.0",
-    "@iqss/dataverse-client-javascript": "2.0.0-alpha.6",
+    "@iqss/dataverse-client-javascript": "2.0.0-pr230.3a26dc9",
     "@iqss/dataverse-design-system": "*",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
     "@tanstack/react-table": "8.9.2",

public/locales/en/collection.json

@@ -31,6 +31,8 @@
     "error": "There was an error publishing your collection."
   },
   "publishedAlert": "Your collection is now public.",
+  "addFacetFilter": "Add {{labelName}} facet filter",
+  "removeSelectedFacet": "Remove {{labelName}} facet filter",
   "editedAlert": "You have successfully updated your collection!",
   "editCollection": {
     "edit": "Edit",

public/locales/en/shared.json

@@ -4,6 +4,8 @@
   "add": "Add",
   "cancel": "Cancel",
   "continue": "Continue",
+  "more": "More...",
+  "less": "Less...",
   "pageNumberNotFound": {
     "heading": "Page Number Not Found",
     "message": "The page number you requested does not exist. Please try a different page number."

src/collection/domain/models/CollectionItemSubset.ts

@@ -4,10 +4,22 @@ import { FileItemTypePreview } from '../../../files/domain/models/FileItemTypePr
 
 export interface CollectionItemSubset {
   items: CollectionItem[]
+  facets: CollectionItemsFacet[]
   totalItemCount: number
 }
 
 export type CollectionItem =
   | CollectionItemTypePreview
   | DatasetItemTypePreview
   | FileItemTypePreview
+
+export interface CollectionItemsFacet {
+  name: string
+  friendlyName: string
+  labels: CollectionItemsFacetLabel[]
+}
+
+interface CollectionItemsFacetLabel {
+  name: string
+  count: number
+}

src/collection/domain/models/CollectionItemsQueryParams.ts

@@ -0,0 +1,8 @@
+export enum CollectionItemsQueryParams {
+  SORT = 'sort',
+  ORDER = 'order',
+  START = 'start',
+  TYPES = 'types',
+  QUERY = 'q',
+  FILTER_QUERIES = 'fqs'
+}

src/collection/domain/models/CollectionSearchCriteria.ts

@@ -0,0 +1,77 @@
+import { type CollectionItemType } from './CollectionItemType'
+
+export enum SortType {
+  NAME = 'name',
+  DATE = 'date'
+}
+
+export enum OrderType {
+  ASC = 'asc',
+  DESC = 'desc'
+}
+
+export type FilterQuery = `${string}:${string}`
+
+export class CollectionSearchCriteria {
+  constructor(
+    public readonly searchText?: string,
+    public readonly itemTypes?: CollectionItemType[],
+    public readonly sort?: SortType,
+    public readonly order?: OrderType,
+    public readonly filterQueries?: FilterQuery[]
+  ) {}
+
+  withSearchText(searchText: string | undefined): CollectionSearchCriteria {
+    return new CollectionSearchCriteria(
+      searchText,
+      this.itemTypes,
+      this.sort,
+      this.order,
+      this.filterQueries
+    )
+  }
+
+  withItemTypes(itemTypes: CollectionItemType[] | undefined): CollectionSearchCriteria {
+    return new CollectionSearchCriteria(
+      this.searchText,
+      itemTypes,
+      this.sort,
+      this.order,
+      this.filterQueries
+    )
+  }
+
+  withSort(sort: SortType | undefined): CollectionSearchCriteria {
+    return new CollectionSearchCriteria(
+      this.searchText,
+      this.itemTypes,
+      sort,
+      this.order,
+      this.filterQueries
+    )
+  }
+
+  withOrder(order: OrderType | undefined): CollectionSearchCriteria {
+    return new CollectionSearchCriteria(
+      this.searchText,
+      this.itemTypes,
+      this.sort,
+      order,
+      this.filterQueries
+    )
+  }
+
+  withFilterQueries(filterQueries: FilterQuery[] | undefined): CollectionSearchCriteria {
+    return new CollectionSearchCriteria(
+      this.searchText,
+      this.itemTypes,
+      this.sort,
+      this.order,
+      filterQueries
+    )
+  }
+
+  hasSearchText(): boolean {
+    return !!this.searchText
+  }
+}

src/collection/infrastructure/repositories/CollectionJSDataverseRepository.ts

@@ -55,6 +55,7 @@ export class CollectionJSDataverseRepository implements CollectionRepository {
 
         return {
           items: collectionItemsPreviewsMapped,
+          facets: jsCollectionItemSubset.facets,
           totalItemCount: jsCollectionItemSubset.totalItemCount
         }
       })

src/sections/Route.enum.ts

@@ -26,8 +26,6 @@ export const RouteWithParams = {
 export enum QueryParamKey {
   VERSION = 'version',
   PERSISTENT_ID = 'persistentId',
-  QUERY = 'q',
-  COLLECTION_ITEM_TYPES = 'types',
   PAGE = 'page',
   COLLECTION_ID = 'collectionId'
 }

src/sections/collection/CollectionHelper.ts

@@ -1,6 +1,7 @@
-import { Collection } from '@/collection/domain/models/Collection'
+import { CollectionItemsQueryParams } from '@/collection/domain/models/CollectionItemsQueryParams'
+import { FilterQuery } from '@/collection/domain/models/CollectionSearchCriteria'
 import { CollectionItemType } from '@/collection/domain/models/CollectionItemType'
-import { QueryParamKey } from '../Route.enum'
+import { Collection } from '@/collection/domain/models/Collection'
 import { UpwardHierarchyNode } from '@/shared/hierarchy/domain/models/UpwardHierarchyNode'
 
 export class CollectionHelper {
@@ -9,11 +10,11 @@ export class CollectionHelper {
       ? parseInt(searchParams.get('page') as string, 10)
       : 1
 
-    const searchQuery = searchParams.get(QueryParamKey.QUERY)
-      ? decodeURIComponent(searchParams.get(QueryParamKey.QUERY) as string)
+    const searchQuery = searchParams.get(CollectionItemsQueryParams.QUERY)
+      ? decodeURIComponent(searchParams.get(CollectionItemsQueryParams.QUERY) as string)
       : undefined
 
-    const typesParam = searchParams.get(QueryParamKey.COLLECTION_ITEM_TYPES) ?? undefined
+    const typesParam = searchParams.get(CollectionItemsQueryParams.TYPES) ?? undefined
 
     const typesQuery = typesParam
       ?.split(',')
@@ -22,7 +23,16 @@ export class CollectionHelper {
         Object.values(CollectionItemType).includes(type as CollectionItemType)
       ) as CollectionItemType[]
 
-    return { pageQuery, searchQuery, typesQuery }
+    const filtersParam = searchParams.get(CollectionItemsQueryParams.FILTER_QUERIES) ?? undefined
+
+    const filtersQuery: FilterQuery[] | undefined = filtersParam
+      ? (filtersParam
+          ?.split(',')
+          .map((filterQuery) => decodeURIComponent(filterQuery))
+          .filter((decodedFilter) => /^[^:]+:[^:]+$/.test(decodedFilter)) as FilterQuery[])
+      : undefined
+
+    return { pageQuery, searchQuery, typesQuery, filtersQuery }
   }
 
   static isRootCollection(collectionHierarchy: Collection['hierarchy']) {