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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sfeos_helpers
-Version: 6.8.0
+Version: 6.9.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.8.0
+Requires-Dist: stac-fastapi-core==6.9.0
 Description-Content-Type: text/markdown
 
 # sfeos-helpers

{sfeos_helpers-6.8.0.dist-info → sfeos_helpers-6.9.0.dist-info}/RECORD

@@ -1,14 +1,14 @@
-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/mappings.py,sha256=NTa2xMYLtF43qWEmCHuAVgC2mihgv2UKdwg_iv9I5KE,12952
+stac_fastapi/sfeos_helpers/version.py,sha256=Zec8murh7xqMR7l6fB74XJcq2QdyNqRgOdhLMwBYPAI,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/client.py,sha256=5aMZPMBbkS17QGLnuDCp9MyAeMj-Z3AOkzZ_JCRNohk,17921
 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=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/index.py,sha256=fddGwVJ3D5zuVj2DyTCujGk_hCXCV4ATCZRxAblo29s,6750
 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
@@ -17,11 +17,11 @@ stac_fastapi/sfeos_helpers/filter/__init__.py,sha256=n3zL_MhEGOoxMz1KeijyK_UKiZ0
 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=wu6t7jbhgK9JIROQ5W82sAyCn6lHnBwuoQzb6o63luI,5725
-stac_fastapi/sfeos_helpers/models/patch.py,sha256=s5n85ktnH6M2SMqpqyItR8uLxliXmnSTg1WO0QLVsmI,3127
+stac_fastapi/sfeos_helpers/models/patch.py,sha256=krgopR6UvRV7NthfO61OwjDw9q2OHNLlk6WWaUyBrwk,3113
 stac_fastapi/sfeos_helpers/search_engine/__init__.py,sha256=Bi0cAtul3FuLjFceTPtEcaWNBfmUX5vKaqDvbSUAm0o,754
 stac_fastapi/sfeos_helpers/search_engine/base.py,sha256=9KOLW3NjW9PzWQzqLuhIjQU7FOHdDnB3ZNwDq469JZU,1400
 stac_fastapi/sfeos_helpers/search_engine/factory.py,sha256=nPty3L8esypSVIzl5IKfmqQ1hVUIjMQ183Ksistr1bM,1066
-stac_fastapi/sfeos_helpers/search_engine/index_operations.py,sha256=mYt1C2HEdwtslNwRHiZkvYTWQSZDwBBnKo5YJXfxnDo,5565
+stac_fastapi/sfeos_helpers/search_engine/index_operations.py,sha256=E4ipJVhAW_asah9QN-Coc2T0ir9rsPK6scDDt4jcdUA,5820
 stac_fastapi/sfeos_helpers/search_engine/inserters.py,sha256=o-I_4OowMJetMwRFPdq8Oix_DAkMNGBw4fYyoa5W6s0,10562
 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
@@ -29,6 +29,6 @@ stac_fastapi/sfeos_helpers/search_engine/selection/base.py,sha256=106c4FK50cgMmT
 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.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.9.0.dist-info/METADATA,sha256=yuWwHyz0TyeDHyyetqj7eqhQ-FoflATvVQqIPsXzalI,3114
+sfeos_helpers-6.9.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+sfeos_helpers-6.9.0.dist-info/RECORD,,

stac_fastapi/sfeos_helpers/aggregation/client.py

@@ -1,12 +1,12 @@
 """Client implementation for the STAC API Aggregation Extension."""
 
-from pathlib import Path
+
 from typing import Annotated, Any, Dict, List, Optional, Union
 from urllib.parse import unquote_plus, urljoin
 
 import attr
 import orjson
-from fastapi import HTTPException, Request
+from fastapi import HTTPException, Path, Request
 from pygeofilter.backends.cql2_json import to_cql2
 from pygeofilter.parsers.cql2_text import parse as parse_cql2_text
 from stac_pydantic.shared import BBox

stac_fastapi/sfeos_helpers/database/index.py

@@ -177,7 +177,12 @@ async def delete_item_index_shared(settings: Any, collection_id: str) -> None:
     client = settings.create_client
 
     name = index_alias_by_collection_id(collection_id)
-    resolved = await client.indices.resolve_index(name=name, ignore=[404])
+    if hasattr(client, "options"):
+        resolved = await client.options(ignore_status=[404]).indices.resolve_index(
+            name=name
+        )
+    else:
+        resolved = await client.indices.resolve_index(name=name, ignore=[404])
     if "aliases" in resolved and resolved["aliases"]:
         [alias] = resolved["aliases"]
         await client.indices.delete_alias(index=alias["indices"], name=alias["name"])

stac_fastapi/sfeos_helpers/mappings.py

@@ -25,11 +25,135 @@ Function Naming Conventions:
 - Parameter names should be consistent across similar functions
 """
 
+import copy
+import json
+import logging
 import os
-from typing import Any, Dict, Literal, Protocol
+from typing import Any, Dict, Literal, Optional, Protocol, Union
 
 from stac_fastapi.core.utilities import get_bool_env
 
+logger = logging.getLogger(__name__)
+
+
+def merge_mappings(base: Dict[str, Any], custom: Dict[str, Any]) -> None:
+    """Recursively merge custom mappings into base mappings.
+
+    Custom mappings will overwrite base mappings if keys collide.
+    Nested dictionaries are merged recursively.
+
+    Args:
+        base: The base mapping dictionary to merge into (modified in place).
+        custom: The custom mapping dictionary to merge from.
+    """
+    for key, value in custom.items():
+        if key in base and isinstance(base[key], dict) and isinstance(value, dict):
+            merge_mappings(base[key], value)
+        else:
+            base[key] = value
+
+
+def parse_dynamic_mapping_config(
+    config_value: Optional[str],
+) -> Union[bool, str]:
+    """Parse the dynamic mapping configuration value.
+
+    Args:
+        config_value: The configuration value from environment variable.
+            Can be "true", "false", "strict", or None.
+
+    Returns:
+        True for "true" (default), False for "false", or the string value
+        for other settings like "strict".
+    """
+    if config_value is None:
+        return True
+    config_lower = config_value.lower()
+    if config_lower == "true":
+        return True
+    elif config_lower == "false":
+        return False
+    else:
+        return config_lower
+
+
+def apply_custom_mappings(
+    mappings: Dict[str, Any], custom_mappings_json: Optional[str]
+) -> None:
+    """Apply custom mappings from a JSON string to the mappings dictionary.
+
+    The custom mappings JSON should have the same structure as ES_ITEMS_MAPPINGS.
+    It will be recursively merged at the root level, allowing users to override
+    any part of the mapping including properties, dynamic_templates, etc.
+
+    Args:
+        mappings: The mappings dictionary to modify (modified in place).
+        custom_mappings_json: JSON string containing custom mappings.
+
+    Raises:
+        Logs error if JSON parsing or merging fails.
+    """
+    if not custom_mappings_json:
+        return
+
+    try:
+        custom_mappings = json.loads(custom_mappings_json)
+        merge_mappings(mappings, custom_mappings)
+    except json.JSONDecodeError as e:
+        logger.error(f"Failed to parse STAC_FASTAPI_ES_CUSTOM_MAPPINGS JSON: {e}")
+    except Exception as e:
+        logger.error(f"Failed to merge STAC_FASTAPI_ES_CUSTOM_MAPPINGS: {e}")
+
+
+def get_items_mappings(
+    dynamic_mapping: Optional[str] = None, custom_mappings: Optional[str] = None
+) -> Dict[str, Any]:
+    """Get the ES_ITEMS_MAPPINGS with optional dynamic mapping and custom mappings applied.
+
+    This function creates a fresh copy of the base mappings and applies the
+    specified configuration. Useful for testing or programmatic configuration.
+
+    Args:
+        dynamic_mapping: Override for STAC_FASTAPI_ES_DYNAMIC_MAPPING.
+            If None, reads from environment variable.
+        custom_mappings: Override for STAC_FASTAPI_ES_CUSTOM_MAPPINGS.
+            If None, reads from environment variable.
+
+    Returns:
+        A new dictionary containing the configured mappings.
+    """
+    mappings = copy.deepcopy(_BASE_ITEMS_MAPPINGS)
+
+    # Apply dynamic mapping configuration
+    dynamic_config = (
+        dynamic_mapping
+        if dynamic_mapping is not None
+        else os.getenv("STAC_FASTAPI_ES_DYNAMIC_MAPPING", "true")
+    )
+    mappings["dynamic"] = parse_dynamic_mapping_config(dynamic_config)
+
+    # Apply custom mappings
+    custom_config = (
+        custom_mappings
+        if custom_mappings is not None
+        else os.getenv("STAC_FASTAPI_ES_CUSTOM_MAPPINGS")
+    )
+
+    if custom_config is None:
+        mappings_file = os.getenv("STAC_FASTAPI_ES_MAPPINGS_FILE")
+        if mappings_file:
+            try:
+                with open(mappings_file, "r") as f:
+                    custom_config = f.read()
+            except Exception as e:
+                logger.error(
+                    f"Failed to read STAC_FASTAPI_ES_MAPPINGS_FILE at {mappings_file}: {e}"
+                )
+
+    apply_custom_mappings(mappings, custom_config)
+
+    return mappings
+
 
 # stac_pydantic classes extend _GeometryBase, which doesn't have a type field,
 # So create our own Protocol for typing
@@ -129,7 +253,8 @@ ES_MAPPINGS_DYNAMIC_TEMPLATES = [
     },
 ]
 
-ES_ITEMS_MAPPINGS = {
+# Base items mappings without dynamic configuration applied
+_BASE_ITEMS_MAPPINGS = {
     "numeric_detection": False,
     "dynamic_templates": ES_MAPPINGS_DYNAMIC_TEMPLATES,
     "properties": {
@@ -155,6 +280,9 @@ ES_ITEMS_MAPPINGS = {
     },
 }
 
+# ES_ITEMS_MAPPINGS with environment-based configuration applied at module load time
+ES_ITEMS_MAPPINGS = get_items_mappings()
+
 ES_COLLECTIONS_MAPPINGS = {
     "numeric_detection": False,
     "dynamic_templates": ES_MAPPINGS_DYNAMIC_TEMPLATES,

stac_fastapi/sfeos_helpers/models/patch.py

@@ -3,7 +3,7 @@
 import re
 from typing import Any, Dict, Optional, Union
 
-from pydantic import BaseModel, model_validator
+from pydantic import BaseModel, ConfigDict, model_validator
 
 regex = re.compile(r"([^.' ]*:[^.'[ ]*)\.?")
 replacements = str.maketrans({"/": "", ".": "", ":": "", "[": "", "]": ""})
@@ -84,10 +84,7 @@ class ElasticPath(BaseModel):
     variable_name: Optional[str] = None
     param_key: Optional[str] = None
 
-    class Config:
-        """Class config."""
-
-        frozen = True
+    model_config = ConfigDict(frozen=True)
 
     @model_validator(mode="before")
     @classmethod

stac_fastapi/sfeos_helpers/search_engine/index_operations.py

@@ -31,11 +31,17 @@ class IndexOperations:
         index_name = f"{index_by_collection_id(collection_id)}-000001"
         alias_name = index_alias_by_collection_id(collection_id)
 
-        await client.indices.create(
-            index=index_name,
-            body=self._create_index_body({alias_name: {}}),
-            params={"ignore": [400]},
-        )
+        if hasattr(client, "options"):
+            await client.options(ignore_status=[400]).indices.create(
+                index=index_name,
+                body=self._create_index_body({alias_name: {}}),
+            )
+        else:
+            await client.indices.create(
+                index=index_name,
+                body=self._create_index_body({alias_name: {}}),
+                params={"ignore": [400]},
+            )
         return index_name
 
     async def create_datetime_index(

stac_fastapi/sfeos_helpers/version.py

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