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

package/README.md

@@ -395,8 +395,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

@@ -807,7 +807,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 +820,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 +1060,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 +1071,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 +1086,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.
 	 */

package/dist/index.mjs

@@ -748,19 +748,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 +786,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 +847,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"}`);
@@ -2193,9 +2195,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 +2212,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.39",
   "description": "TypeScript SDK for the MedScribe Alliance Protocol",
   "main": "dist/index.mjs",
   "module": "dist/index.mjs",