stac-fastapi-opensearch 6.7.6__tar.gz → 6.8.0__tar.gz

{stac_fastapi_opensearch-6.7.6 → stac_fastapi_opensearch-6.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stac_fastapi_opensearch
-Version: 6.7.6
+Version: 6.8.0
 Summary: An implementation of STAC API based on the FastAPI framework with Opensearch.
 Project-URL: Homepage, https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch
 License: MIT
@@ -16,8 +16,8 @@ Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.11
 Requires-Dist: opensearch-py[async]~=2.8.0
 Requires-Dist: opensearch-py~=2.8.0
-Requires-Dist: sfeos-helpers==6.7.6
-Requires-Dist: stac-fastapi-core==6.7.6
+Requires-Dist: sfeos-helpers==6.8.0
+Requires-Dist: stac-fastapi-core==6.8.0
 Requires-Dist: starlette<0.36.0,>=0.35.0
 Requires-Dist: uvicorn~=0.23.0
 Provides-Extra: dev
@@ -29,13 +29,13 @@ Requires-Dist: pytest-cov~=4.0.0; extra == 'dev'
 Requires-Dist: pytest~=8.0; extra == 'dev'
 Requires-Dist: redis~=6.4.0; extra == 'dev'
 Requires-Dist: retry~=0.9.2; extra == 'dev'
-Requires-Dist: stac-fastapi-core[redis]==6.7.6; extra == 'dev'
+Requires-Dist: stac-fastapi-core[redis]==6.8.0; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: mkdocs-material~=9.0.0; extra == 'docs'
 Requires-Dist: mkdocs~=1.4.0; extra == 'docs'
 Requires-Dist: pdocs~=1.2.0; extra == 'docs'
 Provides-Extra: redis
-Requires-Dist: stac-fastapi-core[redis]==6.7.6; extra == 'redis'
+Requires-Dist: stac-fastapi-core[redis]==6.8.0; extra == 'redis'
 Provides-Extra: server
 Requires-Dist: uvicorn[standard]~=0.23.0; extra == 'server'
 Description-Content-Type: text/markdown
@@ -52,7 +52,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)
 
 This is the OpenSearch backend for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md).
 

{stac_fastapi_opensearch-6.7.6 → stac_fastapi_opensearch-6.8.0}/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)
 
 This is the OpenSearch backend for stac-fastapi. For full documentation, please see the [main README](https://github.com/stac-utils/stac-fastapi-elasticsearch-opensearch/blob/main/README.md).
 

{stac_fastapi_opensearch-6.7.6 → stac_fastapi_opensearch-6.8.0}/pyproject.toml

@@ -28,8 +28,8 @@ keywords = [
 ]
 dynamic = ["version"]
 dependencies = [
-    "stac-fastapi-core==6.7.6",
-    "sfeos-helpers==6.7.6",
+    "stac-fastapi-core==6.8.0",
+    "sfeos-helpers==6.8.0",
     "opensearch-py~=2.8.0",
     "opensearch-py[async]~=2.8.0",
     "uvicorn~=0.23.0",
@@ -49,7 +49,7 @@ dev = [
     "httpx>=0.24.0,<0.28.0",
     "redis~=6.4.0",
     "retry~=0.9.2",
-    "stac-fastapi-core[redis]==6.7.6",
+    "stac-fastapi-core[redis]==6.8.0",
 ]
 docs = [
     "mkdocs~=1.4.0",
@@ -57,7 +57,7 @@ docs = [
     "pdocs~=1.2.0",
 ]
 redis = [
-    "stac-fastapi-core[redis]==6.7.6",
+    "stac-fastapi-core[redis]==6.8.0",
 ]
 server = [
     "uvicorn[standard]~=0.23.0",

{stac_fastapi_opensearch-6.7.6 → stac_fastapi_opensearch-6.8.0}/stac_fastapi/opensearch/app.py

@@ -23,6 +23,7 @@ from stac_fastapi.core.extensions.aggregation import (
     EsAggregationExtensionGetRequest,
     EsAggregationExtensionPostRequest,
 )
+from stac_fastapi.core.extensions.catalogs import CatalogsExtension
 from stac_fastapi.core.extensions.collections_search import (
     CollectionsSearchEndpointExtension,
 )
@@ -65,11 +66,13 @@ ENABLE_COLLECTIONS_SEARCH = get_bool_env("ENABLE_COLLECTIONS_SEARCH", default=Tr
 ENABLE_COLLECTIONS_SEARCH_ROUTE = get_bool_env(
     "ENABLE_COLLECTIONS_SEARCH_ROUTE", default=False
 )
+ENABLE_CATALOGS_ROUTE = get_bool_env("ENABLE_CATALOGS_ROUTE", default=False)
 logger.info("TRANSACTIONS_EXTENSIONS is set to %s", TRANSACTIONS_EXTENSIONS)
 logger.info("ENABLE_COLLECTIONS_SEARCH is set to %s", ENABLE_COLLECTIONS_SEARCH)
 logger.info(
     "ENABLE_COLLECTIONS_SEARCH_ROUTE is set to %s", ENABLE_COLLECTIONS_SEARCH_ROUTE
 )
+logger.info("ENABLE_CATALOGS_ROUTE is set to %s", ENABLE_CATALOGS_ROUTE)
 
 settings = OpensearchSettings()
 session = Session.create_from_settings(settings)
@@ -201,6 +204,22 @@ if ENABLE_COLLECTIONS_SEARCH_ROUTE:
     extensions.append(collections_search_endpoint_ext)
 
 
+if ENABLE_CATALOGS_ROUTE:
+    catalogs_extension = CatalogsExtension(
+        client=CoreClient(
+            database=database_logic,
+            session=session,
+            post_request_model=collection_search_post_request_model,
+            landing_page_id=os.getenv("STAC_FASTAPI_LANDING_PAGE_ID", "stac-fastapi"),
+        ),
+        settings=settings,
+        conformance_classes=[
+            "https://api.stacspec.org/v1.0.0-beta.1/catalogs-endpoint",
+        ],
+    )
+    extensions.append(catalogs_extension)
+
+
 database_logic.extensions = [type(ext).__name__ for ext in extensions]
 
 post_request_model = create_post_request_model(search_extensions)
@@ -224,7 +243,7 @@ items_get_request_model = create_request_model(
 app_config = {
     "title": os.getenv("STAC_FASTAPI_TITLE", "stac-fastapi-opensearch"),
     "description": os.getenv("STAC_FASTAPI_DESCRIPTION", "stac-fastapi-opensearch"),
-    "api_version": os.getenv("STAC_FASTAPI_VERSION", "6.0.0"),
+    "api_version": os.getenv("STAC_FASTAPI_VERSION", "6.8.0"),
     "settings": settings,
     "extensions": extensions,
     "client": CoreClient(

{stac_fastapi_opensearch-6.7.6 → stac_fastapi_opensearch-6.8.0}/stac_fastapi/opensearch/config.py

@@ -56,7 +56,7 @@ def _es_config() -> Dict[str, Any]:
 
     # Include timeout setting if set
     if timeout := os.getenv("ES_TIMEOUT"):
-        config["timeout"] = timeout
+        config["timeout"] = int(timeout)
 
     # Explicitly exclude SSL settings when not using SSL
     if not use_ssl:

{stac_fastapi_opensearch-6.7.6 → stac_fastapi_opensearch-6.8.0}/stac_fastapi/opensearch/database_logic.py

@@ -1,7 +1,7 @@
 """Database logic."""
-
 import asyncio
 import logging
+import os
 from base64 import urlsafe_b64decode, urlsafe_b64encode
 from collections.abc import Iterable
 from copy import deepcopy
@@ -15,6 +15,7 @@ from opensearchpy.helpers.query import Q
 from opensearchpy.helpers.search import Search
 from starlette.requests import Request
 
+import stac_fastapi.sfeos_helpers.filter as filter_module
 from stac_fastapi.core.base_database_logic import BaseDatabaseLogic
 from stac_fastapi.core.serializers import CollectionSerializer, ItemSerializer
 from stac_fastapi.core.utilities import MAX_LIMIT, bbox2polygon, get_bool_env
@@ -27,7 +28,6 @@ from stac_fastapi.opensearch.config import (
     AsyncOpensearchSettings as AsyncSearchSettings,
 )
 from stac_fastapi.opensearch.config import OpensearchSettings as SyncSearchSettings
-from stac_fastapi.sfeos_helpers import filter as filter_module
 from stac_fastapi.sfeos_helpers.database import (
     add_bbox_shape_to_collection,
     apply_collections_bbox_filter_shared,
@@ -154,6 +154,26 @@ class DatabaseLogic(BaseDatabaseLogic):
 
     aggregation_mapping: Dict[str, Dict[str, Any]] = AGGREGATION_MAPPING
 
+    # constants for field names
+    # they are used in multiple methods
+    # and could be overwritten in subclasses used with alternate opensearch mappings.
+    PROPERTIES_DATETIME_FIELD = os.getenv(
+        "STAC_FIELD_PROP_DATETIME", "properties.datetime"
+    )
+    PROPERTIES_START_DATETIME_FIELD = os.getenv(
+        "STAC_FIELD_PROP_START_DATETIME", "properties.start_datetime"
+    )
+    PROPERTIES_END_DATETIME_FIELD = os.getenv(
+        "STAC_FIELD_PROP_END_DATETIME", "properties.end_datetime"
+    )
+    COLLECTION_FIELD = os.getenv("STAC_FIELD_COLLECTION", "collection")
+    GEOMETRY_FIELD = os.getenv("STAC_FIELD_GEOMETRY", "geometry")
+
+    @staticmethod
+    def __nested_field__(field: str):
+        """Convert opensearch field to nested field format."""
+        return field.replace(".", "__")
+
     """CORE LOGIC"""
 
     async def get_all_collections(
@@ -436,7 +456,10 @@ class DatabaseLogic(BaseDatabaseLogic):
     @staticmethod
     def apply_collections_filter(search: Search, collection_ids: List[str]):
         """Database logic to search a list of STAC collection ids."""
-        return search.filter("terms", collection=collection_ids)
+        collection_nested_field = DatabaseLogic.__nested_field__(
+            DatabaseLogic.COLLECTION_FIELD
+        )
+        return search.filter("terms", **{collection_nested_field: collection_ids})
 
     @staticmethod
     def apply_free_text_filter(search: Search, free_text_queries: Optional[List[str]]):
@@ -479,6 +502,16 @@ class DatabaseLogic(BaseDatabaseLogic):
         # False: Always search only by start/end datetime
         USE_DATETIME = get_bool_env("USE_DATETIME", default=True)
 
+        nested_datetime_field = DatabaseLogic.__nested_field__(
+            DatabaseLogic.PROPERTIES_DATETIME_FIELD
+        )
+        nested_start_datetime_field = DatabaseLogic.__nested_field__(
+            DatabaseLogic.PROPERTIES_START_DATETIME_FIELD
+        )
+        nested_end_datetime_field = DatabaseLogic.__nested_field__(
+            DatabaseLogic.PROPERTIES_END_DATETIME_FIELD
+        )
+
         if USE_DATETIME:
             if "eq" in datetime_search:
                 # For exact matches, include:
@@ -488,28 +521,42 @@ class DatabaseLogic(BaseDatabaseLogic):
                     Q(
                         "bool",
                         filter=[
-                            Q("exists", field="properties.datetime"),
+                            Q("exists", field=DatabaseLogic.PROPERTIES_DATETIME_FIELD),
                             Q(
                                 "term",
-                                **{"properties__datetime": datetime_search["eq"]},
+                                **{nested_datetime_field: datetime_search["eq"]},
                             ),
                         ],
                     ),
                     Q(
                         "bool",
-                        must_not=[Q("exists", field="properties.datetime")],
+                        must_not=[
+                            Q("exists", field=DatabaseLogic.PROPERTIES_DATETIME_FIELD)
+                        ],
                         filter=[
-                            Q("exists", field="properties.start_datetime"),
-                            Q("exists", field="properties.end_datetime"),
+                            Q(
+                                "exists",
+                                field=DatabaseLogic.PROPERTIES_START_DATETIME_FIELD,
+                            ),
+                            Q(
+                                "exists",
+                                field=DatabaseLogic.PROPERTIES_END_DATETIME_FIELD,
+                            ),
                             Q(
                                 "range",
-                                properties__start_datetime={
-                                    "lte": datetime_search["eq"]
+                                **{
+                                    nested_start_datetime_field: {
+                                        "lte": datetime_search["eq"]
+                                    }
                                 },
                             ),
                             Q(
                                 "range",
-                                properties__end_datetime={"gte": datetime_search["eq"]},
+                                **{
+                                    nested_end_datetime_field: {
+                                        "gte": datetime_search["eq"]
+                                    }
+                                },
                             ),
                         ],
                     ),
@@ -522,32 +569,46 @@ class DatabaseLogic(BaseDatabaseLogic):
                     Q(
                         "bool",
                         filter=[
-                            Q("exists", field="properties.datetime"),
+                            Q("exists", field=DatabaseLogic.PROPERTIES_DATETIME_FIELD),
                             Q(
                                 "range",
-                                properties__datetime={
-                                    "gte": datetime_search["gte"],
-                                    "lte": datetime_search["lte"],
+                                **{
+                                    nested_datetime_field: {
+                                        "gte": datetime_search["gte"],
+                                        "lte": datetime_search["lte"],
+                                    }
                                 },
                             ),
                         ],
                     ),
                     Q(
                         "bool",
-                        must_not=[Q("exists", field="properties.datetime")],
+                        must_not=[
+                            Q("exists", field=DatabaseLogic.PROPERTIES_DATETIME_FIELD)
+                        ],
                         filter=[
-                            Q("exists", field="properties.start_datetime"),
-                            Q("exists", field="properties.end_datetime"),
+                            Q(
+                                "exists",
+                                field=DatabaseLogic.PROPERTIES_START_DATETIME_FIELD,
+                            ),
+                            Q(
+                                "exists",
+                                field=DatabaseLogic.PROPERTIES_END_DATETIME_FIELD,
+                            ),
                             Q(
                                 "range",
-                                properties__start_datetime={
-                                    "lte": datetime_search["lte"]
+                                **{
+                                    nested_start_datetime_field: {
+                                        "lte": datetime_search["lte"]
+                                    }
                                 },
                             ),
                             Q(
                                 "range",
-                                properties__end_datetime={
-                                    "gte": datetime_search["gte"]
+                                **{
+                                    nested_end_datetime_field: {
+                                        "gte": datetime_search["gte"]
+                                    }
                                 },
                             ),
                         ],
@@ -563,15 +624,26 @@ class DatabaseLogic(BaseDatabaseLogic):
                 filter_query = Q(
                     "bool",
                     filter=[
-                        Q("exists", field="properties.start_datetime"),
-                        Q("exists", field="properties.end_datetime"),
+                        Q(
+                            "exists",
+                            field=DatabaseLogic.PROPERTIES_START_DATETIME_FIELD,
+                        ),
+                        Q("exists", field=DatabaseLogic.PROPERTIES_END_DATETIME_FIELD),
                         Q(
                             "range",
-                            properties__start_datetime={"lte": datetime_search["eq"]},
+                            **{
+                                nested_start_datetime_field: {
+                                    "lte": datetime_search["eq"]
+                                }
+                            },
                         ),
                         Q(
                             "range",
-                            properties__end_datetime={"gte": datetime_search["eq"]},
+                            **{
+                                nested_end_datetime_field: {
+                                    "gte": datetime_search["eq"]
+                                }
+                            },
                         ),
                     ],
                 )
@@ -579,15 +651,26 @@ class DatabaseLogic(BaseDatabaseLogic):
                 filter_query = Q(
                     "bool",
                     filter=[
-                        Q("exists", field="properties.start_datetime"),
-                        Q("exists", field="properties.end_datetime"),
+                        Q(
+                            "exists",
+                            field=DatabaseLogic.PROPERTIES_START_DATETIME_FIELD,
+                        ),
+                        Q("exists", field=DatabaseLogic.PROPERTIES_END_DATETIME_FIELD),
                         Q(
                             "range",
-                            properties__start_datetime={"lte": datetime_search["lte"]},
+                            **{
+                                nested_start_datetime_field: {
+                                    "lte": datetime_search["lte"]
+                                }
+                            },
                         ),
                         Q(
                             "range",
-                            properties__end_datetime={"gte": datetime_search["gte"]},
+                            **{
+                                nested_end_datetime_field: {
+                                    "gte": datetime_search["gte"]
+                                }
+                            },
                         ),
                     ],
                 )
@@ -612,7 +695,7 @@ class DatabaseLogic(BaseDatabaseLogic):
             Q(
                 {
                     "geo_shape": {
-                        "geometry": {
+                        DatabaseLogic.GEOMETRY_FIELD: {
                             "shape": {
                                 "type": "polygon",
                                 "coordinates": bbox2polygon(*bbox),
@@ -1723,3 +1806,132 @@ class DatabaseLogic(BaseDatabaseLogic):
             body={"query": {"match_all": {}}},
             wait_for_completion=True,
         )
+
+    """CATALOGS LOGIC"""
+
+    async def get_all_catalogs(
+        self,
+        token: Optional[str],
+        limit: int,
+        request: Any = None,
+        sort: Optional[List[Dict[str, Any]]] = None,
+    ) -> Tuple[List[Dict[str, Any]], Optional[str], Optional[int]]:
+        """Retrieve a list of catalogs from OpenSearch, supporting pagination.
+
+        Args:
+            token (Optional[str]): The pagination token.
+            limit (int): The number of results to return.
+            request (Any, optional): The FastAPI request object. Defaults to None.
+            sort (Optional[List[Dict[str, Any]]], optional): Optional sort parameter. Defaults to None.
+
+        Returns:
+            A tuple of (catalogs, next pagination token if any, optional count).
+        """
+        # Define sortable fields for catalogs
+        sortable_fields = ["id"]
+
+        # Format the sort parameter
+        formatted_sort = []
+        if sort:
+            for item in sort:
+                field = item.get("field")
+                direction = item.get("direction", "asc")
+                if field and field in sortable_fields:
+                    formatted_sort.append({field: {"order": direction}})
+
+        if not formatted_sort:
+            formatted_sort = [{"id": {"order": "asc"}}]
+
+        body = {
+            "sort": formatted_sort,
+            "size": limit,
+            "query": {"term": {"type": "Catalog"}},
+        }
+
+        # Handle search_after token
+        search_after = None
+        if token:
+            try:
+                search_after = token.split("|")
+                if len(search_after) != len(formatted_sort):
+                    search_after = None
+            except Exception:
+                search_after = None
+
+            if search_after is not None:
+                body["search_after"] = search_after
+
+        # Search for catalogs in collections index
+        response = await self.client.search(
+            index=COLLECTIONS_INDEX,
+            body=body,
+        )
+
+        hits = response["hits"]["hits"]
+        catalogs = [hit["_source"] for hit in hits]
+
+        next_token = None
+        if len(hits) == limit:
+            next_token_values = hits[-1].get("sort")
+            if next_token_values:
+                next_token = "|".join(str(val) for val in next_token_values)
+
+        # Get the total count
+        matched = (
+            response["hits"]["total"]["value"]
+            if response["hits"]["total"]["relation"] == "eq"
+            else None
+        )
+
+        return catalogs, next_token, matched
+
+    async def create_catalog(self, catalog: Dict, refresh: bool = False) -> None:
+        """Create a catalog in OpenSearch.
+
+        Args:
+            catalog (Dict): The catalog document to create.
+            refresh (bool): Whether to refresh the index after creation.
+        """
+        await self.client.index(
+            index=COLLECTIONS_INDEX,
+            id=catalog.get("id"),
+            body=catalog,
+            refresh=refresh,
+        )
+
+    async def find_catalog(self, catalog_id: str) -> Dict:
+        """Find a catalog in OpenSearch by ID.
+
+        Args:
+            catalog_id (str): The ID of the catalog to find.
+
+        Returns:
+            Dict: The catalog document.
+
+        Raises:
+            NotFoundError: If the catalog is not found.
+        """
+        try:
+            response = await self.client.get(
+                index=COLLECTIONS_INDEX,
+                id=catalog_id,
+            )
+            # Verify it's a catalog
+            if response["_source"].get("type") != "Catalog":
+                raise NotFoundError(f"Catalog {catalog_id} not found")
+            return response["_source"]
+        except exceptions.NotFoundError:
+            raise NotFoundError(f"Catalog {catalog_id} not found")
+
+    async def delete_catalog(self, catalog_id: str, refresh: bool = False) -> None:
+        """Delete a catalog from OpenSearch.
+
+        Args:
+            catalog_id (str): The ID of the catalog to delete.
+            refresh (bool): Whether to refresh the index after deletion.
+        """
+        await self.client.delete(
+            index=COLLECTIONS_INDEX,
+            id=catalog_id,
+            refresh=refresh,
+        )

{stac_fastapi_opensearch-6.7.6 → stac_fastapi_opensearch-6.8.0}/stac_fastapi/opensearch/version.py

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