Merge pull request #224 from TurtIeSocks/exclude-api-args

feat: exclude query args

client/src/pages/Playground.tsx

@@ -107,6 +107,9 @@ const PARAMS = {
   underscore: 'string',
   dash: 'string',
   space: 'string',
+  exclude: 'string',
+  excludeparents: 'string',
+  excludeproperties: 'string',
   unpolish: 'boolean',
   ignoremanualparent: 'boolean',
 }

docs/pages/api-reference/params.mdx

@@ -69,6 +69,16 @@ pub struct ApiQueryArgs {
     /// If true, all non-alphanumeric characters are removed from the `name` property
     /// (excludes spaces, dashes, and underscores)
     pub alphanumeric: Option<bool>,
+    /// Exclude areas with the specified properties, no matter the value or type.
+    ///
+    /// Property keys separated by a comma
+    pub excludeproperties: Option<String>,
+    /// Excludes areas with the specified parent names
+    ///
+    /// A list of parents names separated by a comma that are to be excluded by the API query
+    pub excludeparents: Option<String>,
+    /// A list of names separated by a comma that are to be excluded by the API query
+    pub exclude: Option<String>,
 }
 ```
 

server/model/src/api/args.rs

@@ -98,6 +98,16 @@ pub struct ApiQueryArgs {
     /// If true, all non-alphanumeric characters are removed from the `name` property
     /// (excludes spaces, dashes, and underscores)
     pub alphanumeric: Option<bool>,
+    /// Exclude areas with the specified properties, no matter the value or type.
+    ///
+    /// Property keys separated by a comma
+    pub excludeproperties: Option<String>,
+    /// Excludes areas with the specified parent names
+    ///
+    /// A list of parents names separated by a comma that are to be excluded by the API query
+    pub excludeparents: Option<String>,
+    /// A list of names separated by a comma that are to be excluded by the API query
+    pub exclude: Option<String>,
 }
 
 impl Default for ApiQueryArgs {
@@ -128,6 +138,9 @@ impl Default for ApiQueryArgs {
             unpolish: None,
             ignoremanualparent: None,
             alphanumeric: None,
+            excludeproperties: None,
+            excludeparents: None,
+            exclude: None,
         }
     }
 }

server/model/src/db/geofence.rs

@@ -11,7 +11,7 @@ use crate::{
     error::ModelError,
     utils::{
         json::{determine_category_by_value, JsonToModel},
-        json_related_sort, name_modifier, parse_order,
+        json_related_sort, name_modifier, parse_order, separate_by_comma,
     },
 };
 
@@ -126,6 +126,7 @@ impl Model {
         args: &ApiQueryArgs,
     ) -> Result<Feature, ModelError> {
         let mut has_manual_parent = String::from("");
+
         let mut properties = if let Some(properties) = property_map.get(&self.id) {
             properties
                 .into_iter()
@@ -143,6 +144,19 @@ impl Model {
             vec![]
         };
 
+        if separate_by_comma(&args.exclude).contains(&self.name) {
+            return Err(ModelError::Geofence("Excluded name".to_string()));
+        }
+        if properties
+            .iter()
+            .find(|prop| {
+                separate_by_comma(&args.excludeproperties).contains(&prop.name.to_string())
+            })
+            .is_some()
+        {
+            return Err(ModelError::Geofence("Excluded property".to_string()));
+        }
+
         let parent_name = if has_manual_parent.is_empty() {
             if let Some(parent_id) = self.parent {
                 if let Some(name) = name_map.get(&parent_id) {
@@ -156,6 +170,15 @@ impl Model {
         } else {
             Some(has_manual_parent)
         };
+
+        if parent_name.is_some()
+            && separate_by_comma(&args.excludeparents)
+                .iter()
+                .any(|parent| parent_name.as_ref().unwrap().eq(parent))
+        {
+            return Err(ModelError::Geofence("Excluded parent".to_string()));
+        }
+
         if args.internal.unwrap_or(false) {
             properties.push(Basic {
                 name: "__id",

server/model/src/utils/mod.rs

@@ -227,6 +227,14 @@ pub fn json_related_sort(json: &mut Vec<serde_json::Value>, sort_by: &String, or
     });
 }
 
+pub fn separate_by_comma(param: &Option<String>) -> Vec<String> {
+    if let Some(param) = param {
+        param.split(",").map(|x| x.to_string()).collect()
+    } else {
+        vec![]
+    }
+}
+
 fn convert_polish_to_ascii(param: String) -> String {
     let polish_characters: [(char, char); 18] = [
         ('ą', 'a'),