med-scribe-alliance-ts-sdk 2.0.38 → 2.0.40

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
 }
 ```
@@ -395,8 +396,8 @@ interface RecordingOptions {
 
 | Method | Returns | Description |
 |---|---|---|
-| `createSession(request)` | `SDKResult<CreateSessionResponse>` | Create a session without starting a recording. |
-| `getSessionStatus(sessionId?, options?)` | `SDKResult<GetSessionStatusResponse>` | Get status. Supports `poll` and `templateId` options. |
+| `createSession(request, version?)` | `SDKResult<CreateSessionResponse>` | Create a session without starting a recording. Optional `version` is sent as a `version` query param. |
+| `getSessionStatus(sessionId?, options?)` | `SDKResult<GetSessionStatusResponse>` | Get status. Supports `poll`, `templateId`, and `version` options (`version` sent as a query param). |
 | `getCurrentSession()` | `CreateSessionResponse \| null` | Get the active session if any. |
 | `updateSession(request, sessionId?)` | `SDKResult<PatchSessionResponse>` | Patch session (patient details, status, etc.). |
 | `processTemplate(templateId, sessionId?)` | `SDKResult<ProcessTemplateResponse>` | Trigger processing for a specific template. |

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;
@@ -771,7 +773,7 @@ export declare class ScribeClient {
 	 * the SDK runs one internal retry pass; if files still fail, the session
 	 * is NOT ended and the result reports `sessionEnded: false`.
 	 */
-	endRecording(): Promise<SDKResult<EndRecordingResult>>;
+	endRecording(version?: string): Promise<SDKResult<EndRecordingResult>>;
 	/**
 	 * Retry uploading audio files that failed during the last recording.
 	 *
@@ -779,7 +781,7 @@ export declare class ScribeClient {
 	 * `hasFailedUploads()` is true). After retrying, call `endSession()` to
 	 * finalize. Retry context is cleared on `reset()` or the next `startRecording()`.
 	 */
-	retryFailedUploads(): Promise<SDKResult<RetryUploadResult>>;
+	retryFailedUploads(version?: string): Promise<SDKResult<RetryUploadResult>>;
 	/**
 	 * Check if there are failed uploads from the last recording that can be retried.
 	 */
@@ -807,7 +809,7 @@ export declare class ScribeClient {
 	/**
 	 * Create a session directly (without starting a recording).
 	 */
-	createSession(sessionRequest: CreateSessionRequest): Promise<SDKResult<CreateSessionResponse>>;
+	createSession(sessionRequest: CreateSessionRequest, version?: string): Promise<SDKResult<CreateSessionResponse>>;
 	/**
 	 * End a session directly.
 	 */
@@ -820,10 +822,12 @@ export declare class ScribeClient {
 	 * terminal state (completed, partial, failed, expired) or times out.
 	 *
 	 * Pass `templateId` to filter status for a specific template.
+	 * Pass `version` to target a specific API version (attached as a query param).
 	 */
 	getSessionStatus(sessionId?: string, options?: {
 		poll?: PollOptions;
 		templateId?: string;
+		version?: string;
 	}): Promise<SDKResult<GetSessionStatusResponse>>;
 	/**
 	 * Get the current active session, if any.
@@ -1058,7 +1062,7 @@ export declare class SessionManager {
 	 * Create a new scribe session.
 	 * Validates the request structure, sends to server, validates response.
 	 */
-	createSession(baseUrl: string, request: CreateSessionRequest): Promise<ApiCallResult<CreateSessionResponse>>;
+	createSession(baseUrl: string, request: CreateSessionRequest, version?: string): Promise<ApiCallResult<CreateSessionResponse>>;
 	/**
 	 * End an active session.
 	 * If no sessionId is provided, ends the current session.
@@ -1069,7 +1073,7 @@ export declare class SessionManager {
 	 * If no sessionId is provided, queries the current session.
 	 * Pass templateId to filter status for a specific template.
 	 */
-	getSessionStatus(baseUrl: string, sessionId?: string, templateId?: string): Promise<ApiCallResult<GetSessionStatusResponse>>;
+	getSessionStatus(baseUrl: string, sessionId?: string, templateId?: string, version?: string): Promise<ApiCallResult<GetSessionStatusResponse>>;
 	/**
 	 * Patch an existing session (e.g., update user_status or processing_status).
 	 */
@@ -1084,7 +1088,7 @@ export declare class SessionManager {
 	 * (completed, partial, or failed) or the max attempts are exhausted.
 	 * Pass templateId to filter the returned status for a specific template.
 	 */
-	pollForCompletion(baseUrl: string, sessionId?: string, options?: PollOptions, templateId?: string): Promise<ApiCallResult<GetSessionStatusResponse>>;
+	pollForCompletion(baseUrl: string, sessionId?: string, options?: PollOptions, templateId?: string, version?: string): Promise<ApiCallResult<GetSessionStatusResponse>>;
 	/**
 	 * Get the current active session, if any.
 	 */
@@ -1171,7 +1175,7 @@ export declare class RecordingManager {
 	 * Resume a paused recording.
 	 */
 	resume(): void;
-	stop(): Promise<ApiCallResult<EndRecordingResult>>;
+	stop(version?: string): Promise<ApiCallResult<EndRecordingResult>>;
 	/**
 	 * End the session, dispatch onSessionEvent, and return the response.
 	 * Called from stop() (auto-finalize) and finalizeAfterExternalEndSession()
@@ -1221,7 +1225,7 @@ export declare class RecordingManager {
 	 * Each file is re-uploaded via transport.request() with retry logic.
 	 * Successfully retried files are removed from the retry context.
 	 */
-	retryFailedUploads(): Promise<ApiCallResult<RetryUploadResult>>;
+	retryFailedUploads(version?: string): Promise<ApiCallResult<RetryUploadResult>>;
 	/**
 	 * Create the appropriate recorder based on upload type.
 	 */

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");
@@ -748,19 +749,19 @@ var z = class {
 	constructor(e, t, n = !1) {
 		this.currentSession = null, this.transport = e, this.validator = t, this.debug = n;
 	}
-	async createSession(e, t) {
+	async createSession(e, t, n) {
 		try {
 			this.validator.validateCreateSessionRequest(t);
-			let n = `${e}/sessions`;
-			this.debug && console.log("[ScribeSDK] Creating session:", n);
-			let r = await this.transport.request({
+			let r = `${e}/sessions`;
+			n && (r += `?version=${encodeURIComponent(n)}`), this.debug && console.log("[ScribeSDK] Creating session:", r);
+			let i = await this.transport.request({
 				method: "POST",
-				url: n,
+				url: r,
 				body: t
 			});
-			return this.validator.validateCreateSessionResponse(r.data), this.currentSession = r.data, this.debug && console.log("[ScribeSDK] Session created:", r.data.session_id), {
-				data: r.data,
-				httpStatus: r.status
+			return this.validator.validateCreateSessionResponse(i.data), this.currentSession = i.data, this.debug && console.log("[ScribeSDK] Session created:", i.data.session_id), {
+				data: i.data,
+				httpStatus: i.status
 			};
 		} catch (e) {
 			throw e instanceof v ? e : new v(`Failed to create session: ${e instanceof Error ? e.message : "Unknown error"}`);
@@ -786,21 +787,23 @@ var z = class {
 			throw e instanceof v ? e : new v(`Failed to end session: ${e instanceof Error ? e.message : "Unknown error"}`);
 		}
 	}
-	async getSessionStatus(e, t, n) {
+	async getSessionStatus(e, t, n, r) {
 		try {
-			let r = t ?? this.currentSession?.session_id;
-			if (!r) throw new v("No active session. Provide a sessionId or start a session first.");
-			this.validator.validateSessionId(r);
-			let i = `${e}/sessions/${r}`;
-			n && (i += `?template_id=${encodeURIComponent(n)}`), this.debug && console.log("[ScribeSDK] Getting session status:", r);
-			let a = await this.transport.request({
+			let i = t ?? this.currentSession?.session_id;
+			if (!i) throw new v("No active session. Provide a sessionId or start a session first.");
+			this.validator.validateSessionId(i);
+			let a = new URLSearchParams();
+			n && a.set("template_id", n), r && a.set("version", r);
+			let o = a.toString(), s = o ? `${e}/sessions/${i}?${o}` : `${e}/sessions/${i}`;
+			this.debug && console.log("[ScribeSDK] Getting session status:", i);
+			let c = await this.transport.request({
 				method: "GET",
-				url: i,
+				url: s,
 				acceptStatuses: [410]
 			});
-			return this.validator.validateGetSessionStatusResponse(a.data), this.debug && console.log("[ScribeSDK] Session status:", r, a.data.status), {
-				data: a.data,
-				httpStatus: a.status
+			return this.validator.validateGetSessionStatusResponse(c.data), this.debug && console.log("[ScribeSDK] Session status:", i, c.data.status), {
+				data: c.data,
+				httpStatus: c.status
 			};
 		} catch (e) {
 			throw e instanceof v ? e : new v(`Failed to get session status: ${e instanceof Error ? e.message : "Unknown error"}`);
@@ -845,42 +848,42 @@ var z = class {
 			throw e instanceof v ? e : new v(`Failed to process template: ${e instanceof Error ? e.message : "Unknown error"}`);
 		}
 	}
-	async pollForCompletion(e, t, n, r) {
+	async pollForCompletion(e, t, n, r, i) {
 		try {
-			let i = t ?? this.currentSession?.session_id;
-			if (!i) throw new v("No active session. Provide a sessionId or start a session first.");
-			let a = n?.maxAttempts ?? 60, o = n?.intervalMs ?? 2e3, s = n?.timeoutMs, c = s !== void 0 && s > 0 ? Date.now() + s : void 0;
-			this.debug && console.log("[ScribeSDK] Polling for completion:", i, {
-				maxAttempts: a,
-				intervalMs: o,
-				timeoutMs: s
+			let a = t ?? this.currentSession?.session_id;
+			if (!a) throw new v("No active session. Provide a sessionId or start a session first.");
+			let o = n?.maxAttempts ?? 60, s = n?.intervalMs ?? 2e3, c = n?.timeoutMs, l = c !== void 0 && c > 0 ? Date.now() + c : void 0;
+			this.debug && console.log("[ScribeSDK] Polling for completion:", a, {
+				maxAttempts: o,
+				intervalMs: s,
+				timeoutMs: c
 			});
-			for (let t = 1; t <= a; t++) {
-				if (n?.signal?.aborted) throw new v("Polling was aborted", "polling_aborted", void 0, { session_id: i });
-				if (c !== void 0 && Date.now() >= c) throw new v(`Polling timed out after ${s}ms for session '${i}'`, "polling_timeout", void 0, {
-					session_id: i,
-					timeout_ms: s
+			for (let t = 1; t <= o; t++) {
+				if (n?.signal?.aborted) throw new v("Polling was aborted", "polling_aborted", void 0, { session_id: a });
+				if (l !== void 0 && Date.now() >= l) throw new v(`Polling timed out after ${c}ms for session '${a}'`, "polling_timeout", void 0, {
+					session_id: a,
+					timeout_ms: c
 				});
-				let l = await this.getSessionStatus(e, i, r), u = l.data;
+				let u = await this.getSessionStatus(e, a, r, i), d = u.data;
 				if (n?.onProgress) try {
-					n.onProgress(u);
+					n.onProgress(d);
 				} catch (e) {
 					console.error("[ScribeSDK] Error in poll onProgress callback:", e);
 				}
-				if (this.isTerminalStatus(u.status)) return this.debug && console.log("[ScribeSDK] Poll complete:", i, u.status, `(attempt ${t})`), l;
-				if (t < a) {
-					let e = o;
-					if (c !== void 0) {
-						let t = c - Date.now();
+				if (this.isTerminalStatus(d.status)) return this.debug && console.log("[ScribeSDK] Poll complete:", a, d.status, `(attempt ${t})`), u;
+				if (t < o) {
+					let e = s;
+					if (l !== void 0) {
+						let t = l - Date.now();
 						if (t <= 0) continue;
-						e = Math.min(o, t);
+						e = Math.min(s, t);
 					}
 					await this.sleepWithAbort(e, n?.signal);
 				}
 			}
-			throw new v(`Polling timed out after ${a} attempts for session '${i}'`, "polling_timeout", void 0, {
-				session_id: i,
-				max_attempts: a
+			throw new v(`Polling timed out after ${o} attempts for session '${a}'`, "polling_timeout", void 0, {
+				session_id: a,
+				max_attempts: o
 			});
 		} catch (e) {
 			throw e instanceof v ? e : new v(`Failed to poll session: ${e instanceof Error ? e.message : "Unknown error"}`);
@@ -1725,8 +1728,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;
 			}
@@ -1855,7 +1858,7 @@ var Se = class {
 			timestamp: (/* @__PURE__ */ new Date()).toISOString()
 		}), this.config.debug && console.log("[ScribeSDK] Recording resumed"));
 	}
-	async stop() {
+	async stop(e) {
 		if (!this.recorder || !this._isRecording) return {
 			data: {
 				failedUploads: [],
@@ -1864,13 +1867,13 @@ var Se = class {
 			},
 			httpStatus: void 0
 		};
-		let e = !1, t;
+		let t = !1, n;
 		try {
-			let n = await this.recorder.stop();
+			let r = await this.recorder.stop();
 			this.preserveRetryContext(), this._isRecording = !1;
-			let r = n.failedUploads;
-			if (r.length > 0) try {
-				r = (await this.retryFailedUploads()).data.stillFailed;
+			let i = r.failedUploads;
+			if (i.length > 0) try {
+				i = (await this.retryFailedUploads(e)).data.stillFailed;
 			} catch (e) {
 				console.error("[ScribeSDK] Internal retry pass failed:", e), this.callbackRegistry.dispatch("onError", {
 					type: m.TRANSPORT_ERROR,
@@ -1881,26 +1884,26 @@ var Se = class {
 					}
 				});
 			}
-			let i = {
-				failedUploads: r,
-				totalFiles: n.totalFiles,
+			let a = {
+				failedUploads: i,
+				totalFiles: r.totalFiles,
 				sessionEnded: !1
 			};
-			if (r.length === 0 && this.activeSession) {
-				let r = await this.finalizeSession(n.totalFiles, n.totalFiles);
-				r && (i.sessionEnded = !0, i.endSessionResponse = r.data, t = r.httpStatus, e = !0);
+			if (i.length === 0 && this.activeSession) {
+				let e = await this.finalizeSession(r.totalFiles, r.totalFiles);
+				e && (a.sessionEnded = !0, a.endSessionResponse = e.data, n = e.httpStatus, t = !0);
 			}
 			return this.callbackRegistry.dispatch("onRecordingStateChange", {
 				type: u.ENDED,
 				timestamp: (/* @__PURE__ */ new Date()).toISOString(),
-				data: i
+				data: a
 			}), this.config.debug && console.log("[ScribeSDK] Recording stopped:", {
-				totalFiles: i.totalFiles,
-				failedUploads: i.failedUploads.length,
-				sessionEnded: i.sessionEnded
+				totalFiles: a.totalFiles,
+				failedUploads: a.failedUploads.length,
+				sessionEnded: a.sessionEnded
 			}), {
-				data: i,
-				httpStatus: t
+				data: a,
+				httpStatus: n
 			};
 		} catch (e) {
 			return console.error("[ScribeSDK] Error stopping recording:", e), this.callbackRegistry.dispatch("onError", {
@@ -1919,7 +1922,7 @@ var Se = class {
 				httpStatus: void 0
 			};
 		} finally {
-			e ? this.cleanupRecordingState() : this.partialCleanupAfterFailedFinalize();
+			t ? this.cleanupRecordingState() : this.partialCleanupAfterFailedFinalize();
 		}
 	}
 	async finalizeSession(e, t) {
@@ -1985,7 +1988,7 @@ var Se = class {
 	finalizeAfterExternalEndSession(e) {
 		this.activeSession && this.activeSession.session_id === e && (this.activeSession = null, this.activeBaseUrl = "", this.retryContext = null);
 	}
-	async retryFailedUploads() {
+	async retryFailedUploads(e) {
 		if (this._isRecording) throw new v("Cannot retry uploads while recording is active.");
 		if (!this.retryContext || this.retryContext.failedChunks.length === 0) return {
 			data: {
@@ -1995,47 +1998,47 @@ var Se = class {
 			},
 			httpStatus: void 0
 		};
-		let { storageProvider: e, failedChunks: t } = this.retryContext, n = t.length, r = [], i = 0, a = this.retryContext.upload;
+		let { storageProvider: t, failedChunks: n } = this.retryContext, r = n.length, i = [], a = 0, o = 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 t = this.activeSession?.session_id;
+			if (t) {
+				let n = await this.sessionManager.getSessionStatus(this.activeBaseUrl, t, void 0, e);
+				n.data.upload_url && (o = n.data.upload_url, this.retryContext.upload = o);
 			}
 		} catch (e) {
 			this.config.debug && console.log("[ScribeSDK] Failed to refresh upload_url, using existing:", e);
 		}
-		this.config.debug && console.log(`[ScribeSDK] Retrying ${n} failed uploads`);
-		for (let o of t) try {
+		this.config.debug && console.log(`[ScribeSDK] Retrying ${r} failed uploads`);
+		for (let e of n) try {
 			await Y(this.transport, {
-				fileName: o.fileName,
-				blob: o.blob,
-				upload: a,
-				storageProvider: e,
+				fileName: e.fileName,
+				blob: e.blob,
+				upload: o,
+				storageProvider: t,
 				maxRetries: 0
-			}), i++, this.callbackRegistry.dispatch("onUploadEvent", {
+			}), a++, this.callbackRegistry.dispatch("onUploadEvent", {
 				type: f.PROGRESS,
 				timestamp: (/* @__PURE__ */ new Date()).toISOString(),
 				data: {
-					successCount: i,
-					totalCount: n
+					successCount: a,
+					totalCount: r
 				}
-			}), this.config.debug && console.log(`[ScribeSDK] Retry succeeded: ${o.fileName}`);
-		} catch (e) {
-			r.push(o.fileName), this.callbackRegistry.dispatch("onUploadEvent", {
+			}), this.config.debug && console.log(`[ScribeSDK] Retry succeeded: ${e.fileName}`);
+		} catch (t) {
+			i.push(e.fileName), this.callbackRegistry.dispatch("onUploadEvent", {
 				type: f.FAILED,
 				timestamp: (/* @__PURE__ */ new Date()).toISOString(),
 				data: {
-					fileName: o.fileName,
-					error: e instanceof Error ? e.message : "Retry failed"
+					fileName: e.fileName,
+					error: t instanceof Error ? t.message : "Retry failed"
 				}
-			}), this.config.debug && console.log(`[ScribeSDK] Retry failed: ${o.fileName}`, e);
+			}), this.config.debug && console.log(`[ScribeSDK] Retry failed: ${e.fileName}`, t);
 		}
-		return r.length === 0 ? this.retryContext = null : this.retryContext.failedChunks = t.filter((e) => r.includes(e.fileName)), this.config.debug && console.log(`[ScribeSDK] Retry complete: ${i}/${n} succeeded`), {
+		return i.length === 0 ? this.retryContext = null : this.retryContext.failedChunks = n.filter((e) => i.includes(e.fileName)), this.config.debug && console.log(`[ScribeSDK] Retry complete: ${a}/${r} succeeded`), {
 			data: {
-				retried: n,
-				succeeded: i,
-				stillFailed: r
+				retried: r,
+				succeeded: a,
+				stillFailed: i
 			},
 			httpStatus: void 0
 		};
@@ -2153,11 +2156,11 @@ var Se = class {
 	resumeRecording() {
 		this.recordingManager.resume();
 	}
-	async endRecording() {
-		return this.wrapResult(() => this.recordingManager.stop());
+	async endRecording(e) {
+		return this.wrapResult(() => this.recordingManager.stop(e));
 	}
-	async retryFailedUploads() {
-		return this.wrapResult(() => this.recordingManager.retryFailedUploads());
+	async retryFailedUploads(e) {
+		return this.wrapResult(() => this.recordingManager.retryFailedUploads(e));
 	}
 	hasFailedUploads() {
 		return this.recordingManager.hasFailedUploads();
@@ -2193,9 +2196,9 @@ var Se = class {
 			};
 		});
 	}
-	async createSession(e) {
-		let t = this.getEffectiveBaseUrl();
-		return this.wrapResult(() => this.sessionManager.createSession(t, e));
+	async createSession(e, t) {
+		let n = this.getEffectiveBaseUrl();
+		return this.wrapResult(() => this.sessionManager.createSession(n, e, t));
 	}
 	async endSession(e, t) {
 		let n = this.getEffectiveBaseUrl();
@@ -2210,7 +2213,7 @@ var Se = class {
 	}
 	async getSessionStatus(e, t) {
 		let n = this.getEffectiveBaseUrl();
-		return t?.poll ? this.wrapResult(() => this.sessionManager.pollForCompletion(n, e, t.poll, t.templateId)) : this.wrapResult(() => this.sessionManager.getSessionStatus(n, e, t?.templateId));
+		return t?.poll ? this.wrapResult(() => this.sessionManager.pollForCompletion(n, e, t.poll, t.templateId, t.version)) : this.wrapResult(() => this.sessionManager.getSessionStatus(n, e, t?.templateId, t?.version));
 	}
 	getCurrentSession() {
 		return this.recordingManager.getActiveSession() ?? this.sessionManager.getCurrentSession();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "med-scribe-alliance-ts-sdk",
-  "version": "2.0.38",
+  "version": "2.0.40",
   "description": "TypeScript SDK for the MedScribe Alliance Protocol",
   "main": "dist/index.mjs",
   "module": "dist/index.mjs",