Skip to content

Commit

Permalink
Added v2compatibility suffix to node-client
Browse files Browse the repository at this point in the history
  • Loading branch information
CSantosM committed Jun 21, 2024
1 parent 6698ae2 commit 30c705e
Show file tree
Hide file tree
Showing 8 changed files with 48 additions and 40 deletions.
4 changes: 2 additions & 2 deletions openvidu-node-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

Expand Down
2 changes: 1 addition & 1 deletion openvidu-node-client/config/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion openvidu-node-client/config/typedoc.js
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions openvidu-node-client/generate-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
rm -rf ../../openvidu.io-docs/docs/api/openvidu-node-client-v2compatibility/*
cp -R ./docs/. ../../openvidu.io-docs/docs/api/openvidu-node-client-v2compatibility
58 changes: 33 additions & 25 deletions openvidu-node-client/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions openvidu-node-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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"
Expand All @@ -24,5 +24,5 @@
"docs": "./generate-docs.sh"
},
"typings": "lib/index.d.ts",
"version": "2.30.0"
"version": "3.0.0-beta1"
}
10 changes: 5 additions & 5 deletions openvidu-node-client/src/OpenVidu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down Expand Up @@ -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);
Expand Down Expand Up @@ -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();
Expand Down Expand Up @@ -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();
Expand All @@ -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<boolean> {
return new Promise<boolean>((resolve, reject) => {
Expand Down
2 changes: 1 addition & 1 deletion openvidu-node-client/src/Session.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down

0 comments on commit 30c705e

Please sign in to comment.