oplnk-python-utils 1.2.0__tar.gz → 1.2.1__tar.gz

{oplnk_python_utils-1.2.0/oplnk_python_utils.egg-info → oplnk_python_utils-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oplnk-python-utils
-Version: 1.2.0
+Version: 1.2.1
 Summary: Reusable utilities for caching, data manipulation, parsing, and MongoDB query building
 Home-page: https://github.com/openlinkspa/oplnk-python-utils
 Author: OpenLink SpA
@@ -623,7 +623,7 @@ relations = [
 ]
 ```
 
-### Reserved Audit Fields (NEW in v1.2.0)
+### Reserved Audit Fields (v1.2.1)
 
 The QueryBuilder automatically handles common audit fields without requiring manual configuration:
 
@@ -642,12 +642,11 @@ query = {
     "populate": ["creation_user", "modification_user"]
 }
 
-# Result will include:
+# Result will include (original ID automatically removed, replaced by populated object):
 # {
 #     "data": [{
 #         "_id": "123",
-#         "creation_user": "user_id_string",
-#         "creation_user_info": {  // Automatically populated
+#         "creation_user": {  // Replaces the original ID field
 #             "_id": "user_id_string",
 #             "name": "John Doe",
 #             "person": "person_id"
@@ -657,11 +656,60 @@ query = {
 ```
 
 **Reserved fields:**
-- `creation_user` → populated as `creation_user_info`
-- `modification_user` → populated as `modification_user_info`
+
+-  `creation_user` → automatically populated, original ID is excluded
+-  `modification_user` → automatically populated, original ID is excluded
 
 These fields are only populated when explicitly requested via the `populate` parameter, following the Strapi philosophy of on-demand loading.
 
+### Populate Field Sanitization (v1.2.1)
+
+By default, when you populate a relation, the original ID field is automatically removed from the response (Strapi-like behavior):
+
+```python
+# Request with populate - establishment_id will be automatically excluded:
+query = {
+    "populate": ["establishment"]
+}
+
+# Response - establishment_id is not present:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment": {  // Populated object replaces the ID
+#             "_id": "est_123",
+#             "name": "Main Office"
+#         }
+#         // establishment_id is NOT here
+#     }]
+# }
+```
+
+**To keep both the ID and populated object, explicitly request it in `fields`:**
+
+```python
+query = {
+    "populate": ["establishment"],
+    "fields": ["name", "establishment_id"]  # Request the ID explicitly
+}
+
+# Response - both ID and populated object are present:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment_id": "est_123",  // Now included
+#         "establishment": {
+#             "_id": "est_123",
+#             "name": "Main Office"
+#         }
+#     }]
+# }
+```
+
+**For audit fields:** The original ID is always excluded (no option to keep it, since there's no `creation_user_id` field).
+
 ### Custom Pipelines
 
 ```python

{oplnk_python_utils-1.2.0 → oplnk_python_utils-1.2.1}/README.md

@@ -581,7 +581,7 @@ relations = [
 ]
 ```
 
-### Reserved Audit Fields (NEW in v1.2.0)
+### Reserved Audit Fields (v1.2.1)
 
 The QueryBuilder automatically handles common audit fields without requiring manual configuration:
 
@@ -600,12 +600,11 @@ query = {
     "populate": ["creation_user", "modification_user"]
 }
 
-# Result will include:
+# Result will include (original ID automatically removed, replaced by populated object):
 # {
 #     "data": [{
 #         "_id": "123",
-#         "creation_user": "user_id_string",
-#         "creation_user_info": {  // Automatically populated
+#         "creation_user": {  // Replaces the original ID field
 #             "_id": "user_id_string",
 #             "name": "John Doe",
 #             "person": "person_id"
@@ -615,11 +614,60 @@ query = {
 ```
 
 **Reserved fields:**
-- `creation_user` → populated as `creation_user_info`
-- `modification_user` → populated as `modification_user_info`
+
+-  `creation_user` → automatically populated, original ID is excluded
+-  `modification_user` → automatically populated, original ID is excluded
 
 These fields are only populated when explicitly requested via the `populate` parameter, following the Strapi philosophy of on-demand loading.
 
+### Populate Field Sanitization (v1.2.1)
+
+By default, when you populate a relation, the original ID field is automatically removed from the response (Strapi-like behavior):
+
+```python
+# Request with populate - establishment_id will be automatically excluded:
+query = {
+    "populate": ["establishment"]
+}
+
+# Response - establishment_id is not present:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment": {  // Populated object replaces the ID
+#             "_id": "est_123",
+#             "name": "Main Office"
+#         }
+#         // establishment_id is NOT here
+#     }]
+# }
+```
+
+**To keep both the ID and populated object, explicitly request it in `fields`:**
+
+```python
+query = {
+    "populate": ["establishment"],
+    "fields": ["name", "establishment_id"]  # Request the ID explicitly
+}
+
+# Response - both ID and populated object are present:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment_id": "est_123",  // Now included
+#         "establishment": {
+#             "_id": "est_123",
+#             "name": "Main Office"
+#         }
+#     }]
+# }
+```
+
+**For audit fields:** The original ID is always excluded (no option to keep it, since there's no `creation_user_id` field).
+
 ### Custom Pipelines
 
 ```python

{oplnk_python_utils-1.2.0 → oplnk_python_utils-1.2.1}/oplnk_python_utils/__init__.py

@@ -7,7 +7,7 @@ from . import core
 from . import cache
 from . import query
 
-__version__ = "1.2.0"
+__version__ = "1.2.1"
 __author__ = "OpenLink SpA"
 
 __all__ = ["core", "cache", "query", "reports", "__version__"]

{oplnk_python_utils-1.2.0 → oplnk_python_utils-1.2.1}/oplnk_python_utils/query/query_builder.py

@@ -21,7 +21,7 @@ RESERVED_AUDIT_FIELDS = {
     "creation_user": {
         "collection": "users",
         "field_name": "creation_user",
-        "alias": "creation_user_info",
+        "alias": "creation_user",
         "field_type": "id",
         "project_exclude": {
             "role": 0,
@@ -49,7 +49,7 @@ RESERVED_AUDIT_FIELDS = {
     "modification_user": {
         "collection": "users",
         "field_name": "modification_user",
-        "alias": "modification_user_info",
+        "alias": "modification_user",
         "field_type": "id",
         "project_exclude": {
             "role": 0,
@@ -778,6 +778,48 @@ class QueryBuilder:
 
         return pipeline_copy
 
+    def _get_populated_field_mappings(self, query_populate: Any) -> Dict[str, str]:
+        """
+        Build a mapping of populated field names to their original ID field names.
+
+        For example: {"establishment": "establishment_id", "creation_user": "_original_creation_user"}
+
+        Args:
+            query_populate: The populate parameter (list or dict)
+
+        Returns:
+            Dict mapping populated field names to their original ID fields
+        """
+        mappings = {}
+
+        if isinstance(query_populate, list):
+            for field in query_populate:
+                if field in RESERVED_AUDIT_FIELDS:
+                    # Audit fields: map to the temporary original field
+                    mappings[field] = f"_original_{field}"
+                else:
+                    # Normal relations: try to find the ID field
+                    for relation in self.relations:
+                        relation_name = relation[1]
+                        # Remove _id or _ids suffix to get base name
+                        base_name = relation_name.replace("_ids", "").replace("_id", "")
+                        if base_name == field:
+                            mappings[field] = relation_name
+                            break
+        elif isinstance(query_populate, dict):
+            for field in query_populate.keys():
+                if field in RESERVED_AUDIT_FIELDS:
+                    mappings[field] = f"_original_{field}"
+                else:
+                    for relation in self.relations:
+                        relation_name = relation[1]
+                        base_name = relation_name.replace("_ids", "").replace("_id", "")
+                        if base_name == field:
+                            mappings[field] = relation_name
+                            break
+
+        return mappings
+
     def sanitize_result(
         self, query: Dict[str, Any], data_result: Any, meta_result: Any
     ) -> Dict[str, Any]:
@@ -800,6 +842,23 @@ class QueryBuilder:
         if not meta_result or "totalCount" not in meta_result:
             meta_result = {"totalCount": 0}
 
+        # Sanitize populate fields: remove original ID fields when populated
+        if "populate" in query and isinstance(data_result, list):
+            fields_requested = query.get("fields", [])
+            populated_mappings = self._get_populated_field_mappings(query["populate"])
+
+            for doc in data_result:
+                for populated_field, original_id_field in populated_mappings.items():
+                    # If it's a reserved audit field (starts with _original_), always remove the temp field
+                    if original_id_field.startswith("_original_"):
+                        if original_id_field in doc:
+                            del doc[original_id_field]
+                    # For normal relations, only remove if not explicitly requested in fields
+                    else:
+                        if original_id_field not in fields_requested:
+                            if original_id_field in doc:
+                                del doc[original_id_field]
+
         return {"data": data_result, "meta": meta_result}
 
     def get_reserved_field_lookup(self, field_name: str) -> List[Dict[str, Any]]:
@@ -821,6 +880,12 @@ class QueryBuilder:
         field_config = RESERVED_AUDIT_FIELDS[field_name]
 
         lookup_pipeline = [
+            # Save the original ID before lookup (will be removed during sanitization)
+            {
+                "$addFields": {
+                    f"_original_{field_config['field_name']}": f"${field_config['field_name']}"
+                }
+            },
             {
                 "$lookup": {
                     "from": field_config["collection"],
@@ -878,7 +943,13 @@ class QueryBuilder:
         else:
             let_value = {"lid": f"${relation_field_name}"}
 
+        # Save the original ID field before lookup (will be sanitized unless requested in fields)
         lookup_relation = [
+            {
+                "$addFields": {
+                    f"_original_{relation_field_name}": f"${relation_field_name}"
+                }
+            },
             {
                 "$lookup": {
                     "from": f"{_prefix}{collection_name_relation}",

{oplnk_python_utils-1.2.0 → oplnk_python_utils-1.2.1/oplnk_python_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oplnk-python-utils
-Version: 1.2.0
+Version: 1.2.1
 Summary: Reusable utilities for caching, data manipulation, parsing, and MongoDB query building
 Home-page: https://github.com/openlinkspa/oplnk-python-utils
 Author: OpenLink SpA
@@ -623,7 +623,7 @@ relations = [
 ]
 ```
 
-### Reserved Audit Fields (NEW in v1.2.0)
+### Reserved Audit Fields (v1.2.1)
 
 The QueryBuilder automatically handles common audit fields without requiring manual configuration:
 
@@ -642,12 +642,11 @@ query = {
     "populate": ["creation_user", "modification_user"]
 }
 
-# Result will include:
+# Result will include (original ID automatically removed, replaced by populated object):
 # {
 #     "data": [{
 #         "_id": "123",
-#         "creation_user": "user_id_string",
-#         "creation_user_info": {  // Automatically populated
+#         "creation_user": {  // Replaces the original ID field
 #             "_id": "user_id_string",
 #             "name": "John Doe",
 #             "person": "person_id"
@@ -657,11 +656,60 @@ query = {
 ```
 
 **Reserved fields:**
-- `creation_user` → populated as `creation_user_info`
-- `modification_user` → populated as `modification_user_info`
+
+-  `creation_user` → automatically populated, original ID is excluded
+-  `modification_user` → automatically populated, original ID is excluded
 
 These fields are only populated when explicitly requested via the `populate` parameter, following the Strapi philosophy of on-demand loading.
 
+### Populate Field Sanitization (v1.2.1)
+
+By default, when you populate a relation, the original ID field is automatically removed from the response (Strapi-like behavior):
+
+```python
+# Request with populate - establishment_id will be automatically excluded:
+query = {
+    "populate": ["establishment"]
+}
+
+# Response - establishment_id is not present:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment": {  // Populated object replaces the ID
+#             "_id": "est_123",
+#             "name": "Main Office"
+#         }
+#         // establishment_id is NOT here
+#     }]
+# }
+```
+
+**To keep both the ID and populated object, explicitly request it in `fields`:**
+
+```python
+query = {
+    "populate": ["establishment"],
+    "fields": ["name", "establishment_id"]  # Request the ID explicitly
+}
+
+# Response - both ID and populated object are present:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment_id": "est_123",  // Now included
+#         "establishment": {
+#             "_id": "est_123",
+#             "name": "Main Office"
+#         }
+#     }]
+# }
+```
+
+**For audit fields:** The original ID is always excluded (no option to keep it, since there's no `creation_user_id` field).
+
 ### Custom Pipelines
 
 ```python

{oplnk_python_utils-1.2.0 → oplnk_python_utils-1.2.1}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="oplnk-python-utils",
-    version="1.2.0",
+    version="1.2.1",
     author="OpenLink SpA",
     author_email="contacto@openlink.cl",
     description="Reusable utilities for caching, data manipulation, parsing, and MongoDB query building",