openvidu-components: Added custom-activities-panel tutorial

openvidu-components/openvidu-custom-activities-panel/.browserslistrc

@@ -0,0 +1,16 @@
+# This file is used by the build system to adjust CSS and JS output to support the specified browsers below.
+# For additional information regarding the format and rule options, please see:
+# https://github.com/browserslist/browserslist#queries
+
+# For the full list of supported browsers by the Angular framework, please see:
+# https://angular.io/guide/browser-support
+
+# You can see what browsers were selected by your queries by running:
+#   npx browserslist
+
+last 1 Chrome version
+last 1 Firefox version
+last 2 Edge major versions
+last 2 Safari major versions
+last 2 iOS major versions
+Firefox ESR

openvidu-components/openvidu-custom-activities-panel/.gitignore

@@ -0,0 +1,44 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# Compiled output
+/dist
+/tmp
+/out-tsc
+/bazel-out
+
+# Node
+/node_modules
+npm-debug.log
+yarn-error.log
+
+# IDEs and editors
+.idea/
+.vscode
+.angular
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# Visual Studio Code
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history/*
+
+# Miscellaneous
+/.angular/cache
+.sass-cache/
+/connect.lock
+/coverage
+/libpeerconnection.log
+testem.log
+/typings
+
+# System files
+.DS_Store
+Thumbs.db

openvidu-components/openvidu-custom-activities-panel/README.md

@@ -0,0 +1,27 @@
+# OpenviduCustomActivitiesPanel
+
+This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 13.3.2.
+
+## Development server
+
+Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.
+
+## Code scaffolding
+
+Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
+
+## Build
+
+Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
+
+## Running unit tests
+
+Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
+
+## Running end-to-end tests
+
+Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.
+
+## Further help
+
+To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.

openvidu-components/openvidu-custom-activities-panel/angular.json

@@ -0,0 +1,118 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "version": 1,
+  "newProjectRoot": "projects",
+  "projects": {
+    "openvidu-custom-activities-panel": {
+      "projectType": "application",
+      "schematics": {
+        "@schematics/angular:component": {
+          "inlineTemplate": true,
+          "inlineStyle": true,
+          "style": "scss",
+          "skipTests": true
+        },
+        "@schematics/angular:class": {
+          "skipTests": true
+        },
+        "@schematics/angular:directive": {
+          "skipTests": true
+        },
+        "@schematics/angular:guard": {
+          "skipTests": true
+        },
+        "@schematics/angular:interceptor": {
+          "skipTests": true
+        },
+        "@schematics/angular:pipe": {
+          "skipTests": true
+        },
+        "@schematics/angular:resolver": {
+          "skipTests": true
+        },
+        "@schematics/angular:service": {
+          "skipTests": true
+        },
+        "@schematics/angular:application": {
+          "strict": true
+        }
+      },
+      "root": "",
+      "sourceRoot": "src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:browser",
+          "options": {
+            "outputPath": "dist/openvidu-custom-activities-panel",
+            "index": "src/index.html",
+            "main": "src/main.ts",
+            "polyfills": "src/polyfills.ts",
+            "tsConfig": "tsconfig.app.json",
+            "inlineStyleLanguage": "scss",
+            "assets": [
+              "src/favicon.ico",
+              "src/assets"
+            ],
+            "styles": [
+              "./node_modules/@angular/material/prebuilt-themes/indigo-pink.css",
+              "src/styles.scss"
+            ],
+            "scripts": []
+          },
+          "configurations": {
+            "production": {
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "500kb",
+                  "maximumError": "1mb"
+                },
+                {
+                  "type": "anyComponentStyle",
+                  "maximumWarning": "2kb",
+                  "maximumError": "4kb"
+                }
+              ],
+              "fileReplacements": [
+                {
+                  "replace": "src/environments/environment.ts",
+                  "with": "src/environments/environment.prod.ts"
+                }
+              ],
+              "outputHashing": "all"
+            },
+            "development": {
+              "buildOptimizer": false,
+              "optimization": false,
+              "vendorChunk": true,
+              "extractLicenses": false,
+              "sourceMap": true,
+              "namedChunks": true
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "configurations": {
+            "production": {
+              "browserTarget": "openvidu-custom-activities-panel:build:production"
+            },
+            "development": {
+              "browserTarget": "openvidu-custom-activities-panel:build:development"
+            }
+          },
+          "defaultConfiguration": "development"
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "browserTarget": "openvidu-custom-activities-panel:build"
+          }
+        }
+      }
+    }
+  },
+  "defaultProject": "openvidu-custom-activities-panel"
+}

openvidu-components/openvidu-custom-activities-panel/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "openvidu-custom-activities-panel",
+  "version": "2.21.0",
+  "scripts": {
+    "ng": "ng",
+    "start": "ng serve",
+    "build": "ng build",
+    "watch": "ng build --watch --configuration development"
+  },
+  "private": true,
+  "dependencies": {
+    "@angular/animations": "~13.3.0",
+    "@angular/cdk": "~13.3.2",
+    "@angular/common": "~13.3.0",
+    "@angular/compiler": "~13.3.0",
+    "@angular/core": "~13.3.0",
+    "@angular/forms": "~13.3.0",
+    "@angular/material": "~13.3.2",
+    "@angular/platform-browser": "~13.3.0",
+    "@angular/platform-browser-dynamic": "~13.3.0",
+    "@angular/router": "~13.3.0",
+    "openvidu-angular": "file:openvidu-angular-2.22.0.tgz",
+    "rxjs": "~7.5.0",
+    "tslib": "^2.3.0",
+    "zone.js": "~0.11.4"
+  },
+  "devDependencies": {
+    "@angular-devkit/build-angular": "~13.3.2",
+    "@angular/cli": "~13.3.2",
+    "@angular/compiler-cli": "~13.3.0",
+    "@types/node": "^12.11.1",
+    "typescript": "~4.6.2"
+  }
+}

openvidu-components/openvidu-custom-activities-panel/src/app/app.component.ts

@@ -0,0 +1,151 @@
+import { Component, OnInit } from "@angular/core";
+import { catchError, throwError as observableThrowError } from "rxjs";
+import { HttpClient, HttpHeaders } from "@angular/common/http";
+
+import { TokenModel } from "openvidu-angular";
+import { Session } from "openvidu-browser";
+
+@Component({
+	selector: "app-root",
+	template: `
+		<ov-videoconference
+			[tokens]="tokens"
+			[toolbarRecordingButton]="false"
+			[toolbarDisplaySessionName]="false"
+		>
+			<div *ovActivitiesPanel id="my-panel">
+				<h3>ACTIVITIES</h3>
+				<div>
+					CUSTOM ACTIVITIES
+				</div>
+			</div>
+		</ov-videoconference>
+	`,
+	styles: [
+		`
+			#my-panel {
+				background: #aafffc;
+				height: 100%;
+				overflow: hidden;
+				text-align: center;
+			}
+		`,
+	],
+})
+export class AppComponent implements OnInit{
+	title = "openvidu-custom-activities-panel";
+	tokens!: TokenModel;
+	sessionId = "activities-panel-directive-example";
+	OPENVIDU_SERVER_URL = "https://localhost:4443";
+	OPENVIDU_SERVER_SECRET = "MY_SECRET";
+	session!: Session;
+	messages: string[] = [];
+	constructor(private httpClient: HttpClient) {}
+
+	async ngOnInit() {
+		this.tokens = {
+			webcam: await this.getToken(),
+			screen: await this.getToken(),
+		};
+	}
+
+	/**
+	 * --------------------------
+	 * SERVER-SIDE RESPONSIBILITY
+	 * --------------------------
+	 * This method retrieve the mandatory user token from OpenVidu Server,
+	 * in this case making use Angular http API.
+	 * This behavior MUST BE IN YOUR SERVER-SIDE IN PRODUCTION. In this case:
+	 *   1) Initialize a Session in OpenVidu Server	(POST /openvidu/api/sessions)
+	 *   2) Create a Connection in OpenVidu Server (POST /openvidu/api/sessions/<SESSION_ID>/connection)
+	 *   3) The Connection.token must be consumed in Session.connect() method
+	 */
+
+	getToken(): Promise<string> {
+		return this.createSession(this.sessionId).then((sessionId: string) => {
+			return this.createToken(sessionId);
+		});
+	}
+
+	createSession(sessionId: string): Promise<string> {
+		return new Promise((resolve, reject) => {
+			const body = JSON.stringify({ customSessionId: sessionId });
+			const options = {
+				headers: new HttpHeaders({
+					Authorization:
+						"Basic " + btoa("OPENVIDUAPP:" + this.OPENVIDU_SERVER_SECRET),
+					"Content-Type": "application/json",
+				}),
+			};
+			return this.httpClient
+				.post(
+					this.OPENVIDU_SERVER_URL + "/openvidu/api/sessions",
+					body,
+					options
+				)
+				.pipe(
+					catchError((error) => {
+						if (error.status === 409) {
+							resolve(sessionId);
+						} else {
+							console.warn(
+								"No connection to OpenVidu Server. This may be a certificate error at " +
+									this.OPENVIDU_SERVER_URL
+							);
+							if (
+								window.confirm(
+									'No connection to OpenVidu Server. This may be a certificate error at "' +
+										this.OPENVIDU_SERVER_URL +
+										'"\n\nClick OK to navigate and accept it. If no certificate warning is shown, then check that your OpenVidu Server' +
+										'is up and running at "' +
+										this.OPENVIDU_SERVER_URL +
+										'"'
+								)
+							) {
+								location.assign(
+									this.OPENVIDU_SERVER_URL + "/accept-certificate"
+								);
+							}
+						}
+						return observableThrowError(error);
+					})
+				)
+				.subscribe((response: any) => {
+					console.log(response);
+					resolve(response["id"]);
+				});
+		});
+	}
+
+	createToken(sessionId: string): Promise<string> {
+		return new Promise((resolve, reject) => {
+			const body = {};
+			const options = {
+				headers: new HttpHeaders({
+					Authorization:
+						"Basic " + btoa("OPENVIDUAPP:" + this.OPENVIDU_SERVER_SECRET),
+					"Content-Type": "application/json",
+				}),
+			};
+			return this.httpClient
+				.post(
+					this.OPENVIDU_SERVER_URL +
+						"/openvidu/api/sessions/" +
+						sessionId +
+						"/connection",
+					body,
+					options
+				)
+				.pipe(
+					catchError((error) => {
+						reject(error);
+						return observableThrowError(error);
+					})
+				)
+				.subscribe((response: any) => {
+					console.log(response);
+					resolve(response["token"]);
+				});
+		});
+	}
+}

openvidu-components/openvidu-custom-activities-panel/src/app/app.module.ts

@@ -0,0 +1,25 @@
+import { NgModule } from '@angular/core';
+import { BrowserModule } from '@angular/platform-browser';
+
+import { AppComponent } from './app.component';
+import { BrowserAnimationsModule } from '@angular/platform-browser/animations';
+import { OpenViduAngularConfig, OpenViduAngularModule } from 'openvidu-angular';
+import { environment } from 'src/environments/environment';
+
+const config: OpenViduAngularConfig = {
+  production: environment.production
+};
+
+@NgModule({
+  declarations: [
+    AppComponent
+  ],
+  imports: [
+    BrowserModule,
+    BrowserAnimationsModule,
+    OpenViduAngularModule.forRoot(config)
+  ],
+  providers: [],
+  bootstrap: [AppComponent]
+})
+export class AppModule { }

openvidu-components/openvidu-custom-activities-panel/src/environments/environment.prod.ts

@@ -0,0 +1,3 @@
+export const environment = {
+  production: true
+};

openvidu-components/openvidu-custom-activities-panel/src/environments/environment.ts

@@ -0,0 +1,16 @@
+// This file can be replaced during build by using the `fileReplacements` array.
+// `ng build` replaces `environment.ts` with `environment.prod.ts`.
+// The list of file replacements can be found in `angular.json`.
+
+export const environment = {
+  production: false
+};
+
+/*
+ * For easier debugging in development mode, you can import the following file
+ * to ignore zone related error stack frames such as `zone.run`, `zoneDelegate.invokeTask`.
+ *
+ * This import should be commented out in production mode because it will have a negative impact
+ * on performance if an error is thrown.
+ */
+// import 'zone.js/plugins/zone-error';  // Included with Angular CLI.

openvidu-components/openvidu-custom-activities-panel/src/index.html

@@ -0,0 +1,16 @@
+<!doctype html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <title>OpenviduCustomActivitiesPanel</title>
+  <base href="/">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="icon" type="image/x-icon" href="favicon.ico">
+  <link rel="preconnect" href="https://fonts.gstatic.com">
+  <link href="https://fonts.googleapis.com/css2?family=Roboto:wght@300;400;500&display=swap" rel="stylesheet">
+  <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
+</head>
+<body>
+  <app-root></app-root>
+</body>
+</html>

openvidu-components/openvidu-custom-activities-panel/src/main.ts

@@ -0,0 +1,12 @@
+import { enableProdMode } from '@angular/core';
+import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
+
+import { AppModule } from './app/app.module';
+import { environment } from './environments/environment';
+
+if (environment.production) {
+  enableProdMode();
+}
+
+platformBrowserDynamic().bootstrapModule(AppModule)
+  .catch(err => console.error(err));

openvidu-components/openvidu-custom-activities-panel/src/polyfills.ts

@@ -0,0 +1,53 @@
+/**
+ * This file includes polyfills needed by Angular and is loaded before the app.
+ * You can add your own extra polyfills to this file.
+ *
+ * This file is divided into 2 sections:
+ *   1. Browser polyfills. These are applied before loading ZoneJS and are sorted by browsers.
+ *   2. Application imports. Files imported after ZoneJS that should be loaded before your main
+ *      file.
+ *
+ * The current setup is for so-called "evergreen" browsers; the last versions of browsers that
+ * automatically update themselves. This includes recent versions of Safari, Chrome (including
+ * Opera), Edge on the desktop, and iOS and Chrome on mobile.
+ *
+ * Learn more in https://angular.io/guide/browser-support
+ */
+
+/***************************************************************************************************
+ * BROWSER POLYFILLS
+ */
+
+/**
+ * By default, zone.js will patch all possible macroTask and DomEvents
+ * user can disable parts of macroTask/DomEvents patch by setting following flags
+ * because those flags need to be set before `zone.js` being loaded, and webpack
+ * will put import in the top of bundle, so user need to create a separate file
+ * in this directory (for example: zone-flags.ts), and put the following flags
+ * into that file, and then add the following code before importing zone.js.
+ * import './zone-flags';
+ *
+ * The flags allowed in zone-flags.ts are listed here.
+ *
+ * The following flags will work for all browsers.
+ *
+ * (window as any).__Zone_disable_requestAnimationFrame = true; // disable patch requestAnimationFrame
+ * (window as any).__Zone_disable_on_property = true; // disable patch onProperty such as onclick
+ * (window as any).__zone_symbol__UNPATCHED_EVENTS = ['scroll', 'mousemove']; // disable patch specified eventNames
+ *
+ *  in IE/Edge developer tools, the addEventListener will also be wrapped by zone.js
+ *  with the following flag, it will bypass `zone.js` patch for IE/Edge
+ *
+ *  (window as any).__Zone_enable_cross_context_check = true;
+ *
+ */
+
+/***************************************************************************************************
+ * Zone JS is required by default for Angular itself.
+ */
+import 'zone.js';  // Included with Angular CLI.
+
+
+/***************************************************************************************************
+ * APPLICATION IMPORTS
+ */

openvidu-components/openvidu-custom-activities-panel/src/styles.scss

@@ -0,0 +1,24 @@
+/* You can add global styles to this file, and also import other style files */
+
+:root {
+  --ov-primary-color: #303030;
+  --ov-secondary-color: #3e3f3f;
+  --ov-tertiary-color: #598eff;
+  --ov-warn-color: #EB5144;
+  --ov-accent-color: #ffae35;
+  --ov-light-color: #e6e6e6;
+
+  --ov-logo-background-color: #3a3d3d;
+
+  --ov-text-color: #ffffff;
+
+  --ov-panel-text-color: #1d1d1d;
+  --ov-panel-background: #ffffff;
+
+  --ov-buttons-radius: 50%; // border-radius property
+  --ov-leave-button-radius: 10px;
+  --ov-video-radius: 5px;
+  --ov-panel-radius: 5px;
+}
+html, body { height: 100%; }
+body { margin: 0; font-family: Roboto, "Helvetica Neue", sans-serif; }

openvidu-components/openvidu-custom-activities-panel/tsconfig.app.json

@@ -0,0 +1,15 @@
+/* To learn more about this file see: https://angular.io/config/tsconfig. */
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./out-tsc/app",
+    "types": []
+  },
+  "files": [
+    "src/main.ts",
+    "src/polyfills.ts"
+  ],
+  "include": [
+    "src/**/*.d.ts"
+  ]
+}

openvidu-components/openvidu-custom-activities-panel/tsconfig.json

@@ -0,0 +1,32 @@
+/* To learn more about this file see: https://angular.io/config/tsconfig. */
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "baseUrl": "./",
+    "outDir": "./dist/out-tsc",
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "sourceMap": true,
+    "declaration": false,
+    "downlevelIteration": true,
+    "experimentalDecorators": true,
+    "moduleResolution": "node",
+    "importHelpers": true,
+    "target": "es2017",
+    "module": "es2020",
+    "lib": [
+      "es2020",
+      "dom"
+    ]
+  },
+  "angularCompilerOptions": {
+    "enableI18nLegacyMessageIdFormat": false,
+    "strictInjectionParameters": true,
+    "strictInputAccessModifiers": true,
+    "strictTemplates": true
+  }
+}

openvidu-components/openvidu-custom-chat-panel/src/app/app.component.ts

@@ -1,4 +1,4 @@
-import { Component } from "@angular/core";
+import { Component, OnInit } from "@angular/core";
 import { catchError, throwError as observableThrowError } from "rxjs";
 import { HttpClient, HttpHeaders } from "@angular/common/http";