UI: AppAPI 1.4: FileAction breaking change (#169)

Adjusted nc_app.ui.files_dropdown_menu.register to be in sync with
nextcloud/app_api#141

Signed-off-by: Alexander Piskun <bigcat88@icloud.com>

Author: bigcat88

nc_py_api/ex_app/__init__.py

@@ -3,5 +3,5 @@
 from .defs import ApiScope, LogLvl
 from .integration_fastapi import nc_app, set_handlers, talk_bot_app
 from .misc import persistent_storage, verify_version
-from .ui.files_actions import UiActionFileInfo, UiFileActionHandlerInfo
+from .ui.files_actions import UiActionFileInfo
 from .uvicorn_fastapi import run_app

nc_py_api/ex_app/ui/files_actions.py

@@ -52,7 +52,7 @@ def order(self) -> int:
 
     @property
     def icon(self) -> str:
-        """-no description-."""
+        """Relative to the ExApp url with icon or empty value to use the default one icon."""
         return self._raw_data["icon"] if self._raw_data["icon"] else ""
 
     @property
@@ -119,21 +119,10 @@ def to_fs_node(self) -> FsNode:
         )
 
 
-class UiFileActionHandlerInfo(BaseModel):
-    """Action information Nextcloud sends to the External Application."""
-
-    actionName: str
-    """Name of the action, useful when App registers multiple actions for one handler."""
-    actionHandler: str
-    """Callback url, which was called with this information."""
-    actionFile: UiActionFileInfo
-    """Information about the file on which the action run."""
-
-
 class _UiFilesActionsAPI:
     """API for the drop-down menu in Nextcloud **Files app**."""
 
-    _ep_suffix: str = "files/actions/menu"
+    _ep_suffix: str = "ui/files-actions-menu"
 
     def __init__(self, session: NcSessionApp):
         self._session = session
@@ -142,25 +131,21 @@ def register(self, name: str, display_name: str, callback_url: str, **kwargs) ->
         """Registers the files a dropdown menu element."""
         require_capabilities("app_api", self._session.capabilities)
         params = {
-            "fileActionMenuParams": {
-                "name": name,
-                "display_name": display_name,
-                "mime": kwargs.get("mime", "file"),
-                "permissions": kwargs.get("permissions", 31),
-                "order": kwargs.get("order", 0),
-                "icon": kwargs.get("icon", ""),
-                "icon_class": kwargs.get("icon_class", "icon-app-api"),
-                "action_handler": callback_url,
-            },
+            "name": name,
+            "displayName": display_name,
+            "actionHandler": callback_url,
+            "icon": kwargs.get("icon", ""),
+            "mime": kwargs.get("mime", "file"),
+            "permissions": kwargs.get("permissions", 31),
+            "order": kwargs.get("order", 0),
         }
         self._session.ocs(method="POST", path=f"{self._session.ae_url}/{self._ep_suffix}", json=params)
 
     def unregister(self, name: str, not_fail=True) -> None:
         """Removes files dropdown menu element."""
         require_capabilities("app_api", self._session.capabilities)
-        params = {"fileActionMenuName": name}
         try:
-            self._session.ocs(method="DELETE", path=f"{self._session.ae_url}/{self._ep_suffix}", json=params)
+            self._session.ocs(method="DELETE", path=f"{self._session.ae_url}/{self._ep_suffix}", json={"name": name})
         except NextcloudExceptionNotFound as e:
             if not not_fail:
                 raise e from None

nc_py_api/ex_app/ui/top_menu.py

@@ -38,11 +38,7 @@ def icon(self) -> str:
     @property
     def admin_required(self) -> bool:
         """Flag that determines whether the entry menu is displayed only for administrators."""
-        return (
-            bool(int(self._raw_data["admin_required"]))
-            if isinstance(self._raw_data["admin_required"], str)
-            else bool(self._raw_data["admin_required"])
-        )
+        return bool(int(self._raw_data["admin_required"]))
 
     def __repr__(self):
         return f"<{self.__class__.__name__} name={self.name}, admin_required={self.admin_required}>"

tests/actual_tests/ui_files_actions_test.py

@@ -23,15 +23,15 @@ def test_register_ui_file_actions(nc_app):
     assert result.permissions == 1
     assert result.order == 1
     assert result.icon == ""
-    nc_app.ui.files_dropdown_menu.register("test_ui_action_any", "UI", "/ui_action2")
+    nc_app.ui.files_dropdown_menu.register("test_ui_action_any", "UI", "/ui_action2", icon="/img/icon.svg")
     result = nc_app.ui.files_dropdown_menu.get_entry("test_ui_action_any")
     assert result.name == "test_ui_action_any"
     assert result.display_name == "UI"
     assert result.action_handler == "/ui_action2"
     assert result.mime == "file"
     assert result.permissions == 31
     assert result.order == 0
-    assert result.icon == ""
+    assert result.icon == "/img/icon.svg"
     nc_app.ui.files_dropdown_menu.unregister(result.name)