Merge pull request #1 from speechmatics/fix-node-example-end-of-events

Fix EndOfTranscript event firing twice and update example

README.md

@@ -109,35 +109,38 @@ import { RealtimeSession } from 'speechmatics';
 
 // imports helpful for the file streaming
 const fs = require('fs');
+const path = require('path');
 
 // init the session
 const session = new RealtimeSession(YOUR_API_KEY);
 
 //add listeners
 session.addListener('RecognitionStarted', () => {
-  console.log('session started');
+  console.log('RecognitionStarted');
 });
 
 session.addListener('Error', (error) => {
   console.log('session error', error);
 });
 
 session.addListener('AddTranscript', (message) => {
-  console.log('message', message);
+  console.log('AddTranscript', message);
 });
 
 session.addListener('AddPartialTranscript', (message) => {
-  console.log('message', message);
+  console.log('AddPartialTranscript', message);
 });
 
-session.addListener('EndOfStream', () => {
-  console.log('Session stopped');
+session.addListener('EndOfTranscript', () => {
+  console.log('EndOfTranscript');
 });
 
 //start session which is an async method
 session.start().then(() => {
   //prepare file stream
-  const fileStream = fs.createReadStream('examples/example_files/example.wav');
+  const fileStream = fs.createReadStream(
+    path.join(__dirname, 'example_files/example.wav'),
+  );
 
   //send it
   fileStream.on('data', (sample) => {
@@ -172,23 +175,23 @@ const session = new RealtimeSession(YOUR_JWT);
 
 //add listeners
 session.addListener('RecognitionStarted', () => {
-  console.log('session started');
+  console.log('RecognitionStarted');
 });
 
 session.addListener('Error', (error) => {
   console.log('session error', error);
 });
 
 session.addListener('AddTranscript', (message) => {
-  console.log('message', message);
+  console.log('AddTranscript', message);
 });
 
 session.addListener('AddPartialTranscript', (message) => {
-  console.log('message', message);
+  console.log('AddPartialTranscript', message);
 });
 
-session.addListener('EndOfStream', () => {
-  console.log('Session stopped');
+session.addListener('EndOfTranscript', () => {
+  console.log('EndOfTranscript');
 });
 
 //start session which is an async method
@@ -258,6 +261,6 @@ We'd love to see your contributions! Please read our [contributing guidelines](.
 
 ## Feedback & Help
 
-- For feature requests or bugs [open an issue](https://github.com/speechmatics/speechmatics-js/issues/new) 
+- For feature requests or bugs [open an issue](https://github.com/speechmatics/speechmatics-js-sdk/issues/new) 
 - To provide direct feedback, email us at [devrel@speechmatics.com](mailto:devrel@speechmatics.com)
 - We're [@speechmatics](https://twitter.com/Speechmatics) on Twitter too!

examples/example_rt_node.js

@@ -5,28 +5,30 @@ const path = require('path');
 const { RealtimeSession } = require('../dist');
 
 if (parseInt(process.version.match(/(?:v)([0-9]{2})/)[1]) < 18) {
-  throw new Error("Requires node 18 or higher. If this isn't possible, see our documentation about polyfilling");
+  throw new Error(
+    "Requires node 18 or higher. If this isn't possible, see our documentation about polyfilling",
+  );
 }
 const session = new RealtimeSession(process.env.API_KEY);
 
 session.addListener('RecognitionStarted', () => {
-  console.log('session started');
+  console.log('RecognitionStarted');
 });
 
 session.addListener('Error', (error) => {
   console.log('session error', error);
 });
 
 session.addListener('AddTranscript', (message) => {
-  console.log('transcript> ', message.metadata.transcript);
+  console.log('AddTranscript', message.metadata.transcript);
 });
 
 session.addListener('AddPartialTranscript', (message) => {
-  // console.log('partial', message);
+  // console.log('AddPartialTranscript', message);
 });
 
-session.addListener('EndOfStream', () => {
-  console.log('Session stopped');
+session.addListener('EndOfTranscript', () => {
+  console.log('EndOfTranscript');
 });
 
 session
@@ -41,10 +43,13 @@ session
   })
   .then(() => {
     //prepare file stream
-    const fileStream = fs.createReadStream(path.join(__dirname, 'example_files/example.wav'));
+    const fileStream = fs.createReadStream(
+      path.join(__dirname, 'example_files/example.wav'),
+    );
 
     //send it
     fileStream.on('data', (sample) => {
+      console.log('sending audio', sample.length);
       session.sendAudio(sample);
     });
 

package.json

@@ -1,10 +1,12 @@
 {
   "name": "speechmatics",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "Speechmatics Javascript Libraries",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build:clean": "rm -rf dist",
     "build:cjs": "./build.js",
@@ -15,7 +17,9 @@
     "check": "npx rome check .",
     "format": "npx rome format --write ."
   },
-  "precommit": ["check"],
+  "precommit": [
+    "check"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/speechmatics/speechmatics-js-sdk.git"

src/management-platform/auth.ts

@@ -8,8 +8,8 @@ export default async function getShortLivedToken(
 ) {
   if (typeof window !== 'undefined') {
     console.warn(
-      "Requesting a short lived token from a browser is not recommended. \
-    More info at https://github.com/speechmatics/speechmatics-js#readme",
+      'Requesting a short lived token from a browser is not recommended. \
+    More info at https://github.com/speechmatics/speechmatics-js#readme',
     );
   }
   const jsonResponse = await request<{ key_value: string }>(

src/realtime/client.ts

@@ -69,9 +69,6 @@ export class RealtimeSession {
       onError: (data: ModelError) => {
         this.emitter.emit(MessagesEnum.Error, data);
       },
-      onDisconnect: () => {
-        this.emitter.emit(MessagesEnum.EndOfTranscript, this);
-      },
     };
   }
 

src/realtime/handlers.ts

@@ -56,7 +56,6 @@ export class RealtimeSocketHandler {
   ): Promise<void> {
     this.seqNoIn = 0;
 
-
     return this.socketWrap.connect(runtimeURL, runtimeKey, appId);
   }
 
@@ -162,7 +161,6 @@ export class RealtimeSocketHandler {
     }
   };
 
-
   private onSocketDisconnect = () => {
     this.sub.onDisconnect?.();
   };