speechrevolutions 0.2.0

package/dist/esm/client.d.ts

@@ -0,0 +1,94 @@
+import { type Transcript } from "./transcript.js";
+import { type JobStatus, type OutputType, type ProgressCallback, type STTClientOptions, type TranscribeOptions, type UploadJob } from "./types.js";
+export declare class STTClient {
+    readonly apiKey: string;
+    readonly baseUrl: string;
+    readonly timeout: number;
+    private readonly fetchFn;
+    private readonly maxRetries;
+    private readonly retryBackoffMs;
+    private readonly requestInit;
+    private readonly multipart;
+    constructor(opts?: STTClientOptions | string);
+    private retryDelayMs;
+    /**
+     * Transcribe a local file path, remote URL, bytes, or Blob. A URL is handed
+     * to the platform to fetch, so nothing is uploaded from here.
+     */
+    transcribe(audio: Uint8Array | ArrayBuffer | Blob | string, options?: TranscribeOptions, onProgress?: ProgressCallback): Promise<Transcript>;
+    /** Waits out the transcription phase and parses the result. */
+    private awaitTranscript;
+    /** Registers a job the platform fetches itself. No bytes leave this process. */
+    private submitUrl;
+    transcribeUrl(url: string, options?: TranscribeOptions, onProgress?: ProgressCallback): Promise<Transcript>;
+    transcribeFile(path: string, options?: TranscribeOptions, onProgress?: ProgressCallback): Promise<Transcript>;
+    /**
+     * Upload and enqueue a job, returning its `jobId` WITHOUT waiting for the
+     * result. Collect it later via a webhook (`callbackUrl`) or by polling
+     * `getJobStatus` / `getTranscript`. Ideal for batch workloads — submit many,
+     * then gather — since it holds no long-lived connection per job.
+     */
+    submit(audio: Uint8Array | ArrayBuffer | Blob | string, options?: TranscribeOptions): Promise<string>;
+    /** JSON body shared by the single-shot and multipart create endpoints. */
+    private uploadBody;
+    /**
+     * Get audio into the platform and return `{ jobId, downloadUrl }`. Prefers a
+     * multipart upload (when enabled) and falls back to a single presigned PUT if
+     * the server has multipart disabled or a multipart upload fails mid-flight.
+     */
+    private ingestUpload;
+    /**
+     * S3 multipart flow: create -> PUT each part -> complete. Throws
+     * {@link MultipartUnavailable} if the server has multipart disabled (404) or a
+     * mid-flight failure means we should retry via the single-shot path.
+     */
+    private uploadMultipart;
+    /** PUT one part to its presigned URL and return the S3 ETag. */
+    private putPart;
+    createUploadJob(fileSize: number, options?: TranscribeOptions): Promise<UploadJob>;
+    touchUploadProgress(jobId: string): Promise<void>;
+    uploadAudio(uploadUrl: string, data: Uint8Array, opts?: {
+        jobId?: string;
+        contentType?: string;
+        onProgress?: ProgressCallback;
+    }): Promise<void>;
+    completeUpload(jobId: string): Promise<void>;
+    waitForResult(jobId: string, downloadUrl: string, onProgress?: ProgressCallback, timeout?: number): Promise<{
+        content: Uint8Array;
+        downloadUrl: string;
+    }>;
+    downloadResult(downloadUrl: string): Promise<Uint8Array>;
+    cancelJob(jobId: string): Promise<void>;
+    checkFailed(jobIds: string[]): Promise<boolean[]>;
+    /** Fetch a job's current status (and a fresh download URL once complete). */
+    getJobStatus(jobId: string): Promise<JobStatus>;
+    /**
+     * Fetch and parse a completed job's transcript by id. Throws
+     * {@link JobFailedError} if it failed, or {@link APIError} if still processing.
+     */
+    getTranscript(jobId: string, opts?: {
+        outputType?: OutputType;
+    }): Promise<Transcript>;
+    /** List the caller's most-recent jobs (newest first), cursor-paginated. */
+    listJobs(opts?: {
+        limit?: number;
+        before?: string;
+    }): Promise<{
+        jobs: {
+            jobId: string;
+            createdAt: string;
+        }[];
+        nextBefore: string | null;
+    }>;
+    private headers;
+    private apiRequest;
+    private raiseForStatus;
+    private putUpload;
+    private waitSSE;
+    private sseAttempt;
+    private waitPoll;
+}
+/** @deprecated Use STTClient — alias for Deepgram / ElevenLabs naming. */
+export declare class SpeechRevolutions extends STTClient {
+}
+export { SpeechRevolutions as SpeechRevolutionsClient };