med-scribe-alliance-ts-sdk 2.0.32 → 2.0.33

package/dist/index.d.ts

@@ -98,7 +98,8 @@ export declare enum ErrorCode {
 	VAD_START_FAILED = "vad_start_failed",
 	STOP_FAILED = "stop_failed",
 	INTERNAL_RETRY_FAILED = "internal_retry_failed",
-	SESSION_END_FAILED = "session_end_failed"
+	SESSION_END_FAILED = "session_end_failed",
+	UNSUPPORTED_STORAGE_PROVIDER = "unsupported_storage_provider"
 }
 export declare enum HttpStatus {
 	OK = 200,
@@ -155,6 +156,11 @@ export declare class UploadError extends ScribeError {
 	constructor(message: string, failedFiles: string[], details?: Record<string, any>);
 	toJSON(): Record<string, any>;
 }
+/** Thrown when discovery advertises a storage provider the SDK has no wrapper for. */
+export declare class UnsupportedStorageProviderError extends ScribeError {
+	readonly provider: string;
+	constructor(provider: string);
+}
 export interface ApiError {
 	code: ErrorCode | string;
 	message: string;
@@ -201,6 +207,13 @@ export interface TransportRequest {
 	body?: any;
 	isUpload?: boolean;
 	uploadBlob?: Blob;
+	uploadFileName?: string;
+	/** Multipart form fields; when set, the request is multipart/form-data with uploadBlob as the file. */
+	uploadFormFields?: Record<string, string>;
+	/** Multipart field name for the file part. Defaults to 'file'. */
+	uploadFileFieldName?: string;
+	/** Attach the service Bearer + flavour header. Defaults to true; false for presigned uploads. */
+	attachAuth?: boolean;
 	/** Additional HTTP status codes to treat as success (not throw). */
 	acceptStatuses?: number[];
 	maxRetries?: number;
@@ -229,8 +242,14 @@ export interface IpcRequest {
 	url: string;
 	headers?: Record<string, string>;
 	body?: any;
-	/** Base64-encoded blob data for uploads */
+	/** Base64-encoded file bytes for uploads. */
 	blobData?: string;
+	/** Multipart fields for presigned uploads — host builds multipart from these + blobData (no auth header). */
+	uploadFormFields?: Record<string, string>;
+	/** Multipart field name for the file part. Defaults to 'file'. */
+	uploadFileFieldName?: string;
+	/** File name for the multipart file part. */
+	uploadFileName?: string;
 }
 export interface IpcResponse {
 	correlationId: string;
@@ -304,6 +323,7 @@ export interface CapabilitiesInfo {
 	upload_methods?: string[];
 	webhook_delivery?: boolean;
 	client_sdk_delivery?: boolean;
+	storage_provider?: string;
 }
 export interface ModelConfig {
 	id: string;
@@ -332,6 +352,7 @@ export interface ResolvedConfig {
 	autoDetectLanguage: boolean;
 	supportedAudioFormats: string[];
 	supportedUploadMethods: string[];
+	storageProvider: string;
 	maxChunkDurationSeconds: number;
 	/** modelId -> max session duration in seconds */
 	maxSessionDurationSeconds: Map<string, number>;
@@ -360,12 +381,14 @@ export interface CreateSessionRequest {
 	patient_details?: PatientDetails;
 	session_id?: string;
 }
+/** Provider-specific upload payload; validated/interpreted by the StorageProvider, not the session schema. */
+export type SessionUploadInfo = Record<string, unknown>;
 export interface CreateSessionResponse {
 	session_id: string;
 	status: SessionStatus;
 	created_at: string;
 	expires_at: string;
-	upload_url: string;
+	upload_url: SessionUploadInfo;
 	patient_details?: PatientDetails;
 }
 export interface EndSessionRequest {
@@ -472,7 +495,9 @@ export interface RecordingOptions {
 }
 export interface RecorderConfig {
 	accessToken?: string;
-	uploadUrl: string;
+	/** Provider-specific upload payload from the create-session response. */
+	upload: SessionUploadInfo;
+	storageProvider: string;
 	uploadHeaders: Record<string, string>;
 	sessionId: string;
 }
@@ -648,7 +673,9 @@ export interface WorkerCompressAndUploadMessage {
 	type: "compress_and_upload";
 	audioFrames: Float32Array;
 	fileName: string;
-	uploadUrl: string;
+	storageProvider: string;
+	/** Provider-specific upload payload from the create-session response. */
+	upload: unknown;
 	headers: Record<string, string>;
 }
 export interface WorkerWaitForUploadsMessage {
@@ -877,6 +904,41 @@ export declare class ScribeClient {
 	private getEffectiveBaseUrl;
 	private validateConfig;
 }
+/**
+ * Storage provider abstraction — the only part of the upload flow that varies
+ * between backends (AWS S3, GCP, ...). A provider is a pure, DOM-free request
+ * builder so it runs on the main thread, in the SharedWorker, and over IPC.
+ *
+ * To add a provider: implement StorageProvider in `<name>-provider.ts` and
+ * register it in `storage-provider-factory.ts`. No other changes needed.
+ */
+export interface UploadContext {
+	fileName: string;
+	blob: Blob;
+	upload: unknown;
+}
+export interface PreparedUpload {
+	url: string;
+	method: "POST" | "PUT";
+	bodyMode: "multipart" | "binary";
+	formFields?: Record<string, string>;
+	fileFieldName?: string;
+	headers: Record<string, string>;
+	attachAuth: boolean;
+}
+export interface StorageProvider {
+	/** Matches discovery's `capabilities.storage_provider`. */
+	readonly name: string;
+	/** @throws UploadError if the upload payload is malformed. */
+	prepareUpload(ctx: UploadContext): PreparedUpload;
+}
+export declare class AwsS3StorageProvider implements StorageProvider {
+	readonly name = "aws";
+	prepareUpload({ fileName, blob, upload }: UploadContext): PreparedUpload;
+}
+export declare function isStorageProviderSupported(name: string): boolean;
+/** @throws UnsupportedStorageProviderError if no wrapper is registered. */
+export declare function getStorageProvider(name: string): StorageProvider;
 export declare class CallbackRegistry {
 	private handlers;
 	/**
@@ -1132,7 +1194,7 @@ export declare class RecordingManager {
 	finalizeAfterExternalEndSession(sessionId: string): void;
 	/**
 	 * Retry uploading audio files that failed during the last recording.
-	 * Uses the stored MP3 blobs and the original upload URL.
+	 * Uses the stored MP3 blobs and the same storage provider as the recording.
 	 *
 	 * Each file is re-uploaded via transport.request() with retry logic.
 	 * Successfully retried files are removed from the retry context.
@@ -1142,6 +1204,10 @@ export declare class RecordingManager {
 	 * Create the appropriate recorder based on upload type.
 	 */
 	private createRecorder;
+	/** Storage provider name from discovery; defaults to 'aws'. */
+	private getStorageProviderName;
+	/** Validate the provider has a wrapper (throws UnsupportedStorageProviderError) and return its name. */
+	private resolveStorageProviderName;
 	/**
 	 * Build upload headers from the current auth state.
 	 */