python-alfresco-api 1.2.0__py3-none-any.whl → 1.2.1__py3-none-any.whl

python_alfresco_api/__init__.py

@@ -36,7 +36,12 @@ from .clients.conversion_utils import (
 # Import raw_clients to ensure they get packaged
 from . import raw_clients
 
-__version__ = "1.2.0"
+# Tolerate Alfresco responses that omit the (spec-required) UserInfo.displayName for JIT /
+# OAuth2 service-account users (defaults displayName -> id). See _compat.py.
+from ._compat import install_shims as _install_shims
+_install_shims()
+
+__version__ = "1.2.1"
 __all__ = [
     # Factory & utilities
     "ClientFactory",

python_alfresco_api/_compat.py

@@ -0,0 +1,55 @@
+"""Runtime compatibility shims for Alfresco responses that deviate from the OpenAPI spec.
+
+Alfresco marks ``UserInfo.displayName`` as *required*, but omits it for JIT / OAuth2 service-account
+users (e.g. ``service-account-*`` produced by the client-credentials grant). That makes the generated
+``UserInfo.from_dict`` raise ``KeyError('displayName')`` while parsing ``createdByUser`` /
+``modifiedByUser`` / ``owner`` on node responses.
+
+This shim defaults ``displayName`` to ``id`` when it is absent, so parsing never crashes. It lives
+outside ``raw_clients/`` so it survives client re-generation.
+
+Scope (verified across all 7 generated raw clients): the ``UserInfo`` model — which is what
+createdBy/modifiedBy/owner deserialize to — exists **only** in the core and search clients; the other
+five (auth, discovery, model, search_sql, workflow) have no required-``displayName`` models. Core's
+group models (``Group`` / ``GroupMember`` / ``GroupBodyCreate`` / ``GroupBodyUpdate``) also mark
+``displayName`` required, but groups always carry a display name and those models have *other* required
+fields (e.g. ``Group.isRoot``), so they are not the JIT/service-account case and are left alone.
+"""
+
+from importlib import import_module
+
+# UserInfo covers every user reference (createdByUser / modifiedByUser / owner), in the two clients
+# that define it.
+_MODELS = (
+    ("python_alfresco_api.raw_clients.alfresco_core_client.core_client.models.user_info", "UserInfo"),
+    ("python_alfresco_api.raw_clients.alfresco_search_client.search_client.models.user_info", "UserInfo"),
+)
+
+
+def _patch_from_dict(cls) -> None:
+    if getattr(cls, "_display_name_shim_installed", False):
+        return
+    _orig_from_dict = cls.from_dict  # bound classmethod
+
+    def _from_dict(src_dict, _orig=_orig_from_dict):
+        d = dict(src_dict)
+        if "displayName" not in d and "id" in d:
+            # Alfresco omitted the (spec-required) display name; fall back to the id.
+            d["displayName"] = d["id"]
+        return _orig(d)
+
+    cls.from_dict = staticmethod(_from_dict)
+    cls._display_name_shim_installed = True
+
+
+def install_shims() -> None:
+    """Patch ``UserInfo.from_dict`` in the raw clients to tolerate a missing ``displayName``.
+
+    Idempotent — safe to call more than once.
+    """
+    for mod_path, cls_name in _MODELS:
+        try:
+            _patch_from_dict(getattr(import_module(mod_path), cls_name))
+        except Exception:
+            # Model not present in this build/layout — skip quietly.
+            continue

{python_alfresco_api-1.2.0.dist-info → python_alfresco_api-1.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-alfresco-api
-Version: 1.2.0
+Version: 1.2.1
 Summary: Python Client for all Alfresco Content Services REST APIs, with Pydantic v2 Models, and Event Support
 Project-URL: Homepage, https://github.com/stevereiner/python-alfresco-api
 Project-URL: Repository, https://github.com/stevereiner/python-alfresco-api
@@ -325,6 +325,8 @@ master_client = factory.create_master_client()
 
   A provided access token that has already expired is detected from its JWT `exp` claim and auto-refreshed when a `refresh_token` + `token_endpoint` are supplied. `ALFRESCO_OAUTH2_*` environment variables are also read when `load_env=True`.
 
+  > **Service account vs. user token.** `client_credentials` authenticates as the client's *service account* (e.g. `service-account-<client-id>`) — a just-in-time Alfresco user with **no display name** and only **default permissions** (not an admin, and not the same as Alfresco's `guest`). For content operations prefer a **user token** (obtain one via a password grant, then pass `access_token`/`refresh_token`) so operations run as a real user with a display name and that user's ACLs. As of **1.2.1** the client also tolerates a missing `displayName` (defaults it to the user id), so the service-account path no longer raises `KeyError`.
+
 ### Sync and Async Usage
 
 ```python

{python_alfresco_api-1.2.0.dist-info → python_alfresco_api-1.2.1.dist-info}/RECORD

@@ -1,4 +1,5 @@
-python_alfresco_api/__init__.py,sha256=HWTClg2gAvbZWWaYeJI6uX40QNG7a0ZgSzYsQ9VLVrA,1757
+python_alfresco_api/__init__.py,sha256=PGcKjRKCcSuamQ20gx5AkghQIzda1YzchOBgPB-lahQ,2001
+python_alfresco_api/_compat.py,sha256=liuk6giBNWxS6Qnk4rvzCi-skJohJM9BcfEwLcYFv9w,2541
 python_alfresco_api/auth_util.py,sha256=pp9Ig_YGIjfS7SwSrjnJGQ0AmhWNx5AHM4B5hZ6_uyY,35333
 python_alfresco_api/client_factory.py,sha256=-fTIUdT_aPCCH_d9A2RJU7554_yNaUo-ZsZMkxR5588,11458
 python_alfresco_api/clients/__init__.py,sha256=3_SHjsn1iCht_kEmXDFzPNOZlp-EvH3BajmuzTmUdkI,1877
@@ -768,7 +769,7 @@ python_alfresco_api/utils/node_utils_highlevel.py,sha256=Xfebn8rv958SkMcaaSRS-oa
 python_alfresco_api/utils/search_utils.py,sha256=0TJGTWtVWb6I-0QNCYyrNfd714CwKl9dZcw6R7L-aR8,15634
 python_alfresco_api/utils/version_utils.py,sha256=3NIhLyM3rkaH-fm4c-PH8MTIMJmwGKg9KiSBEc8FBJc,11462
 python_alfresco_api/utils/version_utils_highlevel.py,sha256=xa2O6xZfNN9Lx6iHKGnvHGW7watnu8rPTPlcsZUpdis,19079
-python_alfresco_api-1.2.0.dist-info/METADATA,sha256=htoyR5ylbqELYheJwIZAm3TnpLhmici1LJ-8V3ir5as,28860
-python_alfresco_api-1.2.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
-python_alfresco_api-1.2.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-python_alfresco_api-1.2.0.dist-info/RECORD,,
+python_alfresco_api-1.2.1.dist-info/METADATA,sha256=45VOzf7hjpjF2ReK5CDaC9oAdP82bVaewhGXDxzGFc4,29505
+python_alfresco_api-1.2.1.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+python_alfresco_api-1.2.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+python_alfresco_api-1.2.1.dist-info/RECORD,,