med-scribe-alliance-ts-sdk 2.0.39 → 2.0.41

package/README.md

@@ -363,6 +363,7 @@ interface RecordingOptions {
   deviceId?: string;                     // Specific microphone device ID
   sessionMode?: string;                  // 'consultation' | 'dictation'
   patientDetails?: PatientDetails;       // Patient info
+  version?: string;                      // Optional API version (sent as a `version` query param on create-session)
   txnId?: string;                        // External transaction ID
 }
 ```
@@ -381,7 +382,7 @@ interface RecordingOptions {
 | Method | Returns | Description |
 |---|---|---|
 | `startRecording(options)` | `SDKResult<CreateSessionResponse>` | Create session + start mic + begin upload. |
-| `startRecordingWithSession(session, options?)` | `SDKResult<void>` | Attach recorder to an existing session. |
+| `startRecordingWithSession(session, options?)` | `SDKResult<void>` | Attach recorder to an existing session. `options.version` (the version the session was created with) is reused when refreshing `upload_url` on upload failure. |
 | `pauseRecording()` | `void` | Pause VAD (mic stays open, no chunks created). |
 | `resumeRecording()` | `void` | Resume VAD processing. |
 | `endRecording()` | `SDKResult<StopRecordingResult>` | Stop mic, flush audio, wait for uploads, end session. |

package/dist/index.d.ts

@@ -493,6 +493,8 @@ export interface RecordingOptions {
 	sessionMode?: string;
 	patientDetails?: PatientDetails;
 	sessionId?: string;
+	/** Optional API version; sent as a `version` query param on the create-session request. */
+	version?: string;
 }
 export interface RecorderConfig {
 	accessToken?: string;
@@ -501,6 +503,7 @@ export interface RecorderConfig {
 	storageProvider: string;
 	uploadHeaders: Record<string, string>;
 	sessionId: string;
+	refreshUploadUrl?: () => Promise<SessionUploadInfo | null>;
 }
 export interface IRecorder {
 	initialize(session: CreateSessionResponse, config: RecorderConfig): void;
@@ -697,10 +700,16 @@ export interface WorkerUpdateTokenMessage {
 	type: "update_auth_token";
 	token: string;
 }
+/** Fresh upload payload sent in response to an upload_url_required request. */
+export interface WorkerUpdateUploadUrlMessage {
+	type: "update_upload_url";
+	/** Provider-specific upload payload from a fresh getSessionStatus call. Null = no refresh available. */
+	upload: unknown | null;
+}
 export interface WorkerTerminateMessage {
 	type: "terminate";
 }
-export type MainToWorkerMessage = WorkerCompressAndUploadMessage | WorkerWaitForUploadsMessage | WorkerUpdateTokenMessage | WorkerTerminateMessage;
+export type MainToWorkerMessage = WorkerCompressAndUploadMessage | WorkerWaitForUploadsMessage | WorkerUpdateTokenMessage | WorkerUpdateUploadUrlMessage | WorkerTerminateMessage;
 export interface WorkerChunkEncodedMessage {
 	type: "chunk_encoded";
 	fileName: string;
@@ -722,7 +731,12 @@ export interface WorkerAllUploadsCompleteMessage {
 export interface WorkerTokenRequiredMessage {
 	type: "token_required";
 }
-export type WorkerToMainMessage = WorkerChunkEncodedMessage | WorkerUploadSuccessMessage | WorkerUploadFailedMessage | WorkerAllUploadsCompleteMessage | WorkerTokenRequiredMessage;
+/** Worker hit an upload error and wants a fresh upload_url before retrying. */
+export interface WorkerUploadUrlRequiredMessage {
+	type: "upload_url_required";
+	fileName: string;
+}
+export type WorkerToMainMessage = WorkerChunkEncodedMessage | WorkerUploadSuccessMessage | WorkerUploadFailedMessage | WorkerAllUploadsCompleteMessage | WorkerTokenRequiredMessage | WorkerUploadUrlRequiredMessage;
 export declare class ScribeClient {
 	private config;
 	private transport;
@@ -754,6 +768,7 @@ export declare class ScribeClient {
 	startRecordingWithSession(session: CreateSessionResponse, options?: {
 		uploadType?: string;
 		deviceId?: string;
+		version?: string;
 	}): Promise<SDKResult<void>>;
 	/**
 	 * Pause the active recording.
@@ -1127,6 +1142,7 @@ export declare class RecordingManager {
 	private recorder;
 	private activeSession;
 	private activeBaseUrl;
+	private activeUploadUrlRefresher;
 	private _isRecording;
 	private _isStarting;
 	private _startGeneration;
@@ -1164,6 +1180,7 @@ export declare class RecordingManager {
 	startWithExistingSession(baseUrl: string, session: CreateSessionResponse, options?: {
 		uploadType?: string;
 		deviceId?: string;
+		version?: string;
 	}, accessToken?: string): Promise<ApiCallResult<void>>;
 	/**
 	 * Pause the active recording.
@@ -1236,6 +1253,8 @@ export declare class RecordingManager {
 	 * Build upload headers from the current auth state.
 	 */
 	private buildUploadHeaders;
+	private buildUploadUrlRefresher;
+	private fetchFreshUploadUrl;
 	/**
 	 * Apply discovery-driven overrides to ChunkedRecorder's VAD config.
 	 * For example, max_chunk_duration_seconds from discovery overrides the default.

package/dist/index.mjs

@@ -277,7 +277,8 @@ var r = "/.well-known/medscribealliance", i = 3600 * 1e3, a = /* @__PURE__ */ fu
 		gender: e.string().optional(),
 		mobile: e.number().optional()
 	}).optional(),
-	sessionId: e.string().optional()
+	sessionId: e.string().optional(),
+	version: e.string().optional()
 }), N = class {
 	validateDiscoveryResponse(e) {
 		this.parseWithValidationError(ae, e, "Invalid discovery response");
@@ -381,7 +382,7 @@ var I = class {
 	}
 	async request(e) {
 		try {
-			return await P(() => this.executeRequest(e), this.getRetryOptions(e));
+			return e.isUpload ? await P(() => this.executeRequest(e), this.getRetryOptions(e)) : await this.executeRequest(e);
 		} catch (t) {
 			throw t instanceof v ? t : new T(`Network error: ${t instanceof Error ? t.message : "Unknown error"}`, {
 				url: e.url,
@@ -505,7 +506,7 @@ var I = class {
 	}
 	async request(e) {
 		try {
-			return await P(() => this.executeRequest(e), this.getRetryOptions(e));
+			return e.isUpload ? await P(() => this.executeRequest(e), this.getRetryOptions(e)) : await this.executeRequest(e);
 		} catch (t) {
 			throw t instanceof v ? t : new T(`IPC error: ${t instanceof Error ? t.message : "Unknown error"}`, {
 				url: e.url,
@@ -1286,7 +1287,7 @@ async function Y(e, t) {
 //#region src/worker/worker-manager.ts
 var Se = class {
 	constructor(e, t, n, r) {
-		if (this.worker = null, this.port = null, this.useWorker = !1, this.uploadPayload = {}, this.storageProviderName = "", this.uploadHeaders = {}, this.pendingUploads = /* @__PURE__ */ new Set(), this.allUploadsResolver = null, this.callbackRegistry = e, this.fileManager = t, this.transport = n, !r?.forceMainThread && typeof SharedWorker < "u" && r?.workerScriptUrl) try {
+		if (this.worker = null, this.port = null, this.useWorker = !1, this.uploadPayload = {}, this.storageProviderName = "", this.uploadHeaders = {}, this.refreshUploadUrl = null, this.inFlightRefresh = null, this.pendingUploads = /* @__PURE__ */ new Set(), this.allUploadsResolver = null, this.callbackRegistry = e, this.fileManager = t, this.transport = n, !r?.forceMainThread && typeof SharedWorker < "u" && r?.workerScriptUrl) try {
 			this.worker = new SharedWorker(r.workerScriptUrl, { name: "scribe-sdk-worker" }), this.port = this.worker.port, this.port.onmessage = (e) => {
 				this.handleWorkerMessage(e.data);
 			}, this.port.start(), this.useWorker = !0;
@@ -1294,8 +1295,8 @@ var Se = class {
 			console.warn("[ScribeSDK] SharedWorker failed to initialize, falling back to main thread:", e), this.worker = null, this.port = null, this.useWorker = !1;
 		}
 	}
-	setUploadConfig(e, t, n) {
-		this.uploadPayload = e, this.storageProviderName = t, this.uploadHeaders = n, J(t);
+	setUploadConfig(e, t, n, r) {
+		this.uploadPayload = e, this.storageProviderName = t, this.uploadHeaders = n, this.refreshUploadUrl = r ?? null, J(t);
 	}
 	compressAndUpload(e, t, n) {
 		let r = e.length / H;
@@ -1405,6 +1406,28 @@ var Se = class {
 					this.updateAuthToken(e);
 				} });
 				break;
+			case "upload_url_required":
+				this.handleUploadUrlRequired();
+				break;
+		}
+	}
+	async handleUploadUrlRequired() {
+		let e = await this.refreshUploadPayload();
+		this.postToWorker({
+			type: "update_upload_url",
+			upload: e
+		});
+	}
+	async refreshUploadPayload() {
+		if (!this.refreshUploadUrl) return null;
+		try {
+			this.inFlightRefresh ||= this.refreshUploadUrl();
+			let e = await this.inFlightRefresh;
+			return e && (this.uploadPayload = e), e;
+		} catch (e) {
+			return console.error("[ScribeSDK] Failed to refresh upload_url:", e), null;
+		} finally {
+			this.inFlightRefresh = null;
 		}
 	}
 	compressAndUploadOnMainThread(e, t, n) {
@@ -1434,12 +1457,25 @@ var Se = class {
 					fileName: t,
 					chunkData: i.chunks
 				}
-			}), await Y(this.transport, {
-				fileName: t,
-				blob: r,
-				upload: this.uploadPayload,
-				storageProvider: this.storageProviderName
-			}), this.fileManager.markSuccess(n), this.dispatchUploadProgress();
+			});
+			try {
+				await Y(this.transport, {
+					fileName: t,
+					blob: r,
+					upload: this.uploadPayload,
+					storageProvider: this.storageProviderName
+				});
+			} catch (e) {
+				let n = await this.refreshUploadPayload();
+				if (!n) throw e;
+				await Y(this.transport, {
+					fileName: t,
+					blob: r,
+					upload: n,
+					storageProvider: this.storageProviderName
+				});
+			}
+			this.fileManager.markSuccess(n), this.dispatchUploadProgress();
 		} catch (e) {
 			this.fileManager.markFailure(n, r ?? new Blob(), e?.message ?? "Upload failed"), this.callbackRegistry.dispatch("onUploadEvent", {
 				type: f.FAILED,
@@ -1483,7 +1519,7 @@ var Se = class {
 	initialize(e, t) {
 		if (!t.upload || typeof t.upload != "object") throw Error("Upload payload is required for chunked recording");
 		if (!t.storageProvider) throw Error("Storage provider is required for chunked recording");
-		this.workerManager.setUploadConfig(t.upload, t.storageProvider, t.uploadHeaders), this.initialized = !0;
+		this.workerManager.setUploadConfig(t.upload, t.storageProvider, t.uploadHeaders, t.refreshUploadUrl), this.initialized = !0;
 	}
 	async start(e) {
 		if (await this.vadClient.init(e), this.vadClient.isVadLoading() && (await this.vadClient.init(e), this.vadClient.isVadLoading())) throw Error("VAD instance failed to initialize after retry");
@@ -1705,7 +1741,7 @@ var Se = class {
 	}
 }, Q = class {
 	constructor(e, t, n, r, i) {
-		this.recorder = null, this.activeSession = null, this.activeBaseUrl = "", this._isRecording = !1, this._isStarting = !1, this._startGeneration = 0, this.retryContext = null, this.callbackRegistry = e, this.sessionManager = t, this.discoveryManager = n, this.transport = r, this.config = i ?? {};
+		this.recorder = null, this.activeSession = null, this.activeBaseUrl = "", this.activeUploadUrlRefresher = null, this._isRecording = !1, this._isStarting = !1, this._startGeneration = 0, this.retryContext = null, this.callbackRegistry = e, this.sessionManager = t, this.discoveryManager = n, this.transport = r, this.config = i ?? {};
 	}
 	async start(e, t, n) {
 		if (this._isRecording || this._isStarting) throw new v("Recording is already in progress. Stop the current recording first.");
@@ -1727,8 +1763,8 @@ var Se = class {
 		try {
 			let a, s;
 			try {
-				let t = await this.sessionManager.createSession(e, o);
-				a = t.data, s = t.httpStatus;
+				let n = await this.sessionManager.createSession(e, o, t.version);
+				a = n.data, s = n.httpStatus;
 			} catch (e) {
 				throw r === this._startGeneration && this.dispatchStartError(m.TRANSPORT_ERROR, g.SESSION_CREATION_FAILED, e), e;
 			}
@@ -1746,13 +1782,14 @@ var Se = class {
 				data: a
 			});
 			let l = this.createRecorder(i);
-			this.recorder = l;
+			this.recorder = l, this.activeUploadUrlRefresher = this.buildUploadUrlRefresher(e, a.session_id, t.version);
 			let d = {
 				accessToken: n,
 				upload: a.upload_url,
 				storageProvider: c,
 				uploadHeaders: this.buildUploadHeaders(n),
-				sessionId: a.session_id
+				sessionId: a.session_id,
+				refreshUploadUrl: this.activeUploadUrlRefresher
 			};
 			try {
 				l.initialize(a, d);
@@ -1796,41 +1833,42 @@ var Se = class {
 		let a = n?.uploadType ?? "chunked";
 		this.activeSession = t;
 		try {
-			let e;
+			let o;
 			try {
-				e = this.resolveStorageProviderName();
+				o = this.resolveStorageProviderName();
 			} catch (e) {
 				throw i === this._startGeneration && (this.cleanupRecordingState(), this.dispatchStartError(m.VALIDATION_ERROR, g.UNSUPPORTED_STORAGE_PROVIDER, e)), e;
 			}
-			let o = this.createRecorder(a);
-			this.recorder = o;
-			let s = {
+			let s = this.createRecorder(a);
+			this.recorder = s, this.activeUploadUrlRefresher = this.buildUploadUrlRefresher(e, t.session_id, n?.version);
+			let c = {
 				accessToken: r,
 				upload: t.upload_url,
-				storageProvider: e,
+				storageProvider: o,
 				uploadHeaders: this.buildUploadHeaders(r),
-				sessionId: t.session_id
+				sessionId: t.session_id,
+				refreshUploadUrl: this.activeUploadUrlRefresher
 			};
 			try {
-				o.initialize(t, s);
+				s.initialize(t, c);
 			} catch (e) {
 				try {
-					o.reset();
+					s.reset();
 				} catch {}
 				throw i === this._startGeneration && (this.cleanupRecordingState(), this.dispatchStartError(m.VALIDATION_ERROR, g.RECORDER_INIT_FAILED, e)), e;
 			}
-			o instanceof X && this.applyDiscoveryOverrides(o);
+			s instanceof X && this.applyDiscoveryOverrides(s);
 			try {
-				await o.start(n?.deviceId);
+				await s.start(n?.deviceId);
 			} catch (e) {
 				try {
-					o.reset();
+					s.reset();
 				} catch {}
 				throw i === this._startGeneration && (this.cleanupRecordingState(), this.dispatchStartError(m.VAD_ERROR, g.VAD_START_FAILED, e)), e;
 			}
 			if (i !== this._startGeneration) {
 				try {
-					o.reset();
+					s.reset();
 				} catch {}
 				throw new v("Recording start was superseded by a concurrent operation.");
 			}
@@ -1985,7 +2023,7 @@ var Se = class {
 		return (this.retryContext?.failedChunks.length ?? 0) > 0;
 	}
 	finalizeAfterExternalEndSession(e) {
-		this.activeSession && this.activeSession.session_id === e && (this.activeSession = null, this.activeBaseUrl = "", this.retryContext = null);
+		this.activeSession && this.activeSession.session_id === e && (this.activeSession = null, this.activeBaseUrl = "", this.activeUploadUrlRefresher = null, this.retryContext = null);
 	}
 	async retryFailedUploads() {
 		if (this._isRecording) throw new v("Cannot retry uploads while recording is active.");
@@ -1999,11 +2037,8 @@ var Se = class {
 		};
 		let { storageProvider: e, failedChunks: t } = this.retryContext, n = t.length, r = [], i = 0, a = this.retryContext.upload;
 		try {
-			let e = this.activeSession?.session_id;
-			if (e) {
-				let t = await this.sessionManager.getSessionStatus(this.activeBaseUrl, e);
-				t.data.upload_url && (a = t.data.upload_url, this.retryContext.upload = a);
-			}
+			let e = await this.activeUploadUrlRefresher?.();
+			e && (a = e, this.retryContext.upload = e);
 		} catch (e) {
 			this.config.debug && console.log("[ScribeSDK] Failed to refresh upload_url, using existing:", e);
 		}
@@ -2060,6 +2095,12 @@ var Se = class {
 		let t = {};
 		return e && (t.Authorization = `Bearer ${e}`), this.config.flavour && (t.flavour = this.config.flavour), t;
 	}
+	buildUploadUrlRefresher(e, t, n) {
+		return () => this.fetchFreshUploadUrl(e, t, n);
+	}
+	async fetchFreshUploadUrl(e, t, n) {
+		return (await this.sessionManager.getSessionStatus(e, t, void 0, n)).data.upload_url ?? null;
+	}
 	applyDiscoveryOverrides(e) {
 		try {
 			let t = this.discoveryManager.getResolvedConfig();
@@ -2096,7 +2137,7 @@ var Se = class {
 		}, this.config.debug && console.log(`[ScribeSDK] Preserved ${e.length} failed uploads for retry`);
 	}
 	cleanupRecordingState() {
-		this.recorder = null, this.activeSession = null, this.activeBaseUrl = "", this._isRecording = !1, this._isStarting = !1;
+		this.recorder = null, this.activeSession = null, this.activeBaseUrl = "", this.activeUploadUrlRefresher = null, this._isRecording = !1, this._isStarting = !1;
 	}
 	partialCleanupAfterFailedFinalize() {
 		this.recorder = null, this._isRecording = !1, this._isStarting = !1;