add occ example, update pkgs and scopes, bump versions (#1)

* add occ example, update pkgs and scopes, bump versions

* remove commands for nc27

Author: andrey18106

Makefile

@@ -9,15 +9,15 @@ help:
 	@echo "  "
 	@echo "  build-push        build image and upload to ghcr.io"
 	@echo "  "
-	@echo "  run27             install UiExample for Nextcloud 27"
 	@echo "  run28             install UiExample for Nextcloud 28"
+	@echo "  run29             install UiExample for Nextcloud 29"
 	@echo "  run               install UiExample for Nextcloud Last"
 	@echo "  "
 	@echo "  For development of this example use PyCharm run configurations. Development is always set for last Nextcloud."
 	@echo "  First run 'UiExample' and then 'make registerXX', after that you can use/debug/develop it and easy test."
 	@echo "  "
-	@echo "  register27        perform registration of running UiExample into the 'manual_install' deploy daemon."
 	@echo "  register28        perform registration of running UiExample into the 'manual_install' deploy daemon."
+	@echo "  register29        perform registration of running UiExample into the 'manual_install' deploy daemon."
 	@echo "  register          perform registration of running UiExample into the 'manual_install' deploy daemon."
 	@echo "  "
 	@echo "  L10N (for manual translation):"
@@ -30,46 +30,46 @@ build-push:
 	docker login ghcr.io
 	docker buildx build --push --platform linux/arm64/v8,linux/amd64 --tag ghcr.io/cloud-py-api/ui_example:latest .
 
-.PHONY: run27
-run27:
-	docker exec master-stable27-1 sudo -u www-data php occ app_api:app:unregister ui_example --silent --force || true
-	docker exec master-stable27-1 sudo -u www-data php occ app_api:app:register ui_example --force-scopes \
-		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/ui_example/appinfo/info.xml
-
 .PHONY: run28
 run28:
 	docker exec master-stable28-1 sudo -u www-data php occ app_api:app:unregister ui_example --silent --force || true
 	docker exec master-stable28-1 sudo -u www-data php occ app_api:app:register ui_example --force-scopes \
 		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/ui_example/appinfo/info.xml
 
+.PHONY: run29
+run28:
+	docker exec master-stable29-1 sudo -u www-data php occ app_api:app:unregister ui_example --silent --force || true
+	docker exec master-stable29-1 sudo -u www-data php occ app_api:app:register ui_example --force-scopes \
+		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/ui_example/appinfo/info.xml
+
 .PHONY: run
 run:
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:unregister ui_example --silent --force || true
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:register ui_example --force-scopes \
 		--info-xml https://raw.githubusercontent.com/cloud-py-api/nc_py_api/main/examples/as_app/ui_example/appinfo/info.xml
 
-.PHONY: register27
-register27:
-	docker exec master-stable27-1 sudo -u www-data php occ app_api:app:unregister ui_example --silent --force || true
-	docker exec master-stable27-1 rm -rf /tmp/ui_example_l10n && docker cp l10n master-stable27-1:/tmp/ui_example_l10n
-	docker exec master-stable27-1 sudo -u www-data php occ app_api:app:register ui_example manual_install --json-info \
-  "{\"id\":\"ui_example\",\"name\":\"UI Example\",\"daemon_config_name\":\"manual_install\",\"version\":\"1.0.0\",\"secret\":\"12345\",\"port\":9035,\"scopes\":[],\"system_app\":0, \"translations_folder\":\"\/tmp\/ui_example_l10n\"}" \
-  --force-scopes --wait-finish
-
 .PHONY: register28
 register28:
 	docker exec master-stable28-1 sudo -u www-data php occ app_api:app:unregister ui_example --silent --force || true
 	docker exec master-stable28-1 rm -rf /tmp/ui_example_l10n && docker cp l10n master-stable28-1:/tmp/ui_example_l10n
 	docker exec master-stable28-1 sudo -u www-data php occ app_api:app:register ui_example manual_install --json-info \
-  "{\"id\":\"ui_example\",\"name\":\"UI Example\",\"daemon_config_name\":\"manual_install\",\"version\":\"1.0.0\",\"secret\":\"12345\",\"port\":9035,\"scopes\":[],\"system_app\":0, \"translations_folder\":\"\/tmp\/ui_example_l10n\"}" \
+  "{\"id\":\"ui_example\",\"name\":\"UI Example\",\"daemon_config_name\":\"manual_install\",\"version\":\"1.0.0\",\"secret\":\"12345\",\"port\":9035,\"scopes\":[\"OCC_COMMAND\", \"NOTIFICATIONS\"],\"system_app\":0, \"translations_folder\":\"\/tmp\/ui_example_l10n\"}" \
+  --force-scopes --wait-finish
+
+.PHONY: register29
+register29:
+	docker exec master-stable29-1 sudo -u www-data php occ app_api:app:unregister ui_example --silent --force || true
+	docker exec master-stable29-1 rm -rf /tmp/ui_example_l10n && docker cp l10n master-stable29-1:/tmp/ui_example_l10n
+	docker exec master-stable29-1 sudo -u www-data php occ app_api:app:register ui_example manual_install --json-info \
+  "{\"id\":\"ui_example\",\"name\":\"UI Example\",\"daemon_config_name\":\"manual_install\",\"version\":\"1.0.0\",\"secret\":\"12345\",\"port\":9035,\"scopes\":[\"OCC_COMMAND\", \"NOTIFICATIONS\"],\"system_app\":0, \"translations_folder\":\"\/tmp\/ui_example_l10n\"}" \
   --force-scopes --wait-finish
 
 .PHONY: register
 register:
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:unregister ui_example --silent --force || true
 	docker exec master-nextcloud-1 rm -rf /tmp/ui_example_l10n && docker cp l10n master-nextcloud-1:/tmp/ui_example_l10n
 	docker exec master-nextcloud-1 sudo -u www-data php occ app_api:app:register ui_example manual_install --json-info \
-  "{\"id\":\"ui_example\",\"name\":\"UI Example\",\"daemon_config_name\":\"manual_install\",\"version\":\"1.0.0\",\"secret\":\"12345\",\"port\":9035,\"scopes\":[\"NOTIFICATIONS\"],\"system_app\":0, \"translations_folder\":\"\/tmp\/ui_example_l10n\"}" \
+  "{\"id\":\"ui_example\",\"name\":\"UI Example\",\"daemon_config_name\":\"manual_install\",\"version\":\"1.0.0\",\"secret\":\"12345\",\"port\":9035,\"scopes\":[\"OCC_COMMAND\", \"NOTIFICATIONS\"],\"system_app\":0, \"translations_folder\":\"\/tmp\/ui_example_l10n\"}" \
   --force-scopes --wait-finish
 
 .PHONY: translation_templates

appinfo/info.xml

@@ -16,7 +16,7 @@
 	<bugs>https://github.com/cloud-py-api/ui_example/issues</bugs>
 	<repository type="git">https://github.com/cloud-py-api/ui_example</repository>
 	<dependencies>
-		<nextcloud min-version="27" max-version="29"/>
+		<nextcloud min-version="28" max-version="30"/>
 	</dependencies>
 	<external-app>
 		<docker-install>
@@ -25,6 +25,8 @@
 			<image-tag>latest</image-tag>
 		</docker-install>
 		<scopes>
+			<value>OCC_COMMAND</value>
+			<value>NOTIFICATIONS</value>
 		</scopes>
 		<system>false</system>
 	</external-app>

lib/main.py

@@ -2,10 +2,12 @@
 
 import os
 import random
+import time
 from contextlib import asynccontextmanager
 from typing import Annotated
 
 from fastapi import FastAPI, responses, Header, Request, Depends
+from fastapi.responses import StreamingResponse
 from starlette.middleware.base import BaseHTTPMiddleware
 from pydantic import BaseModel
 
@@ -197,6 +199,38 @@ def enabled_handler(enabled: bool, nc: NextcloudApp) -> str:
         nc.ui.resources.set_script("top_menu", "first_menu", "js/ui_example-main")
         nc.ui.top_menu.register("first_menu", "UI example", "img/app.svg")
         nc.ui.files_dropdown_menu.register("test_menu", _("Test menu"), "/test_menu", mime="image/jpeg", icon="img/app-dark.svg")
+        nc.occ_commands.register("ui_example:ping", "/occ_ping")
+        nc.occ_commands.register(
+            "ui_example:setup",
+            "/occ_setup",
+            arguments=[
+                {
+                    "name": "test_arg",
+                    "mode": "required",
+                    "description": "Test argument",
+                }
+            ],
+        )
+        nc.occ_commands.register(
+            "ui_example:stream",
+            "/occ_stream",
+            arguments=[
+                {
+                    "name": "stream_count",
+                    "mode": "required",
+                    "description": "Number of stream rows",
+                }
+            ],
+            options=[
+                {
+                    "name": "double",
+                    "mode": "optional",
+                    "description": "Double the stream rows",
+                    "default": False,
+                }
+            ],
+        )
+
 
         if nc.srv_version["major"] >= 29:
             nc.ui.settings.register_form(SETTINGS_EXAMPLE)
@@ -207,6 +241,9 @@ def enabled_handler(enabled: bool, nc: NextcloudApp) -> str:
         nc.ui.resources.delete_script("top_menu", "first_menu", "js/ui_example-main")
         nc.ui.top_menu.unregister("first_menu")
         nc.ui.files_dropdown_menu.unregister("test_menu")
+        nc.occ_commands.unregister("ui_example:ping")
+        nc.occ_commands.unregister("ui_example:setup")
+        nc.occ_commands.unregister("ui_example:stream")
     return ""
 
 
@@ -238,15 +275,46 @@ async def test_menu_handler(
     return responses.Response()
 
 
-class FileInfo(BaseModel):
-    getlastmodified: str
-    getetag: str
-    getcontenttype: str
-    fileid: int
-    permissions: str
-    size: int
-    getcontentlength: int
-    favorite: int
+class OccPayload(BaseModel):
+    arguments: dict | None = None
+    options: dict | None = None
+
+
+class OccData(BaseModel):
+    occ: OccPayload
+
+
+@APP.post("/occ_ping")
+async def occ_ping():
+    return responses.Response(content="<info>PONG</info>\n")
+
+
+@APP.post("/occ_setup")
+async def occ_setup(data: OccData):
+    print(f"params: {data}")
+    test_arg = data.occ.arguments['test_arg']
+    print(f"test_arg: {test_arg}")
+    if test_arg == "test":
+        return responses.Response(content="<info>OK</info>\n")
+    else:
+        return responses.Response(content="<error>ERROR</error>\n")
+
+
+def fake_data_streamer(data: OccData):
+    stream_count = int(data.occ.arguments['stream_count'])
+    if not stream_count:
+        stream_count = 1
+    if 'double' in data.occ.options:
+        stream_count *= 2
+    for i in range(stream_count):
+        yield f"<info>Test stream row {i}</info>\n"
+        time.sleep(0.5)
+
+
+@APP.post("/occ_stream")
+async def occ_stream(data: OccData):
+    print(f"params: {data}")
+    return StreamingResponse(fake_data_streamer(data), status_code=200, media_type="text/plain")
 
 
 @APP.post("/nextcloud_file")