make extension work also with OpenCloud

Author: individual-it

.gitignore

@@ -1,6 +1,7 @@
 node_modules
 dist
 coverage
+pnpm-lock.yaml
 
 # Editor directories and files
 .vscode

Makefile

@@ -0,0 +1,25 @@
+.PHONY: installOcis installOpencloud dependenciesOcis dependenciesOpencloud install clean package
+
+installOcis: dependenciesOcis install
+
+installOpencloud: dependenciesOpencloud install
+
+dependenciesOcis: clean
+	$(MAKE) package PACKAGE_JSON=package-ocis.json
+	$(MAKE) depencenciesReplacement SOURCE=opencloud-eu DEST=ownclouders
+
+dependenciesOpencloud: clean
+	$(MAKE) package PACKAGE_JSON=package-opencloud.json
+	$(MAKE) depencenciesReplacement SOURCE=ownclouders DEST=opencloud-eu
+
+package:
+	jq -s '.[0] * .[1]' package-general.json $(PACKAGE_JSON) > package.json
+
+depencenciesReplacement:
+	find . -type f \( -name "*.ts" -o -name "*.vue" -o -name "*.prettierrc"  \) -not \( -path "./node_modules/*" -o -path "./dist/*" \) -print0 | xargs -0 sed -i 's/${SOURCE}/${DEST}/g'
+
+clean:
+	rm package.json
+
+install:
+	pnpm install

README.md

@@ -2,7 +2,7 @@
 
 ![cover photo](./images/cover-large.png)
 
-A markdown presentation viewer for [ownCloud web](https://github.com/owncloud/web/) (the webUI of [oCIS](https://github.com/owncloud/ocis/)) using the [reveal.js](https://revealjs.com/) library.
+A markdown presentation viewer for [OpenCloud](https://github.com/opencloud-eu/opencloud/) and [oCIS](https://github.com/owncloud/ocis/) using the [reveal.js](https://revealjs.com/) library.
 
 It allows users to:
 
@@ -11,42 +11,35 @@ It allows users to:
 
 ## Demonstration
 
-- [Demonstation page](https://ocis.in-nepal.de/com.github.jankaritech.mdpresentation-viewer/public/phDIUqntYOMSfcE/presentation.md)
+- [Demonstation page oCIS](https://ocis.in-nepal.de/com.github.jankaritech.mdpresentation-viewer/public/phDIUqntYOMSfcE/presentation.md)
 - Click on `Open in Presentation Viewer` to view the slides
 
 ## Supported oCIS and Web Versions
 
-- [oCIS](https://github.com/owncloud/ocis) (>= 6.x.x)
-- [Web](https://nodejs.org/en/) (>= 9.x.x)
+- [oCIS](https://github.com/owncloud/ocis) (>= 6.x.x) or [OpenCloud](https://github.com/opencloud-eu/opencloud/) (>= 2.0.0)
 
 ## App Installation
 
-> NOTE: Requires oCIS >= 6.0.0
-
 1. Download the zip file from the [releases page](https://github.com/JankariTech/web-app-presentation-viewer/releases)
 
-   For example: `mdpresentation-viewer-x.x.x.zip`
+   For example: `mdpresentation-viewer-<architecture>-x.x.x.zip`
 
-2. Extract the zip file to the `apps` directory of the oCIS server.
+2. Extract the zip file to the `apps` directory of the OpenCloud/oCIS server.
 
    Apps directory is set using the `WEB_ASSET_APPS_PATH` environment variable.
 
-### App Installation With [oCIS Deployment](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full)
+### App Installation With [OpenCloud](https://github.com/opencloud-eu/opencloud/tree/main/deployments/examples/opencloud_full) or [oCIS Deployment](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full)
 
-1. Copy [`deployments/mdpresentation-viewer.yml`](./deployments/mdpresentation-viewer.yml) into the [web_extensions](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full/web_extensions)
-subfolder of oCIS full deployment example.
-2. Add `MDPRESENTATION_VIEWER=:web_extensions/mdpresentation-viewer.yml` to the `## oCIS Web Extensions ##` section of the `.env` file of your installation (file is located in `deployments/examples/ocis_full`) and append it to the `COMPOSE_FILE` variable.
+1. Copy [`deployments/mdpresentation-viewer.yml`](./deployments/mdpresentation-viewer.yml) into the `web_extensions`
+subfolder.
+2. Add `MDPRESENTATION_VIEWER=:web_extensions/mdpresentation-viewer.yml` to the `Web Extensions` section of the `.env` file of your installation and append it to the `COMPOSE_FILE` variable.
     ```env
     ## oCIS Web Extensions ##
     MDPRESENTATION_VIEWER=:web_extensions/mdpresentation-viewer.yml
     
     COMPOSE_FILE=docker-compose.yml${...}${MDPRESENTATION_VIEWER:-}
     ```
-3. Run `docker compose up` to run oCIS with the extensions
-
-  oCIS URL: [ocis.owncloud.test](https://ocis.owncloud.test)
-
-  See the [docs](https://github.com/owncloud/ocis/tree/master/deployments/examples/ocis_full).
+3. Run `docker compose up` to run the system with the extensions
 
 ## Creating Presentation
 
@@ -59,16 +52,26 @@ This app has the following default slide separators:
 
 ## Development
 
+> [!IMPORTANT] When switching between OpenCloud and oCIS, make sure to clean the browser cache!
+> [!CAUTION] Before commiting changes run `make installOcis`
+
 #### Prerequisites
 
 - [Node.js `v18`](https://nodejs.org/en/)
 - [pnpm `v8`](https://pnpm.io/)
 - [Docker Compose](https://docs.docker.com/compose/)
+- [jq](https://jqlang.org/)
 
 #### 1. Install dependencies:
 
+For OpenCloud:
 ```bash
-pnpm install
+make installOpencloud
+```
+
+For oCIS:
+```bash
+make installOcis
 ```
 
 #### 2. Build the extension
@@ -81,12 +84,16 @@ pnpm build:w
 
 #### 3. Load the extension
 
-> NOTE: Requires oCIS >= 6.0.0
+Run the server with the extension:
 
-Run the oCIS server:
+For OpenCloud:
+```bash
+docker compose -f docker-compose-opencloud.yml up
+```
 
+For oCIS:
 ```bash
-docker compose up
+docker compose -f docker-compose-ocis.yml up
 ```
 
-oCIS URL: [localhost:9200](https://localhost:9200)
+server URL: [localhost:9200](https://localhost:9200)

docker-compose.yml docker-compose-ocis.ymldocker-compose.yml renamed to docker-compose-ocis.yml

@@ -0,0 +1,22 @@
+services:
+  ocis:
+    image: opencloudeu/opencloud-rolling:${OC_IMAGE_TAG:-latest}
+    entrypoint: /bin/sh
+    command: ['-c', 'opencloud init || true && opencloud server']
+    ports:
+      - 9200:9200
+    environment:
+      OC_URL: https://localhost:9200
+      OC_INSECURE: true
+      OC_LOG_LEVEL: error
+      # WEB
+      WEB_ASSET_APPS_PATH: /web/apps
+      # IDM
+      IDM_CREATE_DEMO_USERS: true
+      IDM_ADMIN_PASSWORD: admin
+      # PROXY
+      PROXY_ENABLE_BASIC_AUTH: true
+      PROXY_CSP_CONFIG_FILE_LOCATION: /etc/ocis/csp.yml
+    volumes:
+      - ./dist:/web/apps:ro
+      - ./dev/config/csp.yml:/etc/ocis/csp.yml

docker-compose-opencloud.yml

@@ -0,0 +1,51 @@
+{
+  "name": "mdpresentation-viewer",
+  "version": "2.1.0-alpha.1",
+  "description": "Markdown Presentation Viewer for ownCloud Web",
+  "license": "Apache-2.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "pnpm vite build",
+    "build:w": "pnpm vite build --watch --mode development",
+    "lint": "eslint './*.{js,cjs,mjs,ts}' '{src,tests}/**/*.{js,cjs,mjs,ts,vue}' --color",
+    "lint:fix": "pnpm lint --fix",
+    "test:unit": "vitest",
+    "test:e2e": "NODE_TLS_REJECT_UNAUTHORIZED=0 cucumber-js"
+  },
+  "dependencies": {
+    "@pnpm/meta-updater": "^2.0.5",
+    "@types/reveal.js": "^4.4.8",
+    "reveal.js": "^5.1.0"
+  },
+  "devDependencies": {
+    "@babel/eslint-parser": "^7.24.5",
+    "@cucumber/cucumber": "^10.6.0",
+    "@cucumber/pretty-formatter": "^1.0.1",
+    "@playwright/test": "^1.44.0",
+    "@types/node": "^20.12.10",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
+    "@vitejs/plugin-vue": "^5.0.5",
+    "@vitest/coverage-v8": "1.5.0",
+    "@vue/test-utils": "^2.4.6",
+    "axios": "^1.8.2",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier-vue": "^5.0.0",
+    "eslint-plugin-unused-imports": "^3.2.0",
+    "eslint-plugin-vue": "^9.25.0",
+    "happy-dom": "^15.10.2",
+    "typescript": "^5.4.5",
+    "vite": "^5.2.11",
+    "vitest": "^1.6.1",
+    "vue": "^3.4.27"
+  },
+  "pnpm": {
+    "peerDependencyRules": {
+      "ignoreMissing": [
+        "design-system"
+      ]
+    }
+  },
+  "packageManager": "pnpm@8.15.1"
+}

package-general.json

@@ -0,0 +1,12 @@
+{
+  "devDependencies": {
+    "@ownclouders/extension-sdk": "0.0.5-alpha.2",
+    "@ownclouders/prettier-config": "0.0.1"
+  },
+  "pnpm": {
+    "peerDependencies": {
+      "@ownclouders/web-client": "https://gitpkg.vercel.app/owncloud/web/packages/web-client?1d95aec2326958dd28643697618c8bb1cea44929",
+      "@ownclouders/web-pkg": "https://gitpkg.vercel.app/owncloud/web/packages/web-pkg?1d95aec2326958dd28643697618c8bb1cea44929"
+    }
+  }
+}

package-ocis.json

@@ -0,0 +1,12 @@
+{
+  "devDependencies": {
+    "@opencloud-eu/extension-sdk": "^1.0.0",
+    "@opencloud-eu/prettier-config": "^1.0.0"
+  },
+  "pnpm": {
+    "peerDependencies": {
+      "@opencloud-eu/web-client": "^1.0.0",
+      "@opencloud-eu/web-pkg": "^1.0.0"
+    }
+  }
+}

package-opencloud.json

@@ -14,15 +14,14 @@
     "test:e2e": "NODE_TLS_REJECT_UNAUTHORIZED=0 cucumber-js"
   },
   "dependencies": {
+    "@pnpm/meta-updater": "^2.0.5",
     "@types/reveal.js": "^4.4.8",
     "reveal.js": "^5.1.0"
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.24.5",
     "@cucumber/cucumber": "^10.6.0",
     "@cucumber/pretty-formatter": "^1.0.1",
-    "@ownclouders/extension-sdk": "0.0.5-alpha.2",
-    "@ownclouders/prettier-config": "0.0.1",
     "@playwright/test": "^1.44.0",
     "@types/node": "^20.12.10",
     "@typescript-eslint/eslint-plugin": "^7.8.0",
@@ -39,17 +38,19 @@
     "typescript": "^5.4.5",
     "vite": "^5.2.11",
     "vitest": "^1.6.1",
-    "vue": "^3.4.27"
-  },
-  "peerDependencies": {
-    "@ownclouders/web-client": "https://gitpkg.vercel.app/owncloud/web/packages/web-client?1d95aec2326958dd28643697618c8bb1cea44929",
-    "@ownclouders/web-pkg": "https://gitpkg.vercel.app/owncloud/web/packages/web-pkg?1d95aec2326958dd28643697618c8bb1cea44929"
+    "vue": "^3.4.27",
+    "@ownclouders/extension-sdk": "0.0.5-alpha.2",
+    "@ownclouders/prettier-config": "0.0.1"
   },
   "pnpm": {
     "peerDependencyRules": {
       "ignoreMissing": [
         "design-system"
       ]
+    },
+    "peerDependencies": {
+      "@ownclouders/web-client": "https://gitpkg.vercel.app/owncloud/web/packages/web-client?1d95aec2326958dd28643697618c8bb1cea44929",
+      "@ownclouders/web-pkg": "https://gitpkg.vercel.app/owncloud/web/packages/web-pkg?1d95aec2326958dd28643697618c8bb1cea44929"
     }
   },
   "packageManager": "pnpm@8.15.1"