med-scribe-alliance-ts-sdk 1.0.13 → 2.0.0

package/dist/audio/audio-buffer-manager.d.ts

@@ -1,3 +1,13 @@
+/**
+ * AudioBufferManager — accumulates audio frames into a growable Float32Array buffer.
+ *
+ * Responsibilities:
+ * - Append incoming audio frames from VAD
+ * - Track sample count, frame count, and duration
+ * - Provide the accumulated audio data for chunk processing
+ * - Calculate chunk timestamps based on raw sample position
+ * - Reset buffer state after a chunk is clipped (without re-allocating)
+ */
 export declare class AudioBufferManager {
     private buffer;
     private currentSampleLength;
@@ -5,49 +15,46 @@ export declare class AudioBufferManager {
     private samplingRate;
     private incrementalAllocationSize;
     /**
-     * Class that creates an audio buffer to store frame data
      * @param samplingRate - The sampling rate of the audio in Hz
      * @param allocationTimeInSeconds - The size of each incremental allocation in seconds
      */
     constructor(samplingRate: number, allocationTimeInSeconds: number);
     /**
-     * Append audio frame to the buffer
-     * @param audioFrame - Float32Array containing audio samples to append
-     * @returns The current position in the buffer after appending
+     * Append an audio frame to the buffer.
+     * Expands the buffer if needed.
      */
     append(audioFrame: Float32Array): number;
     /**
-     * Get the current audio data as a Float32Array
+     * Get the current audio data as a new Float32Array (copy, not reference).
      */
     getAudioData(): Float32Array;
-    /**
-     * Get the current length of audio data in samples
-     * @returns The number of samples currently in the buffer
-     */
     getCurrentSampleLength(): number;
-    /**
-     * Get the current length of audio data in samples
-     * @returns The number of samples currently in the buffer
-     */
     getCurrentFrameLength(): number;
     /**
-     * Get the current length of audio data in seconds
-     * @returns The duration of audio currently in the buffer in seconds
+     * Get the current duration of buffered audio in seconds.
      */
     getDurationInSeconds(): number;
     /**
-     * Expand the buffer by allocating a new block of memory
-     * @private
-     */
-    private expandBuffer;
-    /**
-     * Calculate timestamps for an audio chunk
+     * Calculate timestamps for the current chunk relative to the overall recording.
+     *
+     * @param totalRawSamples - Total raw samples received since recording started
+     * @returns start and end timestamps formatted as MM:SS.ffffff
      */
-    calculateChunkTimestamps(rawSamplesLength: number): {
+    calculateChunkTimestamps(totalRawSamples: number): {
         start: string;
         end: string;
     };
+    /**
+     * Reset sample/frame counters without re-allocating the buffer.
+     * Called after a chunk is clipped and sent for processing.
+     */
     resetBufferState(): void;
-    resetBufferManagerInstance(): void;
+    /**
+     * Full reset — re-allocates buffer memory.
+     * Called when recording is completely stopped/reset.
+     */
+    resetInstance(): void;
+    private expandBuffer;
+    private formatTimestamp;
 }
 //# sourceMappingURL=audio-buffer-manager.d.ts.map

package/dist/audio/audio-buffer-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"audio-buffer-manager.d.ts","sourceRoot":"","sources":["../../src/audio/audio-buffer-manager.ts"],"names":[],"mappings":"AAEA,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,MAAM,CAAgB;IAC9B,OAAO,CAAC,mBAAmB,CAAa;IACxC,OAAO,CAAC,kBAAkB,CAAa;IACvC,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,yBAAyB,CAAa;IAE9C;;;;OAIG;gBACS,YAAY,EAAE,MAAM,EAAE,uBAAuB,EAAE,MAAM;IAWjE;;;;OAIG;IACI,MAAM,CAAC,UAAU,EAAE,YAAY,GAAG,MAAM;IAc/C;;OAEG;IACI,YAAY,IAAI,YAAY;IAInC;;;OAGG;IACI,sBAAsB,IAAI,MAAM;IAIvC;;;OAGG;IACI,qBAAqB,IAAI,MAAM;IAItC;;;OAGG;IACI,oBAAoB,IAAI,MAAM;IAIrC;;;OAGG;IACH,OAAO,CAAC,YAAY;IAWpB;;OAEG;IACH,wBAAwB,CAAC,gBAAgB,EAAE,MAAM,GAAG;QAClD,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;KACb;IAyBM,gBAAgB;IAMhB,0BAA0B;CAKlC"}
+{"version":3,"file":"audio-buffer-manager.d.ts","sourceRoot":"","sources":["../../src/audio/audio-buffer-manager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,mBAAmB,CAAa;IACxC,OAAO,CAAC,kBAAkB,CAAa;IACvC,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,yBAAyB,CAAS;IAE1C;;;OAGG;gBACS,YAAY,EAAE,MAAM,EAAE,uBAAuB,EAAE,MAAM;IAMjE;;;OAGG;IACH,MAAM,CAAC,UAAU,EAAE,YAAY,GAAG,MAAM;IAiBxC;;OAEG;IACH,YAAY,IAAI,YAAY;IAI5B,sBAAsB,IAAI,MAAM;IAIhC,qBAAqB,IAAI,MAAM;IAI/B;;OAEG;IACH,oBAAoB,IAAI,MAAM;IAI9B;;;;;OAKG;IACH,wBAAwB,CAAC,eAAe,EAAE,MAAM,GAAG;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE;IAgBjF;;;OAGG;IACH,gBAAgB,IAAI,IAAI;IAKxB;;;OAGG;IACH,aAAa,IAAI,IAAI;IAMrB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,eAAe;CAKxB"}

package/dist/audio/audio-buffer-manager.js

@@ -1,109 +1,109 @@
-import { SAMPLING_RATE } from './constants';
+/**
+ * AudioBufferManager — accumulates audio frames into a growable Float32Array buffer.
+ *
+ * Responsibilities:
+ * - Append incoming audio frames from VAD
+ * - Track sample count, frame count, and duration
+ * - Provide the accumulated audio data for chunk processing
+ * - Calculate chunk timestamps based on raw sample position
+ * - Reset buffer state after a chunk is clipped (without re-allocating)
+ */
 export class AudioBufferManager {
     /**
-     * Class that creates an audio buffer to store frame data
      * @param samplingRate - The sampling rate of the audio in Hz
      * @param allocationTimeInSeconds - The size of each incremental allocation in seconds
      */
     constructor(samplingRate, allocationTimeInSeconds) {
         this.currentSampleLength = 0;
         this.currentFrameLength = 0;
-        this.samplingRate = 0;
-        this.incrementalAllocationSize = 0;
         this.samplingRate = samplingRate;
-        // Calculate the size of each incremental allocation in samples
         this.incrementalAllocationSize = Math.floor(samplingRate * allocationTimeInSeconds);
-        // Initialize buffer with the first allocation block
         this.buffer = new Float32Array(this.incrementalAllocationSize);
-        this.currentSampleLength = 0;
     }
     /**
-     * Append audio frame to the buffer
-     * @param audioFrame - Float32Array containing audio samples to append
-     * @returns The current position in the buffer after appending
+     * Append an audio frame to the buffer.
+     * Expands the buffer if needed.
      */
     append(audioFrame) {
-        // Check if we need to allocate more memory
-        if (this.currentSampleLength + audioFrame.length > this.buffer.length) {
-            this.expandBuffer();
+        try {
+            if (this.currentSampleLength + audioFrame.length > this.buffer.length) {
+                this.expandBuffer();
+            }
+            this.buffer.set(audioFrame, this.currentSampleLength);
+            this.currentSampleLength += audioFrame.length;
+            this.currentFrameLength += 1;
+            return this.currentSampleLength;
+        }
+        catch (error) {
+            console.error('[ScribeSDK] Error appending audio frame:', error);
+            return this.currentSampleLength;
         }
-        // Copy the new frame into the buffer
-        this.buffer.set(audioFrame, this.currentSampleLength);
-        this.currentSampleLength += audioFrame.length; // for 1 frame increase by 1024
-        this.currentFrameLength += 1; // for 1 frame increase by 1
-        return this.currentSampleLength;
     }
     /**
-     * Get the current audio data as a Float32Array
+     * Get the current audio data as a new Float32Array (copy, not reference).
      */
     getAudioData() {
         return this.buffer.slice(0, this.currentSampleLength);
     }
-    /**
-     * Get the current length of audio data in samples
-     * @returns The number of samples currently in the buffer
-     */
     getCurrentSampleLength() {
         return this.currentSampleLength;
     }
-    /**
-     * Get the current length of audio data in samples
-     * @returns The number of samples currently in the buffer
-     */
     getCurrentFrameLength() {
         return this.currentFrameLength;
     }
     /**
-     * Get the current length of audio data in seconds
-     * @returns The duration of audio currently in the buffer in seconds
+     * Get the current duration of buffered audio in seconds.
      */
     getDurationInSeconds() {
         return this.currentSampleLength / this.samplingRate;
     }
     /**
-     * Expand the buffer by allocating a new block of memory
-     * @private
+     * Calculate timestamps for the current chunk relative to the overall recording.
+     *
+     * @param totalRawSamples - Total raw samples received since recording started
+     * @returns start and end timestamps formatted as MM:SS.ffffff
      */
-    expandBuffer() {
-        const newSize = this.buffer.length + this.incrementalAllocationSize;
-        const newBuffer = new Float32Array(newSize);
-        // Copy existing data to the new buffer
-        newBuffer.set(this.buffer, 0);
-        // Replace old buffer with new one
-        this.buffer = newBuffer;
+    calculateChunkTimestamps(totalRawSamples) {
+        try {
+            const chunkDuration = this.getDurationInSeconds();
+            const endSeconds = totalRawSamples / this.samplingRate;
+            const startSeconds = endSeconds - chunkDuration;
+            return {
+                start: this.formatTimestamp(Math.max(0, startSeconds)),
+                end: this.formatTimestamp(endSeconds),
+            };
+        }
+        catch (error) {
+            console.error('[ScribeSDK] Error calculating chunk timestamps:', error);
+            return { start: '00:00.000000', end: '00:00.000000' };
+        }
     }
     /**
-     * Calculate timestamps for an audio chunk
+     * Reset sample/frame counters without re-allocating the buffer.
+     * Called after a chunk is clipped and sent for processing.
      */
-    calculateChunkTimestamps(rawSamplesLength) {
-        const start = rawSamplesLength / SAMPLING_RATE - this.getDurationInSeconds();
-        const end = start + this.getDurationInSeconds();
-        // Format start time as MM:SS.ffffff
-        const startMinutes = Math.floor(start / 60)
-            .toString()
-            .padStart(2, '0');
-        const startSeconds = (start % 60).toFixed(6).toString().padStart(2, '0');
-        const formattedStartTime = `${startMinutes}:${startSeconds}`;
-        // Format end time as MM:SS.ffffff
-        const endMinutes = Math.floor(end / 60)
-            .toString()
-            .padStart(2, '0');
-        const endSeconds = (end % 60).toFixed(6).toString().padStart(2, '0');
-        const formattedEndTime = `${endMinutes}:${endSeconds}`;
-        // Return timestamp object
-        return {
-            start: formattedStartTime,
-            end: formattedEndTime,
-        };
-    }
     resetBufferState() {
-        // Zero out the existing buffer instead of allocating new memory
         this.currentSampleLength = 0;
         this.currentFrameLength = 0;
     }
-    resetBufferManagerInstance() {
+    /**
+     * Full reset — re-allocates buffer memory.
+     * Called when recording is completely stopped/reset.
+     */
+    resetInstance() {
         this.buffer = new Float32Array(this.incrementalAllocationSize);
         this.currentSampleLength = 0;
         this.currentFrameLength = 0;
     }
+    expandBuffer() {
+        const newSize = this.buffer.length + this.incrementalAllocationSize;
+        const newBuffer = new Float32Array(newSize);
+        newBuffer.set(this.buffer, 0);
+        this.buffer = newBuffer;
+    }
+    formatTimestamp(seconds) {
+        const minutes = Math.floor(seconds / 60).toString().padStart(2, '0');
+        const secs = (seconds % 60).toFixed(6).padStart(9, '0');
+        return `${minutes}:${secs}`;
+    }
 }

package/dist/audio/audio-file-manager.d.ts

@@ -1,48 +1,85 @@
-import { TAudioChunksInfo, UploadProgressCallback } from './types';
-type TUploadAudioChunkParams = {
-    audioFrames: Float32Array;
-    fileName: string;
-    chunkIndex: number;
-};
+/**
+ * AudioFileManager — tracks audio chunk metadata throughout a recording session.
+ *
+ * Responsibilities:
+ * - Track chunk metadata (fileName, timestamps, status)
+ * - Track total raw samples/frames received from VAD
+ * - Track total inserted samples/frames (committed to chunks)
+ * - Mark chunks as success/failure after upload
+ * - Provide lists of successful/failed uploads
+ *
+ * This class does NOT handle upload logic — that's delegated to WorkerManager.
+ * File naming follows the protocol spec: audio_{sequence_number}.{extension}
+ */
+import { AudioChunkInfo } from '../types';
 export declare class AudioFileManager {
-    audioChunks: TAudioChunksInfo[];
-    private uploadPromises;
+    private chunks;
     private successfulUploads;
     private totalRawSamples;
     private totalRawFrames;
     private totalInsertedSamples;
     private totalInsertedFrames;
-    private sessionId;
-    private uploadUrl;
-    private uploadHeaders?;
-    private onUploadProgress?;
-    initialiseClassInstance(): void;
-    constructor();
-    setSessionInfo({ sessionId, uploadUrl, uploadHeaders, }: {
-        sessionId: string;
-        uploadUrl: string;
-        uploadHeaders?: Record<string, string>;
-    }): void;
-    setUploadProgressCallback(callback: UploadProgressCallback): void;
+    /**
+     * Track raw samples received from VAD (before chunking).
+     */
+    incrementRawSamples(frame: Float32Array): void;
+    /**
+     * Track samples/frames committed to a chunk.
+     */
+    incrementInsertedSamples(samples: number, frames: number): void;
     getRawSampleDetails(): {
         totalRawSamples: number;
         totalRawFrames: number;
     };
-    incrementTotalRawSamples(frames: Float32Array): void;
-    incrementInsertedSamples(samples: number, frames: number): void;
     getInsertedSampleDetails(): {
         totalInsertedSamples: number;
         totalInsertedFrames: number;
     };
-    updateAudioInfo(audioChunks: TAudioChunksInfo): number;
-    uploadAudio({ audioFrames, fileName, chunkIndex }: TUploadAudioChunkParams): Promise<void>;
-    private uploadAudioChunkInMain;
-    waitForAllUploads(): Promise<void>;
+    /**
+     * Generate the next chunk file name per protocol spec.
+     * Format: audio_{sequence_number}.{extension} (1-based index)
+     */
+    getNextFileName(): string;
+    /**
+     * Add a new chunk to the tracking list.
+     * Returns the chunk index (zero-based).
+     */
+    addChunk(chunk: AudioChunkInfo): number;
+    /**
+     * Mark a chunk as successfully uploaded.
+     */
+    markSuccess(chunkIndex: number, response?: string): void;
+    /**
+     * Mark a chunk as failed upload. Stores the blob for potential retry.
+     */
+    markFailure(chunkIndex: number, fileBlob: Blob, errorMessage?: string): void;
+    /**
+     * Get all chunks.
+     */
+    getChunks(): AudioChunkInfo[];
+    /**
+     * Get the total number of chunks.
+     */
+    getChunkCount(): number;
+    /**
+     * Get list of successfully uploaded file names.
+     */
     getSuccessfulUploads(): string[];
+    /**
+     * Get list of file names that failed to upload.
+     */
     getFailedUploads(): string[];
-    getTotalAudioChunks(): TAudioChunksInfo[];
-    retryFailedUploads(): Promise<string[]>;
-    resetFileManagerInstance(): void;
+    /**
+     * Get chunks that are in failure state (have blobs for retry).
+     */
+    getFailedChunksWithBlobs(): Array<{
+        chunkIndex: number;
+        fileName: string;
+        fileBlob: Blob;
+    }>;
+    /**
+     * Full reset — clears all state.
+     */
+    resetInstance(): void;
 }
-export {};
 //# sourceMappingURL=audio-file-manager.d.ts.map

package/dist/audio/audio-file-manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"audio-file-manager.d.ts","sourceRoot":"","sources":["../../src/audio/audio-file-manager.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AAInE,KAAK,uBAAuB,GAAG;IAC7B,WAAW,EAAE,YAAY,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,qBAAa,gBAAgB;IACpB,WAAW,EAAE,gBAAgB,EAAE,CAAM;IAC5C,OAAO,CAAC,cAAc,CAAsB;IAC5C,OAAO,CAAC,iBAAiB,CAAgB;IACzC,OAAO,CAAC,eAAe,CAAa;IACpC,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,oBAAoB,CAAa;IACzC,OAAO,CAAC,mBAAmB,CAAa;IAExC,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,aAAa,CAAC,CAAyB;IAG/C,OAAO,CAAC,gBAAgB,CAAC,CAAyB;IAElD,uBAAuB;;IAcvB,cAAc,CAAC,EACb,SAAS,EACT,SAAS,EACT,aAAa,GACd,EAAE;QACD,SAAS,EAAE,MAAM,CAAC;QAClB,SAAS,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACxC;IAMD,yBAAyB,CAAC,QAAQ,EAAE,sBAAsB;IAI1D,mBAAmB,IAAI;QACrB,eAAe,EAAE,MAAM,CAAC;QACxB,cAAc,EAAE,MAAM,CAAC;KACxB;IAOD,wBAAwB,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI;IAKpD,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAK/D,wBAAwB,IAAI;QAC1B,oBAAoB,EAAE,MAAM,CAAC;QAC7B,mBAAmB,EAAE,MAAM,CAAC;KAC7B;IAOD,eAAe,CAAC,WAAW,EAAE,gBAAgB,GAAG,MAAM;IAKhD,WAAW,CAAC,EAAE,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,EAAE,uBAAuB;YAMlE,sBAAsB;IA+D9B,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxC,oBAAoB,IAAI,MAAM,EAAE;IAIhC,gBAAgB,IAAI,MAAM,EAAE;IAU5B,mBAAmB,IAAI,gBAAgB,EAAE;IAInC,kBAAkB,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAsD7C,wBAAwB,IAAI,IAAI;CAQjC"}
+{"version":3,"file":"audio-file-manager.d.ts","sourceRoot":"","sources":["../../src/audio/audio-file-manager.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAG1C,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,iBAAiB,CAAgB;IACzC,OAAO,CAAC,eAAe,CAAa;IACpC,OAAO,CAAC,cAAc,CAAa;IACnC,OAAO,CAAC,oBAAoB,CAAa;IACzC,OAAO,CAAC,mBAAmB,CAAa;IAExC;;OAEG;IACH,mBAAmB,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI;IAK9C;;OAEG;IACH,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAK/D,mBAAmB,IAAI;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE;IAO1E,wBAAwB,IAAI;QAAE,oBAAoB,EAAE,MAAM,CAAC;QAAC,mBAAmB,EAAE,MAAM,CAAA;KAAE;IAOzF;;;OAGG;IACH,eAAe,IAAI,MAAM;IAKzB;;;OAGG;IACH,QAAQ,CAAC,KAAK,EAAE,cAAc,GAAG,MAAM;IAKvC;;OAEG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IAsBxD;;OAEG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI;IAmB5E;;OAEG;IACH,SAAS,IAAI,cAAc,EAAE;IAI7B;;OAEG;IACH,aAAa,IAAI,MAAM;IAIvB;;OAEG;IACH,oBAAoB,IAAI,MAAM,EAAE;IAIhC;;OAEG;IACH,gBAAgB,IAAI,MAAM,EAAE;IAM5B;;OAEG;IACH,wBAAwB,IAAI,KAAK,CAAC;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,IAAI,CAAA;KAAE,CAAC;IAU3F;;OAEG;IACH,aAAa,IAAI,IAAI;CAQtB"}