sfeos-helpers 6.7.6__tar.gz → 6.8.1__tar.gz

{sfeos_helpers-6.7.6 → sfeos_helpers-6.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sfeos_helpers
-Version: 6.7.6
+Version: 6.8.1
 Summary: Helper library for the Elasticsearch and Opensearch stac-fastapi backends.
 Project-URL: Homepage, https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch
 License: MIT
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.11
-Requires-Dist: stac-fastapi-core==6.7.6
+Requires-Dist: stac-fastapi-core==6.8.1
 Description-Content-Type: text/markdown
 
 # sfeos-helpers
@@ -29,7 +29,7 @@ Description-Content-Type: text/markdown
   [![GitHub forks](https://img.shields.io/github/forks/stac-utils/stac-fastapi-elasticsearch-opensearch.svg?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/network/members)
    [![PyPI version](https://img.shields.io/pypi/v/stac-fastapi-elasticsearch.svg?color=blue)](https://pypi.org/project/stac-fastapi-elasticsearch/)
   [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0)
-  [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-6.0.0-blue.svg)](https://github.com/stac-utils/stac-fastapi)
+  [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-6.1.1-blue.svg)](https://github.com/stac-utils/stac-fastapi)
 
 Helper utilities for the stac-fastapi project. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md).
 

{sfeos_helpers-6.7.6 → sfeos_helpers-6.8.1}/README.md

@@ -10,7 +10,7 @@
   [![GitHub forks](https://img.shields.io/github/forks/stac-utils/stac-fastapi-elasticsearch-opensearch.svg?color=blue)](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/network/members)
    [![PyPI version](https://img.shields.io/pypi/v/stac-fastapi-elasticsearch.svg?color=blue)](https://pypi.org/project/stac-fastapi-elasticsearch/)
   [![STAC](https://img.shields.io/badge/STAC-1.1.0-blue.svg)](https://github.com/radiantearth/stac-spec/tree/v1.1.0)
-  [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-6.0.0-blue.svg)](https://github.com/stac-utils/stac-fastapi)
+  [![stac-fastapi](https://img.shields.io/badge/stac--fastapi-6.1.1-blue.svg)](https://github.com/stac-utils/stac-fastapi)
 
 Helper utilities for the stac-fastapi project. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md).
 

{sfeos_helpers-6.7.6 → sfeos_helpers-6.8.1}/pyproject.toml

@@ -29,7 +29,7 @@ keywords = [
 ]
 dynamic = ["version"]
 dependencies = [
-    "stac-fastapi.core==6.7.6",
+    "stac-fastapi.core==6.8.1",
 ]
 
 [project.urls]

sfeos_helpers-6.8.1/stac_fastapi/sfeos_helpers/database/mapping.py

@@ -0,0 +1,111 @@
+"""Mapping functions for Elasticsearch/OpenSearch.
+
+This module provides functions for working with Elasticsearch/OpenSearch mappings.
+"""
+
+import os
+from collections import deque
+from typing import Any, Dict, Set
+
+
+def _get_excluded_from_queryables() -> Set[str]:
+    """Get fields to exclude from queryables endpoint and filtering.
+
+    Reads from EXCLUDED_FROM_QUERYABLES environment variable.
+    Supports comma-separated list of field names.
+
+    For each exclusion pattern, both the original and the version with/without
+    'properties.' prefix are included. This ensures fields are excluded regardless
+    of whether they appear at the top level or under 'properties' in the mapping.
+
+    Example:
+        EXCLUDED_FROM_QUERYABLES="properties.auth:schemes,storage:schemes"
+
+        This will exclude:
+        - properties.auth:schemes (and children like properties.auth:schemes.s3.type)
+        - auth:schemes (and children like auth:schemes.s3.type)
+        - storage:schemes (and children)
+        - properties.storage:schemes (and children)
+
+    Returns:
+        Set[str]: Set of field names to exclude from queryables
+    """
+    excluded = os.getenv("EXCLUDED_FROM_QUERYABLES", "")
+    if not excluded:
+        return set()
+
+    result = set()
+    for field in excluded.split(","):
+        field = field.strip()
+        if not field:
+            continue
+
+        result.add(field)
+
+        if field.startswith("properties."):
+            result.add(field.removeprefix("properties."))
+        else:
+            result.add(f"properties.{field}")
+
+    return result
+
+
+async def get_queryables_mapping_shared(
+    mappings: Dict[str, Dict[str, Any]],
+    collection_id: str = "*",
+) -> Dict[str, str]:
+    """Retrieve mapping of Queryables for search.
+
+    Fields listed in the EXCLUDED_FROM_QUERYABLES environment variable will be
+    excluded from the result, along with their children.
+
+    Args:
+        mappings (Dict[str, Dict[str, Any]]): The mapping information returned from
+            Elasticsearch/OpenSearch client's indices.get_mapping() method.
+            Expected structure is {index_name: {"mappings": {...}}}.
+        collection_id (str, optional): The id of the Collection the Queryables
+            belongs to. Defaults to "*".
+
+    Returns:
+        Dict[str, str]: A dictionary containing the Queryables mappings, where keys are
+            field names (with 'properties.' prefix removed) and values are the
+            corresponding paths in the Elasticsearch/OpenSearch document structure.
+    """
+    queryables_mapping = {}
+    excluded = _get_excluded_from_queryables()
+
+    def is_excluded(path: str) -> bool:
+        """Check if the path starts with any excluded prefix."""
+        return any(
+            path == prefix or path.startswith(prefix + ".") for prefix in excluded
+        )
+
+    for mapping in mappings.values():
+        mapping_properties = mapping["mappings"].get("properties", {})
+
+        stack: deque[tuple[str, Dict[str, Any]]] = deque(mapping_properties.items())
+
+        while stack:
+            field_fqn, field_def = stack.popleft()
+
+            nested_properties = field_def.get("properties")
+            if nested_properties:
+                stack.extend(
+                    (f"{field_fqn}.{k}", v)
+                    for k, v in nested_properties.items()
+                    if v.get("enabled", True) and not is_excluded(f"{field_fqn}.{k}")
+                )
+
+            field_type = field_def.get("type")
+            if (
+                not field_type
+                or not field_def.get("enabled", True)
+                or is_excluded(field_fqn)
+            ):
+                continue
+
+            field_name = field_fqn.removeprefix("properties.")
+
+            queryables_mapping[field_name] = field_fqn
+
+    return queryables_mapping

{sfeos_helpers-6.7.6 → sfeos_helpers-6.8.1}/stac_fastapi/sfeos_helpers/filter/client.py

@@ -26,8 +26,12 @@ class EsAsyncBaseFiltersClient(AsyncBaseFiltersClient):
         Reads from EXCLUDED_FROM_QUERYABLES environment variable.
         Supports comma-separated list of field names.
 
+        For each exclusion pattern, both the original and the version with/without
+        'properties.' prefix are included. This ensures fields are excluded regardless
+        of whether they appear at the top level or under 'properties' in the mapping.
+
         Example:
-            EXCLUDED_FROM_QUERYABLES="auth:schemes,storage:schemes"
+            EXCLUDED_FROM_QUERYABLES="properties.auth:schemes,storage:schemes"
 
         Returns:
             Set[str]: Set of field names to exclude from queryables
@@ -35,7 +39,41 @@ class EsAsyncBaseFiltersClient(AsyncBaseFiltersClient):
         excluded = os.getenv("EXCLUDED_FROM_QUERYABLES", "")
         if not excluded:
             return set()
-        return {field.strip() for field in excluded.split(",") if field.strip()}
+
+        result = set()
+        for field in excluded.split(","):
+            field = field.strip()
+            if not field:
+                continue
+
+            result.add(field)
+
+            if field.startswith("properties."):
+                result.add(field.removeprefix("properties."))
+            else:
+                result.add(f"properties.{field}")
+
+        return result
+
+    @staticmethod
+    def _is_excluded(field_fqn: str, excluded: set[str]) -> bool:
+        """Check if a field should be excluded based on prefix matching.
+
+        A field is excluded if:
+        - It exactly matches an exclusion pattern
+        - It starts with an exclusion pattern followed by a dot (nested child)
+
+        Args:
+            field_fqn: Fully qualified field name (e.g., "properties.auth:schemes.s3.type")
+            excluded: Set of exclusion patterns
+
+        Returns:
+            True if field should be excluded, False otherwise
+        """
+        for prefix in excluded:
+            if field_fqn == prefix or field_fqn.startswith(prefix + "."):
+                return True
+        return False
 
     async def get_queryables(
         self,
@@ -92,23 +130,20 @@ class EsAsyncBaseFiltersClient(AsyncBaseFiltersClient):
         while stack:
             field_fqn, field_def = stack.popleft()
 
-            # Iterate over nested fields
+            if self._is_excluded(field_fqn, excluded_fields):
+                continue
+
             field_properties = field_def.get("properties")
             if field_properties:
                 stack.extend(
                     (f"{field_fqn}.{k}", v)
                     for k, v in field_properties.items()
                     if v.get("enabled", True)
-                    and f"{field_fqn}.{k}" not in excluded_fields
                 )
 
             # Skip non-indexed or disabled fields
             field_type = field_def.get("type")
-            if (
-                not field_type
-                or not field_def.get("enabled", True)
-                or field_fqn in excluded_fields
-            ):
+            if not field_type or not field_def.get("enabled", True):
                 continue
 
             # Fields in Item Properties should be exposed with their un-prefixed names,

{sfeos_helpers-6.7.6 → sfeos_helpers-6.8.1}/stac_fastapi/sfeos_helpers/filter/transform.py

@@ -22,7 +22,20 @@ def to_es_field(queryables_mapping: Dict[str, Any], field: str) -> str:
     Returns:
         str: The mapped field name suitable for Elasticsearch queries.
     """
-    return queryables_mapping.get(field, field)
+    # First, try to find the field as-is in the mapping
+    if field in queryables_mapping:
+        return queryables_mapping[field]
+
+    # If field has 'properties.' prefix, try without it
+    # This handles cases where users specify 'properties.eo:cloud_cover'
+    # but queryables_mapping uses 'eo:cloud_cover' as the key
+    if field.startswith("properties."):
+        normalized_field = field[11:]  # len("properties.") == 11
+        if normalized_field in queryables_mapping:
+            return queryables_mapping[normalized_field]
+
+    # If not found, return the original field
+    return field
 
 
 def to_es(queryables_mapping: Dict[str, Any], query: Dict[str, Any]) -> Dict[str, Any]:

{sfeos_helpers-6.7.6 → sfeos_helpers-6.8.1}/stac_fastapi/sfeos_helpers/mappings.py

@@ -160,6 +160,7 @@ ES_COLLECTIONS_MAPPINGS = {
     "dynamic_templates": ES_MAPPINGS_DYNAMIC_TEMPLATES,
     "properties": {
         "id": {"type": "keyword"},
+        "parent_ids": {"type": "keyword"},
         "bbox_shape": {"type": "geo_shape"},
         "extent.temporal.interval": {
             "type": "date",

{sfeos_helpers-6.7.6 → sfeos_helpers-6.8.1}/stac_fastapi/sfeos_helpers/search_engine/selection/cache_manager.py

@@ -12,7 +12,7 @@ from stac_fastapi.sfeos_helpers.mappings import ITEMS_INDEX_PREFIX
 class IndexCacheManager:
     """Manages caching of index aliases with expiration."""
 
-    def __init__(self, cache_ttl_seconds: int = 3600):
+    def __init__(self, cache_ttl_seconds: int = 1800):
         """Initialize the cache manager.
 
         Args:

{sfeos_helpers-6.7.6 → sfeos_helpers-6.8.1}/stac_fastapi/sfeos_helpers/version.py

@@ -1,2 +1,2 @@
 """library version."""
-__version__ = "6.7.6"
+__version__ = "6.8.1"

sfeos_helpers-6.7.6/stac_fastapi/sfeos_helpers/database/mapping.py

@@ -1,38 +0,0 @@
-"""Mapping functions for Elasticsearch/OpenSearch.
-
-This module provides functions for working with Elasticsearch/OpenSearch mappings.
-"""
-
-from typing import Any, Dict
-
-
-async def get_queryables_mapping_shared(
-    mappings: Dict[str, Dict[str, Any]], collection_id: str = "*"
-) -> Dict[str, str]:
-    """Retrieve mapping of Queryables for search.
-
-    Args:
-        mappings (Dict[str, Dict[str, Any]]): The mapping information returned from
-            Elasticsearch/OpenSearch client's indices.get_mapping() method.
-            Expected structure is {index_name: {"mappings": {...}}}.
-        collection_id (str, optional): The id of the Collection the Queryables
-            belongs to. Defaults to "*".
-
-    Returns:
-        Dict[str, str]: A dictionary containing the Queryables mappings, where keys are
-            field names and values are the corresponding paths in the Elasticsearch/OpenSearch
-            document structure.
-    """
-    queryables_mapping = {}
-
-    for mapping in mappings.values():
-        fields = mapping["mappings"].get("properties", {})
-        properties = fields.pop("properties", {}).get("properties", {}).keys()
-
-        for field_key in fields:
-            queryables_mapping[field_key] = field_key
-
-        for property_key in properties:
-            queryables_mapping[property_key] = f"properties.{property_key}"
-
-    return queryables_mapping