sfeos-helpers 6.7.5__py3-none-any.whl → 6.8.0__py3-none-any.whl

{sfeos_helpers-6.7.5.dist-info → sfeos_helpers-6.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sfeos_helpers
-Version: 6.7.5
+Version: 6.8.0
 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.5
+Requires-Dist: stac-fastapi-core==6.8.0
 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.5.dist-info → sfeos_helpers-6.8.0.dist-info}/RECORD

@@ -1,22 +1,22 @@
-stac_fastapi/sfeos_helpers/mappings.py,sha256=AikPY20F7cqbiHHkFEmWdMtxruhfNJbYK7hugKq7qTQ,8602
-stac_fastapi/sfeos_helpers/version.py,sha256=WRUWk2u8pozjztw-4p6a3fAkitIN0nGhe4tLZ6P6xUk,45
+stac_fastapi/sfeos_helpers/mappings.py,sha256=uzgwm-JTTLU_yti6YsjDBk790AuReF5YavLTrp4Otx0,8645
+stac_fastapi/sfeos_helpers/version.py,sha256=ib-H9zXMsXhMlZkHut5gkqf27FPYcv0_wBkKUIXnJbA,45
 stac_fastapi/sfeos_helpers/aggregation/README.md,sha256=SDlvCOpKyaJrlJvx84T2RzCnGALe_PK51zNeo3RP9ac,2122
 stac_fastapi/sfeos_helpers/aggregation/__init__.py,sha256=Mym17lFh90by1GnoQgMyIKAqRNJnvCgVSXDYzjBiPQk,1210
 stac_fastapi/sfeos_helpers/aggregation/client.py,sha256=PPUk0kAZnms46FlLGrR5w8wa52vG-dT6BG37896R5CY,17939
 stac_fastapi/sfeos_helpers/aggregation/format.py,sha256=qUW1jjh2EEjy-V7riliFR77grpi-AgsTmP76z60K5Lo,2011
 stac_fastapi/sfeos_helpers/database/README.md,sha256=TVYFDD4PqDD57ZsWBv4i4LawaL_DAEIOjM6OQuqwLAU,4049
 stac_fastapi/sfeos_helpers/database/__init__.py,sha256=Kvnz8hpXq_sSz8K5OW3PoPsvh9864Vv1zWhI5hxgd4o,2891
-stac_fastapi/sfeos_helpers/database/datetime.py,sha256=XHS5mg9NXUi2P0FtBpjTjy-g7nRzCtFgp3juq6Fr1_M,6831
+stac_fastapi/sfeos_helpers/database/datetime.py,sha256=LMh8dFjifpjfB_IKvOqQ7bQWMy4SXAYvWaLHMsad4tg,6806
 stac_fastapi/sfeos_helpers/database/document.py,sha256=LtjX15gvaOuZC_k2t_oQhys_c-zRTLN5rwX0hNJkHnM,1725
 stac_fastapi/sfeos_helpers/database/index.py,sha256=g7_sKfd5XUwq4IhdKRNiasejk045dKlullsdeDSZTq8,6585
-stac_fastapi/sfeos_helpers/database/mapping.py,sha256=4-MSd4xH5wg7yoC4aPjzYMDSEvP026bw4k2TfffMT5E,1387
+stac_fastapi/sfeos_helpers/database/mapping.py,sha256=4vGUuBLGoBOkQ984pYOciiz9UUWb4sbZyt-iViIsmdM,3809
 stac_fastapi/sfeos_helpers/database/query.py,sha256=bbSYe0cLC7oFbhkHR5WTKCF7Ca9iZI3fdanD90KYN98,9476
 stac_fastapi/sfeos_helpers/database/utils.py,sha256=CLtZgoUT37oklc9MsExXsxDviv4bzK-ZP7oxAOXS32Y,11780
 stac_fastapi/sfeos_helpers/filter/README.md,sha256=Rb5qHmDkI-7-o3I82Lb_zfmrviqUj958wef021xI6pQ,1955
 stac_fastapi/sfeos_helpers/filter/__init__.py,sha256=n3zL_MhEGOoxMz1KeijyK_UKiZ0MKPl90zHtYI5RAy8,1557
-stac_fastapi/sfeos_helpers/filter/client.py,sha256=QZP0Dm_T7SoMdR65IOjFmKBW7Rphr4z2xPgozZ93TPs,5339
+stac_fastapi/sfeos_helpers/filter/client.py,sha256=_LX3mlW9MYhoMGxvyi7Eg-LJICElQXYGbzzhSPXYRtw,6517
 stac_fastapi/sfeos_helpers/filter/cql2.py,sha256=Cg9kRYD9CVkVSyRqOyB5oVXmlyteSn2bw88sqklGpUM,955
-stac_fastapi/sfeos_helpers/filter/transform.py,sha256=-hslJ1MUNssEnaMyTknVUMCbaTnR--yvkd4D2CmUEr4,5171
+stac_fastapi/sfeos_helpers/filter/transform.py,sha256=wu6t7jbhgK9JIROQ5W82sAyCn6lHnBwuoQzb6o63luI,5725
 stac_fastapi/sfeos_helpers/models/patch.py,sha256=s5n85ktnH6M2SMqpqyItR8uLxliXmnSTg1WO0QLVsmI,3127
 stac_fastapi/sfeos_helpers/search_engine/__init__.py,sha256=Bi0cAtul3FuLjFceTPtEcaWNBfmUX5vKaqDvbSUAm0o,754
 stac_fastapi/sfeos_helpers/search_engine/base.py,sha256=9KOLW3NjW9PzWQzqLuhIjQU7FOHdDnB3ZNwDq469JZU,1400
@@ -26,9 +26,9 @@ stac_fastapi/sfeos_helpers/search_engine/inserters.py,sha256=o-I_4OowMJetMwRFPdq
 stac_fastapi/sfeos_helpers/search_engine/managers.py,sha256=nldomKmw8iQfOxeGZbBRGG_rWk-vB5Hy_cOjJ2e0ArE,6454
 stac_fastapi/sfeos_helpers/search_engine/selection/__init__.py,sha256=qKd4KzZkERwF_yhIeFcjAUnq5vQarr3CuXxE3SWmt6c,441
 stac_fastapi/sfeos_helpers/search_engine/selection/base.py,sha256=106c4FK50cgMmTpPJkWdgbExPkU2yIH4Wq684Ww-fYE,859
-stac_fastapi/sfeos_helpers/search_engine/selection/cache_manager.py,sha256=5yrgf9JA4mgRNMPDKih6xySF8mD724lEWnXhWud7m2c,4039
+stac_fastapi/sfeos_helpers/search_engine/selection/cache_manager.py,sha256=jG5XYWocCfhMgopA0bknGdw6R6zZ1cjanlX2554TFTA,4039
 stac_fastapi/sfeos_helpers/search_engine/selection/factory.py,sha256=vbgNVCUW2lviePqzpgsPLxp6IEqcX3GHiahqN2oVObA,1305
 stac_fastapi/sfeos_helpers/search_engine/selection/selectors.py,sha256=q83nfCfNfLUqtkHpORwNHNRU9Pa-heeaDIPO0RlHb-8,4779
-sfeos_helpers-6.7.5.dist-info/METADATA,sha256=Uc87_remruIvFaSeGvZLSNhU-4RENX1f2E1DKK00ys8,3114
-sfeos_helpers-6.7.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-sfeos_helpers-6.7.5.dist-info/RECORD,,
+sfeos_helpers-6.8.0.dist-info/METADATA,sha256=muFxhUPRtjlWPHqaQgIIcCUpaSKfLGz-WYiz8RwXIpA,3114
+sfeos_helpers-6.8.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+sfeos_helpers-6.8.0.dist-info/RECORD,,

{sfeos_helpers-6.7.5.dist-info → sfeos_helpers-6.8.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

stac_fastapi/sfeos_helpers/database/datetime.py

@@ -53,12 +53,12 @@ def return_date(
             if "/" in interval:
                 parts = interval.split("/")
                 result["gte"] = (
-                    parts[0] if parts[0] != ".." else MIN_DATE_NANOS.isoformat() + "Z"
+                    parts[0] if parts[0] != ".." else MIN_DATE_NANOS.isoformat()
                 )
                 result["lte"] = (
                     parts[1]
                     if len(parts) > 1 and parts[1] != ".."
-                    else MAX_DATE_NANOS.isoformat() + "Z"
+                    else MAX_DATE_NANOS.isoformat()
                 )
             else:
                 converted_time = interval if interval != ".." else None
@@ -75,7 +75,7 @@ def return_date(
                 dt_utc = MIN_DATE_NANOS
             elif dt_utc > MAX_DATE_NANOS:
                 dt_utc = MAX_DATE_NANOS
-            datetime_iso = dt_utc.isoformat()
+            datetime_iso = dt_utc.isoformat().replace("+00:00", "Z")
             result["gte"] = result["lte"] = datetime_iso
         elif isinstance(interval, tuple):
             start, end = interval
@@ -90,7 +90,7 @@ def return_date(
                     start_utc = MIN_DATE_NANOS
                 elif start_utc > MAX_DATE_NANOS:
                     start_utc = MAX_DATE_NANOS
-                result["gte"] = start_utc.strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z"
+                result["gte"] = start_utc.isoformat().replace("+00:00", "Z")
             if end:
                 end_utc = (
                     end.astimezone(timezone.utc)
@@ -101,7 +101,7 @@ def return_date(
                     end_utc = MIN_DATE_NANOS
                 elif end_utc > MAX_DATE_NANOS:
                     end_utc = MAX_DATE_NANOS
-                result["lte"] = end_utc.strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z"
+                result["lte"] = end_utc.isoformat().replace("+00:00", "Z")
 
         return result
 
@@ -131,9 +131,9 @@ def return_date(
             start, end = interval
             # Ensure datetimes are converted to UTC and formatted with 'Z'
             if start:
-                result["gte"] = start.strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z"
+                result["gte"] = start.isoformat().replace("+00:00", "Z")
             if end:
-                result["lte"] = end.strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z"
+                result["lte"] = end.isoformat().replace("+00:00", "Z")
 
         return result
 

stac_fastapi/sfeos_helpers/database/mapping.py

@@ -3,14 +3,62 @@
 This module provides functions for working with Elasticsearch/OpenSearch mappings.
 """
 
-from typing import Any, Dict
+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 = "*"
+    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.
@@ -20,19 +68,44 @@ async def get_queryables_mapping_shared(
 
     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.
+            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():
-        fields = mapping["mappings"].get("properties", {})
-        properties = fields.pop("properties", {}).get("properties", {}).keys()
+        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
 
-        for field_key in fields:
-            queryables_mapping[field_key] = field_key
+            field_name = field_fqn.removeprefix("properties.")
 
-        for property_key in properties:
-            queryables_mapping[property_key] = f"properties.{property_key}"
+            queryables_mapping[field_name] = field_fqn
 
     return queryables_mapping

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,

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]:

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",

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:

stac_fastapi/sfeos_helpers/version.py

@@ -1,2 +1,2 @@
 """library version."""
-__version__ = "6.7.5"
+__version__ = "6.8.0"