From 30c705e8fc45c5043f4c04d26f46acaddc3f89e3 Mon Sep 17 00:00:00 2001 From: Carlos Santos <4a.santos@gmail.com> Date: Fri, 21 Jun 2024 11:30:34 +0200 Subject: [PATCH] Added v2compatibility suffix to node-client --- openvidu-node-client/README.md | 4 +- openvidu-node-client/config/tsconfig.json | 2 +- openvidu-node-client/config/typedoc.js | 2 +- openvidu-node-client/generate-docs.sh | 4 +- openvidu-node-client/package-lock.json | 58 +++++++++++++---------- openvidu-node-client/package.json | 6 +-- openvidu-node-client/src/OpenVidu.ts | 10 ++-- openvidu-node-client/src/Session.ts | 2 +- 8 files changed, 48 insertions(+), 40 deletions(-) diff --git a/openvidu-node-client/README.md b/openvidu-node-client/README.md index 52abccea..b29cae28 100644 --- a/openvidu-node-client/README.md +++ b/openvidu-node-client/README.md @@ -5,12 +5,12 @@ [![][OpenViduLogo]](https://openvidu.io) -openvidu-node-client +openvidu-node-client-v2compatibility === - **Description**: Library for your NODE server. It is a fully compatible and simple alternative to the REST API exposed by OpenVidu Server. -- **Docs**: [openvidu-node-client API](https://docs.openvidu.io/en/stable/reference-docs/openvidu-node-client/) +- **Docs**: [openvidu-node-client-v2compatibility API](https://docs.openvidu.io/en/stable/reference-docs/openvidu-node-client-v2compatibility/) - **Release**: [OpenVidu Artifacts](https://docs.openvidu.io/en/stable/releases/) diff --git a/openvidu-node-client/config/tsconfig.json b/openvidu-node-client/config/tsconfig.json index 72db6b18..ffbbdeda 100644 --- a/openvidu-node-client/config/tsconfig.json +++ b/openvidu-node-client/config/tsconfig.json @@ -2,7 +2,7 @@ "include": ["../src"], "exclude": ["../config", "../docs", "../lib", "../node_modules"], "typedocOptions": { - "name": "OpenVidu Node Client", + "name": "OpenVidu Node Client V2 Compatibility", "entryPoints": ["../src/index.ts"], "out": "../docs", "theme": "default", diff --git a/openvidu-node-client/config/typedoc.js b/openvidu-node-client/config/typedoc.js index 987eccd7..45018621 100644 --- a/openvidu-node-client/config/typedoc.js +++ b/openvidu-node-client/config/typedoc.js @@ -7,7 +7,7 @@ module.exports = { ], mode: "file", module: "commonjs", - name: "OpenVidu Node Client", + name: "OpenVidu Node Client V2 Compatibility", target: "es5", externalPattern: "node_modules", excludeExternals: true, diff --git a/openvidu-node-client/generate-docs.sh b/openvidu-node-client/generate-docs.sh index a7374396..6e5d4523 100755 --- a/openvidu-node-client/generate-docs.sh +++ b/openvidu-node-client/generate-docs.sh @@ -15,5 +15,5 @@ grep -rl '/en/stable/' src | xargs sed -i -e 's|/en/stable/|/en/'${BASEHREF_VERS grep -rl '/en/'${BASEHREF_VERSION}'/' src | xargs sed -i -e 's|/en/'${BASEHREF_VERSION}'/|/en/stable/|g' # Clean previous docs from openvidu.io-docs repo and copy new ones -rm -rf ../../openvidu.io-docs/docs/api/openvidu-node-client/* -cp -R ./docs/. ../../openvidu.io-docs/docs/api/openvidu-node-client \ No newline at end of file +rm -rf ../../openvidu.io-docs/docs/api/openvidu-node-client-v2compatibility/* +cp -R ./docs/. ../../openvidu.io-docs/docs/api/openvidu-node-client-v2compatibility \ No newline at end of file diff --git a/openvidu-node-client/package-lock.json b/openvidu-node-client/package-lock.json index 8f38a35f..3f8aa65c 100644 --- a/openvidu-node-client/package-lock.json +++ b/openvidu-node-client/package-lock.json @@ -1,12 +1,12 @@ { - "name": "openvidu-node-client", - "version": "2.30.0", + "name": "openvidu-node-client-v2compatibility", + "version": "3.0.0-beta1", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "openvidu-node-client", - "version": "2.30.0", + "name": "openvidu-node-client-v2compatibility", + "version": "3.0.0-beta1", "license": "Apache-2.0", "dependencies": { "axios": "1.7.1", @@ -21,12 +21,12 @@ } }, "node_modules/@babel/code-frame": { - "version": "7.24.2", - "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.2.tgz", - "integrity": "sha512-y5+tLQyV8pg3fsiln67BVLD1P13Eg4lh5RW9mF0zUuvLrv9uIQ4MCL+CRT+FTsBlBjcIan6PGsLcBN0m3ClUyQ==", + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.24.7.tgz", + "integrity": "sha512-BcYH1CVJBO9tvyIZ2jVeXgSIMvGZ2FDRvDdOIVQyuklNKSsx+eppDEBq/g47Ayw+RqNFE+URvOShmf+f/qwAlA==", "dev": true, "dependencies": { - "@babel/highlight": "^7.24.2", + "@babel/highlight": "^7.24.7", "picocolors": "^1.0.0" }, "engines": { @@ -34,21 +34,21 @@ } }, "node_modules/@babel/helper-validator-identifier": { - "version": "7.24.5", - "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.5.tgz", - "integrity": "sha512-3q93SSKX2TWCG30M2G2kwaKeTYgEUp5Snjuj8qm729SObL6nbtUldAi37qbxkD5gg3xnBio+f9nqpSepGZMvxA==", + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.24.7.tgz", + "integrity": "sha512-rR+PBcQ1SMQDDyF6X0wxtG8QyLCgUB0eRAGguqRLfkCA87l7yAP7ehq8SNj96OOGTO8OBV70KhuFYcIkHXOg0w==", "dev": true, "engines": { "node": ">=6.9.0" } }, "node_modules/@babel/highlight": { - "version": "7.24.5", - "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.24.5.tgz", - "integrity": "sha512-8lLmua6AVh/8SLJRRVD6V8p73Hir9w5mJrhE+IPpILG31KKlI9iz5zmBYKcWPS59qSfgP9RaSBQSHHE81WKuEw==", + "version": "7.24.7", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.24.7.tgz", + "integrity": "sha512-EStJpq4OuY8xYfhGVXngigBJRWxftKX9ksiGDnmlY3o7B/V7KIAc9X4oiK87uPJSc/vs5L869bem5fhZa8caZw==", "dev": true, "dependencies": { - "@babel/helper-validator-identifier": "^7.24.5", + "@babel/helper-validator-identifier": "^7.24.7", "chalk": "^2.4.2", "js-tokens": "^4.0.0", "picocolors": "^1.0.0" @@ -128,9 +128,9 @@ } }, "node_modules/acorn": { - "version": "8.11.3", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.11.3.tgz", - "integrity": "sha512-Y9rRfJG5jcKOE0CLisYbojUjIrIEE7AGMzA/Sm4BslANhbS+cDMpgBdcPT91oJ7OuJ9hYJBx59RjbhxVnrF8Xg==", + "version": "8.12.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.12.0.tgz", + "integrity": "sha512-RTvkC4w+KNXrM39/lWCUaG0IbRkWdCv7W/IOW9oU6SawyxulvkQy5HQPVTKxEjczcUvapcrw3cFx/60VN/NRNw==", "dev": true, "bin": { "acorn": "bin/acorn" @@ -140,10 +140,13 @@ } }, "node_modules/acorn-walk": { - "version": "8.3.2", - "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.2.tgz", - "integrity": "sha512-cjkyv4OtNCIeqhHrfS81QWXoCBPExR/J62oyEqepVw8WaQeSqpW2uhuLPh1m9eWhDuOo/jUXVTlifvesOWp/4A==", + "version": "8.3.3", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.3.tgz", + "integrity": "sha512-MxXdReSRhGO7VlFe1bRG/oI7/mdLV9B9JJT0N8vZOhF7gFRR5l3M8W9G8JxmKV+JC5mGqJ0QvqfSOLsCPa4nUw==", "dev": true, + "dependencies": { + "acorn": "^8.11.0" + }, "engines": { "node": ">=0.4.0" } @@ -411,6 +414,7 @@ "version": "7.2.3", "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", "integrity": "sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==", + "deprecated": "Glob versions prior to v9 are no longer supported", "dev": true, "dependencies": { "fs.realpath": "^1.0.0", @@ -471,6 +475,7 @@ "version": "1.0.6", "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", "integrity": "sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==", + "deprecated": "This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.", "dev": true, "dependencies": { "once": "^1.3.0", @@ -484,12 +489,15 @@ "dev": true }, "node_modules/is-core-module": { - "version": "2.13.1", - "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.13.1.tgz", - "integrity": "sha512-hHrIjvZsftOsvKSn2TRYl63zvxsgE0K+0mYMoH6gD4omR5IWB2KynivBQczo3+wF1cCkjzvptnI9Q0sPU66ilw==", + "version": "2.14.0", + "resolved": "https://registry.npmjs.org/is-core-module/-/is-core-module-2.14.0.tgz", + "integrity": "sha512-a5dFJih5ZLYlRtDc0dZWP7RiKr6xIKzmn/oAYCDvdLThadVgyJwlaoQPmRtMSpz+rk0OGAgIu+TcM9HUF0fk1A==", "dev": true, "dependencies": { - "hasown": "^2.0.0" + "hasown": "^2.0.2" + }, + "engines": { + "node": ">= 0.4" }, "funding": { "url": "https://github.com/sponsors/ljharb" diff --git a/openvidu-node-client/package.json b/openvidu-node-client/package.json index 7df83d72..412b0da1 100644 --- a/openvidu-node-client/package.json +++ b/openvidu-node-client/package.json @@ -4,7 +4,7 @@ "axios": "1.7.1", "buffer": "6.0.3" }, - "description": "OpenVidu Node Client", + "description": "OpenVidu Node Client V2 Compatibility", "devDependencies": { "@types/node": "20.12.12", "ts-node": "10.9.2", @@ -14,7 +14,7 @@ }, "license": "Apache-2.0", "main": "lib/index.js", - "name": "openvidu-node-client", + "name": "openvidu-node-client-v2compatibility", "repository": { "type": "git", "url": "git://github.com/OpenVidu/openvidu" @@ -24,5 +24,5 @@ "docs": "./generate-docs.sh" }, "typings": "lib/index.d.ts", - "version": "2.30.0" + "version": "3.0.0-beta1" } diff --git a/openvidu-node-client/src/OpenVidu.ts b/openvidu-node-client/src/OpenVidu.ts index 17dce737..772765f7 100644 --- a/openvidu-node-client/src/OpenVidu.ts +++ b/openvidu-node-client/src/OpenVidu.ts @@ -216,7 +216,7 @@ export class OpenVidu { logger.warn( "No active session found for sessionId '" + r.sessionId + - "'. This instance of OpenVidu Node Client didn't create this session" + "'. This instance of OpenVidu Node Client V2 Compatibility didn't create this session" ); } resolve(r); @@ -263,7 +263,7 @@ export class OpenVidu { logger.warn( "No active session found for sessionId '" + r.sessionId + - "'. This instance of OpenVidu Node Client didn't create this session" + "'. This instance of OpenVidu Node Client V2 Compatibility didn't create this session" ); } resolve(r); @@ -450,7 +450,7 @@ export class OpenVidu { logger.warn( "No active session found for sessionId '" + sessionId + - "'. This instance of OpenVidu Node Client didn't create this session" + "'. This instance of OpenVidu Node Client V2 Compatibility didn't create this session" ); } resolve(); @@ -500,7 +500,7 @@ export class OpenVidu { logger.warn( "No active session found for sessionId '" + sessionId + - "'. This instance of OpenVidu Node Client didn't create this session" + "'. This instance of OpenVidu Node Client V2 Compatibility didn't create this session" ); } resolve(); @@ -521,7 +521,7 @@ export class OpenVidu { * After calling this method you can access the updated array of active sessions in {@link activeSessions} * * @returns A promise resolved to true if any Session status has changed with respect to the server, or to false if not. - * This applies to any property or sub-property of any of the sessions locally stored in OpenVidu Node Client + * This applies to any property or sub-property of any of the sessions locally stored in OpenVidu Node Client V2 Compatibility */ public fetch(): Promise { return new Promise((resolve, reject) => { diff --git a/openvidu-node-client/src/Session.ts b/openvidu-node-client/src/Session.ts index f93d88f0..ba872c74 100644 --- a/openvidu-node-client/src/Session.ts +++ b/openvidu-node-client/src/Session.ts @@ -329,7 +329,7 @@ export class Session { }); } else { logger.warn( - "The closed connection wasn't fetched in OpenVidu Node Client. No changes in the collection of active connections of the Session" + "The closed connection wasn't fetched in OpenVidu Node Client V2 Compatibility. No changes in the collection of active connections of the Session" ); } this.updateActiveConnectionsArray();