@eka-care/ekascribe-ts-sdk 1.4.39

package/README.md

@@ -0,0 +1,437 @@
+# Eka Care Ekascribe Typescript SDK Integration
+
+This guide explains how to integrate the Eka Care Ekascribe Typescript SDK into your application.
+
+## Overview
+
+The Eka Care Ekascribe SDK allows you to capture and process audio, generating structured medical documentation using Eka Care's voice transcription API.
+
+## Documentation
+
+[Visit the documentation site](https://developer.eka.care/api-reference/general-tools/medical/voice/SDKs/TS-sdk)
+
+## Prerequisites
+
+Before getting started, ensure you have:
+
+- Node 14 or higher
+- `npm` or `yarn` for dependency management
+- Access and refresh tokens from Eka Care (optional for some methods)
+- Microphone access via browser permissions
+- Stable network connectivity
+
+## Installation
+
+Install the SDK using `npm` or `yarn`:
+
+```bash
+npm install ekascribe-ts-sdk
+# or
+yarn add ekascribe-ts-sdk
+```
+
+## Usage
+
+### 1. Initialize Ekascribe
+
+Before using any other method, initialize the SDK with access and refresh tokens.
+
+```ts
+initEkascribe({
+  access_token: '<your_access_token>',
+  refresh_token: '<your_refresh_token>',
+});
+```
+
+### 2. Fetch configurations list
+
+Get supported input languages, output formats, and consultation modes.
+
+```ts
+getEkascribeConfig();
+```
+
+- #### Response type:
+
+```ts
+{
+  data?: {
+    supported_languages: [
+      { id: '1', name: 'EN' },
+      { id: '2', name: 'HI' }
+    ];
+    supported_output_formats: [
+      { id: 'eka-emr-template', name: 'Eka EMR Format' },
+      { id: 'clinical-notes-template', name: 'Clinical Notes' }
+    ];
+    consultation_modes: [
+      {
+        id: 'consultation',
+        name: 'Consultation',
+        desc: 'Eka Scribe will listen to your conversation and create clinical notes'
+      },
+      {
+        id: 'dictation',
+        name: 'Dictation',
+        desc: 'Dictate your notes to Eka Scribe and create clinical notes'
+      }
+    ];
+    max_selection: {
+      languages: 2;
+      output_formats: 2;
+      consultation_mode: 2;
+    };
+  };
+  message?: string;
+  code?: number;
+}
+```
+
+### 3. Init transaction
+
+Use this method to init a transaction before starting recording.
+
+```ts
+await initTransaction({
+  mode: 'consultation',
+  input_language: ['te', 'en'],
+  output_format_template: [{ template_id: 'eka_emr_template' }],
+  txn_id: 'abc-123',
+});
+```
+
+- #### Response type:
+
+```ts
+{
+  error_code?: ERROR_CODE;
+  status_code: number;
+  message: string;
+  business_id?: string;
+  txn_id?: string;
+  oid?: string;
+  uuid?: string;
+};
+```
+
+### 4. Start recording
+
+Start recording with user-selected options.
+
+```ts
+await startRecording();
+```
+
+- #### Response type:
+
+```ts
+{
+  error_code?: ERROR_CODE;
+  status_code: number;
+  message: string;
+  txn_id?: string;
+};
+```
+
+### 5. Pause recording
+
+Use the method to pause voice recording
+
+```ts
+await pauseRecording();
+```
+
+- #### Response type:
+
+```ts
+{
+  error_code?: ERROR_CODE;
+  status_code: number;
+  message: string;
+  is_paused?: boolean;
+};
+```
+
+### 6. Resume recording
+
+Use the method to resume voice recording
+
+```ts
+await resumeRecording();
+```
+
+- #### Response type:
+
+```ts
+{
+  error_code?: ERROR_CODE;
+  status_code: number;
+  message: string;
+  is_paused?: boolean;
+};
+```
+
+### 7. End recording
+
+Use the method to end voice recording
+
+```ts
+await endRecording();
+```
+
+- #### Response type:
+
+```ts
+{
+  error_code?: ERROR_CODE;
+  status_code: number;
+  message: string;
+  failed_files?: ['1.mp3', '2.mp3']; // if there are any failed files
+  total_audio_files?: ['1.mp3', '2.mp3', '3.mp3', '4.mp3']; // list of all audio files generated
+};
+```
+
+### 8. Retry upload recording
+
+Use this method to retry uploading failed audio files.
+
+```ts
+await retryUploadRecording({ force_commit: true / false });
+```
+
+- #### Response type:
+
+```ts
+{
+  error_code?: ERROR_CODE;
+  status_code: number;
+  message: string;
+  failed_files?: ['1.mp3', '2.mp3'];
+  total_audio_files?: ['1.mp3', '2.mp3', '3.mp3', '4.mp3'];
+};
+```
+
+`force_commit` behavior
+
+-- If `force_commit` is set to `true`, the SDK will call the commit API even if some audio files still fail to upload after retrying once.
+
+-- If `force_commit` is set to `false`, the SDK will wait until **all audio files** are uploaded successfully before making the commit request.
+
+### 9. Patch recording session status
+
+Use the method to cancel a recording session.
+
+```ts
+await patchSessionStatus({
+  sessionId: 'abc-123',
+  processing_status: 'cancelled',
+  processing_error: {
+    error: {
+      type: '',
+      code: 'cancelled_by_user',
+      msg: 'Cancelled_by_user',
+    },
+  },
+});
+```
+
+- #### Response type:
+
+```ts
+{
+  status: string;
+  message: string;
+  code: number;
+  error?: {
+    code: string;
+    message: string;
+    display_message: string;
+  };
+}
+```
+
+### 10. Commit transaction
+
+Use this method to commit a transaction that is not yet committed or returned a "commit failed" error in a previous step.
+
+```ts
+await commitTransactionCall();
+```
+
+- #### Response type:
+
+```ts
+{
+  error_code?: ERROR_CODE;
+  status_code: number;
+  message: string;
+};
+```
+
+### 11. Stop transaction
+
+Use this method to stop a transaction that has not yet been stopped or returned a "stop failed" error in a previous step.
+
+```ts
+await stopTransactionCall();
+```
+
+- #### Response type:
+
+```ts
+{
+  error_code?: ERROR_CODE;
+  status_code: number;
+  message: string;
+};
+```
+
+### 12. Get output template prescriptions
+
+Use this method to fetch the final generated prescription output for a session.
+
+```ts
+await getTemplateOutput({ txn_id: 'abc-123' });
+```
+
+### 13. Get previous sessions
+
+Use this method to retrieve all the previous sessions for a specific doctor ID
+
+```ts
+const sessions = await getSessionHistory({ txn_count: 10 });
+```
+
+- #### Response type:
+
+```ts
+{
+  data: [
+    {
+      "created_at": "string",
+      "b_id": "string",
+      "user_status": "string",
+      "processing_status": "string",
+      "txn_id": "string",
+      "mode": "string",
+      "uuid": "string",
+      "oid": "string"
+    }
+  ],
+  status: "string",
+  code: "number",
+  message: "string",
+  retrieved_count: "number"
+}
+```
+
+### 14. Get total uploaded files
+
+Use this method to retrieve all the audio files generated for a specific session.
+
+```ts
+const files = await getTotalAudioFiles();
+```
+
+- #### Response type:
+
+```ts
+['1.mp3', '2.mp3', '3.mp3', '4.mp3'];
+```
+
+### 15. Get successfully uploaded files
+
+Use this method to retrieve all the audio files that were uploaded successfully.
+
+```ts
+const successFiles = await getSuccessfullyUploadedFiles();
+```
+
+- #### Response type:
+
+```ts
+['3.mp3', '4.mp3'];
+```
+
+### 16. Get failed audio files
+
+Use this method to retrieve all the audio files that failed to upload.
+
+```ts
+const failedFiles = await getFailedFiles();
+```
+
+- #### Response type:
+
+```ts
+['1.mp3', '2.mp3'];
+```
+
+## Generic Callbacks
+
+### 1. Error callback
+
+Whenever an error occurs in the SDK during voice recording, the following callback will be triggered. You can listen to this to handle errors globally.
+
+```ts
+onError(({ error_code, status_code, message }) => {
+  console.error('Ekascribe SDK Error:', { error_code, status_code, message });
+});
+```
+
+### 2. User speech callback
+
+This callback will return a boolean indicating whether the user is speaking or not.
+
+```ts
+onUserSpeechCallback((isSpeech) => {
+  console.error(isSpeech ? 'User is speaking' : 'User is not speaking');
+});
+```
+
+### 3. File upload progress callback
+
+This callback provides the number of successfully uploaded files, the total number of files, the filename, and the chunk data for a particular file.
+
+```ts
+onFileUploadProgressCallback(({ success, total, fileName, chunkData }) => {
+  console.error('Progress till now: ', { success, total, fileName, chunkData });
+});
+```
+
+### Error codes
+
+| Error Code            | Description                                                 |
+| --------------------- | ----------------------------------------------------------- |
+| `microphone`          | Microphone access error (permission denied or unavailable)  |
+| `txn_init_failed`     | Failed to initialize transaction                            |
+| `txn_limit_exceeded`  | Maximum number of concurrent transactions exceeded          |
+| `unknown_error`       | An unknown or unclassified error occurred                   |
+| `txn_stop_failed`     | Error occurred while stopping the transaction               |
+| `audio_upload_failed` | Audio file upload to server failed                          |
+| `txn_commit_failed`   | Commit call failed for the current transaction              |
+| `invalid_request`     | Request to SDK was malformed or missing required parameters |
+| `vad_not_initialized` | Voice activity detection engine was not initialized         |
+| `no_audio_capture`    | No audio was captured during the recording session          |
+| `txn_status_mismatch` | Invalid operation due to mismatched transaction status      |
+
+## Contribution Guidelines
+
+This is a continually updated, open source project.
+Contributions are welcome!
+
+## Tips
+
+- The SDK internally handles shared worker logic to reduce load on the main thread. Try to execute these functions in the main thread to avoid unnecessary issues.
+
+## Advanced Usage (for later use)
+
+- Maximum retries for file upload in case of failure.
+- Update VAD configurations
+
+## Under Development
+
+- Opus compression of audio files
+- Test cases
+
+Refer [Ekascribe](https://github.com/eka-care/v2rx-extension) for SDK implementations.

package/dist/api/get-transaction-history.d.ts

@@ -0,0 +1,5 @@
+import { TGetTransactionHistoryResponse } from '../constants/types';
+declare const getTransactionHistory: ({ txn_count, }: {
+    txn_count: number;
+}) => Promise<TGetTransactionHistoryResponse>;
+export default getTransactionHistory;

package/dist/api/get-transaction-history.js

@@ -0,0 +1,28 @@
+import { SDK_STATUS_CODE } from '../constants/constant';
+import fetchWrapper from '../fetch-client';
+import { GET_EKA_V2RX_HOST_V2 } from '../fetch-client/helper';
+// TODO: pagination changes
+const getTransactionHistory = async ({ txn_count, }) => {
+    try {
+        const headers = new Headers();
+        headers.append('Content-Type', 'application/json');
+        const options = {
+            method: 'GET',
+            headers,
+        };
+        const responseJson = await fetchWrapper(`${GET_EKA_V2RX_HOST_V2()}/transaction/history?count=${txn_count}`, options);
+        const response = await responseJson.json();
+        return {
+            data: response.data,
+            status_code: responseJson.status,
+            message: `Past ${txn_count} transactions fetched successfully.`,
+        };
+    }
+    catch (error) {
+        return {
+            status_code: SDK_STATUS_CODE.INTERNAL_SERVER_ERROR,
+            message: `Something went wrong in fetching transactions. ${error}`,
+        };
+    }
+};
+export default getTransactionHistory;

package/dist/api/get-voice-api-v2-config.d.ts

@@ -0,0 +1,2 @@
+import { TGetConfigV2Response } from '../constants/types';
+export declare const getConfigV2: () => Promise<TGetConfigV2Response>;

package/dist/api/get-voice-api-v2-config.js

@@ -0,0 +1,26 @@
+import { SDK_STATUS_CODE } from '../constants/constant';
+import fetchWrapper from '../fetch-client';
+import { GET_EKA_V2RX_HOST_V2 } from '../fetch-client/helper';
+export const getConfigV2 = async () => {
+    try {
+        const options = {
+            method: 'GET',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+        };
+        const response = await fetchWrapper(`${GET_EKA_V2RX_HOST_V2()}/config/`, options);
+        const res = await response.json();
+        return {
+            ...res,
+            code: response.status,
+        };
+    }
+    catch (error) {
+        console.log('Error in getConfigV2 api: ', error);
+        return {
+            code: SDK_STATUS_CODE.INTERNAL_SERVER_ERROR,
+            message: `Failed to fetch initial configurations, ${error}`,
+        };
+    }
+};

package/dist/api/get-voice-api-v2-status.d.ts

@@ -0,0 +1,51 @@
+export type TTemplateMessage = {
+    type: 'warning' | 'error';
+    code?: string;
+    msg: string;
+};
+export type TOutputSummary = {
+    template_id: string;
+    value?: string | null;
+    type: string;
+    name: string;
+    status: TTemplateStatus;
+    errors?: TTemplateMessage[];
+    warnings?: TTemplateMessage[];
+};
+export type TTemplateStatus = 'success' | 'partial_success' | 'failure';
+type TAdditionalData = {
+    doctor: {
+        _id: string;
+        profile: {
+            personal: {
+                name: {
+                    l: string;
+                    f: string;
+                };
+            };
+        };
+    };
+};
+type TApiResponse = {
+    data: {
+        output?: TOutputSummary[];
+        additional_data?: TAdditionalData;
+        meta_data?: {
+            total_resources?: number;
+            total_parsed_resources?: number;
+        };
+    };
+    error?: {
+        code: string;
+        msg: string;
+    };
+};
+export type TGetStatusResponse = {
+    response?: TApiResponse | null;
+    code: number;
+    message?: string;
+};
+export declare const getVoiceApiV2Status: ({ txnId, }: {
+    txnId: string;
+}) => Promise<TGetStatusResponse>;
+export {};

package/dist/api/get-voice-api-v2-status.js

@@ -0,0 +1,25 @@
+import { SDK_STATUS_CODE } from '../constants/constant';
+import fetchWrapper from '../fetch-client';
+import { GET_EKA_V2RX_HOST_V3 } from '../fetch-client/helper';
+export const getVoiceApiV2Status = async ({ txnId, }) => {
+    try {
+        const headers = new Headers();
+        headers.append('Content-Type', 'application/json');
+        const options = {
+            method: 'GET',
+            headers,
+        };
+        const getResponse = await fetchWrapper(`${GET_EKA_V2RX_HOST_V3()}/status/${txnId}`, options);
+        const response = await getResponse.json();
+        return {
+            response,
+            code: getResponse.status,
+        };
+    }
+    catch (error) {
+        return {
+            code: SDK_STATUS_CODE.INTERNAL_SERVER_ERROR,
+            message: `Something went wrong! ${error}`,
+        };
+    }
+};

package/dist/api/get-voice-api-v3-status.d.ts

@@ -0,0 +1,51 @@
+export type TTemplateMessage = {
+    type: 'warning' | 'error';
+    code?: string;
+    msg: string;
+};
+export type TOutputSummary = {
+    template_id: string;
+    value?: string | null;
+    type: string;
+    name: string;
+    status: TTemplateStatus;
+    errors?: TTemplateMessage[];
+    warnings?: TTemplateMessage[];
+};
+export type TTemplateStatus = 'success' | 'partial_success' | 'failure';
+type TAdditionalData = {
+    doctor: {
+        _id: string;
+        profile: {
+            personal: {
+                name: {
+                    l: string;
+                    f: string;
+                };
+            };
+        };
+    };
+};
+type TApiResponse = {
+    data: {
+        output?: TOutputSummary[];
+        additional_data?: TAdditionalData;
+        meta_data?: {
+            total_resources?: number;
+            total_parsed_resources?: number;
+        };
+    };
+    error?: {
+        code: string;
+        msg: string;
+    };
+};
+export type TGetStatusResponse = {
+    response?: TApiResponse | null;
+    status_code: number;
+    message?: string;
+};
+export declare const getVoiceApiV3Status: ({ txnId, }: {
+    txnId: string;
+}) => Promise<TGetStatusResponse>;
+export {};

package/dist/api/get-voice-api-v3-status.js

@@ -0,0 +1,26 @@
+import { SDK_STATUS_CODE } from '../constants/constant';
+import fetchWrapper from '../fetch-client';
+import { GET_EKA_V2RX_HOST_V3 } from '../fetch-client/helper';
+export const getVoiceApiV3Status = async ({ txnId, }) => {
+    try {
+        const headers = new Headers();
+        headers.append('Content-Type', 'application/json');
+        const options = {
+            method: 'GET',
+            headers,
+        };
+        // Use custom timeout for this API (16 seconds instead of default 5 seconds)
+        const getResponse = await fetchWrapper(`${GET_EKA_V2RX_HOST_V3()}/status/${txnId}`, options, 16000);
+        const response = await getResponse.json();
+        return {
+            response,
+            status_code: getResponse.status,
+        };
+    }
+    catch (error) {
+        return {
+            status_code: SDK_STATUS_CODE.INTERNAL_SERVER_ERROR,
+            message: `Something went wrong! ${error}`,
+        };
+    }
+};

package/dist/api/patch-transaction-status.d.ts

@@ -0,0 +1,4 @@
+import { TPatchTransactionError, TPatchTransactionRequest, TPostTransactionResponse } from '../constants/types';
+export declare const processingError: TPatchTransactionError;
+declare const patchTransactionStatus: ({ sessionId, processing_status, processing_error, }: TPatchTransactionRequest) => Promise<TPostTransactionResponse>;
+export default patchTransactionStatus;

package/dist/api/patch-transaction-status.js

@@ -0,0 +1,43 @@
+import { SDK_STATUS_CODE } from '../constants/constant';
+import fetchWrapper from '../fetch-client';
+import { GET_EKA_V2RX_HOST_V2 } from '../fetch-client/helper';
+export const processingError = {
+    error: {
+        type: '',
+        code: 'cancelled_by_user',
+        msg: 'Cancelled_by_user',
+    },
+};
+const patchTransactionStatus = async ({ sessionId, processing_status, processing_error, }) => {
+    try {
+        const headers = new Headers();
+        headers.append('Content-Type', 'application/json');
+        const raw = {
+            processing_status,
+            processing_error,
+        };
+        const options = {
+            method: 'PATCH',
+            headers,
+            body: JSON.stringify(raw),
+        };
+        const response = await fetchWrapper(`${GET_EKA_V2RX_HOST_V2()}/transaction/${sessionId}`, options);
+        if (!response.ok) {
+            throw new Error(`Error: ${response.statusText}`);
+        }
+        let res = await response.json();
+        res = {
+            ...res,
+            code: response.status,
+        };
+        return res;
+    }
+    catch (error) {
+        console.error('Patch transaction status api failed', error);
+        return {
+            code: SDK_STATUS_CODE.INTERNAL_SERVER_ERROR,
+            message: `Something went wrong! ${error}`,
+        };
+    }
+};
+export default patchTransactionStatus;