feat: support geo shape queries

src/protocol/search/filter.ts

@@ -19,6 +19,7 @@ import {SCMap} from '../../general/map';
 import {SCSearchAvailabilityFilter} from './filters/availability';
 import {SCSearchBooleanFilter} from './filters/boolean';
 import {SCSearchDistanceFilter} from './filters/distance';
+import {SCGeoFilter} from './filters/geo';
 import {SCSearchDateRangeFilter, SCSearchNumericRangeFilter} from './filters/range';
 import {SCSearchValueFilter} from './filters/value';
 
@@ -31,7 +32,8 @@ export type SCSearchFilterType =
   | 'distance'
   | 'value'
   | 'date range'
-  | 'numeric range';
+  | 'numeric range'
+  | 'geo';
 
 /**
  * Structure of a filter instruction
@@ -62,4 +64,5 @@ export type SCSearchFilter =
   | SCSearchDistanceFilter
   | SCSearchValueFilter
   | SCSearchNumericRangeFilter
-  | SCSearchDateRangeFilter;
+  | SCSearchDateRangeFilter
+  | SCGeoFilter;

src/protocol/search/filters/geo.ts

@@ -0,0 +1,55 @@
+/*
+ * Copyright (C) 2021 StApps
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation, version 3.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+// tslint:disable-next-line:no-implicit-dependencies
+import {Polygon} from 'geojson';
+import {SCThingsField} from '../../../meta';
+import {SCSearchAbstractFilter, SCSearchAbstractFilterArguments} from '../filter';
+
+/**
+ * A geo filter
+ *
+ * Filter for documents that are in relation to some geo data
+ */
+export interface SCGeoFilter extends SCSearchAbstractFilter<SCGeoFilterArguments> {
+  /**
+   * @see SCSearchAbstractFilter.type
+   */
+  type: 'geo';
+}
+
+/**
+ * Arguments for filter instruction by geo data
+ */
+export interface SCGeoFilterArguments extends SCSearchAbstractFilterArguments {
+  /**
+   * Field on which to filter
+   */
+  field: SCThingsField;
+
+  /**
+   * Geo data to check up on
+   */
+  shape: Polygon;
+
+  /**
+   * Spatial relation between the provided shape and the shape of the field.
+   *
+   * intersects - both shapes intersect (default)
+   * disjoint   - both shapes don't intersect
+   * within     - the search shape contains the field shape
+   * contains   - the search shape is contained in the field shape
+   */
+  spatialRelation?: 'intersects' | 'disjoint' | 'within' | 'contains';
+}