@deepgram/sdk 1.2.0 → 1.2.4

package/CHANGELOG.md

@@ -9,6 +9,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
+## [1.2.4]
+
+### Fixed
+
+- Getting the list of API keys was returning the wrong type of object. The SDK now returns the correct object type, but also returns what was previously implemented with deprecation notices.
+- The `version` parameter was typed as required for both pre-recorded and live transcription. Changed this to be optional.
+
+## [1.2.2]
+
+### Updated
+
+- Updated the `wordBase` type to include an optional `speaker` property.
+- Updated the documentation for the speaker property of the `utterance` type.
+
+## [1.2.1]
+
+### Fixed
+
+- Fixed a bug that caused real-time transcriptions to not close correctly. This
+would result in the user not received the final transcription.
+
 ## [1.2.0]
 
 ### Updated
@@ -137,7 +158,11 @@ throw an error.
 
 ---
 
-[unreleased]: https://github.com/deepgram/node-sdk/compare/1.1.0...HEAD
+[unreleased]: https://github.com/deepgram/node-sdk/compare/1.2.4...HEAD
+[1.2.2]: https://github.com/deepgram/node-sdk/compare/1.2.2...1.2.4
+[1.2.2]: https://github.com/deepgram/node-sdk/compare/1.2.1...1.2.2
+[1.2.1]: https://github.com/deepgram/node-sdk/compare/1.2.0...1.2.1
+[1.2.0]: https://github.com/deepgram/node-sdk/compare/1.1.0...1.2.0
 [1.1.0]: https://github.com/deepgram/node-sdk/compare/1.0.3...1.1.0
 [1.0.3]: https://github.com/deepgram/node-sdk/compare/1.0.2...1.0.3
 [1.0.2]: https://github.com/deepgram/node-sdk/compare/1.0.0...1.0.2

package/README.md

@@ -84,7 +84,7 @@ navigator.mediaDevices.getUserMedia({ audio: true }).then((stream) => {
     mediaRecorder.start(1000)
   });
 
-  deepgramSocket.addListener("transcriptReceived", (transcription) => {
+  deepgramSocket.addListener("transcriptReceived", (received) => {
     const transcript = received.channel.alternatives[0].transcript;
     if (transcript && received.is_final) {
       console.log(transcript);
@@ -147,5 +147,5 @@ project, let us know! You can either:
 
 Check out the Developer Documentation at [https://developers.deepgram.com/](https://developers.deepgram.com/)
 
-[signup]: https://console.deepgram.com?utm_source=node-sdk&utm_content=readme
+[signup]: https://console.deepgram.com/signup?utm_medium=github&utm_source=DEVREL&utm_content=node-sdk
 [license]: LICENSE.txt

package/dist/keys.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -50,8 +61,17 @@ var Keys = /** @class */ (function () {
      */
     Keys.prototype.list = function (projectId) {
         return __awaiter(this, void 0, void 0, function () {
+            var response, output;
             return __generator(this, function (_a) {
-                return [2 /*return*/, (0, httpRequest_1._request)("GET", this._credentials, this._apiUrl, this.apiPath + "/" + projectId + "/keys")];
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, httpRequest_1._request)("GET", this._credentials, this._apiUrl, this.apiPath + "/" + projectId + "/keys")];
+                    case 1:
+                        response = _a.sent();
+                        output = response.api_keys.map(function (apiKey) {
+                            return __assign(__assign({}, apiKey), apiKey.api_key);
+                        });
+                        return [2 /*return*/, { api_keys: output }];
+                }
             });
         });
     };

package/dist/keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"keys.js","sourceRoot":"","sources":["../src/keys.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAAyC;AAGzC;IACE,cAAoB,YAAoB,EAAU,OAAe;QAA7C,iBAAY,GAAZ,YAAY,CAAQ;QAAU,YAAO,GAAP,OAAO,CAAQ;QAEzD,YAAO,GAAG,cAAc,CAAC;IAFmC,CAAC;IAIrE;;;OAGG;IACG,mBAAI,GAAV,UAAW,SAAiB;;;gBAC1B,sBAAO,IAAA,sBAAQ,EACb,KAAK,EACL,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,OAAO,EACT,IAAI,CAAC,OAAO,SAAI,SAAS,UAAO,CACpC,EAAC;;;KACH;IAED;;;;OAIG;IACG,kBAAG,GAAT,UAAU,SAAiB,EAAE,KAAa;;;gBACxC,sBAAO,IAAA,sBAAQ,EACb,KAAK,EACL,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,OAAO,EACT,IAAI,CAAC,OAAO,SAAI,SAAS,cAAS,KAAO,CAC7C,EAAC;;;KACH;IAED;;;;;;OAMG;IACG,qBAAM,GAAZ,UACE,SAAiB,EACjB,OAAe,EACf,MAAqB,EACrB,OAA0B;;;gBAE1B,6EAA6E;gBAC7E,IACE,OAAO;oBACP,OAAO,CAAC,cAAc,KAAK,SAAS;oBACpC,OAAO,CAAC,UAAU,KAAK,SAAS,EAChC;oBACA,MAAM,IAAI,KAAK,CACb,wFAAwF,CACzF,CAAC;iBACH;gBAED,sBAAO,IAAA,sBAAQ,EACb,MAAM,EACN,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,OAAO,EACT,IAAI,CAAC,OAAO,SAAI,SAAS,UAAO,EACnC,IAAI,CAAC,SAAS,CAAC;wBACb,OAAO,SAAA;wBACP,MAAM,QAAA;wBACN,eAAe,EACb,OAAO,IAAI,OAAO,CAAC,cAAc;4BAC/B,CAAC,CAAC,OAAO,CAAC,cAAc;4BACxB,CAAC,CAAC,SAAS;wBACf,uBAAuB,EACrB,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;qBACjE,CAAC,CACH,EAAC;;;KACH;IAED;;;;OAIG;IACG,qBAAM,GAAZ,UAAa,SAAiB,EAAE,KAAa;;;gBAC3C,sBAAO,IAAA,sBAAQ,EACb,QAAQ,EACR,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,OAAO,EACT,IAAI,CAAC,OAAO,SAAI,SAAS,cAAS,KAAO,CAC7C,EAAC;;;KACH;IACH,WAAC;AAAD,CAAC,AAvFD,IAuFC;AAvFY,oBAAI"}
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../src/keys.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAAyC;AAGzC;IACE,cAAoB,YAAoB,EAAU,OAAe;QAA7C,iBAAY,GAAZ,YAAY,CAAQ;QAAU,YAAO,GAAP,OAAO,CAAQ;QAEzD,YAAO,GAAG,cAAc,CAAC;IAFmC,CAAC;IAIrE;;;OAGG;IACG,mBAAI,GAAV,UAAW,SAAiB;;;;;4BACT,qBAAM,IAAA,sBAAQ,EAC7B,KAAK,EACL,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,OAAO,EACT,IAAI,CAAC,OAAO,SAAI,SAAS,UAAO,CACpC,EAAA;;wBALK,QAAQ,GAAG,SAKhB;wBAEK,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAC,MAAM;4BAC1C,6BACK,MAAM,GACN,MAAM,CAAC,OAAO,EAClB;wBACH,CAAC,CAAC,CAAC;wBAEH,sBAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAC;;;;KAC7B;IAED;;;;OAIG;IACG,kBAAG,GAAT,UAAU,SAAiB,EAAE,KAAa;;;gBACxC,sBAAO,IAAA,sBAAQ,EACb,KAAK,EACL,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,OAAO,EACT,IAAI,CAAC,OAAO,SAAI,SAAS,cAAS,KAAO,CAC7C,EAAC;;;KACH;IAED;;;;;;OAMG;IACG,qBAAM,GAAZ,UACE,SAAiB,EACjB,OAAe,EACf,MAAqB,EACrB,OAA0B;;;gBAE1B,6EAA6E;gBAC7E,IACE,OAAO;oBACP,OAAO,CAAC,cAAc,KAAK,SAAS;oBACpC,OAAO,CAAC,UAAU,KAAK,SAAS,EAChC;oBACA,MAAM,IAAI,KAAK,CACb,wFAAwF,CACzF,CAAC;iBACH;gBAED,sBAAO,IAAA,sBAAQ,EACb,MAAM,EACN,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,OAAO,EACT,IAAI,CAAC,OAAO,SAAI,SAAS,UAAO,EACnC,IAAI,CAAC,SAAS,CAAC;wBACb,OAAO,SAAA;wBACP,MAAM,QAAA;wBACN,eAAe,EACb,OAAO,IAAI,OAAO,CAAC,cAAc;4BAC/B,CAAC,CAAC,OAAO,CAAC,cAAc;4BACxB,CAAC,CAAC,SAAS;wBACf,uBAAuB,EACrB,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS;qBACjE,CAAC,CACH,EAAC;;;KACH;IAED;;;;OAIG;IACG,qBAAM,GAAZ,UAAa,SAAiB,EAAE,KAAa;;;gBAC3C,sBAAO,IAAA,sBAAQ,EACb,QAAQ,EACR,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,OAAO,EACT,IAAI,CAAC,OAAO,SAAI,SAAS,cAAS,KAAO,CAC7C,EAAC;;;KACH;IACH,WAAC;AAAD,CAAC,AAhGD,IAgGC;AAhGY,oBAAI"}

package/dist/transcription/liveTranscription.js

@@ -75,7 +75,7 @@ var LiveTranscription = /** @class */ (function (_super) {
      * the websocket connection when transcription is finished
      */
     LiveTranscription.prototype.finish = function () {
-        this._socket.close(1000);
+        this._socket.send(new Uint8Array(0));
     };
     return LiveTranscription;
 }(events_1.default));

package/dist/transcription/liveTranscription.js.map

@@ -1 +1 @@
-{"version":3,"file":"liveTranscription.js","sourceRoot":"","sources":["../../src/transcription/liveTranscription.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,kDAAkC;AAClC,4DAAsC;AACtC,0CAA2B;AAC3B,kCAAoE;AAEpE,0CAAyC;AAEzC;IAAuC,qCAAY;IAGjD,2BACE,WAAmB,EACnB,MAAc,EACd,OAAkC;QAHpC,YAKE,kBAAM,SAAS,CAAC,SAWjB;QAVC,KAAI,CAAC,OAAO,GAAG,IAAI,YAAS,CAC1B,WAAS,MAAM,mBAAc,qBAAW,CAAC,SAAS,CAAC,OAAO,CAAG,EAC7D;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,WAAS,WAAa;gBACrC,YAAY,EAAE,IAAA,qBAAS,GAAE;aAC1B;SACF,CACF,CAAC;QACF,KAAI,CAAC,iBAAiB,EAAE,CAAC;;IAC3B,CAAC;IAEO,6CAAiB,GAAzB;QAAA,iBAgBC;QAfC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG;YACpB,KAAI,CAAC,IAAI,oBAA+B,KAAI,CAAC,CAAC;QAChD,CAAC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,UAAC,KAA2B;YACjD,KAAI,CAAC,IAAI,sBAAgC,KAAK,CAAC,CAAC;QAClD,CAAC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,UAAC,KAAK;YAC3B,KAAI,CAAC,IAAI,sBAAgC,KAAK,CAAC,CAAC;QAClD,CAAC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,UAAC,CAAC;YACzB,KAAI,CAAC,IAAI,gDAA6C,CAAC,CAAC,IAAI,CAAC,CAAC;QAChE,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,yCAAa,GAApB;QACE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IACjC,CAAC;IAED;;;OAGG;IACI,gCAAI,GAAX,UAAY,IAAuD;QACjE,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,uBAAe,CAAC,IAAI,EAAE;YACpD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACzB;aAAM;YACL,IAAI,CAAC,IAAI,sBAEP,sCAAsC,CACvC,CAAC;SACH;IACH,CAAC;IAED;;;OAGG;IACI,kCAAM,GAAb;QACE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IACH,wBAAC;AAAD,CAAC,AApED,CAAuC,gBAAY,GAoElD;AApEY,8CAAiB"}
+{"version":3,"file":"liveTranscription.js","sourceRoot":"","sources":["../../src/transcription/liveTranscription.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA,kDAAkC;AAClC,4DAAsC;AACtC,0CAA2B;AAC3B,kCAAoE;AAEpE,0CAAyC;AAEzC;IAAuC,qCAAY;IAGjD,2BACE,WAAmB,EACnB,MAAc,EACd,OAAkC;QAHpC,YAKE,kBAAM,SAAS,CAAC,SAWjB;QAVC,KAAI,CAAC,OAAO,GAAG,IAAI,YAAS,CAC1B,WAAS,MAAM,mBAAc,qBAAW,CAAC,SAAS,CAAC,OAAO,CAAG,EAC7D;YACE,OAAO,EAAE;gBACP,aAAa,EAAE,WAAS,WAAa;gBACrC,YAAY,EAAE,IAAA,qBAAS,GAAE;aAC1B;SACF,CACF,CAAC;QACF,KAAI,CAAC,iBAAiB,EAAE,CAAC;;IAC3B,CAAC;IAEO,6CAAiB,GAAzB;QAAA,iBAgBC;QAfC,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG;YACpB,KAAI,CAAC,IAAI,oBAA+B,KAAI,CAAC,CAAC;QAChD,CAAC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,UAAC,KAA2B;YACjD,KAAI,CAAC,IAAI,sBAAgC,KAAK,CAAC,CAAC;QAClD,CAAC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,UAAC,KAAK;YAC3B,KAAI,CAAC,IAAI,sBAAgC,KAAK,CAAC,CAAC;QAClD,CAAC,CAAC;QAEF,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,UAAC,CAAC;YACzB,KAAI,CAAC,IAAI,gDAA6C,CAAC,CAAC,IAAI,CAAC,CAAC;QAChE,CAAC,CAAC;IACJ,CAAC;IAED;;OAEG;IACI,yCAAa,GAApB;QACE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC;IACjC,CAAC;IAED;;;OAGG;IACI,gCAAI,GAAX,UAAY,IAAuD;QACjE,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,KAAK,uBAAe,CAAC,IAAI,EAAE;YACpD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACzB;aAAM;YACL,IAAI,CAAC,IAAI,sBAEP,sCAAsC,CACvC,CAAC;SACH;IACH,CAAC;IAED;;;OAGG;IACI,kCAAM,GAAb;QACE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC;IACH,wBAAC;AAAD,CAAC,AApED,CAAuC,gBAAY,GAoElD;AApEY,8CAAiB"}

package/dist/types/keyResponse.d.ts

@@ -1,4 +1,5 @@
 import { Key } from "./key";
+import { Member } from "./member";
 /**
  * Response from the Deepgram API to list keys
  */
@@ -6,5 +7,44 @@ export declare type KeyResponse = {
     /**
      * Array of API keys associated with the project
      */
-    api_keys: Array<Key>;
+    api_keys: Array<{
+        /**
+         * Optional member associated with the API key
+         */
+        member?: Member;
+        /**
+         * API key
+         */
+        api_key: Key;
+        /**
+         * Unique identifier of the key to use in API requests
+         * @deprecated This property has moved to api_key.api_key_id and will
+         * be removed in future versions.
+         */
+        api_key_id: string;
+        /**
+         * API key to send in API requests (Only displayed when first created)
+         * @deprecated This property has moved to api_key.key and will
+         * be removed in future versions.
+         */
+        key?: string;
+        /**
+         * Comment for user reference
+         * @deprecated This property has moved to api_key.comment and will
+         * be removed in future versions.
+         */
+        comment: string;
+        /**
+         * Timestamp of the date/time the key was created
+         * @deprecated This property has moved to api_key.created and will
+         * be removed in future versions.
+         */
+        created: string;
+        /**
+         * Array of scopes assigned to the key
+         * @deprecated This property has moved to api_key.scopes and will
+         * be removed in future versions.
+         */
+        scopes: Array<string>;
+    }>;
 };

package/dist/types/liveTranscriptionOptions.d.ts

@@ -16,7 +16,7 @@ export declare type LiveTranscriptionOptions = {
      * @remarks latest OR <version_id>
      * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/version
      */
-    version: string;
+    version?: string;
     /**
      * BCP-47 language tag that hints at the primary spoken language.
      * @default en-US

package/dist/types/member.d.ts

@@ -1,6 +1,6 @@
 export declare type Member = {
-    id: string;
-    name: string;
-    scopes: Array<string>;
+    member_id: string;
+    name?: string;
+    scopes?: Array<string>;
     email: string;
 };

package/dist/types/prerecordedTranscriptionOptions.d.ts

@@ -16,7 +16,7 @@ export declare type PrerecordedTranscriptionOptions = {
      * @remarks latest OR <version_id>
      * @see https://developers.deepgram.com/api-reference/speech-recognition-api#operation/transcribeAudio/properties/version
      */
-    version: string;
+    version?: string;
     /**
      * BCP-47 language tag that hints at the primary spoken language.
      * @default en-US

package/dist/types/utterance.d.ts

@@ -28,7 +28,8 @@ export declare type Utterance = {
      */
     words: Array<WordBase>;
     /**
-     * Integer indicating the speaker who is saying the word being processed.
+     * Integer indicating the predicted speaker of the majority of words
+     * in the utterance who is saying the words being processed.
      */
     speaker?: number;
     /**

package/dist/types/wordBase.d.ts

@@ -4,4 +4,5 @@ export declare type WordBase = {
     end: number;
     confidence: number;
     punctuated_word?: string;
+    speaker?: number;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deepgram/sdk",
-  "version": "1.2.0",
+  "version": "1.2.4",
   "description": "An SDK for the Deepgram automated speech recognition platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -13,7 +13,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/deepgram/node-sdk.git"
+    "url": "git+https://github.com/deepgram/deepgram-node-sdk.git"
   },
   "keywords": [
     "deepgram",
@@ -27,9 +27,9 @@
   },
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/deepgram/node-sdk/issues"
+    "url": "https://github.com/deepgram/deepgram-node-sdk/issues"
   },
-  "homepage": "https://github.com/deepgram/node-sdk#readme",
+  "homepage": "https://github.com/deepgram/deepgram-node-sdk#readme",
   "devDependencies": {
     "@types/chai": "^4.2.22",
     "@types/mocha": "^9.0.0",