@bottlenose/rxtranscribe - npm Package Compare versions

Comparing version 0.2.1-beta.3 to 0.6.0

build/operators/transcribe.js

@@ -7,6 +7,7 @@ // copied from https://github.com/aws-samples/amazon-transcribe-websocket-static
 import { of, throwError } from 'rxjs';
-import { map, takeUntil } from 'rxjs/operators';
+import { mergeMap, takeUntil } from 'rxjs/operators';
 import { conduit } from '@bottlenose/rxws';
 import createAwsSignedUrl from '../internals/createAwsSignedUrl';
 import convertAudioToBinaryMessage from '../internals/convertAudioToBinaryMessage';
+import decodeMessage from '../internals/decodeMessage';
 
@@ -19,21 +20,28 @@ const transcribe = function transcribe({
   _conduit = conduit,
-  _convertAudioToBinaryMessage = convertAudioToBinaryMessage,
+  _serializer = audioBinary => convertAudioToBinaryMessage({
+    audioBinary
+  }),
+  _deserializer = message => decodeMessage({
+    message
+  }),
   _getPresignedUrl = createAwsSignedUrl
 }) {
-  if (!accessKeyId || !secretAccessKey) {
-    return throwError(new Error('AWS credentials must be set'));
-  }
+  return fileChunk$ => {
+    const url = _getPresignedUrl({
+      region,
+      accessKeyId,
+      secretAccessKey
+    });
 
-  const url = _getPresignedUrl({
-    region,
-    accessKeyId,
-    secretAccessKey
-  });
-
-  return source$ => source$.pipe(map(audioBinary => _convertAudioToBinaryMessage(audioBinary)), _conduit({
-    url
-  }), // outputs JSON response objects
-  takeUntil(stop$));
+    const message$ = fileChunk$.pipe(mergeMap(fileChunk => !accessKeyId || !secretAccessKey ? throwError(new Error('AWS credentials must be set')) : of(fileChunk)), // audioBinary should be streamed as an arraybuffer type on the websocket...
+    _conduit({
+      url,
+      serializer: _serializer,
+      deserializer: _deserializer
+    }), // outputs JSON response objects
+    takeUntil(stop$));
+    return message$;
+  };
 };
 
 export default transcribe;

build/operators/transcribe.test.js

@@ -0,7 +1,11 @@
+import fs from 'fs';
+import path from 'path';
 import { expect } from 'chai';
 import sinon from 'sinon';
-import { from, of } from 'rxjs';
-import { map, mapTo } from 'rxjs/operators';
+import { from, Observable, of } from 'rxjs';
+import { map, mapTo, take, tap } from 'rxjs/operators';
 import { marbles } from 'rxjs-marbles/mocha';
+import { fromFile } from '@bottlenose/rxfs';
 import transcribe from './transcribe';
+const audioSampleFilePath = path.resolve(__dirname, '../../demo/sample-audio.mp3');
 describe('operators.transcribe', () => {
@@ -28,2 +32,3 @@ it('should properly call its workflow', marbles(m => {
     m.expect(actual$).toBeObservable(expected$);
+    m.expect(input$).toHaveSubscriptions('^--------!');
     expect(params._getPresignedUrl.calledOnce).to.be.true;
@@ -38,3 +43,31 @@ expect(params._getPresignedUrl.getCall(0).args[0]).to.deep.equal({
   }));
-  it('should produce correct output when given a valid input stream', marbles(m => {}));
+  it('should parse audio into ArrayBuffer objects and stream to websocket', done => {
+    const onData = sinon.spy();
+    const onError = sinon.spy();
+    const params = {
+      accessKeyId: 'fakeaccesskey',
+      secretAccessKey: 'fakesecretkey',
+      _conduit: sinon.stub().returns(source$ => source$.pipe()),
+      _getPresignedUrl: sinon.stub().returns('wss://buccaneer.ai?something'),
+      _serializer: d => d,
+      _deserializer: d => d
+    };
+    const mp3Stream$ = fromFile({
+      filePath: audioSampleFilePath
+    }).pipe(take(2));
+    const transcription$ = mp3Stream$.pipe(transcribe(params));
+    transcription$.subscribe(onData, onError, () => {
+      expect(params._conduit.calledOnce).to.be.true;
+      expect(params._conduit.getCall(0).args[0]).to.deep.equal({
+        url: 'wss://buccaneer.ai?something',
+        serializer: params._serializer,
+        deserializer: params._deserializer
+      });
+      expect(onData.callCount).to.equal(2);
+      const bufferOut = onData.getCall(0).args[0];
+      expect(bufferOut.constructor).to.equal(Buffer);
+      done();
+    });
+    transcription$.subscribe();
+  });
 });

package.json

 {
   "name": "@bottlenose/rxtranscribe",
-  "version": "0.2.1-beta.3+9c29114",
+  "version": "0.6.0",
   "description": "👂 Realtime speech-to-text (S2T) transcription with AWS Transcribe and RxJS",
@@ -39,3 +39,3 @@ "main": "build/index.js",
     "@aws-sdk/util-utf8-node": "^0.1.0-preview.1",
-    "@bottlenose/rxws": "^0.2.1-beta.3+9c29114",
+    "@bottlenose/rxws": "^0.6.0",
     "lodash": "^4.17.15",
@@ -45,2 +45,7 @@ "qs": "^6.9.1",
   },
+  "devDependencies": {
+    "@bottlenose/rxfs": "^0.6.0",
+    "optimist": "^0.6.1",
+    "prompt": "^1.0.0"
+  },
   "browserslist": [],
@@ -52,5 +57,6 @@ "scripts": {
     "test:watch": "yarn test -- --watch",
-    "prepublishOnly": "yarn lint && yarn test && yarn build"
+    "prepublishOnly": "yarn lint && yarn test && yarn build",
+    "demo:run": "BABEL_ENV=script yarn babel-node --config-file ../../babel.config.js ./demo/runDemo.js"
   },
-  "gitHead": "9c29114e43a42d5c0caa41a3e4e1d457e8d84f4f"
+  "gitHead": "1965941211ad529a5067910f43ba2c782cbbb5ac"
 }

README.md

@@ -18,7 +18,7 @@ [![CircleCI](https://circleci.com/gh/buccaneerai/bottlenose/tree/master.svg?style=shield)](https://circleci.com/gh/buccaneerai/bottlenose/tree/master)
 ```bash
-yarn add @buccaneer/rxtranscribe
+yarn add @bottlenose/rxtranscribe
 ```
 
 ```bash
-npm i --save @buccaneer/rxtranscribe
+npm i --save @bottlenose/rxtranscribe
 ```
@@ -31,11 +31,11 @@
 |node.js (>10.8)|✅|
-|Browsers|❌|
-|React Native|❌|
-|Electron|❌|
+|Browsers|❓|
+|React Native|❓|
+|Electron|❓|
 
-💡 This package could perhaps be modified to work universally by polyfilling in the `Buffer` object.  The authors haven't bothered to do it because our use case did not require it to run on clients.  But if you want to take a stab at implementing it, [contact us](mailto:[e-mail])!
+💡 This package has only been tested in the node.js environment.  If it doesn't work isomorphically, it could probably be modified to do so without much effort.  The authors haven't one so because running it on client devices does not seem like an advisable design for production situations.  But if you want to take a stab at implementing isomorphic support, [contact us](mailto:[e-mail])!
 
 ## Basic Usage
 ```javascript
-import { transcribe } from '@buccaneer/rxtranscribe';
+import { transcribe } from '@bottlenose/rxtranscribe';
 
@@ -45,3 +45,3 @@ // The pipeline takes a stream of .wav audio chunks (Buffer, String, Blob or Typed Array)
   map(chunkStr => Buffer.from(chunkString, 'base64')),
-  transcribe()
+  transcribe({})
 );
@@ -48,0 +48,0 @@ ```

New alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20768

28.13%

Number of package files

16

14.29%

Lines of code

355

41.43%

Number of medium supply chain risk alerts

0

-100%

Worsened metrics

Dev dependency count

3

Infinity%

Number of low supply chain risk alerts

5

25%

Dependency changes

• + Added

  @bottlenose/rxws@0.6.0
  (transitive)

• - Removed

  @bottlenose/rxws@0.2.1-beta.3
  (transitive)

• Updated

  @bottlenose/rxws@^0.6.0