@4players/odin-nodejs 0.10.0 → 0.10.2

package/README.md

@@ -35,7 +35,15 @@ Having two libs also allows us to optimize for each platform without having to w
 
 ## Prerequisites
 
-You need to have a C++ compiler installed. On macOS, you can install XCode and the command line tools. On Linux you need
+This NodeJS SDK is based on the native ODIN SDK and is implemented via Native NodeJS bindings. This means that during 
+`npm install` this module will be compiled, which means you may need to have a compiler installed.
+
+For some target systems, precompiled libraries are provided:
+- macOS (x86_64 and arm64)
+- Windows (x86_64)
+- Linux (x86_64)
+
+Otherwise you need to have a C++ compiler installed. On macOS, you can install XCode and the command line tools. On Linux you need
 to have GCC installed. More information can be found here: [node-gyp](https://github.com/nodejs/node-gyp).
 
 ## Getting Started and compiling

package/cppsrc/odinclient.cpp

@@ -11,8 +11,12 @@
 Napi::Object OdinClient::Init(Napi::Env env, Napi::Object exports) {
     // This method is used to hook the accessor and method callbacks
     Napi::Function func = DefineClass(env, "OdinClient", {
-            InstanceMethod<&OdinClient::GenerateAccessToken>("generateAccessToken", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
+            InstanceMethod<&OdinClient::GenerateAccessToken>("generateToken", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
             InstanceMethod<&OdinClient::CreateRoom>("createRoom", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
+            InstanceMethod<&OdinClient::CreateRoomWithAccessToken>("createRoomWithToken", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
+
+            // Deprecated functions
+            InstanceMethod<&OdinClient::GenerateAccessToken>("generateAccessToken", static_cast<napi_property_attributes>(napi_writable | napi_configurable)),
             InstanceMethod<&OdinClient::CreateRoomWithAccessToken>("createRoomWithAccessToken", static_cast<napi_property_attributes>(napi_writable | napi_configurable))
     });
 

package/odin.client.d.ts

@@ -13,13 +13,23 @@ export declare class OdinClient {
     constructor(sampleRate?: number, channelCount?: number);
 
     /**
-     * Generates an access token for the given access key, room and user ID. This token can be used to join the room.
+     * Generates a token for the given access key, room and user ID. This token can be used to join the room.
+     * To be more consistent with other SDKs, this method is deprecated. Use generateToken instead.
      * @param accessKey - The access key to use to generate the token. You can get a free access token in our developer center
      * @param roomId - The ID of the room to generate the token for.
      * @param userId - The ID of the user to generate the token for.
+     * @deprecated Use generateToken instead
      */
     generateAccessToken(accessKey: string, roomId: string, userId: string): string;
 
+    /**
+     * Generates a room token for the given access key, room and user ID. This token can be used to join the room.
+     * @param accessKey - The access key to use to generate the token. You can get a free access token in our developer center
+     * @param roomId - The ID of the room to generate the token for.
+     * @param userId - The ID of the user to generate the token for.
+     */
+    generateToken(accessKey: string, roomId: string, userId: string): string;
+
     /**
      * Creates a new local room instance with the given ID and user ID. Use join to connect to that room.
      * @param accessKey - The access key to use to generate the token. You can get a free access token in our developer center
@@ -31,8 +41,18 @@ export declare class OdinClient {
     /**
      * Creates a new local room instance with the given access token. Use `join` on the returned OdinRoom instance to
      * connect to that room. Use this method if you already have an access token, either created elsewhere or by calling
-     * `generateAccessToken`.
+     * `generateToken`.
+     * To be more consistent with other SDKs, this method is deprecated. Use createRoomWithToken instead.
      * @param accessToken - The access token to use to join the room.
+     * @deprecated Use createRoomWithToken instead
     */
     createRoomWithAccessToken(accessToken: string): OdinRoom;
+
+    /**
+     * Creates a new local room instance with the given room token. Use `join` on the returned OdinRoom instance to
+     * connect to that room. Use this method if you already have an access token, either created elsewhere or by calling
+     * `generateAccessToken`.
+     * @param accessToken - The access token to use to join the room.
+     */
+    createRoomWithToken(accessToken: string): OdinRoom;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4players/odin-nodejs",
-  "version": "0.10.0",
+  "version": "0.10.2",
   "description": "NodeJS bindings for the ODIN SDK. Use for AI enhanced human interactions, content moderation and audio processing features in a backend.",
   "main": "index.cjs",
   "types": "index.d.ts",

package/tests/audio-recording/index.js

@@ -18,8 +18,8 @@ const configuration = new Configuration({
 const openai = new OpenAIApi(configuration);
 
 // Create an odin client instance using our access key and create a room
-const odinClient = new OdinClient(accessKey);
-const room = odinClient.createRoom(roomName, userName);
+const odinClient = new OdinClient();
+const room = odinClient.createRoom(accessKey, roomName, userName);
 
 // Listen on PeerJoined messages and print the user data of the joined peer
 room.addEventListener('PeerJoined', (event) => {

package/tests/sending-audio/index.js

@@ -24,8 +24,8 @@ const data = new TextEncoder().encode(JSON.stringify(userData));
 const odinClient = new OdinClient(48000, 2);
 
 // Create a token then join the room with that token, token may also be created elsewhere
-const token = odinClient.generateAccessToken(accessKey, roomName, userName);
-const room = odinClient.createRoomWithAccessToken(token);
+const token = odinClient.generateToken(accessKey, roomName, userName);
+const room = odinClient.createRoomWithToken(token);
 
 // It's also possible to create a room with an access key, room name and username then token is created internally
 //const room = odinClient.createRoom(accessKey, roomName, userName);