@eka-care/ekascribe-ts-sdk 2.0.45 → 2.0.47

package/README.md

@@ -141,7 +141,38 @@ const config = await ekascribe.getEkascribeConfig();
 }
 ```
 
-### 3. Init transaction
+### 3. Fetch user's favorite templates
+
+Get the list of templates marked as favorites by the user (configured via `my_templates` in the config).
+
+```ts
+const myTemplates = await ekascribe.getConfigMyTemplates();
+```
+
+- #### Sample Response:
+
+```ts
+{
+  "data": {
+    "my_templates": [
+      {
+        "id": "template_123",
+        "name": "General Consultation"
+      },
+      {
+        "id": "template_456",
+        "name": "Cardiology Template"
+      }
+    ],
+  },
+  "message": "Configuration fetched successfully",
+  "code": 200
+}
+```
+
+**Note:** The `my_templates` field contains templates that were previously saved using the `updateConfig()` method (see Templates SDK Methods section).
+
+### 4. Init transaction
 
 Initialize a transaction before starting recording. This sets up the session with your configuration.
 
@@ -215,7 +246,7 @@ ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
 const response = await ekascribe.initTransaction({ ... });
 ```
 
-### 4. Start recording
+### 5. Start recording
 
 Start recording audio after initializing the transaction.
 
@@ -237,7 +268,7 @@ const response = await ekascribe.startRecording();
 }
 ```
 
-### 5. Pause recording
+### 6. Pause recording
 
 Pause the ongoing voice recording.
 
@@ -256,7 +287,7 @@ const response = await ekascribe.pauseRecording();
 }
 ```
 
-### 6. Resume recording
+### 7. Resume recording
 
 Resume a paused recording.
 
@@ -275,7 +306,7 @@ const response = await ekascribe.resumeRecording();
 }
 ```
 
-### 7. End recording
+### 8. End recording
 
 End the recording session. This method:
 
@@ -323,34 +354,31 @@ ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
 const response = await ekascribe.endRecording();
 ```
 
-### 8. Get output recorded prescription
-
-You can fetch output in two ways:
-
-- `getTemplateOutput({ txn_id })`: polling is your responsibility; call repeatedly until processing finishes.
-- `pollSessionOutput({ txn_id, max_polling_time })`: SDK polls for you and resolves when processing finishes (default max wait: 2 minutes; override via `max_polling_time`, pass time in milliseconds).
-
-Example (manual polling):
-
-```ts
-const res = await ekascribe.getTemplateOutput({ txn_id: 'transaction-id' });
-```
+### 9. Get output recorded prescription
 
-Example (SDK-managed polling):
+The SDK polls for you and resolves when processing finishes (default max wait: 2 minutes; override via `max_polling_time`, pass time in milliseconds).
 
 ```ts
 // Waits up to 2 minutes by default; override as needed
 const res = await ekascribe.pollSessionOutput({
   txn_id: 'transaction-id',
   max_polling_time: 2 * 60 * 1000, // optional
+  template_id: 'template-id', // optional
 });
 ```
 
+**Note:**
+
+1. On passing `template_id` in request params, the function will return output only for that specific template ID. If `template_id` is not passed, it will return all template responses generated for that `txn_id`.
+2. Use `onPartialResultCallback` (see Generic Callbacks section) before calling `pollSessionOutput` to receive real-time updates during polling, display partial transcription results, and improve user experience with processing progress indicators.
+
 Status codes to handle:
 
 - `200`: Success; all templates processed.
 - `202`: Templates are still processing; poll again (or let `pollSessionOutput` continue).
 - `206`: Partial success; some templates not processed fully.
+- `401`: Authentication token expired. Update the token.
+- `403`: Invalid Authentication token. Pass new token.
 - `500`: All template processing failed, or internal server error; stop and surface error.
 
 - #### Response type:
@@ -442,7 +470,7 @@ type TOutputSummary = {
 }
 ```
 
-### 9. Retry upload recording
+### 10. Retry upload recording
 
 Retry uploading failed audio files after `endRecording`.
 
@@ -482,7 +510,7 @@ ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
 const response = await ekascribe.retryUploadRecording({ force_commit: true });
 ```
 
-### 10. Patch recording session status
+### 11. Patch recording session status
 
 Cancel or update the status of a recording session.
 
@@ -531,7 +559,7 @@ ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
 const response = await ekascribe.patchSessionStatus({ ... });
 ```
 
-### 11. Commit transaction
+### 12. Commit transaction
 
 Call this if `endRecording` returns `error_code: 'txn_commit_failed'` or the transaction is not yet committed.
 
@@ -564,7 +592,7 @@ ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
 const response = await ekascribe.commitTransactionCall();
 ```
 
-### 12. Stop transaction
+### 13. Stop transaction
 
 Use this method to stop a transaction that has not yet been stopped or returned a `txn_stop_failed` error in a previous step.
 
@@ -597,7 +625,7 @@ ekascribe.updateAuthTokens({ access_token: sdkConfig.access_token });
 const response = await ekascribe.stopTransactionCall();
 ```
 
-### 13. Get previous sessions
+### 14. Get previous sessions
 
 Fetch previous sessions. `txn_count` controls how many sessions the API returns.
 
@@ -635,6 +663,49 @@ const sessions = await ekascribe.getSessionHistory({ txn_count: 10 }); // txn_co
 }
 ```
 
+### 15. Convert response to other template post session
+
+Use this method to convert an existing transcription from a completed transaction into a different template format. This is useful when you want to reformat existing transcription data without re-recording.
+
+```ts
+const response = await ekascribe.postTransactionConvertToTemplate({
+  txn_id: 'transaction-id-123',
+  template_id: 'new-template-id',
+});
+```
+
+**Key Parameters:**
+
+- `txn_id`: The transaction ID of the completed session you want to convert
+- `template_id`: The ID of the template format you want to convert the transcription into
+
+- #### Sample Response:
+
+```ts
+{
+  status: 'success' | 'failed';
+  message: string;
+  txn_id: string;
+  template_id: string;
+  b_id: string;
+  code: number;
+  msg: string;
+  error?: {
+    code: string;
+    message: string;
+    display_message: string;
+  };
+}
+```
+
+**When to use:**
+
+- When you need to apply a different template to an existing transcription
+- To generate multiple template formats from the same recording session
+- After completing a session, when you want to see the output in a different template structure
+
+**Note:** After getting success response from this method, call `pollSessionOutput` (Point 9) to get the output for the new template_id.
+
 ## Templates SDK Methods
 
 ### 1. Get All Templates
@@ -1174,6 +1245,57 @@ ekascribe.onUserSpeechCallback((isSpeech) => {
 });
 ```
 
+### 3. Partial result callback
+
+This callback provides real-time partial results while polling for the final output. Use it to display intermediate transcription and template results to users before processing is complete.
+
+```ts
+ekascribe.onPartialResultCallback((partialData) => {
+  console.log('Partial result received:', partialData);
+
+  // Handle different poll statuses
+  switch (partialData.poll_status) {
+    case 'in-progress':
+      // Processing is still ongoing, display partial results
+      console.log('Processing...', partialData.response);
+      break;
+    case 'success':
+      // Final result received
+      console.log('Processing complete:', partialData.response);
+      break;
+    case 'failed':
+      // Processing failed
+      console.error('Processing failed:', partialData.message);
+      break;
+    case 'timeout':
+      // Polling timed out
+      console.warn('Polling timeout:', partialData.message);
+      break;
+  }
+});
+```
+
+- #### Callback Structure:
+
+```ts
+{
+  txn_id: string; // Transaction ID
+  response: TGetStatusApiResponse | null; // The response structure is the same as returned by `pollSessionOutput` method
+  status_code: number; // HTTP status code
+  message: string; // Status message
+  poll_status: 'in-progress' | 'success' | 'failed' | 'timeout'; // Current polling state
+}
+```
+
+**When to use:**
+
+- Set this callback before calling `pollSessionOutput` to receive real-time updates
+- Display partial transcription results to improve user experience
+- Show processing progress indicators
+- Handle intermediate template results
+
+**Note:** This callback is triggered multiple times during polling - once for each poll attempt until processing completes or times out.
+
 ### Error codes
 
 | Error Code            | Description                                                 |

package/dist/index.d.ts

@@ -21,18 +21,17 @@ declare class EkaScribe {
     private audioBufferInstance;
     private compatibilityManager;
     private constructor();
-    static getInstance({ access_token, env, clientId, clientEndpoint, }: {
+    static getInstance({ access_token, env, clientId, }: {
         access_token?: string;
         env?: 'PROD' | 'DEV';
         clientId?: string;
-        clientEndpoint?: string;
     }): EkaScribe;
     resetInstance(): void;
     getEkascribeConfig(): Promise<TGetConfigV2Response>;
     updateAuthTokens({ access_token }: {
         access_token: string;
     }): void;
-    initTransaction(request: TPostTransactionInitRequest): Promise<TStartRecordingResponse>;
+    initTransaction(request: TPostTransactionInitRequest, sharedWorkerUrl?: string): Promise<TStartRecordingResponse>;
     startRecording(): Promise<TStartRecordingResponse>;
     reinitializeVad(): void;
     destroyVad(): void;
@@ -55,7 +54,7 @@ declare class EkaScribe {
     pollSessionOutput(request: {
         txn_id: string;
         max_polling_time?: number;
-        is_ongoing_session?: boolean;
+        template_id?: string;
     }): Promise<TPollingResponse>;
     getSessionHistory({ txn_count }: {
         txn_count: number;
@@ -122,11 +121,10 @@ declare enum ERROR_CODE {
 
 declare type Gender = 'M' | 'F' | 'O';
 
-export declare const getEkaScribeInstance: ({ access_token, env, clientId, clientEndpoint, }: {
+export declare const getEkaScribeInstance: ({ access_token, env, clientId, }: {
     access_token?: string;
     env?: "PROD" | "DEV";
     clientId?: string;
-    clientEndpoint?: string;
 }) => EkaScribe;
 
 declare type TAudioChunksInfo = {

package/dist/index.mjs

@@ -38528,40 +38528,40 @@ class AudioFileManager {
   updateAudioInfo(a) {
     return this.audioChunks.push(a), this.audioChunks.length;
   }
-  createSharedWorkerInstance() {
+  createSharedWorkerInstance(a) {
     try {
-      const a = new SharedWorker(new URL("../shared-worker/s3-file-upload.js"));
-      this.sharedWorkerInstance = a;
-      const s = EkaScribeStore$1.eventCallback;
-      return this.sharedWorkerInstance.port.onmessage = async (n) => {
-        const r = n.data;
-        switch (r.action) {
+      const s = new SharedWorker(a);
+      this.sharedWorkerInstance = s;
+      const n = EkaScribeStore$1.eventCallback;
+      return this.sharedWorkerInstance.port.onmessage = async (r) => {
+        const c = r.data;
+        switch (c.action) {
           case SHARED_WORKER_ACTION.CONFIGURE_AWS_SUCCESS: {
-            s && s({
+            n && n({
               callback_type: CALLBACK_TYPE.AWS_CONFIGURE_STATUS,
               status: "success",
-              message: r.message,
+              message: c.message,
               timestamp: (/* @__PURE__ */ new Date()).toISOString()
             });
             return;
           }
           case SHARED_WORKER_ACTION.CONFIGURE_AWS_ERROR: {
-            s && s({
+            n && n({
               callback_type: CALLBACK_TYPE.AWS_CONFIGURE_STATUS,
               status: "error",
-              message: r.message,
+              message: c.message,
               timestamp: (/* @__PURE__ */ new Date()).toISOString()
             });
             return;
           }
           case SHARED_WORKER_ACTION.UPLOAD_FILE_WITH_WORKER_SUCCESS: {
             const {
-              fileCount: c,
-              chunkIndex: u,
-              fileBlob: m,
-              compressedAudioBuffer: y
-            } = r.requestBody;
-            s && y && s({
+              fileCount: u,
+              chunkIndex: m,
+              fileBlob: y,
+              compressedAudioBuffer: l
+            } = c.requestBody;
+            n && l && n({
               callback_type: CALLBACK_TYPE.FILE_UPLOAD_STATUS,
               status: "info",
               message: "Audioframes of chunk to store in IDB",
@@ -38569,57 +38569,57 @@ class AudioFileManager {
               data: {
                 success: this.successfulUploads.length,
                 total: this.audioChunks.length,
-                fileName: c,
-                chunkData: y
+                fileName: u,
+                chunkData: l
               }
-            }), r.response.success ? (this.successfulUploads.push(c), u !== -1 && (this.audioChunks[u] = {
-              ...this.audioChunks[u],
+            }), c.response.success ? (this.successfulUploads.push(u), m !== -1 && (this.audioChunks[m] = {
+              ...this.audioChunks[m],
               audioFrames: void 0,
               fileBlob: void 0,
               status: "success",
-              response: r.response.success
-            }), s && s({
+              response: c.response.success
+            }), n && n({
               callback_type: CALLBACK_TYPE.FILE_UPLOAD_STATUS,
               status: "success",
-              message: r.response.success,
+              message: c.response.success,
               timestamp: (/* @__PURE__ */ new Date()).toISOString(),
               data: {
                 success: this.successfulUploads.length,
                 total: this.audioChunks.length,
                 is_uploaded: !0
               }
-            })) : (s && s({
+            })) : (n && n({
               callback_type: CALLBACK_TYPE.FILE_UPLOAD_STATUS,
               status: "error",
-              message: r.response.error || "Upload failed",
+              message: c.response.error || "Upload failed",
               timestamp: (/* @__PURE__ */ new Date()).toISOString(),
               error: {
-                code: r.response.code,
-                msg: r.response.error,
-                details: r.response.errorCode
+                code: c.response.code,
+                msg: c.response.error,
+                details: c.response.errorCode
               },
               data: {
-                fileName: c,
+                fileName: u,
                 is_uploaded: !1
               }
-            }), u !== -1 && (this.audioChunks[u] = {
-              ...this.audioChunks[u],
-              fileBlob: m,
+            }), m !== -1 && (this.audioChunks[m] = {
+              ...this.audioChunks[m],
+              fileBlob: y,
               audioFrames: void 0,
               status: "failure",
-              response: r.response.error || "Upload failed"
-            }), r.response.errorCode === "ExpiredToken" && this.setupAWSConfiguration({
+              response: c.response.error || "Upload failed"
+            }), c.response.errorCode === "ExpiredToken" && this.setupAWSConfiguration({
               is_shared_worker: !0
             }));
           }
         }
-      }, a.port.start(), !0;
-    } catch (a) {
-      const s = a instanceof Error ? a.message : String(a);
-      return s.includes("SecurityError") || s.includes("Failed to construct") ? console.error(
+      }, s.port.start(), !0;
+    } catch (s) {
+      const n = s instanceof Error ? s.message : String(s);
+      return n.includes("SecurityError") || n.includes("Failed to construct") ? console.error(
         "Error creating shared worker instance: CORS/Same-origin policy violation. The SharedWorker script must be served from the same origin as your application, or the server must allow cross-origin access with proper CORS headers. Falling back to non-worker upload method.",
-        a
-      ) : console.error("Error creating shared worker instance:", a), !1;
+        s
+      ) : console.error("Error creating shared worker instance:", s), !1;
     }
   }
   async setupAWSConfiguration({ is_shared_worker: a }) {
@@ -38753,20 +38753,7 @@ class AudioFileManager {
     };
   }
   async uploadAudioToS3({ audioFrames: a, fileName: s, chunkIndex: n }) {
-    if (typeof SharedWorker > "u" || !SharedWorker)
-      console.log("Shared Workers are NOT supported in this browser."), await this.uploadAudioToS3WithoutWorker({ audioFrames: a, fileName: s, chunkIndex: n });
-    else {
-      if (console.log("Shared Workers are supported in this browser."), !this.sharedWorkerInstance) {
-        const r = this.createSharedWorkerInstance();
-        if (console.log(r, "worker created"), !r) {
-          console.warn(
-            "Failed to create SharedWorker instance. Falling back to non-worker upload method."
-          ), await this.uploadAudioToS3WithoutWorker({ audioFrames: a, fileName: s, chunkIndex: n });
-          return;
-        }
-      }
-      await this.uploadAudioToS3WithWorker({ audioFrames: a, fileName: s, chunkIndex: n });
-    }
+    typeof SharedWorker > "u" || !SharedWorker || !this.sharedWorkerInstance ? (console.log("Shared Workers are NOT supported in this browser."), await this.uploadAudioToS3WithoutWorker({ audioFrames: a, fileName: s, chunkIndex: n })) : (console.log("Shared Workers are supported in this browser."), await this.uploadAudioToS3WithWorker({ audioFrames: a, fileName: s, chunkIndex: n }));
   }
   async uploadAudioToS3WithWorker({
     audioFrames: a,
@@ -54204,7 +54191,7 @@ const decodeApiResponse = (i) => {
 }, pollOutputSummary = async ({
   txn_id: i,
   max_polling_time: a = 120 * 1e3,
-  is_ongoing_session: s
+  template_id: s
 }) => {
   const n = EkaScribeStore$1.partialResultCallback, r = (c, u, m, y) => {
     const l = {
@@ -54251,7 +54238,7 @@ const decodeApiResponse = (i) => {
             }
           } else
             m = 0;
-          return y();
+          return y(s ? `template_id=${s}` : "");
         }
         return r(
           t,
@@ -54268,7 +54255,7 @@ const decodeApiResponse = (i) => {
         );
       }
     };
-    return y(s ? "template_id=transcript" : "");
+    return y(s ? `template_id=${s}` : "");
   } catch (c) {
     return c instanceof Error && c.name === "AbortError" ? r(-1, null, "Request was aborted due to timeout.", "timeout") : r(
       -1,
@@ -54827,14 +54814,13 @@ const Ur = class Ur {
   static getInstance({
     access_token: a,
     env: s,
-    clientId: n,
-    clientEndpoint: r
+    clientId: n
   }) {
     return setEnv({
       ...a ? { auth_token: a } : {},
       ...s ? { env: s } : {},
       ...n ? { clientId: n } : {}
-    }), console.log(r, "clientEndpoint"), Ur.instance || (Ur.instance = new Ur()), Ur.instance;
+    }), Ur.instance || (Ur.instance = new Ur()), Ur.instance;
   }
   // Method to reset the singleton instance (useful for testing)
   resetInstance() {
@@ -54848,15 +54834,15 @@ const Ur = class Ur {
       auth_token: a
     });
   }
-  async initTransaction(a) {
-    EkaScribeStore$1.resetStore(), this.audioFileManagerInstance = new AudioFileManager(), EkaScribeStore$1.audioFileManagerInstance = this.audioFileManagerInstance, this.audioBufferInstance = new AudioBufferManager(SAMPLING_RATE, AUDIO_BUFFER_SIZE_IN_S), EkaScribeStore$1.audioBufferInstance = this.audioBufferInstance, this.vadInstance = new VadWebClient(
+  async initTransaction(a, s) {
+    EkaScribeStore$1.resetStore(), this.audioFileManagerInstance = new AudioFileManager(), EkaScribeStore$1.audioFileManagerInstance = this.audioFileManagerInstance, s && this.audioFileManagerInstance.createSharedWorkerInstance(s), this.audioBufferInstance = new AudioBufferManager(SAMPLING_RATE, AUDIO_BUFFER_SIZE_IN_S), EkaScribeStore$1.audioBufferInstance = this.audioBufferInstance, this.vadInstance = new VadWebClient(
       PREF_CHUNK_LENGTH,
       DESP_CHUNK_LENGTH,
       MAX_CHUNK_LENGTH,
       FRAME_RATE
     ), EkaScribeStore$1.vadInstance = this.vadInstance, console.log("Initialising SDK Instances ", EkaScribeStore$1);
-    const s = await initialiseTransaction(a);
-    return console.log(s, "initTransactionResponse"), s;
+    const n = await initialiseTransaction(a);
+    return console.log(n, "initTransactionResponse"), n;
   }
   async startRecording() {
     const a = await startVoiceRecording();
@@ -55123,9 +55109,8 @@ let EkaScribe = Ur;
 const getEkaScribeInstance = ({
   access_token: i,
   env: a,
-  clientId: s,
-  clientEndpoint: n
-}) => EkaScribe.getInstance({ access_token: i, env: a, clientId: s, clientEndpoint: n });
+  clientId: s
+}) => EkaScribe.getInstance({ access_token: i, env: a, clientId: s });
 export {
   getEkaScribeInstance
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eka-care/ekascribe-ts-sdk",
-  "version": "2.0.45",
+  "version": "2.0.47",
   "description": "EkaScribe TypeScript SDK - Modern ES2020 build",
   "main": "dist/index.mjs",
   "module": "dist/index.mjs",
@@ -28,7 +28,7 @@
     "clean": "rm -rf dist",
     "build:main": "vite build",
     "build:worker": "vite build --config vite.worker.config.ts",
-    "build": "yarn clean && yarn build:main && yarn build:worker && cp ../../README.md .",
+    "build": "yarn clean && yarn build:main && yarn build:worker",
     "prepublishOnly": "yarn build"
   },
   "publishConfig": {