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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oplnk-python-utils
-Version: 1.2.0
+Version: 1.2.2
 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,80 @@ 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)
+
+The behavior of original ID fields depends on whether they are being populated:
+
+#### Without populate - ID field shown as-is:
+
+```python
+# No populate - field shown normally
+query = {
+    "fields": ["name", "establishment_id"]
+}
+
+# Response:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment_id": "est_123"  // Shown normally
+#     }]
+# }
+```
+
+#### With populate - ID field removed by default:
+
+```python
+# With populate but no explicit fields request
+query = {
+    "populate": ["establishment"]
+}
+
+# Response - establishment_id automatically excluded:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment": {  // Populated object
+#             "_id": "est_123",
+#             "name": "Main Office"
+#         }
+#     }]
+# }
+```
+
+#### With populate AND explicit fields request - show both:
+
+```python
+# Request both populate and the original ID field explicitly
+query = {
+    "populate": ["establishment"],
+    "fields": ["name", "establishment_id"]  # Explicitly request the ID
+}
+
+# Response - both are present:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment_id": "est_123",  // Shown because explicitly requested
+#         "establishment": {
+#             "_id": "est_123",
+#             "name": "Main Office"
+#         }
+#     }]
+# }
+```
+
+**For audit fields:** The original ID is always excluded and never shown (no `creation_user_id` field exists to request).
+
 ### Custom Pipelines
 
 ```python

{oplnk_python_utils-1.2.0 → oplnk_python_utils-1.2.2}/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,80 @@ 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)
+
+The behavior of original ID fields depends on whether they are being populated:
+
+#### Without populate - ID field shown as-is:
+
+```python
+# No populate - field shown normally
+query = {
+    "fields": ["name", "establishment_id"]
+}
+
+# Response:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment_id": "est_123"  // Shown normally
+#     }]
+# }
+```
+
+#### With populate - ID field removed by default:
+
+```python
+# With populate but no explicit fields request
+query = {
+    "populate": ["establishment"]
+}
+
+# Response - establishment_id automatically excluded:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment": {  // Populated object
+#             "_id": "est_123",
+#             "name": "Main Office"
+#         }
+#     }]
+# }
+```
+
+#### With populate AND explicit fields request - show both:
+
+```python
+# Request both populate and the original ID field explicitly
+query = {
+    "populate": ["establishment"],
+    "fields": ["name", "establishment_id"]  # Explicitly request the ID
+}
+
+# Response - both are present:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment_id": "est_123",  // Shown because explicitly requested
+#         "establishment": {
+#             "_id": "est_123",
+#             "name": "Main Office"
+#         }
+#     }]
+# }
+```
+
+**For audit fields:** The original ID is always excluded and never shown (no `creation_user_id` field exists to request).
+
 ### Custom Pipelines
 
 ```python

{oplnk_python_utils-1.2.0 → oplnk_python_utils-1.2.2}/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.2"
 __author__ = "OpenLink SpA"
 
 __all__ = ["core", "cache", "query", "reports", "__version__"]

{oplnk_python_utils-1.2.0 → oplnk_python_utils-1.2.2}/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,47 @@ class QueryBuilder:
 
         return pipeline_copy
 
+    def _get_populated_fields_list(self, query_populate: Any) -> List[str]:
+        """
+        Get list of field names that are being populated.
+
+        For example: ["establishment", "creation_user"]
+
+        Args:
+            query_populate: The populate parameter (list or dict)
+
+        Returns:
+            List of field names being populated
+        """
+        populated = []
+
+        if isinstance(query_populate, list):
+            populated = query_populate
+        elif isinstance(query_populate, dict):
+            populated = list(query_populate.keys())
+
+        return populated
+
+    def _get_id_field_for_relation(self, relation_name: str) -> Optional[str]:
+        """
+        Get the ID field name for a given relation.
+
+        For example: "establishment" -> "establishment_id"
+
+        Args:
+            relation_name: The relation name (e.g., "establishment")
+
+        Returns:
+            The ID field name (e.g., "establishment_id") or None if not found
+        """
+        for relation in self.relations:
+            field_name = relation[1]
+            # Remove _id or _ids suffix to get base name
+            base_name = field_name.replace("_ids", "").replace("_id", "")
+            if base_name == relation_name:
+                return field_name
+        return None
+
     def sanitize_result(
         self, query: Dict[str, Any], data_result: Any, meta_result: Any
     ) -> Dict[str, Any]:
@@ -800,6 +841,27 @@ 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 (unless requested in fields)
+        if "populate" in query and isinstance(data_result, list):
+            fields_requested = query.get("fields", [])
+            populated_fields = self._get_populated_fields_list(query["populate"])
+
+            for doc in data_result:
+                # Always remove temporary audit field copies
+                for field in RESERVED_AUDIT_FIELDS.keys():
+                    temp_field = f"_original_{field}"
+                    if temp_field in doc:
+                        del doc[temp_field]
+
+                # For normal relations: remove original ID unless explicitly requested in fields
+                for populated_field in populated_fields:
+                    if populated_field not in RESERVED_AUDIT_FIELDS:
+                        # Try to find the ID field for this relation
+                        id_field = self._get_id_field_for_relation(populated_field)
+                        if id_field and id_field not in fields_requested:
+                            if id_field in doc:
+                                del doc[id_field]
+
         return {"data": data_result, "meta": meta_result}
 
     def get_reserved_field_lookup(self, field_name: str) -> List[Dict[str, Any]]:
@@ -821,6 +883,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"],

{oplnk_python_utils-1.2.0 → oplnk_python_utils-1.2.2/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.2
 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,80 @@ 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)
+
+The behavior of original ID fields depends on whether they are being populated:
+
+#### Without populate - ID field shown as-is:
+
+```python
+# No populate - field shown normally
+query = {
+    "fields": ["name", "establishment_id"]
+}
+
+# Response:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment_id": "est_123"  // Shown normally
+#     }]
+# }
+```
+
+#### With populate - ID field removed by default:
+
+```python
+# With populate but no explicit fields request
+query = {
+    "populate": ["establishment"]
+}
+
+# Response - establishment_id automatically excluded:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment": {  // Populated object
+#             "_id": "est_123",
+#             "name": "Main Office"
+#         }
+#     }]
+# }
+```
+
+#### With populate AND explicit fields request - show both:
+
+```python
+# Request both populate and the original ID field explicitly
+query = {
+    "populate": ["establishment"],
+    "fields": ["name", "establishment_id"]  # Explicitly request the ID
+}
+
+# Response - both are present:
+# {
+#     "data": [{
+#         "_id": "123",
+#         "name": "Product",
+#         "establishment_id": "est_123",  // Shown because explicitly requested
+#         "establishment": {
+#             "_id": "est_123",
+#             "name": "Main Office"
+#         }
+#     }]
+# }
+```
+
+**For audit fields:** The original ID is always excluded and never shown (no `creation_user_id` field exists to request).
+
 ### Custom Pipelines
 
 ```python

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

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