assemblyai 4.4.2 → 4.4.3

package/CHANGELOG.md

@@ -1,10 +1,15 @@
 # Changelog
 
-## [4.4.2]
+## [4.4.3] - 2024-05-09
+
+- Add react-native exports that resolve to the browser version of the library.
+
+## [4.4.2] - 2024-05-03
 
 ### Changed
 
 - Caching is disabled for all HTTP request made by the SDK
+- Accept data-URIs in `client.files.upload(dataUri)`, `client.transcripts.submit(audio: dataUri)`, `client.transcripts.transcribe(audio: dataUri)`.
 - Change how the WebSocket libraries are imported for better compatibility across frameworks and runtimes.
   The library no longer relies on a internal `#ws` import, and instead compiles the imports into the dist bundles.
   Browser builds will use the native `WebSocket`, other builds will use the `ws` package.

package/README.md

@@ -53,6 +53,30 @@ const client = new AssemblyAI({
 
 You can now use the `client` object to interact with the AssemblyAI API.
 
+### Using a CDN
+
+You can use automatic CDNs like [UNPKG](https://unpkg.com/) to load the library from a script tag.
+
+- Replace `:version` with the desired version or `latest`.
+- Remove `.min` to load the non-minified version.
+
+```html
+<script src="https://www.unpkg.com/assemblyai@:version/dist/assemblyai.umd.min.js"></script>
+```
+
+The script creates a global `assemblyai` variable containing all the services.
+Here's how you create a `RealtimeTranscriber` object.
+
+```js
+const { RealtimeTranscriber } = assemblyai;
+const transcriber = new RealtimeTranscriber({
+  token: "[GENERATE TEMPORARY AUTH TOKEN IN YOUR API]",
+  ...
+});
+```
+
+For type support in your IDE, see [Reference types from JavaScript](./docs/reference-types-from-js.md).
+
 ## Speech-To-Text
 
 ### Transcribe audio and video files
@@ -227,18 +251,26 @@ const rt = client.realtime.transcriber({
 });
 ```
 
-You can also generate a temporary auth token for real-time.
-
-```typescript
-const token = await client.realtime.createTemporaryToken({ expires_in = 60 });
-const rt = client.realtime.transcriber({
-  token: token,
-});
-```
-
 > [!WARNING]
 > Storing your API key in client-facing applications exposes your API key.
 > Generate a temporary auth token on the server and pass it to your client.
+> _Server code_:
+>
+> ```typescript
+> const token = await client.realtime.createTemporaryToken({ expires_in = 60 });
+> // TODO: return token to client
+> ```
+>
+> _Client code_:
+>
+> ```typescript
+> import { RealtimeTranscriber } from "assemblyai";
+> // TODO: implement getToken to retrieve token from server
+> const token = await getToken();
+> const rt = new RealtimeTranscriber({
+>   token,
+> });
+> ```
 
 You can configure the following events.
 
@@ -344,3 +376,7 @@ const response = await client.lemur.purgeRequestData(lemurResponse.request_id);
 ```
 
 </details>
+
+## Contributing
+
+If you want to contribute to the JavaScript SDK, follow the guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md).

package/docs/reference-types-from-js.md

@@ -0,0 +1,27 @@
+# Reference types from JavaScript
+
+Types are automatically configured in most IDEs when you import the `assemblyai` module using `require` or `import`.
+However, if you're using the _assemblyai.umd.js_ or _assemblyai.umd.min.js_ script,
+you need to manually reference the types.
+
+1. Install the `assemblyai` module locally.
+2. Create an _assemblyai.d.ts_ file with the following content.
+   ```typescript
+   import AssemblyAIModule from "assemblyai";
+   declare global {
+     const assemblyai: typeof AssemblyAIModule;
+   }
+   ```
+   This will import the TypeScript types from the `assemblyai` module,
+   and configure them as the global `assemblyai` variable.
+3. Reference the _assemblyai.d.ts_ file at the top of your script file.
+
+   ```js
+   /// <reference path="assemblyai.d.ts" />
+   const { RealtimeTranscriber } = assemblyai;
+   ...
+   ```
+
+   Your IDE will load the types specified in the `<reference />` tag.
+
+   > [!INFO] > `/// <reference />` tags only work in script files, not script-blocks, and should be at the top of the file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.4.2",
+  "version": "4.4.3",
   "description": "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.",
   "engines": {
     "node": ">=18"
@@ -18,6 +18,7 @@
       },
       "workerd": "./dist/index.mjs",
       "browser": "./dist/browser.mjs",
+      "react-native": "./dist/browser.mjs",
       "node": {
         "types": "./dist/index.d.ts",
         "import": "./dist/node.mjs",
@@ -47,6 +48,8 @@
     }
   },
   "type": "commonjs",
+  "react-native": "./dist/browser.mjs",
+  "browser": "./dist/browser.mjs",
   "main": "./dist/index.cjs",
   "require": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -68,7 +71,7 @@
     "test": "pnpm run test:unit && pnpm run test:integration",
     "test:unit": "jest --config jest.unit.config.js --testTimeout 1000",
     "test:integration": "jest --config jest.integration.config.js --testTimeout 360000",
-    "format": "prettier '**/*' --write",
+    "format": "prettier {*,**/*} --write --no-error-on-unmatched-pattern",
     "generate:types": "tsx ./scripts/generate-types.ts && prettier 'src/types/*.generated.ts' --write",
     "generate:reference": "typedoc",
     "copybara:dry-run": "./copybara.sh dry_run --init-history",
@@ -97,16 +100,16 @@
     "docs"
   ],
   "devDependencies": {
-    "@babel/preset-env": "^7.24.0",
-    "@babel/preset-typescript": "^7.23.3",
+    "@babel/preset-env": "^7.24.5",
+    "@babel/preset-typescript": "^7.24.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/jest": "^29.5.12",
-    "@types/node": "^18.11.9",
+    "@types/node": "^18.19.32",
     "@types/websocket": "^1.0.10",
     "@types/ws": "^8.5.10",
-    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
     "dotenv": "^16.4.5",
     "eslint": "^8.57.0",
     "eslint-plugin-tsdoc": "^0.2.17",
@@ -120,14 +123,14 @@
     "prettier": "^3.2.5",
     "publint": "^0.2.7",
     "rimraf": "^5.0.5",
-    "rollup": "^4.13.0",
+    "rollup": "^4.17.2",
     "ts-jest": "^29.1.2",
     "tslib": "^2.5.3",
-    "typescript": "^5.4.2",
-    "typedoc": "^0.25.12",
-    "typedoc-plugin-extras": "^3.0.0"
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-extras": "^3.0.0",
+    "typescript": "^5.4.5"
   },
   "dependencies": {
-    "ws": "^8.16.0"
+    "ws": "^8.17.0"
   }
 }