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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oplnk-python-utils
-Version: 1.2.2
+Version: 1.2.4
 Summary: Reusable utilities for caching, data manipulation, parsing, and MongoDB query building
 Home-page: https://github.com/openlinkspa/oplnk-python-utils
 Author: OpenLink SpA
@@ -642,11 +642,11 @@ query = {
     "populate": ["creation_user", "modification_user"]
 }
 
-# Result will include (original ID automatically removed, replaced by populated object):
+# Result will include (original ID removed, replaced by populated object):
 # {
 #     "data": [{
 #         "_id": "123",
-#         "creation_user": {  // Replaces the original ID field
+#         "creation_user_info": {  // Populated object
 #             "_id": "user_id_string",
 #             "name": "John Doe",
 #             "person": "person_id"
@@ -657,8 +657,8 @@ query = {
 
 **Reserved fields:**
 
--  `creation_user` → automatically populated, original ID is excluded
--  `modification_user` → automatically populated, original ID is excluded
+-  `creation_user` → automatically populated as `creation_user_info`, original ID is excluded
+-  `modification_user` → automatically populated as `modification_user_info`, original ID is excluded
 
 These fields are only populated when explicitly requested via the `populate` parameter, following the Strapi philosophy of on-demand loading.
 
@@ -666,10 +666,10 @@ These fields are only populated when explicitly requested via the `populate` par
 
 The behavior of original ID fields depends on whether they are being populated:
 
-#### Without populate - ID field shown as-is:
+#### Without populate - ID field shown as-is (from database):
 
 ```python
-# No populate - field shown normally
+# No populate - field shown normally from database
 query = {
     "fields": ["name", "establishment_id"]
 }
@@ -728,7 +728,32 @@ query = {
 # }
 ```
 
-**For audit fields:** The original ID is always excluded and never shown (no `creation_user_id` field exists to request).
+#### Audit fields behavior:
+
+```python
+# Without populate - original field shown
+query = {
+    "fields": ["name", "creation_user"]
+}
+# Response:
+# { "creation_user": "user_123" }
+
+# With populate - original field removed, *_info shown instead
+query = {
+    "populate": ["creation_user"]
+}
+# Response:
+# { "creation_user_info": { "_id": "user_123", ... } }
+# Note: creation_user field is NOT shown
+
+# With populate AND explicit request for original - show both
+query = {
+    "populate": ["creation_user"],
+    "fields": ["creation_user"]  # Explicitly request the ID
+}
+# Response:
+# { "creation_user": "user_123", "creation_user_info": { "_id": "user_123", ... } }
+```
 
 ### Custom Pipelines
 

{oplnk_python_utils-1.2.2 → oplnk_python_utils-1.2.4}/README.md

@@ -600,11 +600,11 @@ query = {
     "populate": ["creation_user", "modification_user"]
 }
 
-# Result will include (original ID automatically removed, replaced by populated object):
+# Result will include (original ID removed, replaced by populated object):
 # {
 #     "data": [{
 #         "_id": "123",
-#         "creation_user": {  // Replaces the original ID field
+#         "creation_user_info": {  // Populated object
 #             "_id": "user_id_string",
 #             "name": "John Doe",
 #             "person": "person_id"
@@ -615,8 +615,8 @@ query = {
 
 **Reserved fields:**
 
--  `creation_user` → automatically populated, original ID is excluded
--  `modification_user` → automatically populated, original ID is excluded
+-  `creation_user` → automatically populated as `creation_user_info`, original ID is excluded
+-  `modification_user` → automatically populated as `modification_user_info`, original ID is excluded
 
 These fields are only populated when explicitly requested via the `populate` parameter, following the Strapi philosophy of on-demand loading.
 
@@ -624,10 +624,10 @@ These fields are only populated when explicitly requested via the `populate` par
 
 The behavior of original ID fields depends on whether they are being populated:
 
-#### Without populate - ID field shown as-is:
+#### Without populate - ID field shown as-is (from database):
 
 ```python
-# No populate - field shown normally
+# No populate - field shown normally from database
 query = {
     "fields": ["name", "establishment_id"]
 }
@@ -686,7 +686,32 @@ query = {
 # }
 ```
 
-**For audit fields:** The original ID is always excluded and never shown (no `creation_user_id` field exists to request).
+#### Audit fields behavior:
+
+```python
+# Without populate - original field shown
+query = {
+    "fields": ["name", "creation_user"]
+}
+# Response:
+# { "creation_user": "user_123" }
+
+# With populate - original field removed, *_info shown instead
+query = {
+    "populate": ["creation_user"]
+}
+# Response:
+# { "creation_user_info": { "_id": "user_123", ... } }
+# Note: creation_user field is NOT shown
+
+# With populate AND explicit request for original - show both
+query = {
+    "populate": ["creation_user"],
+    "fields": ["creation_user"]  # Explicitly request the ID
+}
+# Response:
+# { "creation_user": "user_123", "creation_user_info": { "_id": "user_123", ... } }
+```
 
 ### Custom Pipelines
 

{oplnk_python_utils-1.2.2 → oplnk_python_utils-1.2.4}/oplnk_python_utils/__init__.py

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

{oplnk_python_utils-1.2.2 → oplnk_python_utils-1.2.4}/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",
+        "alias": "creation_user_info",
         "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",
+        "alias": "modification_user_info",
         "field_type": "id",
         "project_exclude": {
             "role": 0,
@@ -626,10 +626,11 @@ class QueryBuilder:
         return {"$sort": sort_pipeline}
 
     def build_fields_pipeline(
-        self, fields_params: List[str], populate_params: Optional[List] = None
+        self, fields_params: List[str], populate_params: Optional[Any] = None
     ) -> Dict[str, Any]:
         """
         Build fields projection pipeline with support for dot notation and array notation.
+        Automatically includes aliases for populated fields when fields is specified.
         """
         fields_pipeline = {}
 
@@ -648,15 +649,43 @@ class QueryBuilder:
 
         # Process populate_params if provided
         if populate_params:
-            for field in populate_params:
+            # Convert to list if it's a dict
+            populate_list = (
+                populate_params
+                if isinstance(populate_params, list)
+                else list(populate_params.keys())
+            )
+
+            for field in populate_list:
                 try:
+                    # Add the original field so sanitization can work
                     normalized_field = normalize_field_path(field)
                     if validate_field_path(normalized_field):
                         fields_pipeline[normalized_field] = 1
+
+                    # Add the populated alias for audit fields
+                    if field in RESERVED_AUDIT_FIELDS:
+                        alias = RESERVED_AUDIT_FIELDS[field]["alias"]
+                        normalized_alias = normalize_field_path(alias)
+                        if validate_field_path(normalized_alias):
+                            fields_pipeline[normalized_alias] = 1
                     else:
-                        print(
-                            f"Warning: Invalid populate field path '{field}', skipping in projection"
-                        )
+                        # For normal relations, find the alias and add it
+                        for relation in self.relations:
+                            relation_name = relation[1]
+                            base_name = relation_name.replace("_ids", "").replace(
+                                "_id", ""
+                            )
+                            if base_name == field:
+                                # Use custom alias if provided (5th element)
+                                if len(relation) > 4 and relation[4]:
+                                    alias = relation[4]
+                                else:
+                                    alias = base_name
+                                normalized_alias = normalize_field_path(alias)
+                                if validate_field_path(normalized_alias):
+                                    fields_pipeline[normalized_alias] = 1
+                                break
                 except Exception as e:
                     print(
                         f"Warning: Error processing populate field '{field}' in projection: {e}"
@@ -847,11 +876,16 @@ class QueryBuilder:
             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 audit fields: remove original if populated version exists and not requested in fields
+                for field_name, field_config in RESERVED_AUDIT_FIELDS.items():
+                    if field_name in populated_fields:
+                        # If the populated alias exists and original field is not explicitly requested
+                        if (
+                            field_config["alias"] in doc
+                            and field_name not in fields_requested
+                        ):
+                            if field_name in doc:
+                                del doc[field_name]
 
                 # For normal relations: remove original ID unless explicitly requested in fields
                 for populated_field in populated_fields:
@@ -883,12 +917,6 @@ 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.2 → oplnk_python_utils-1.2.4/oplnk_python_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oplnk-python-utils
-Version: 1.2.2
+Version: 1.2.4
 Summary: Reusable utilities for caching, data manipulation, parsing, and MongoDB query building
 Home-page: https://github.com/openlinkspa/oplnk-python-utils
 Author: OpenLink SpA
@@ -642,11 +642,11 @@ query = {
     "populate": ["creation_user", "modification_user"]
 }
 
-# Result will include (original ID automatically removed, replaced by populated object):
+# Result will include (original ID removed, replaced by populated object):
 # {
 #     "data": [{
 #         "_id": "123",
-#         "creation_user": {  // Replaces the original ID field
+#         "creation_user_info": {  // Populated object
 #             "_id": "user_id_string",
 #             "name": "John Doe",
 #             "person": "person_id"
@@ -657,8 +657,8 @@ query = {
 
 **Reserved fields:**
 
--  `creation_user` → automatically populated, original ID is excluded
--  `modification_user` → automatically populated, original ID is excluded
+-  `creation_user` → automatically populated as `creation_user_info`, original ID is excluded
+-  `modification_user` → automatically populated as `modification_user_info`, original ID is excluded
 
 These fields are only populated when explicitly requested via the `populate` parameter, following the Strapi philosophy of on-demand loading.
 
@@ -666,10 +666,10 @@ These fields are only populated when explicitly requested via the `populate` par
 
 The behavior of original ID fields depends on whether they are being populated:
 
-#### Without populate - ID field shown as-is:
+#### Without populate - ID field shown as-is (from database):
 
 ```python
-# No populate - field shown normally
+# No populate - field shown normally from database
 query = {
     "fields": ["name", "establishment_id"]
 }
@@ -728,7 +728,32 @@ query = {
 # }
 ```
 
-**For audit fields:** The original ID is always excluded and never shown (no `creation_user_id` field exists to request).
+#### Audit fields behavior:
+
+```python
+# Without populate - original field shown
+query = {
+    "fields": ["name", "creation_user"]
+}
+# Response:
+# { "creation_user": "user_123" }
+
+# With populate - original field removed, *_info shown instead
+query = {
+    "populate": ["creation_user"]
+}
+# Response:
+# { "creation_user_info": { "_id": "user_123", ... } }
+# Note: creation_user field is NOT shown
+
+# With populate AND explicit request for original - show both
+query = {
+    "populate": ["creation_user"],
+    "fields": ["creation_user"]  # Explicitly request the ID
+}
+# Response:
+# { "creation_user": "user_123", "creation_user_info": { "_id": "user_123", ... } }
+```
 
 ### Custom Pipelines
 

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

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