assemblyai 2.0.1-beta → 2.0.2-beta

package/README.md

@@ -1,7 +1,16 @@
-<img src="https://github.com/AssemblyAI/assemblyai-typescript-sdk/blob/master/assemblyai.png?raw=true" width="500"/>
+<img src="https://github.com/AssemblyAI/assemblyai-node-sdk/blob/main/assemblyai.png?raw=true" width="500"/>
 
 ---
 
+[![npm](https://img.shields.io/npm/v/assemblyai)](https://www.npmjs.com/package/assemblyai)
+[![Test](https://github.com/AssemblyAI/assemblyai-node-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/AssemblyAI/assemblyai-node-sdk/actions/workflows/test.yml)
+[![GitHub License](https://img.shields.io/github/license/AssemblyAI/assemblyai-node-sdk)](https://github.com/AssemblyAI/assemblyai-node-sdk/blob/master/LICENSE)
+[![AssemblyAI Twitter](https://img.shields.io/twitter/follow/AssemblyAI?label=%40AssemblyAI&style=social)](https://twitter.com/AssemblyAI)
+[![AssemblyAI YouTube](https://img.shields.io/youtube/channel/subscribers/UCtatfZMf-8EkIwASXM4ts0A)](https://www.youtube.com/@AssemblyAI)
+[![Discord](https://img.shields.io/discord/875120158014853141?logo=discord&label=Discord&link=https%3A%2F%2Fdiscord.com%2Fchannels%2F875120158014853141&style=social)
+](https://discord.gg/5aQNZyq3)
+
+
 # AssemblyAI Node.js SDK
 
 The AssemblyAI Node.js SDK provides an easy-to-use interface for interacting with the AssemblyAI API,
@@ -173,7 +182,7 @@ const service = client.realtime.createService({
 You can also generate a temporary auth token for real-time.
 
 ```typescript
-const token = await client.realtime.createTemporaryToken({expires_in = 60});
+const token = await client.realtime.createTemporaryToken({ expires_in = 60 });
 const rt = client.realtime.createService({
   token: token
 });
@@ -212,7 +221,7 @@ getAudio((chunk) => {
 Close the connection when you're finished.
 
 ```typescript
-rt.close();
+await rt.close();
 ```
 
 # Tests

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import AssemblyAI from "./services";
+import { AssemblyAI } from "./services";
 export * from "./services";
 export type * from "./types";
 export default AssemblyAI;

package/dist/index.esm.js

@@ -164,11 +164,12 @@ class RealtimeService {
         url.search = searchParams.toString();
         return url;
     }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     on(event, listener) {
         this.listeners[event] = listener;
     }
     connect() {
-        return new Promise((resolve, _) => {
+        return new Promise((resolve) => {
             if (this.socket) {
                 throw new Error("Already connected");
             }
@@ -251,7 +252,7 @@ class RealtimeService {
                 if (this.socket.readyState === WebSocket.OPEN) {
                     const terminateSessionMessage = `{"terminate_session": true}`;
                     if (waitForSessionTermination) {
-                        const sessionTerminatedPromise = new Promise((resolve, _) => {
+                        const sessionTerminatedPromise = new Promise((resolve) => {
                             this.sessionTerminatedResolve = resolve;
                         });
                         this.socket.send(terminateSessionMessage);
@@ -321,6 +322,7 @@ class TranscriptService extends BaseService {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const startTime = Date.now();
+            // eslint-disable-next-line no-constant-condition
             while (true) {
                 const transcript = yield this.get(transcriptId);
                 if (transcript.status === "completed" || transcript.status === "error") {
@@ -470,4 +472,18 @@ class AssemblyAI {
     }
 }
 
-export { FileService, LemurService, RealtimeService, RealtimeServiceFactory, TranscriptService, AssemblyAI as default };
+var services = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  AssemblyAI: AssemblyAI,
+  FileService: FileService,
+  LemurService: LemurService,
+  RealtimeService: RealtimeService,
+  RealtimeServiceFactory: RealtimeServiceFactory,
+  TranscriptService: TranscriptService
+});
+
+class AssemblyAIExports extends AssemblyAI {
+}
+module.exports = Object.assign(AssemblyAIExports, services);
+
+export { AssemblyAI, FileService, LemurService, RealtimeService, RealtimeServiceFactory, TranscriptService, AssemblyAI as default };

package/dist/index.js

@@ -168,11 +168,12 @@ class RealtimeService {
         url.search = searchParams.toString();
         return url;
     }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     on(event, listener) {
         this.listeners[event] = listener;
     }
     connect() {
-        return new Promise((resolve, _) => {
+        return new Promise((resolve) => {
             if (this.socket) {
                 throw new Error("Already connected");
             }
@@ -255,7 +256,7 @@ class RealtimeService {
                 if (this.socket.readyState === WebSocket.OPEN) {
                     const terminateSessionMessage = `{"terminate_session": true}`;
                     if (waitForSessionTermination) {
-                        const sessionTerminatedPromise = new Promise((resolve, _) => {
+                        const sessionTerminatedPromise = new Promise((resolve) => {
                             this.sessionTerminatedResolve = resolve;
                         });
                         this.socket.send(terminateSessionMessage);
@@ -325,6 +326,7 @@ class TranscriptService extends BaseService {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const startTime = Date.now();
+            // eslint-disable-next-line no-constant-condition
             while (true) {
                 const transcript = yield this.get(transcriptId);
                 if (transcript.status === "completed" || transcript.status === "error") {
@@ -474,6 +476,21 @@ class AssemblyAI {
     }
 }
 
+var services = /*#__PURE__*/Object.freeze({
+  __proto__: null,
+  AssemblyAI: AssemblyAI,
+  FileService: FileService,
+  LemurService: LemurService,
+  RealtimeService: RealtimeService,
+  RealtimeServiceFactory: RealtimeServiceFactory,
+  TranscriptService: TranscriptService
+});
+
+class AssemblyAIExports extends AssemblyAI {
+}
+module.exports = Object.assign(AssemblyAIExports, services);
+
+exports.AssemblyAI = AssemblyAI;
 exports.FileService = FileService;
 exports.LemurService = LemurService;
 exports.RealtimeService = RealtimeService;

package/dist/services/base.d.ts

@@ -2,7 +2,7 @@ import { AxiosInstance } from "axios";
 /**
  * Base class for services that communicate with the API.
  */
-declare abstract class BaseService {
+export declare abstract class BaseService {
     protected client: AxiosInstance;
     /**
      * Create a new service.
@@ -10,4 +10,3 @@ declare abstract class BaseService {
      */
     constructor(client: AxiosInstance);
 }
-export default BaseService;

package/dist/services/files/index.d.ts

@@ -1,5 +1,5 @@
-import BaseService from "@/services/base";
-export default class FileService extends BaseService {
+import { BaseService } from "@/services/base";
+export declare class FileService extends BaseService {
     /**
      * Upload a local file to AssemblyAI.
      * @param path The local file to upload.

package/dist/services/index.d.ts

@@ -1,9 +1,9 @@
 import { BaseServiceParams } from "@/types";
-import LemurService from "./lemur";
+import { LemurService } from "./lemur";
 import { RealtimeService, RealtimeServiceFactory } from "./realtime";
-import TranscriptService from "./transcripts";
-import FileService from "./files";
-export default class AssemblyAI {
+import { TranscriptService } from "./transcripts";
+import { FileService } from "./files";
+declare class AssemblyAI {
     /**
      * The files service.
      */
@@ -26,4 +26,4 @@ export default class AssemblyAI {
      */
     constructor(params: BaseServiceParams);
 }
-export { LemurService, RealtimeServiceFactory, RealtimeService, TranscriptService, FileService, };
+export { AssemblyAI, LemurService, RealtimeServiceFactory, RealtimeService, TranscriptService, FileService, };

package/dist/services/lemur/index.d.ts

@@ -1,6 +1,6 @@
 import { LemurSummaryParameters, LemurActionItemsParameters, LemurQuestionAnswerParameters, LemurTaskParameters, LemurSummaryResponse, LemurQuestionAnswerResponse, LemurActionItemsResponse, LemurTaskResponse } from "@/types";
-import BaseService from "@/services/base";
-export default class LemurService extends BaseService {
+import { BaseService } from "@/services/base";
+export declare class LemurService extends BaseService {
     summary(params: LemurSummaryParameters): Promise<LemurSummaryResponse>;
     questionAnswer(params: LemurQuestionAnswerParameters): Promise<LemurQuestionAnswerResponse>;
     actionItems(params: LemurActionItemsParameters): Promise<LemurActionItemsResponse>;

package/dist/services/transcripts/index.d.ts

@@ -1,8 +1,8 @@
-import BaseService from "@/services/base";
+import { BaseService } from "@/services/base";
 import { ParagraphsResponse, SentencesResponse, Transcript, TranscriptList, CreateTranscriptParameters, CreateTranscriptOptions, Createable, Deletable, Listable, Retrieveable, SubtitleFormat, RedactedAudioResponse } from "@/types";
 import { AxiosInstance } from "axios";
-import FileService from "../files";
-export default class TranscriptService extends BaseService implements Createable<Transcript, CreateTranscriptParameters, CreateTranscriptOptions>, Retrieveable<Transcript>, Deletable<Transcript>, Listable<TranscriptList> {
+import { FileService } from "../files";
+export declare class TranscriptService extends BaseService implements Createable<Transcript, CreateTranscriptParameters, CreateTranscriptOptions>, Retrieveable<Transcript>, Deletable<Transcript>, Listable<TranscriptList> {
     private files;
     constructor(client: AxiosInstance, files: FileService);
     /**

package/dist/types/services/abstractions.d.ts

@@ -3,7 +3,7 @@
  * @template T The type of the resource.
  * @template Parameters The type of the parameters required to create the resource.
  */
-interface Createable<T, Parameters, Options = Record<string, any>> {
+interface Createable<T, Parameters, Options = Record<string, unknown>> {
     /**
      * Create a new resource.
      * @param params The parameters of the new resource.

package/dist/utils/errors/index.d.ts

@@ -1 +1 @@
-export { default as RealtimeError, RealtimeErrorType, RealtimeErrorMessages, } from "./realtime";
+export { RealtimeError, RealtimeErrorType, RealtimeErrorMessages, } from "./realtime";

package/dist/utils/errors/realtime.d.ts

@@ -19,5 +19,4 @@ declare enum RealtimeErrorType {
 declare const RealtimeErrorMessages: Record<RealtimeErrorType, string>;
 declare class RealtimeError extends Error {
 }
-export { RealtimeErrorType, RealtimeErrorMessages };
-export default RealtimeError;
+export { RealtimeError, RealtimeErrorType, RealtimeErrorMessages };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "2.0.1-beta",
+  "version": "2.0.2-beta",
   "description": "The AssemblyAI Node.js 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.",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -8,7 +8,7 @@
   "typings": "dist/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/AssemblyAI/assemblyai-typescript-sdk.git"
+    "url": "git+https://github.com/AssemblyAI/assemblyai-node-sdk.git"
   },
   "publishConfig": {
     "tag": "beta",
@@ -18,15 +18,20 @@
   "scripts": {
     "build": "pnpm clean && pnpm rollup -c",
     "clean": "rimraf dist",
-    "lint": "tslint -p tsconfig.json",
+    "lint": "eslint -c .eslintrc.json 'src/**/*'",
     "test": "pnpm lint && pnpm test:unit",
     "test:unit": "jest --config jest.config.rollup.ts",
-    "prettier": "prettier --write 'src/**/*.ts'",
-    "generate-types": "tsx ./scripts/generate-types.ts && pnpm prettier"
+    "format": "prettier --write 'src/**/*.ts'",
+    "generate-types": "tsx ./scripts/generate-types.ts && pnpm format",
+    "copybara:dry-run": "./copybara.sh dry_run --init-history",
+    "copybara:pr": "./copybara.sh sync_out --init-history"
   },
   "keywords": [
     "AssemblyAI",
-    "Speech-to-text"
+    "Speech-to-text",
+    "Transcription",
+    "Audio",
+    "LLM"
   ],
   "author": "AssemblyAI (https://www.assemblyai.com)",
   "license": "MIT",
@@ -40,8 +45,9 @@
     "@types/jest": "^29.5.5",
     "@types/node": "^20.5.7",
     "@types/ws": "^8.5.5",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
     "dotenv": "^16.3.1",
-    "eslint": "^8.43.0",
+    "eslint": "^8.48.0",
     "i": "^0.3.7",
     "jest": "^29.5.0",
     "jest-cli": "^29.5.0",
@@ -58,7 +64,6 @@
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.3",
-    "tslint": "^6.1.3",
     "typescript": "^5.2.2"
   },
   "dependencies": {

package/src/index.ts

@@ -1,5 +1,7 @@
-import AssemblyAI from "./services";
-
+import * as services from "./services";
+import { AssemblyAI } from "./services";
 export * from "./services";
 export type * from "./types";
 export default AssemblyAI;
+class AssemblyAIExports extends AssemblyAI {}
+module.exports = Object.assign(AssemblyAIExports, services);

package/src/services/base.ts

@@ -3,12 +3,10 @@ import { AxiosInstance } from "axios";
 /**
  * Base class for services that communicate with the API.
  */
-abstract class BaseService {
+export abstract class BaseService {
   /**
    * Create a new service.
    * @param params The AxiosInstance to send HTTP requests to the API.
    */
   constructor(protected client: AxiosInstance) {}
 }
-
-export default BaseService;

package/src/services/files/index.ts

@@ -1,8 +1,8 @@
 import { readFile } from "fs/promises";
-import BaseService from "@/services/base";
+import { BaseService } from "@/services/base";
 import { UploadedFile } from "@/types";
 
-export default class FileService extends BaseService {
+export class FileService extends BaseService {
   /**
    * Upload a local file to AssemblyAI.
    * @param path The local file to upload.

package/src/services/index.ts

@@ -1,11 +1,11 @@
 import { createAxiosClient } from "@/utils/axios";
 import { BaseServiceParams } from "@/types";
-import LemurService from "./lemur";
+import { LemurService } from "./lemur";
 import { RealtimeService, RealtimeServiceFactory } from "./realtime";
-import TranscriptService from "./transcripts";
-import FileService from "./files";
+import { TranscriptService } from "./transcripts";
+import { FileService } from "./files";
 
-export default class AssemblyAI {
+class AssemblyAI {
   /**
    * The files service.
    */
@@ -41,6 +41,7 @@ export default class AssemblyAI {
 }
 
 export {
+  AssemblyAI,
   LemurService,
   RealtimeServiceFactory,
   RealtimeService,

package/src/services/lemur/index.ts

@@ -8,9 +8,9 @@ import {
   LemurActionItemsResponse,
   LemurTaskResponse,
 } from "@/types";
-import BaseService from "@/services/base";
+import { BaseService } from "@/services/base";
 
-export default class LemurService extends BaseService {
+export class LemurService extends BaseService {
   async summary(params: LemurSummaryParameters): Promise<LemurSummaryResponse> {
     const { data } = await this.client.post<LemurSummaryResponse>(
       "/lemur/v3/generate/summary",

package/src/services/realtime/service.ts

@@ -75,12 +75,13 @@ export class RealtimeService {
   ): void;
   on(event: "error", listener: (error: Error) => void): void;
   on(event: "close", listener: (code: number, reason: string) => void): void;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
   on(event: RealtimeEvents, listener: (...args: any[]) => void) {
     this.listeners[event] = listener;
   }
 
   connect() {
-    return new Promise<SessionBeginsEventData>((resolve, _) => {
+    return new Promise<SessionBeginsEventData>((resolve) => {
       if (this.socket) {
         throw new Error("Already connected");
       }
@@ -165,7 +166,7 @@ export class RealtimeService {
       if (this.socket.readyState === WebSocket.OPEN) {
         const terminateSessionMessage = `{"terminate_session": true}`;
         if (waitForSessionTermination) {
-          const sessionTerminatedPromise = new Promise<void>((resolve, _) => {
+          const sessionTerminatedPromise = new Promise<void>((resolve) => {
             this.sessionTerminatedResolve = resolve;
           });
           this.socket.send(terminateSessionMessage);

package/src/services/transcripts/index.ts

@@ -1,4 +1,4 @@
-import BaseService from "@/services/base";
+import { BaseService } from "@/services/base";
 import {
   ParagraphsResponse,
   SentencesResponse,
@@ -14,9 +14,9 @@ import {
   RedactedAudioResponse,
 } from "@/types";
 import { AxiosInstance } from "axios";
-import FileService from "../files";
+import { FileService } from "../files";
 
-export default class TranscriptService
+export class TranscriptService
   extends BaseService
   implements
     Createable<Transcript, CreateTranscriptParameters, CreateTranscriptOptions>,
@@ -58,6 +58,7 @@ export default class TranscriptService
     options?: CreateTranscriptOptions
   ): Promise<Transcript> {
     const startTime = Date.now();
+    // eslint-disable-next-line no-constant-condition
     while (true) {
       const transcript = await this.get(transcriptId);
       if (transcript.status === "completed" || transcript.status === "error") {

package/src/types/services/abstractions.ts

@@ -3,7 +3,7 @@
  * @template T The type of the resource.
  * @template Parameters The type of the parameters required to create the resource.
  */
-interface Createable<T, Parameters, Options = Record<string, any>> {
+interface Createable<T, Parameters, Options = Record<string, unknown>> {
   /**
    * Create a new resource.
    * @param params The parameters of the new resource.

package/src/utils/errors/index.ts

@@ -1,5 +1,5 @@
 export {
-  default as RealtimeError,
+  RealtimeError,
   RealtimeErrorType,
   RealtimeErrorMessages,
 } from "./realtime";

package/src/utils/errors/realtime.ts

@@ -41,5 +41,4 @@ const RealtimeErrorMessages: Record<RealtimeErrorType, string> = {
 
 class RealtimeError extends Error {}
 
-export { RealtimeErrorType, RealtimeErrorMessages };
-export default RealtimeError;
+export { RealtimeError, RealtimeErrorType, RealtimeErrorMessages };