assemblyai 3.1.3 → 4.0.0-beta.1

package/CHANGELOG.md

@@ -0,0 +1,92 @@
+# Changelog
+
+## [4.0.0]
+
+### Added
+
+- Add `browser` and `workerd` (Cloudflare Workers) exports to package.json. These exports are compatible versions of the SDK, with a few limitations. You can't use the file system and you have to use a temporary auth token with the real-time transcriber.
+- Add `dist/assemblyai.umd.js` and `dist/assemblyai.umd.min.js`. You can reference these script files directly in the browser and the SDK will be available at the global `assemblyai` variable.
+
+### Changed
+
+- `RealtimeService.sendAudio` accepts audio via type `ArrayBufferLike`.
+- **Breaking**: `RealtimeService.stream` returns a [WHATWG Streams Standard stream](https://nodejs.org/api/webstreams.html), instead of a Node stream. In the browser, the native web standard stream will be used.
+- `ws` is used as the WebSocket client as before, but in the browser, the native WebSocket client is used.
+- Rename Node SDK to JavaScript SDK as the SDK is compatible with more runtimes now.
+
+## [3.1.1] - 2023-11-21
+
+### Added
+
+- Add `client.transcripts.transcribe` function to transcribe an audio file with polling until transcript status is `completed` or `error`. This function takes an `audio` option which can be an audio file URL, path, stream, or buffer.
+- Add `client.transcripts.submit` function to queue a transcript. You can use `client.transcripts.waitUntilReady` to poll the transcript returned by `submit`. This function also takes an `audio` option which can be an audio file URL, path, stream, or buffer.
+
+### Changed
+
+- Deprecated `client.transcripts.create` in favor of `transcribe` and `submit`, to be more consistent with other AssemblyAI SDKs.
+- Renamed types
+  - Renamed `Parameters` type suffix with `Params` type suffix
+  - Renamed `CreateTranscriptParameters` to `TranscriptParams`
+  - Renamed `CreateTranscriptOptionalParameters` to `TranscriptOptionalParams`.
+- Added deprecated aliases for the forementioned types
+- Improved type docs
+
+## [3.1.0] - 2023-11-16
+
+### Added
+
+- Add `AssemblyAI.transcripts.waitUntilReady` function to wait until a transcript is ready, meaning `status` is `completed` or `error`.
+- Add `chars_per_caption` parameter to `AssemblyAI.transcripts.subtitles` function.
+- Add `input_text` property to LeMUR functions. Instead of using `transcript_ids`, you can use `input_text` to provide custom formatted transcripts as input to LeMUR.
+
+### Changed
+
+- Change default timeout from 3 minutes to infinite (-1). Fixes [#17](https://github.com/AssemblyAI/assemblyai-node-sdk/issues/17)
+
+### Fixed
+
+- Correctly serialize the keywords for `client.transcripts.wordSearch`.
+- Use more widely compatible syntax for wildcard exporting types. Fixes [#18](https://github.com/AssemblyAI/assemblyai-node-sdk/issues/18).
+
+## [3.0.1] - 2023-10-30
+
+### Changed
+
+- The SDK uses `fetch` instead of Axios. This removes the Axios dependency. Axios relies on XMLHttpRequest which isn't supported in Cloudflare Workers, Deno, Bun, etc. By using `fetch`, the SDK is now more compatible on the forementioned runtimes.
+
+### Fixed
+
+- The SDK uses relative imports instead of using path aliases, to make the library transpilable with tsc for consumers. Fixes [#14](https://github.com/AssemblyAI/assemblyai-node-sdk/issues/14).
+- Added `speaker` property to the `TranscriptUtterance` type, and removed `channel` property.
+
+## [3.0.0] - 2023-10-24
+
+### Changed
+
+- `AssemblyAI.files.upload` accepts streams and buffers, in addition to a string (path to file).
+
+### Removed
+
+- **Breaking**: The module does not have a default export anymore, because of inconsistent functionality across module systems. Instead, use `AssemblyAI` as a named import like this: `import { AssemblyAI } from 'assemblyai'`.
+
+## [2.0.2] - 2023-10-13
+
+### Added
+
+- `AssemblyAI.transcripts.wordSearch` searches for keywords in the transcript.
+- `AssemblyAI.lemur.purgeRequestData` deletes data related to your LeMUR request.
+- `RealtimeService.stream` creates a writable stream that you can write audio data to instead of using `RealtimeService.sendAudio``.
+
+### Fixed
+
+- The AssemblyAI class would be exported as default named export instead in certain module systems.
+
+## [2.0.1] - 2023-10-10
+
+Re-implement the Node SDK in TypeScript and add all AssemblyAI APIs.
+
+### Added
+
+- Transcript API client
+- LeMUR API client
+- Real-time transcript client

package/README.md

@@ -10,10 +10,11 @@
 [![Discord](https://img.shields.io/discord/875120158014853141?logo=discord&label=Discord&link=https%3A%2F%2Fdiscord.com%2Fchannels%2F875120158014853141&style=social)
 ](https://assemblyai.com/discord)
 
-# AssemblyAI Node.js SDK
+# AssemblyAI JavaScript SDK
 
-The AssemblyAI Node.js SDK provides an easy-to-use interface for interacting with the AssemblyAI API,
+The AssemblyAI JavaScript SDK provides an easy-to-use interface for interacting with the AssemblyAI API,
 which supports async and real-time transcription, as well as the latest LeMUR models.
+It is written primarily for Node.js in TypeScript with all types exported, but also [compatible with other runtimes](./docs/compat.md).
 
 ## Installation
 
@@ -51,7 +52,7 @@ You can now use the `client` object to interact with the AssemblyAI API.
 
 ## Create a transcript
 
-When you create a transcript, you can either pass in a URL to an audio file, or upload a file directly.
+When you create a transcript, you can either pass in a URL to an audio file or upload a file directly.
 
 ```javascript
 // Transcribe file at remote URL
@@ -242,10 +243,10 @@ getAudio((chunk) => {
 });
 ```
 
-Or send audio data via a stream by piping to the realtime stream.
+Or send audio data via a stream by piping to the real-time stream.
 
 ```typescript
-audioStream.pipe(rt.stream());
+audioStream.pipeTo(rt.stream());
 ```
 
 Close the connection when you're finished.