@deepgram/sdk 1.4.5 → 1.5.0

package/dist/types/usageResponse.d.ts

@@ -0,0 +1,10 @@
+import { UsageResponseDetail } from "./usageResponseDetail";
+export declare type UsageResponse = {
+    start: string;
+    end: string;
+    resolution: {
+        units: string;
+        amount: number;
+    };
+    results: Array<UsageResponseDetail>;
+};

package/dist/types/usageResponseDetail.d.ts

@@ -0,0 +1,6 @@
+export declare type UsageResponseDetail = {
+    start: string;
+    end: string;
+    hours: number;
+    requests: number;
+};

package/dist/types/utterance.d.ts

@@ -0,0 +1,39 @@
+import { WordBase } from "./wordBase";
+export declare type Utterance = {
+    /**
+     * Start time (in seconds) from the beginning of the audio stream.
+     */
+    start: number;
+    /**
+     * End time (in seconds) from the beginning of the audio stream.
+     */
+    end: number;
+    /**
+     * Floating point value between 0 and 1 that indicates overall transcript
+     * reliability. Larger values indicate higher confidence.
+     */
+    confidence: number;
+    /**
+     * Audio channel to which the utterance belongs. When using multichannel audio,
+     * utterances are chronologically ordered by channel.
+     */
+    channel: number;
+    /**
+     *  Transcript for the audio segment being processed.
+     */
+    transcript: string;
+    /**
+     * Object containing each word in the transcript, along with its start time
+     * and end time (in seconds) from the beginning of the audio stream, and a confidence value.
+     */
+    words: Array<WordBase>;
+    /**
+     * Integer indicating the predicted speaker of the majority of words
+     * in the utterance who is saying the words being processed.
+     */
+    speaker?: number;
+    /**
+     * Unique identifier of the utterance
+     */
+    id: string;
+};

package/dist/types/wordBase.d.ts

@@ -0,0 +1,9 @@
+export declare type WordBase = {
+    word: string;
+    start: number;
+    end: number;
+    confidence: number;
+    punctuated_word?: string;
+    speaker?: number;
+    speaker_confidence?: number;
+};

package/dist/usage.d.ts

@@ -0,0 +1,35 @@
+import { RequestFunction, UsageField, UsageFieldOptions, UsageOptions, UsageRequest, UsageRequestList, UsageRequestListOptions, UsageResponse } from "./types";
+export declare class Usage {
+    private _credentials;
+    private _apiUrl;
+    private _request;
+    constructor(_credentials: string, _apiUrl: string, _request: RequestFunction);
+    private apiPath;
+    /**
+     * Retrieves all requests associated with the provided projectId based
+     * on the provided options
+     * @param projectId Unique identifier of the project
+     * @param options Additional filter options
+     */
+    listRequests(projectId: string, options?: UsageRequestListOptions): Promise<UsageRequestList>;
+    /**
+     * Retrieves a specific request associated with the provided projectId
+     * @param projectId Unique identifier of the project
+     * @param requestId Unique identifier for the request to retrieve
+     */
+    getRequest(projectId: string, requestId: string): Promise<UsageRequest>;
+    /**
+     * Retrieves usage associated with the provided projectId based
+     * on the provided options
+     * @param projectId Unique identifier of the project
+     * @param options Options to filter usage
+     */
+    getUsage(projectId: string, options?: UsageOptions): Promise<UsageResponse>;
+    /**
+     * Retrieves features used by the provided projectId based
+     * on the provided options
+     * @param projectId Unique identifier of the project
+     * @param options Options to filter usage
+     */
+    getFields(projectId: string, options?: UsageFieldOptions): Promise<UsageField>;
+}

package/dist/userAgent.d.ts

@@ -0,0 +1 @@
+export declare function userAgent(): string;

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@deepgram/sdk",
-  "version": "1.4.5",
+  "version": "1.5.0",
   "description": "An SDK for the Deepgram automated speech recognition platform",
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "npm run build:lib && webpack --config webpack.config.js && npm run bundle",
+    "build": "npm run build:lib && webpack --config webpack.config.js && npm run types",
     "build:lib": "tsc --project ./tsconfig.json && tsc --project ./tsconfig-es6.json",
     "coverage": "nyc npm run test",
     "lint": "eslint ./src --ext .ts && prettier --config .prettierrc src/*.ts src/**/*.ts --write",
     "test": "mocha -r ts-node/register tests/*test.ts tests/**/*test.ts --insect",
     "watch": "nodemon -e ts --watch src --exec \"npm run build\"",
-    "bundle": "dts-generator --project ./ --out dist/index.d.ts"
+    "types": "copyfiles -f bundle/*.d.ts dist && copyfiles -u 1 bundle/**/*.d.ts dist"
   },
   "exports": {
     ".": "./dist/index.js",
@@ -47,6 +47,7 @@
     "@typescript-eslint/parser": "^4.33.0",
     "browserify": "^17.0.0",
     "chai": "^4.3.4",
+    "copyfiles": "^2.4.1",
     "eslint": "^7.32.0",
     "eslint-config-airbnb-base": "^14.2.1",
     "eslint-plugin-import": "^2.25.2",
@@ -63,7 +64,6 @@
   },
   "dependencies": {
     "bufferutil": "^4.0.6",
-    "dts-generator": "^3.0.0",
     "utf-8-validate": "^5.0.9",
     "ws": "^7.5.5"
   }

package/webpack.config.js

@@ -2,7 +2,7 @@ const path = require("path");
 
 const clientConfig = {
   name: "client",
-  target: "web", // <=== can be omitted as default is 'web'
+  target: "web",
   entry: "./bundle/browser/index.js",
   output: {
     path: path.resolve(__dirname, "dist/browser"),
@@ -14,7 +14,6 @@ const clientConfig = {
   experiments: {
     outputModule: true,
   },
-  //…
 };
 
 const serverConfig = {
@@ -29,7 +28,6 @@ const serverConfig = {
       type: "umd",
     },
   },
-  //…
 };
 
 module.exports = [serverConfig, clientConfig];

package/CHANGELOG.md

@@ -1,234 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
----
-
-## [1.4.5]
-
-### Updated
-
-- Updated ReadStream to Readable
-
-## [1.4.4]
-
-### Added
-
-- Added `replace` to transcription option types
-
-## [1.4.3]
-
-### Added
-
-- Added `tier` to transcription option types
-
-## [1.4.2]
-
-### Added
-
-- Updated build step to build separate files for browser version
-
-## [1.4.1]
-
-### Added
-
-- Small fix for npm deployment
-
-## [1.4.0]
-
-### Added
-
-- Added Browser compatible versions of the live and preRecorded transcription methods
-
-## [1.3.1]
-
-### Updated
-
-- Updated user-agent header to be generated on build rather than on demand. This should remove warnings when using webpack
-
-## [1.3.0]
-
-### Added
-
-- Added Message Class for generic message responses
-- Added member endpoint functionality
-  - This includes the `listMembers` and `removeMember` methods
-  - Added Member and MemberList Class
-- Added scopes endpoint functionality
-  - This includes the `get` and `update` methods
-  - Added ScopeList Class
-- Added invites endpoint functionality
-  - This includes the `list`, `send`, `leave` and `delete` methods
-  - Added InvitationOptions and InvitationList Class
-- Added balances endpoint functionality
-  - This includes the `listBalances` and `getBalance` methods
-  - Added Balance and BalanceList Class
-
-## [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
-
-- Updated the `keys.create` function to allow new `expirationDate` or `timeToLive`
-  values. These are optional and one at most can be provided. Providing both will
-  throw an error.
-
-## [1.1.0]
-
-### Added
-
-- Prerecorded transcription responses can now be used to generate WebVTT and
-  SRT caption files. Example:
-
-  ```js
-  const response = await deepgram.transcription.preRecorded(
-    { url: "URL_TO_FILE" },
-    {
-      punctuate: true,
-      utterances: true,
-    }
-  );
-  const webVTT = response.toWebVTT();
-  const SRT = response.toSRT();
-  ```
-
-  The [utterances](https://developers.deepgram.com/documentation/features/utterances/)
-  feature is required to use this functionality.
-
-## [1.0.3]
-
-### Added
-
-- In addition to a Url and Buffer, `trascricription.preRecorded` now accepts a
-  ReadStream as a source of the file to transcribe.
-
-### Updated
-
-- Removed a console log that occurred when an HTTP request ended
-
-## [1.0.2]
-
-### Added
-
-- `deepgram.projects.update` will now update a project
-- Prerecorded transcription responses now include utterances
-
-### Updated
-
-- The project type has been modified to the following:
-
-```ts
-{
-  project_id: string;
-  name?: string;
-  company?: string;
-};
-```
-
-- The key type has been modified to the following:
-
-```ts
-{
-  api_key_id: string;
-  key?: string;
-  comment: string;
-  created: string;
-  scopes: Array<string>;
-};
-```
-
-- The usage request type has been modified to the following:
-
-```ts
-{
-  request_id: string;
-  created: string;
-  path: string;
-  accessor: string;
-  response?: UsageRequestDetail | UsageRequestMessage;
-  callback?: UsageCallback;
-};
-```
-
-## [1.0.0]
-
-### Added
-
-#### Live transcription
-
-- `deepgram.transcription.live` now manages a websocket connection to Deepgram's API
-  for live transcription
-
-#### Projects
-
-- `deepgram.projects` allows listing projects or getting a specific project from
-  your Deepgram account
-
-### Updated
-
-#### Pre-recorded transcription
-
-- `deepgram.batch` has been moved to `deepgram.transcription.preRecorded`
-- Type of `source` parameter of pre-recorded transcriptions has changed. You can now
-  send one of two types of objects: `{ url: YOUR_FILES_URL }` or
-  `{ buffer: BUFFER_OF_YOUR_FILE, mimetype: FILES_MIME_TYPE }`
-
-#### API Key management
-
-- All `deepgram.keys` methods now require a `projectId`.
-- `deepgram.keys.create` now requires an additional parameter `scopes`. This is a
-  string array specifying the scopes available to the newly created API key
-
-## [0.6.5]
-
-- Added notice to README to denote the library is in a very unstable state.
-
-## [0.6.4]
-
-### Added
-
-- `transcribe` method will now return transcription results for both urls or buffers.
-- `keys` now provides `create`, `list`, and `delete` methods that allow managing of
-  API keys.
-
----
-
-[unreleased]: https://github.com/deepgram/node-sdk/compare/1.4.0...HEAD
-[1.4.0]: https://github.com/deepgram/node-sdk/compare/1.3.1...1.4.0
-[1.3.1]: https://github.com/deepgram/node-sdk/compare/1.3.0...1.3.1
-[1.3.0]: https://github.com/deepgram/node-sdk/compare/1.2.4...1.3.0
-[1.2.4]: 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
-[1.0.0]: https://github.com/deepgram/node-sdk/compare/0.6.5...1.0.0
-[0.6.5]: https://github.com/deepgram/node-sdk/compare/0.6.4...0.6.5
-[0.6.4]: https://github.com/deepgram/node-sdk/compare/edc07b4...0.6.4