UI implementation draft (AppAPI 1.4+)(Part1) (#168)

Reference: nextcloud/app_api#135 First part. * Added API for UI, Example(not finished yet). Missing: * Example and description how to use it in docs, and example in example folder is not fully finished. --------- Signed-off-by: Alexander Piskun <[email protected]> Signed-off-by: Andrey Borysenko <[email protected]> Co-authored-by: Andrey Borysenko <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
cloud-py-api · Dec 3, 2023 · 2dbc82c · 2dbc82c
1 parent d229b43
commit 2dbc82c
Show file tree

Hide file tree

Showing 59 changed files with 17,834 additions and 114 deletions.
diff --git a/.run/Skeleton (27).run.xml b/.run/Skeleton (27).run.xml
@@ -0,0 +1,29 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Skeleton (27)" type="PythonConfigurationType" factoryName="Python">
+    <module name="nc_py_api" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <envs>
+      <env name="PYTHONUNBUFFERED" value="1" />
+      <env name="APP_ID" value="skeleton" />
+      <env name="APP_PORT" value="9030" />
+      <env name="APP_SECRET" value="12345" />
+      <env name="APP_VERSION" value="1.0.0" />
+      <env name="NEXTCLOUD_URL" value="http://stable27.local/index.php" />
+    </envs>
+    <option name="SDK_HOME" value="" />
+    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />
+    <option name="IS_MODULE_SDK" value="true" />
+    <option name="ADD_CONTENT_ROOTS" value="true" />
+    <option name="ADD_SOURCE_ROOTS" value="true" />
+    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+    <option name="SCRIPT_NAME" value="$PROJECT_DIR$/examples/as_app/skeleton/src/main.py" />
+    <option name="PARAMETERS" value="" />
+    <option name="SHOW_COMMAND_LINE" value="false" />
+    <option name="EMULATE_TERMINAL" value="false" />
+    <option name="MODULE_MODE" value="false" />
+    <option name="REDIRECT_INPUT" value="false" />
+    <option name="INPUT_FILE" value="" />
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/.run/Skeleton (28).run.xml → .run/Skeleton (last).run.xml b/.run/Skeleton (28).run.xml → .run/Skeleton (last).run.xml
@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Skeleton (28)" type="PythonConfigurationType" factoryName="Python">
+  <configuration default="false" name="Skeleton (last)" type="PythonConfigurationType" factoryName="Python">
     <module name="nc_py_api" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />

diff --git a/.run/TalkBot (27).run.xml b/.run/TalkBot (27).run.xml
@@ -0,0 +1,29 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="TalkBot (27)" type="PythonConfigurationType" factoryName="Python">
+    <module name="nc_py_api" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <envs>
+      <env name="PYTHONUNBUFFERED" value="1" />
+      <env name="APP_ID" value="talk_bot" />
+      <env name="APP_PORT" value="9032" />
+      <env name="APP_SECRET" value="12345" />
+      <env name="APP_VERSION" value="1.0.0" />
+      <env name="NEXTCLOUD_URL" value="http://stable27.local/index.php" />
+    </envs>
+    <option name="SDK_HOME" value="" />
+    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />
+    <option name="IS_MODULE_SDK" value="true" />
+    <option name="ADD_CONTENT_ROOTS" value="true" />
+    <option name="ADD_SOURCE_ROOTS" value="true" />
+    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+    <option name="SCRIPT_NAME" value="$PROJECT_DIR$/examples/as_app/talk_bot/src/main.py" />
+    <option name="PARAMETERS" value="" />
+    <option name="SHOW_COMMAND_LINE" value="false" />
+    <option name="EMULATE_TERMINAL" value="false" />
+    <option name="MODULE_MODE" value="false" />
+    <option name="REDIRECT_INPUT" value="false" />
+    <option name="INPUT_FILE" value="" />
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/.run/TalkBot (28).run.xml → .run/TalkBot (last).run.xml b/.run/TalkBot (28).run.xml → .run/TalkBot (last).run.xml
@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="TalkBot (28)" type="PythonConfigurationType" factoryName="Python">
+  <configuration default="false" name="TalkBot (last)" type="PythonConfigurationType" factoryName="Python">
     <module name="nc_py_api" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />

diff --git a/.run/TalkBotAI (28).run.xml → .run/TalkBotAI (last).run.xml b/.run/TalkBotAI (28).run.xml → .run/TalkBotAI (last).run.xml
@@ -1,15 +1,15 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="TalkBotAI (28)" type="PythonConfigurationType" factoryName="Python">
+  <configuration default="false" name="TalkBotAI (last)" type="PythonConfigurationType" factoryName="Python">
     <module name="nc_py_api" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
     <envs>
+      <env name="PYTHONUNBUFFERED" value="1" />
       <env name="APP_ID" value="talk_bot_ai" />
       <env name="APP_PORT" value="9034" />
       <env name="APP_SECRET" value="12345" />
       <env name="APP_VERSION" value="1.0.0" />
       <env name="NEXTCLOUD_URL" value="http://nextcloud.local" />
-      <env name="PYTHONUNBUFFERED" value="1" />
     </envs>
     <option name="SDK_HOME" value="" />
     <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$" />

diff --git a/.run/ToGif (28).run.xml → .run/ToGif (last).run.xml b/.run/ToGif (28).run.xml → .run/ToGif (last).run.xml
@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="ToGif (28)" type="PythonConfigurationType" factoryName="Python">
+  <configuration default="false" name="ToGif (last)" type="PythonConfigurationType" factoryName="Python">
     <module name="nc_py_api" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />

diff --git a/.run/UiExample (27).run.xml b/.run/UiExample (27).run.xml
@@ -0,0 +1,29 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="UiExample (27)" type="PythonConfigurationType" factoryName="Python">
+    <module name="nc_py_api" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <envs>
+      <env name="PYTHONUNBUFFERED" value="1" />
+      <env name="APP_ID" value="ui_example" />
+      <env name="APP_PORT" value="9035" />
+      <env name="APP_SECRET" value="12345" />
+      <env name="APP_VERSION" value="1.0.0" />
+      <env name="NEXTCLOUD_URL" value="http://stable27.local/index.php" />
+    </envs>
+    <option name="SDK_HOME" value="" />
+    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/examples/as_app/ui_example/" />
+    <option name="IS_MODULE_SDK" value="true" />
+    <option name="ADD_CONTENT_ROOTS" value="true" />
+    <option name="ADD_SOURCE_ROOTS" value="true" />
+    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+    <option name="SCRIPT_NAME" value="$PROJECT_DIR$/examples/as_app/ui_example/lib/main.py" />
+    <option name="PARAMETERS" value="" />
+    <option name="SHOW_COMMAND_LINE" value="false" />
+    <option name="EMULATE_TERMINAL" value="false" />
+    <option name="MODULE_MODE" value="false" />
+    <option name="REDIRECT_INPUT" value="false" />
+    <option name="INPUT_FILE" value="" />
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/.run/UiExample (last).run.xml b/.run/UiExample (last).run.xml
@@ -0,0 +1,29 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="UiExample (last)" type="PythonConfigurationType" factoryName="Python">
+    <module name="nc_py_api" />
+    <option name="INTERPRETER_OPTIONS" value="" />
+    <option name="PARENT_ENVS" value="true" />
+    <envs>
+      <env name="PYTHONUNBUFFERED" value="1" />
+      <env name="APP_ID" value="ui_example" />
+      <env name="APP_PORT" value="9035" />
+      <env name="APP_SECRET" value="12345" />
+      <env name="APP_VERSION" value="1.0.0" />
+      <env name="NEXTCLOUD_URL" value="http://nextcloud.local/index.php" />
+    </envs>
+    <option name="SDK_HOME" value="" />
+    <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/examples/as_app/ui_example/" />
+    <option name="IS_MODULE_SDK" value="true" />
+    <option name="ADD_CONTENT_ROOTS" value="true" />
+    <option name="ADD_SOURCE_ROOTS" value="true" />
+    <EXTENSION ID="PythonCoverageRunConfigurationExtension" runner="coverage.py" />
+    <option name="SCRIPT_NAME" value="$PROJECT_DIR$/examples/as_app/ui_example/lib/main.py" />
+    <option name="PARAMETERS" value="" />
+    <option name="SHOW_COMMAND_LINE" value="false" />
+    <option name="EMULATE_TERMINAL" value="false" />
+    <option name="MODULE_MODE" value="false" />
+    <option name="REDIRECT_INPUT" value="false" />
+    <option name="INPUT_FILE" value="" />
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/.run/register_nc_py_api (28).run.xml → .run/register_nc_py_api (last).run.xml b/.run/register_nc_py_api (28).run.xml → .run/register_nc_py_api (last).run.xml
@@ -1,15 +1,15 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="register_nc_py_api (28)" type="PythonConfigurationType" factoryName="Python">
+  <configuration default="false" name="register_nc_py_api (last)" type="PythonConfigurationType" factoryName="Python">
     <module name="nc_py_api" />
     <option name="INTERPRETER_OPTIONS" value="" />
     <option name="PARENT_ENVS" value="true" />
     <envs>
+      <env name="PYTHONUNBUFFERED" value="1" />
       <env name="APP_ID" value="nc_py_api" />
       <env name="APP_PORT" value="9009" />
       <env name="APP_SECRET" value="12345" />
       <env name="APP_VERSION" value="1.0.0" />
       <env name="NEXTCLOUD_URL" value="http://nextcloud.local" />
-      <env name="PYTHONUNBUFFERED" value="1" />
     </envs>
     <option name="SDK_HOME" value="" />
     <option name="WORKING_DIRECTORY" value="$PROJECT_DIR$/tests" />

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,11 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.5.2 - 2023-11-xx]
+## [0.6.0 - 2023-12-0x]
+
+### Added
+
+- Ability to develop applications with `UI`, example of such app, support for all new stuff of `AppAPI 1.4`. #168
 
 ### Fixed
 

diff --git a/Makefile b/Makefile
@@ -15,22 +15,22 @@ help:
 	@echo "  Next commands are only for dev environment with nextcloud-docker-dev!"
 	@echo "  They should run from the host you are developing on(with activated venv) and not in the container with Nextcloud!"
 	@echo "  "
-	@echo "  register28          register nc_py_api for Nextcloud 28"
+	@echo "  register            register nc_py_api for Nextcloud Last"
 	@echo "  register27          register nc_py_api for Nextcloud 27"
 	@echo "  "
-	@echo "  tests28             run nc_py_api tests for Nextcloud 28"
+	@echo "  tests               run nc_py_api tests for Nextcloud Last"
 	@echo "  tests27             run nc_py_api tests for Nextcloud 27"
 
-.PHONY: register28
-register28:
+.PHONY: register
+register:
 	/bin/sh scripts/dev_register.sh master-nextcloud-1 nextcloud.local
 
 .PHONY: register27
 register27:
 	/bin/sh scripts/dev_register.sh master-stable27-1 stable27.local
 
-.PHONY: tests28
-tests28:
+.PHONY: tests
+tests:
 	NEXTCLOUD_URL=http://nextcloud.local python3 -m pytest
 
 .PHONY: tests27

diff --git a/docs/NextcloudApp.rst b/docs/NextcloudApp.rst
@@ -195,7 +195,7 @@ an empty response (which will be a status of 200) and in the background already
 The last parameter is a structure describing the action and the file on which it needs to be performed,
 which is passed by the AppAPI when clicking on the drop-down context menu of the file.
 
-We use the built method :py:meth:`~nc_py_api.ex_app.ui.files.UiActionFileInfo.to_fs_node` into the structure to convert it
+We use the built method :py:meth:`~nc_py_api.ex_app.ui.files_actions.UiActionFileInfo.to_fs_node` into the structure to convert it
 into a standard :py:class:`~nc_py_api.files.FsNode` class that describes the file and pass the FsNode class instance to the background task.
 
 In the **convert_video_to_gif** function, a standard conversion using ``OpenCV`` from a video file to a GIF image occurs,

diff --git a/docs/reference/ExApp.rst b/docs/reference/ExApp.rst
@@ -33,8 +33,26 @@ UI methods should be accessed with the help of :class:`~nc_py_api.nextcloud.Next
 .. autoclass:: nc_py_api.ex_app.ui.ui.UiApi
     :members:
 
-.. automodule:: nc_py_api.ex_app.ui.files
+.. automodule:: nc_py_api.ex_app.ui.files_actions
     :members:
 
-.. autoclass:: nc_py_api.ex_app.ui.files._UiFilesActionsAPI
+.. autoclass:: nc_py_api.ex_app.ui.files_actions._UiFilesActionsAPI
+    :members:
+
+.. automodule:: nc_py_api.ex_app.ui.top_menu
+    :members:
+
+.. autoclass:: nc_py_api.ex_app.ui.top_menu._UiTopMenuAPI
+    :members:
+
+.. autoclass:: nc_py_api.ex_app.ui.resources._UiResources
+    :members:
+
+.. autoclass:: nc_py_api.ex_app.ui.resources.UiInitState
+    :members:
+
+.. autoclass:: nc_py_api.ex_app.ui.resources.UiScript
+    :members:
+
+.. autoclass:: nc_py_api.ex_app.ui.resources.UiStyle
     :members:
diff --git a/examples/as_app/skeleton/Makefile b/examples/as_app/skeleton/Makefile
@@ -9,25 +9,25 @@ help:
 	@echo "  "
 	@echo "  build-push        build image and upload to ghcr.io"
 	@echo "  "
-	@echo "  deploy28          deploy Skeleton to registered 'docker_dev' for Nextcloud 28"
+	@echo "  deploy            deploy Skeleton to registered 'docker_dev' for Nextcloud Last"
 	@echo "  deploy27          deploy Skeleton to registered 'docker_dev' for Nextcloud 27"
 	@echo "  "
-	@echo "  run28             install Skeleton for Nextcloud 28"
+	@echo "  run               install Skeleton for Nextcloud Last"
 	@echo "  run27             install Skeleton for Nextcloud 27"
 	@echo "  "
 	@echo "  For development of this example use PyCharm run configurations. Development is always set for last Nextcloud."
 	@echo "  First run 'Skeleton' and then 'make registerXX', after that you can use/debug/develop it and easy test."
 	@echo "  "
-	@echo "  register28        perform registration of running Skeleton into the 'manual_install' deploy daemon."
+	@echo "  register          perform registration of running Skeleton into the 'manual_install' deploy daemon."
 	@echo "  register27        perform registration of running Skeleton into the 'manual_install' deploy daemon."
 
 .PHONY: build-push
 build-push:
 	docker login ghcr.io
 	docker buildx build --push --platform linux/arm64/v8,linux/amd64 --tag ghcr.io/cloud-py-api/skeleton:latest .
 
-.PHONY: deploy28
-deploy28:
+.PHONY: deploy
+deploy:
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:unregister skeleton --silent || true
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:deploy skeleton docker_dev \
 		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/skeleton/appinfo/info.xml
@@ -38,8 +38,8 @@ deploy27:
 	docker exec master-stable27-1 sudo -u www-data php occ app_api:app:deploy skeleton docker_dev \
 		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/skeleton/appinfo/info.xml
 
-.PHONY: run28
-run28:
+.PHONY: run
+run:
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:unregister skeleton --silent || true
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:register skeleton docker_dev --force-scopes \
 		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/skeleton/appinfo/info.xml
@@ -50,8 +50,8 @@ run27:
 	docker exec master-stable27-1 sudo -u www-data php occ app_api:app:register skeleton docker_dev --force-scopes \
 		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/skeleton/appinfo/info.xml
 
-.PHONY: register28
-register28:
+.PHONY: register
+register:
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:unregister skeleton --silent || true
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:register skeleton manual_install --json-info \
   "{\"appid\":\"skeleton\",\"name\":\"App Skeleton\",\"daemon_config_name\":\"manual_install\",\"version\":\"1.0.0\",\"secret\":\"12345\",\"host\":\"host.docker.internal\",\"port\":9030,\"scopes\":{\"required\":[],\"optional\":[]},\"protocol\":\"http\",\"system_app\":0}" \

diff --git a/examples/as_app/skeleton/appinfo/info.xml b/examples/as_app/skeleton/appinfo/info.xml
@@ -16,7 +16,7 @@
 	<bugs>https://github.com/cloud-py-api/nc_py_api/issues</bugs>
 	<repository type="git">https://github.com/cloud-py-api/nc_py_api</repository>
 	<dependencies>
-		<nextcloud min-version="27" max-version="28"/>
+		<nextcloud min-version="27" max-version="29"/>
 	</dependencies>
 	<external-app>
 		<docker-install>

diff --git a/examples/as_app/talk_bot/Makefile b/examples/as_app/talk_bot/Makefile
@@ -9,25 +9,25 @@ help:
 	@echo "  "
 	@echo "  build-push        build image and upload to ghcr.io"
 	@echo "  "
-	@echo "  deploy28          deploy example to registered 'docker_dev' for Nextcloud 28"
+	@echo "  deploy            deploy example to registered 'docker_dev' for Nextcloud Last"
 	@echo "  deploy27          deploy example to registered 'docker_dev' for Nextcloud 27"
 	@echo "  "
-	@echo "  run28             install TalkBot for Nextcloud 28"
+	@echo "  run               install TalkBot for Nextcloud Last"
 	@echo "  run27             install TalkBot for Nextcloud 27"
 	@echo "  "
 	@echo "  For development of this example use PyCharm run configurations. Development is always set for last Nextcloud."
 	@echo "  First run 'TalkBot' and then 'make registerXX', after that you can use/debug/develop it and easy test."
 	@echo "  "
-	@echo "  register28        perform registration of running 'TalkBot' into the 'manual_install' deploy daemon."
+	@echo "  register          perform registration of running 'TalkBot' into the 'manual_install' deploy daemon."
 	@echo "  register27        perform registration of running 'TalkBot' into the 'manual_install' deploy daemon."
 
 .PHONY: build-push
 build-push:
 	docker login ghcr.io
 	docker buildx build --push --platform linux/arm64/v8,linux/amd64 --tag ghcr.io/cloud-py-api/talk_bot:latest .
 
-.PHONY: deploy28
-deploy28:
+.PHONY: deploy
+deploy:
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:unregister talk_bot --silent || true
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:deploy talk_bot docker_dev \
 		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/talk_bot/appinfo/info.xml
@@ -38,8 +38,8 @@ deploy27:
 	docker exec master-stable27-1 sudo -u www-data php occ app_api:app:deploy talk_bot docker_dev \
 		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/talk_bot/appinfo/info.xml
 
-.PHONY: run28
-run28:
+.PHONY: run
+run:
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:unregister talk_bot --silent || true
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:register talk_bot docker_dev --force-scopes \
 		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/talk_bot/appinfo/info.xml
@@ -50,8 +50,8 @@ run27:
 	docker exec master-stable27-1 sudo -u www-data php occ app_api:app:register talk_bot docker_dev --force-scopes \
 		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/talk_bot/appinfo/info.xml
 
-.PHONY: register28
-register28:
+.PHONY: register
+register:
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:unregister talk_bot --silent || true
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:register talk_bot manual_install --json-info \
   "{\"appid\":\"talk_bot\",\"name\":\"TalkBot\",\"daemon_config_name\":\"manual_install\",\"version\":\"1.0.0\",\"secret\":\"12345\",\"host\":\"host.docker.internal\",\"port\":9032,\"scopes\":{\"required\":[\"TALK\", \"TALK_BOT\"],\"optional\":[]},\"protocol\":\"http\",\"system_app\":0}" \

diff --git a/examples/as_app/talk_bot/appinfo/info.xml b/examples/as_app/talk_bot/appinfo/info.xml
@@ -16,7 +16,7 @@
 	<bugs>https://github.com/cloud-py-api/nc_py_api/issues</bugs>
 	<repository type="git">https://github.com/cloud-py-api/nc_py_api</repository>
 	<dependencies>
-		<nextcloud min-version="27" max-version="28"/>
+		<nextcloud min-version="27" max-version="29"/>
 	</dependencies>
 	<external-app>
 		<docker-install>