feat: Add ID filter (resolves #21)

Author: oliverroick

src/hooks/useStacSearch.test.ts

@@ -13,6 +13,30 @@ function parseRequestPayload(mockApiCall?: RequestInit) {
 describe('useStacSearch — API supports POST', () => {
   beforeEach(() => fetch.resetMocks());
 
+  it('includes IDs in search', async () => {
+    fetch
+      .mockResponseOnce(
+        JSON.stringify({ links: [{ rel: 'search', method: 'POST' }] }),
+        { url: 'https://fake-stac-api.net' }
+      )
+      .mockResponseOnce(JSON.stringify({ data: '12345' }));
+
+    const { result, waitForNextUpdate } = renderHook(
+      () => useStacSearch(),
+      { wrapper }
+    );
+    await waitForNextUpdate();
+
+    act(() => result.current.setIds(['collection_1', 'collection_2']));
+    act(() => result.current.submit());
+    
+    await waitForNextUpdate();
+
+    const postPayload = parseRequestPayload(fetch.mock.calls[1][1]);
+    expect(postPayload).toEqual({ ids: ['collection_1', 'collection_2'], limit: 25 });
+    expect(result.current.results).toEqual({ data: '12345' });
+  });
+
   it('includes Bbox in search', async () => {
     fetch
       .mockResponseOnce(

src/hooks/useStacSearch.ts

@@ -14,6 +14,8 @@ import { useStacApiContext } from '../context';
 type PaginationHandler = () => void;
 
 type StacSearchHook = {
+  ids?: string[]
+  setIds: (ids: string[]) => void
   bbox?: Bbox
   setBbox: (bbox: Bbox) => void
   collections?: CollectionIdList
@@ -33,6 +35,7 @@ type StacSearchHook = {
 function useStacSearch(): StacSearchHook {
   const { stacApi } = useStacApiContext();
   const [ results, setResults ] = useState<SearchResponse>();
+  const [ ids, setIds ] = useState<string[]>();
   const [ bbox, setBbox ] = useState<Bbox>();
   const [ collections, setCollections ] = useState<CollectionIdList>();
   const [ dateRangeFrom, setDateRangeFrom ] = useState<string>('');
@@ -47,6 +50,7 @@ function useStacSearch(): StacSearchHook {
     setResults(undefined);
     setBbox(undefined);
     setCollections(undefined);
+    setIds(undefined);
     setDateRangeFrom('');
     setDateRangeTo('');
   };
@@ -71,11 +75,12 @@ function useStacSearch(): StacSearchHook {
    */
   const getSearchPayload = useCallback(
     () => ({
+      ids,
       bbox,
       collections,
       dateRange: { from: dateRangeFrom, to: dateRangeTo }
     }),
-    [ bbox, collections, dateRangeFrom, dateRangeTo ]
+    [ ids, bbox, collections, dateRangeFrom, dateRangeTo ]
   );
 
   /**
@@ -161,6 +166,8 @@ function useStacSearch(): StacSearchHook {
 
   return {
     submit,
+    ids,
+    setIds,
     bbox,
     setBbox,
     collections,

src/stac-api/index.ts

@@ -1,5 +1,5 @@
 import type { ApiError, GenericObject } from '../types';
-import type { Bbox, SearchPayload, DateRange, CollectionIdList } from '../types/stac';
+import type { Bbox, SearchPayload, DateRange } from '../types/stac';
 
 type RequestPayload = SearchPayload;
 type FetchOptions = {
@@ -45,8 +45,8 @@ class StacApi {
     return sortedBbox;
   }
 
-  makeCollectionsPayload(collections?: CollectionIdList) {
-    return collections?.length ? collections : undefined;
+  makeArrayPayload(arr?: any[]) { /* eslint-disable-line @typescript-eslint/no-explicit-any */
+    return arr?.length ? arr : undefined;
   }
 
   makeDatetimePayload(dateRange?: DateRange): string | undefined {
@@ -116,10 +116,11 @@ class StacApi {
   }
 
   search(payload: SearchPayload, headers = {}): Promise<Response> {
-    const { bbox, dateRange, collections, ...restPayload } = payload;
+    const { ids, bbox, dateRange, collections, ...restPayload } = payload;
     const requestPayload = {
       ...restPayload,
-      collections: this.makeCollectionsPayload(collections),
+      ids: this.makeArrayPayload(ids),
+      collections: this.makeArrayPayload(collections),
       bbox: this.fixBboxCoordinateOrder(bbox),
       datetime: this.makeDatetimePayload(dateRange),
       limit: 25

src/types/stac.d.ts

@@ -2,13 +2,15 @@ import type { Geometry } from 'geojson';
 import type { GenericObject } from '.';
 
 export type Bbox = [number, number, number, number];
+export type IdList = string[];
 export type CollectionIdList = string[];
 export type DateRange = {
   from?: string,
   to?: string
 }
 
 export type SearchPayload = {
+  ids?: IdList,
   bbox?: Bbox,
   collections?: CollectionIdList,
   dateRange?: DateRange,