ref: Update plugin to match manifest structure (#4)

* [manifest-structure] - Update plugin to match new manifest structure and update libraries accordingly.

* Apply suggestions from code review

Co-authored-by: João Victor Nunes <62393923+JoVictorNunes@users.noreply.github.com>

* [manifest-structure] - changes in review

---------

Co-authored-by: João Victor Nunes <62393923+JoVictorNunes@users.noreply.github.com>

Author: GuiLeme

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 dist
+dist-tsc
 debian/.debhelper/
 debian/debhelper-build-stamp
 debian/files

README.md

@@ -4,46 +4,30 @@
 
 This plugin is one of the official bbb plugins. It basically decreases the external video's volume when a user is speaking in the meeting.
 
-## Running the Plugin from Source
-
-1. Start the development server:
-
-```bash
-cd src/plugin-decrease-volume-on-speak
-npm install
-npm start
-```
-
-2. Add reference to it on BigBlueButton's `settings.yml` or `/etc/bigbluebutton/bbb-html5.yml`:
-
-```yaml
-  plugins:
-    - name: DecreaseVolumeOnSpeak
-      url: http://127.0.0.1:4701/static/DecreaseVolumeOnSpeak.js
-```
 
 ## Building the Plugin
 
 To build the plugin for production use, follow these steps:
 
 ```bash
-cd src/plugin-decrease-volume-on-speak
+cd $HOME/src/plugin-decrease-volume-on-speak
 npm ci
 npm run build-bundle
 ```
 
-The above command will generate the `dist` folder, containing the bundled JavaScript file named `DecreaseVolumeOnSpeak.js`. This file can be hosted on any HTTPS server.
+The above commands will generate the `dist` folder, containing the bundled JavaScript file named `DecreaseVolumeOnSpeak.js`. This file can be hosted on any HTTPS server along with its `manifest.json`.
+
+If you install the plugin separated from the manifest, remember to change the `javascriptEntrypointUrl` in the `manifest.json` to the correct endpoint.
 
-To use the plugin with BigBlueButton, add the plugin's URL to `settings.yml` as shown below:
+To use the plugin in BigBlueButton, send this parameter along in create call:
 
-```yaml
-public:
-  app:
-    ... // All app configurations
-  plugins:
-    - name: DecreaseVolumeOnSpeak
-      url: <<PLUGIN_URL>>
-  ... // All other configurations
 ```
+pluginManifests=[{"url":"<your-domain>/path/to/manifest.json"}]
+```
+
+Or additionally, you can add this same configuration in the `.properties` file from `bbb-web` in `/usr/share/bbb-web/WEB-INF/classes/bigbluebutton.properties`
+
+
+## Development mode
 
-Alternatively, you can host the bundled file on the BigBlueButton server by copying `dist/DecreaseVolumeOnSpeak.js` to the folder `/var/www/bigbluebutton-default/assets/plugins`. In this case, the `<<PLUGIN_URL>>` will be `https://<your-host>/plugins/DecreaseVolumeOnSpeak.js`.
+As for development mode (running this plugin from source), please, refer back to https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk section `Running the Plugin from Source`

manifest.json

@@ -0,0 +1,6 @@
+{
+  "requiredSdkVersion": "~0.0.59",
+  "name": "DecreaseVolumeOnSpeak",
+  "javascriptEntrypointUrl": "DecreaseVolumeOnSpeak.js",
+  "localesBaseUrl": "https://cdn.domain.com/pluginabc/"
+}