@eka-care/ekascribe-ts-sdk 2.0.44 → 2.0.46

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

@@ -55,6 +55,7 @@ declare class EkaScribe {
     pollSessionOutput(request: {
         txn_id: string;
         max_polling_time?: number;
+        template_id?: string;
     }): Promise<TPollingResponse>;
     getSessionHistory({ txn_count }: {
         txn_count: number;

package/dist/index.mjs

@@ -54203,76 +54203,77 @@ const decodeApiResponse = (i) => {
   }
 }, pollOutputSummary = async ({
   txn_id: i,
-  max_polling_time: a = 120 * 1e3
+  max_polling_time: a = 120 * 1e3,
+  template_id: s
 }) => {
-  const s = EkaScribeStore$1.partialResultCallback, n = (r, c, u, m) => {
-    const y = {
-      response: c ?? null,
-      status_code: r,
-      errorMessage: m === "success" || m === "in-progress" ? void 0 : u
+  const n = EkaScribeStore$1.partialResultCallback, r = (c, u, m, y) => {
+    const l = {
+      response: u ?? null,
+      status_code: c,
+      errorMessage: y === "success" || y === "in-progress" ? void 0 : m
     };
-    return s?.({
+    return n?.({
       txn_id: i,
-      response: c ?? null,
-      status_code: r,
-      message: u,
-      poll_status: m
-    }), y;
+      response: u ?? null,
+      status_code: c,
+      message: m,
+      poll_status: y
+    }), l;
   };
   try {
-    const c = (/* @__PURE__ */ new Date()).getTime() + a;
-    let u = 0;
-    s?.({
+    const u = (/* @__PURE__ */ new Date()).getTime() + a;
+    let m = 0;
+    n?.({
       txn_id: i,
       response: null,
       status_code: 202,
       message: "Polling for session output summary started",
       poll_status: "in-progress"
     });
-    const m = async (y) => {
+    const y = async (l) => {
       try {
-        const l = await getVoiceApiV3Status({ txnId: i, queryParams: y }), { status_code: p, response: t } = l;
-        if ((/* @__PURE__ */ new Date()).getTime() >= c)
-          return n(500, null, "We encountered an error while fetching analysis results due to timeout. Please try again.", "timeout");
-        if (p === 401 || p === 403)
-          return n(p, t, "Unauthorized or Forbidden", "failed");
-        if (p === 202 || p === 400 || p >= 500) {
-          if (p === 202 && t && s?.({
+        const p = await getVoiceApiV3Status({ txnId: i, queryParams: l }), { status_code: t, response: e } = p;
+        if ((/* @__PURE__ */ new Date()).getTime() >= u)
+          return r(500, null, "We encountered an error while fetching analysis results due to timeout. Please try again.", "timeout");
+        if (t === 401 || t === 403)
+          return r(t, e, "Unauthorized or Forbidden", "failed");
+        if (t === 202 || t === 400 || t >= 500) {
+          if (t === 202 && e && n?.({
             txn_id: i,
-            response: t,
-            status_code: p,
+            response: e,
+            status_code: t,
             message: "Partial result received",
             poll_status: "in-progress"
-          }), p >= 400) {
-            if (u++, u >= 3) {
-              const o = t?.error?.msg || "We encountered a backend error while fetching results. Please try again.";
-              return n(p, null, o, "failed");
+          }), t >= 400) {
+            if (m++, m >= 3) {
+              const d = e?.error?.msg || "We encountered a backend error while fetching results. Please try again.";
+              return r(t, null, d, "failed");
             }
           } else
-            u = 0;
-          return m();
+            m = 0;
+          return y(s ? `template_id=${s}` : "");
         }
-        return n(
-          p,
+        return r(
           t,
+          e,
           "Template results generated successfully. Polling for this session is complete.",
           "success"
         );
-      } catch (l) {
-        return n(
+      } catch (p) {
+        return r(
           -1,
           null,
-          `Something went wrong from inside catch block. ${l}`,
+          `Something went wrong from inside catch block. ${p}`,
           "failed"
         );
       }
     };
-    return m("template_id=transcript");
-  } catch (r) {
-    return r instanceof Error && r.name === "AbortError" ? n(-1, null, "Request was aborted due to timeout.", "timeout") : n(
+    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,
       null,
-      `Something went wrong from outer catch block, ${r}`,
+      `Something went wrong from outer catch block, ${c}`,
       "failed"
     );
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eka-care/ekascribe-ts-sdk",
-  "version": "2.0.44",
+  "version": "2.0.46",
   "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": {