whisperai-sdk 1.0.2 → 2.0.0

package/dist/types.d.ts

@@ -4,12 +4,29 @@ export interface ClientOptions {
         email: string;
         password: string;
     };
-    chunkSize?: number;
     whisperUrl?: string;
+    chunkSize?: number;
+    maxUploadAttempts?: number;
+    initialRetryDelayMs?: number;
+    maxRetryDelayMs?: number;
+    diagnostics?: boolean;
+    pollIntervalMs?: number;
+    transcriptionTimeoutMs?: number;
+}
+export interface OperationOptions {
+    signal?: AbortSignal;
+    onProgress?: (percentage: number) => void;
+    diagnosticId?: string;
+    diagnostics?: boolean;
+}
+export interface TranscribeOptions extends OperationOptions {
+    pollIntervalMs?: number;
+    timeoutMs?: number;
 }
 export interface RequestError {
     message: string;
-    path: string;
+    path?: string;
+    code?: string;
 }
 export interface UserInfo {
     id: number;
@@ -18,7 +35,7 @@ export interface UserInfo {
     firstName: string;
     lastName: string;
     profileImageUrl: string | null;
-    subscriptionTier: "free" | "premium";
+    subscriptionTier: string;
     stripeSubscriptionId: string | null;
     stripeCustomerId: string | null;
     trialStartDate: string | null;
@@ -27,12 +44,12 @@ export interface UserInfo {
     monthlyUsageMinutes: number;
     usageResetDate: string;
     deletedMinutesThisCycle: number;
-    subscriptionStatus: "past_due" | "active";
+    subscriptionStatus: string;
     subscriptionEndDate: string | null;
     cancellationOffered: boolean;
     unsubscribed: boolean;
     hearAboutUs: string | null;
-    industry: "Healthcare & Medical" | "Legal & Compliance" | "Education & Research" | "Media & Entertainment" | "Technology & Software" | "Consulting & Professional Services" | "Financial Services (Banking, Insurance, Accounting)" | "Government & Nonprofit" | "Sales & Marketing / Advertising" | "Real Estate & Construction" | "Manufacturing & Engineering" | "Human Resources & Recruiting" | "Customer Support / Call Centers" | "Student" | string;
+    industry: string;
     totalMinutes: number;
     recordingsCount: number;
     subscriptionPausedUntil: string | null;
@@ -40,7 +57,7 @@ export interface UserInfo {
     subscriptionOriginalTier: string | null;
     discountCodeApplied: string | null;
     retentionOfferShown: string | null;
-    billingFrequency: "monthly" | "weekly";
+    billingFrequency: string;
     hasSeenTutorial: boolean;
     lastLoginAt: string | null;
     createdAt: string;
@@ -48,34 +65,91 @@ export interface UserInfo {
 }
 export interface UsageInfo {
     monthlyUsageMinutes: number;
-    subscriptionTier: "free" | "premium";
+    subscriptionTier: string;
     limits: {
         monthlyMinutes: number;
         dailyMinutes: number;
         maxFileSize: number;
     };
+    maxFileSizeBytes: number;
 }
+export type TranscriptionStyle = "standard" | "clean_readable" | (string & {});
+export type SpeakerIdentificationMode = "role" | "name" | (string & {});
 export interface InitMetaFile {
     filename: string;
     durationSeconds: number;
     title?: string;
     mimeType?: string;
     totalSize?: number;
-    language?: number;
+    language?: string;
     enableSpeakerDetection?: boolean;
     speakerCount?: "auto" | number;
+    transcriptionStyle?: TranscriptionStyle;
+    importantTerms?: string;
+    customPrompt?: string;
+    speakerIdentificationEnabled?: boolean;
+    speakerIdentificationMode?: SpeakerIdentificationMode;
+    speakerIdentificationValues?: string[];
+    folderId?: number;
+}
+export interface SignedUploadResponse {
+    recordingId: number;
+    objectPath: string;
+    signedResumableInitUrl: string;
+    requiredHeaders: Record<string, string>;
+    ttlSec: number;
+}
+export interface RecordingStatusResponse {
+    recordingId: number;
+    recordingStatus: `${WhisperStatus}` | "canceled" | "retry_pending" | "retry_processing";
 }
-export interface InitChunkResponse {
-    sessionId: string;
+export interface TranscriptionResponse {
+    id: number;
     recordingId: number;
+    status: "queued" | "processing" | "completed" | "failed" | "canceled";
+    createdAt: string;
+    updatedAt: string;
+}
+export interface Translation {
+    id: number;
+    transcriptionId: number;
+    targetLanguage: string;
+    content: string;
+    status: string;
+    createdAt: string;
 }
-export interface UploadChunkResponse {
-    success: boolean;
-    chunkIndex: number;
-    uploadedChunks: number;
-    totalChunks: number;
+export interface Transcription {
+    id: number;
+    userId: number;
+    recordingId: number;
+    content: string;
+    editedContent: string | null;
+    confidence: number;
+    segments: Array<{
+        id: number;
+        start: number;
+        end: number;
+        text: string;
+    }>;
+    translations: Translation[];
+    timestamps: {
+        words: unknown[];
+        duration: number;
+        language: string;
+        segments: Array<{
+            id: number;
+            start: number;
+            end: number;
+            text: string;
+        }>;
+    };
+    speakers: unknown | null;
+    speakerNames: Record<string, unknown>;
+    createdAt: string;
+    updatedAt: string;
+    summary: unknown | null;
 }
-export interface FinalizeChunkResponse {
+export interface RecordingResponse {
     id: number;
     userId: number;
     title: string;
@@ -85,33 +159,40 @@ export interface FinalizeChunkResponse {
     audioUrl: string;
     duration: number;
     language: string;
-    status: WhisperStatus;
+    status: `${WhisperStatus}` | "canceled" | "retry_pending" | "retry_processing";
     speakerDetectionEnabled: boolean;
     speakerCount: number | null;
-    totalChunks: number;
+    totalChunks: number | null;
+    acceptedMaxFileSizeBytes?: number;
+    format?: string;
     metadata: Record<string, unknown> | null;
     idempotencyKey: string | null;
     uploadSessionId: string;
+    source?: string;
+    sourceUrl?: string | null;
+    transcriptionStyle?: string;
+    importantTerms?: string[];
+    customPrompt?: string;
+    speakerIdentificationEnabled?: boolean;
+    speakerIdentificationMode?: string;
+    speakerIdentificationValues?: string[];
+    organizationId?: number | null;
+    folderId?: number | null;
+    accessToken?: string;
+    accessTokenExpiry?: string;
     createdAt: string;
     updatedAt: string;
+    transcription: Transcription | null;
 }
-export interface TranscriptionResponse {
-    id: number;
-    recordingId: number;
-    status: "queued" | "processing" | "completed" | "failed" | "canceled";
-    createdAt: string;
-    updatedAt: string;
+export interface CompletedRecordingResponse extends RecordingResponse {
+    status: WhisperStatus.COMPLETED;
+    transcription: Transcription;
 }
+export type FinalizeUploadResponse = RecordingResponse;
 export interface TranslateResponse {
     success: true;
     message: string;
-    translation: {
-        id: number;
-        transcriptionId: number;
-        targetLanguage: string;
-        content: string;
-        status: string;
-    };
+    translation: Translation;
 }
 export interface SummaryResponse {
     usage: {
@@ -136,78 +217,27 @@ export interface SummaryResponse {
         upgradeReason: string;
     };
 }
-export interface RecordingResponse {
-    id: number;
-    userId: number;
-    title: string;
-    originalFilename: string;
-    fileExtension: string;
-    mimeType: string;
-    audioUrl: string;
-    duration: number;
-    language: string;
-    status: string;
-    speakerDetectionEnabled: boolean;
-    speakerCount: number | null;
-    totalChunks: number;
-    metadata: Record<string, unknown> | null;
-    idempotencyKey: string | null;
-    uploadSessionId: string;
-    accessToken: string;
-    accessTokenExpiry: string;
-    createdAt: string;
-    updatedAt: string;
-    transcription: {
-        id: number;
-        userId: number;
-        recordingId: number;
-        content: string;
-        editedContent: string | null;
-        confidence: number;
-        segments: Array<{
-            id: number;
-            start: number;
-            end: number;
-            text: string;
-        }>;
-        translations: Array<{
-            id: number;
-            transcriptionId: number;
-            targetLanguage: string;
-            content: string;
-            status: string;
-            createdAt: string;
-        }>;
-        timestamps: {
-            words: unknown[];
-            duration: number;
-            language: string;
-            segments: Array<{
-                id: number;
-                start: number;
-                end: number;
-                text: string;
-            }>;
-        };
-        speakers: unknown | null;
-        speakerNames: Record<string, unknown>;
-        createdAt: string;
-        updatedAt: string;
-        summary: unknown | null;
-    };
-}
 export interface RecordingsQuery {
     page?: number;
     limit?: number;
+    cursor?: string;
+    direction?: "next" | "prev";
+    search?: string;
+    status?: string;
+    sort?: "newest" | "oldest";
 }
 export interface RecordingsResponse {
     data: RecordingResponse[];
-    total: string;
-    page: number;
+    sharedItems?: RecordingResponse[];
+    total: number | string;
+    page?: number;
     limit: number;
-    pages: number;
+    pages?: number;
     hasNext: boolean;
     hasPrev: boolean;
+    nextCursor?: string | null;
+    prevCursor?: string | null;
+    startIndex?: number;
 }
 export interface SubscriptionDetailsResponse {
     isPaidPlan: boolean;
@@ -216,3 +246,17 @@ export interface SubscriptionDetailsResponse {
     billingAmount: number | null;
     subscriptionStatus: string;
 }
+export interface DiagnosticEvent {
+    diagId: string;
+    phase: string;
+    recordingId?: number;
+    chunkIndex?: number;
+    attempt?: number;
+    httpStatus?: number;
+    errorName?: string;
+    errorMessage?: string;
+    fileName?: string;
+    fileSize?: number;
+    fileType?: string;
+    timestamp: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "whisperai-sdk",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "TypeScript SDK for WhisperAI: methods and interfaces for interacting with the service without external runtime dependencies.",
   "keywords": [
     "whisper",
@@ -37,6 +37,7 @@
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "clean": "rm -rf dist",
     "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "bun test",
     "release": "semantic-release"
   },
   "dependencies": {},