@independo/capacitor-voice-recorder 8.0.2-dev.1 → 8.1.0-dev.2

package/dist/docs.json

@@ -115,7 +115,7 @@
             "text": "Error with one of the specified error codes if the recording cannot be stopped."
           }
         ],
-        "docs": "Stops audio recording.\nWill stop the recording that has been previously started.\nIf the function `startRecording` has not been called beforehand, the promise will reject with `RECORDING_HAS_NOT_STARTED`.\nIf the recording has been stopped immediately after it has been started, the promise will reject with `EMPTY_RECORDING`.\nIn a case of unknown error, the promise will reject with `FAILED_TO_FETCH_RECORDING`.\nIn case of success, the promise resolves to RecordingData containing the recording in base-64, the duration of the recording in milliseconds, and the MIME type.",
+        "docs": "Stops audio recording.\nWill stop the recording that has been previously started.\nIf the function `startRecording` has not been called beforehand, the promise will reject with `RECORDING_HAS_NOT_STARTED`.\nIf the recording has been stopped immediately after it has been started, the promise will reject with `EMPTY_RECORDING`.\nIn a case of unknown error, the promise will reject with `FAILED_TO_FETCH_RECORDING`.\nOn iOS, if a recording interrupted by the system cannot be merged, the promise will reject with `FAILED_TO_MERGE_RECORDING`.\nIn case of success, the promise resolves to RecordingData containing the recording in base-64, the duration of the recording in milliseconds, and the MIME type.",
         "complexTypes": [
           "RecordingData"
         ],
@@ -157,7 +157,7 @@
             "text": "Error with one of the specified error codes if the recording cannot be resumed."
           }
         ],
-        "docs": "Resumes a paused audio recording.\nIf the recording has not started yet, the promise will reject with an error code `RECORDING_HAS_NOT_STARTED`.\nOn success, the promise will resolve to { value: true } if the resume was successful or { value: false } if the recording is already running.\nOn certain mobile OS versions, this function is not supported and will reject with `NOT_SUPPORTED_OS_VERSION`.",
+        "docs": "Resumes a paused or interrupted audio recording.\nIf the recording has not started yet, the promise will reject with an error code `RECORDING_HAS_NOT_STARTED`.\nOn success, the promise will resolve to { value: true } if the resume was successful or { value: false } if the recording is already running.\nOn certain mobile OS versions, this function is not supported and will reject with `NOT_SUPPORTED_OS_VERSION`.",
         "complexTypes": [
           "GenericResponse"
         ],
@@ -178,11 +178,95 @@
             "text": "Error if the status cannot be fetched."
           }
         ],
-        "docs": "Gets the current status of the voice recorder.\nWill resolve with one of the following values:\n`{ status: \"NONE\" }` if the plugin is idle and waiting to start a new recording.\n`{ status: \"RECORDING\" }` if the plugin is in the middle of recording.\n`{ status: \"PAUSED\" }` if the recording is paused.",
+        "docs": "Gets the current status of the voice recorder.\nWill resolve with one of the following values:\n`{ status: \"NONE\" }` if the plugin is idle and waiting to start a new recording.\n`{ status: \"RECORDING\" }` if the plugin is in the middle of recording.\n`{ status: \"PAUSED\" }` if the recording is paused.\n`{ status: \"INTERRUPTED\" }` if the recording was paused due to a system interruption.",
         "complexTypes": [
           "CurrentRecordingStatus"
         ],
         "slug": "getcurrentstatus"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'voiceRecordingInterrupted', listenerFunc: (event: VoiceRecordingInterruptedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "The name of the event to listen for.",
+            "type": "'voiceRecordingInterrupted'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "The callback function to invoke when the event occurs.",
+            "type": "(event: VoiceRecordingInterruptedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName The name of the event to listen for."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc The callback function to invoke when the event occurs."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves to a PluginListenerHandle."
+          }
+        ],
+        "docs": "Listen for audio recording interruptions (e.g., phone calls, other apps using microphone).\nAvailable on iOS and Android only.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "VoiceRecordingInterruptedEvent"
+        ],
+        "slug": "addlistenervoicerecordinginterrupted-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'voiceRecordingInterruptionEnded', listenerFunc: (event: VoiceRecordingInterruptionEndedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "The name of the event to listen for.",
+            "type": "'voiceRecordingInterruptionEnded'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "The callback function to invoke when the event occurs.",
+            "type": "(event: VoiceRecordingInterruptionEndedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName The name of the event to listen for."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc The callback function to invoke when the event occurs."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves to a PluginListenerHandle."
+          }
+        ],
+        "docs": "Listen for audio recording interruption end events.\nAvailable on iOS and Android only.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "VoiceRecordingInterruptionEndedEvent"
+        ],
+        "slug": "addlistenervoicerecordinginterruptionended-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
       }
     ],
     "properties": []
@@ -262,9 +346,25 @@
         {
           "name": "status",
           "tags": [],
-          "docs": "The current status of the recorder, which can be one of the following values: 'RECORDING', 'PAUSED', 'NONE'.",
+          "docs": "The current status of the recorder, which can be one of the following values: 'RECORDING', 'PAUSED', 'INTERRUPTED', 'NONE'.",
           "complexTypes": [],
-          "type": "'NONE' | 'RECORDING' | 'PAUSED'"
+          "type": "'NONE' | 'RECORDING' | 'PAUSED' | 'INTERRUPTED'"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
         }
       ]
     }
@@ -387,6 +487,46 @@
           "complexTypes": []
         }
       ]
+    },
+    {
+      "name": "VoiceRecordingInterruptedEvent",
+      "slug": "voicerecordinginterruptedevent",
+      "docs": "Event payload for voiceRecordingInterrupted event (empty - no data).",
+      "types": [
+        {
+          "text": "Record<string, never>",
+          "complexTypes": [
+            "Record"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "Record",
+      "slug": "record",
+      "docs": "Construct a type with a set of properties K of type T",
+      "types": [
+        {
+          "text": "{\r\n    [P in K]: T;\r\n}",
+          "complexTypes": [
+            "K",
+            "T"
+          ]
+        }
+      ]
+    },
+    {
+      "name": "VoiceRecordingInterruptionEndedEvent",
+      "slug": "voicerecordinginterruptionendedevent",
+      "docs": "Event payload for voiceRecordingInterruptionEnded event (empty - no data).",
+      "types": [
+        {
+          "text": "Record<string, never>",
+          "complexTypes": [
+            "Record"
+          ]
+        }
+      ]
     }
   ],
   "pluginConfigs": []

package/dist/esm/adapters/VoiceRecorderWebAdapter.d.ts

@@ -0,0 +1,23 @@
+import type { CurrentRecordingStatus, GenericResponse, RecordingData, RecordingOptions } from '../definitions';
+import type { VoiceRecorderPlatform } from '../service/VoiceRecorderService';
+/** Web adapter that delegates to the browser-specific implementation. */
+export declare class VoiceRecorderWebAdapter implements VoiceRecorderPlatform {
+    /** Browser implementation that talks to MediaRecorder APIs. */
+    private readonly voiceRecorderImpl;
+    /** Checks whether the browser can record audio. */
+    canDeviceVoiceRecord(): Promise<GenericResponse>;
+    /** Returns whether the browser has microphone permission. */
+    hasAudioRecordingPermission(): Promise<GenericResponse>;
+    /** Requests microphone permission through the browser. */
+    requestAudioRecordingPermission(): Promise<GenericResponse>;
+    /** Starts a recording session using MediaRecorder. */
+    startRecording(options?: RecordingOptions): Promise<GenericResponse>;
+    /** Stops the recording session and returns the payload. */
+    stopRecording(): Promise<RecordingData>;
+    /** Pauses the recording session when supported. */
+    pauseRecording(): Promise<GenericResponse>;
+    /** Resumes a paused recording session when supported. */
+    resumeRecording(): Promise<GenericResponse>;
+    /** Returns the current recording state. */
+    getCurrentStatus(): Promise<CurrentRecordingStatus>;
+}

package/dist/esm/adapters/VoiceRecorderWebAdapter.js

@@ -0,0 +1,41 @@
+import { VoiceRecorderImpl } from '../platform/web/VoiceRecorderImpl';
+/** Web adapter that delegates to the browser-specific implementation. */
+export class VoiceRecorderWebAdapter {
+    constructor() {
+        /** Browser implementation that talks to MediaRecorder APIs. */
+        this.voiceRecorderImpl = new VoiceRecorderImpl();
+    }
+    /** Checks whether the browser can record audio. */
+    canDeviceVoiceRecord() {
+        return VoiceRecorderImpl.canDeviceVoiceRecord();
+    }
+    /** Returns whether the browser has microphone permission. */
+    hasAudioRecordingPermission() {
+        return VoiceRecorderImpl.hasAudioRecordingPermission();
+    }
+    /** Requests microphone permission through the browser. */
+    requestAudioRecordingPermission() {
+        return VoiceRecorderImpl.requestAudioRecordingPermission();
+    }
+    /** Starts a recording session using MediaRecorder. */
+    startRecording(options) {
+        return this.voiceRecorderImpl.startRecording(options);
+    }
+    /** Stops the recording session and returns the payload. */
+    stopRecording() {
+        return this.voiceRecorderImpl.stopRecording();
+    }
+    /** Pauses the recording session when supported. */
+    pauseRecording() {
+        return this.voiceRecorderImpl.pauseRecording();
+    }
+    /** Resumes a paused recording session when supported. */
+    resumeRecording() {
+        return this.voiceRecorderImpl.resumeRecording();
+    }
+    /** Returns the current recording state. */
+    getCurrentStatus() {
+        return this.voiceRecorderImpl.getCurrentStatus();
+    }
+}
+//# sourceMappingURL=VoiceRecorderWebAdapter.js.map

package/dist/esm/adapters/VoiceRecorderWebAdapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VoiceRecorderWebAdapter.js","sourceRoot":"","sources":["../../../src/adapters/VoiceRecorderWebAdapter.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAC;AAGtE,yEAAyE;AACzE,MAAM,OAAO,uBAAuB;IAApC;QACI,+DAA+D;QAC9C,sBAAiB,GAAG,IAAI,iBAAiB,EAAE,CAAC;IAyCjE,CAAC;IAvCG,mDAAmD;IAC5C,oBAAoB;QACvB,OAAO,iBAAiB,CAAC,oBAAoB,EAAE,CAAC;IACpD,CAAC;IAED,6DAA6D;IACtD,2BAA2B;QAC9B,OAAO,iBAAiB,CAAC,2BAA2B,EAAE,CAAC;IAC3D,CAAC;IAED,0DAA0D;IACnD,+BAA+B;QAClC,OAAO,iBAAiB,CAAC,+BAA+B,EAAE,CAAC;IAC/D,CAAC;IAED,sDAAsD;IAC/C,cAAc,CAAC,OAA0B;QAC5C,OAAO,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED,2DAA2D;IACpD,aAAa;QAChB,OAAO,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,CAAC;IAClD,CAAC;IAED,mDAAmD;IAC5C,cAAc;QACjB,OAAO,IAAI,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;IACnD,CAAC;IAED,yDAAyD;IAClD,eAAe;QAClB,OAAO,IAAI,CAAC,iBAAiB,CAAC,eAAe,EAAE,CAAC;IACpD,CAAC;IAED,2CAA2C;IACpC,gBAAgB;QACnB,OAAO,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,EAAE,CAAC;IACrD,CAAC;CACJ","sourcesContent":["import type {\n    CurrentRecordingStatus,\n    GenericResponse,\n    RecordingData,\n    RecordingOptions,\n} from '../definitions';\nimport { VoiceRecorderImpl } from '../platform/web/VoiceRecorderImpl';\nimport type { VoiceRecorderPlatform } from '../service/VoiceRecorderService';\n\n/** Web adapter that delegates to the browser-specific implementation. */\nexport class VoiceRecorderWebAdapter implements VoiceRecorderPlatform {\n    /** Browser implementation that talks to MediaRecorder APIs. */\n    private readonly voiceRecorderImpl = new VoiceRecorderImpl();\n\n    /** Checks whether the browser can record audio. */\n    public canDeviceVoiceRecord(): Promise<GenericResponse> {\n        return VoiceRecorderImpl.canDeviceVoiceRecord();\n    }\n\n    /** Returns whether the browser has microphone permission. */\n    public hasAudioRecordingPermission(): Promise<GenericResponse> {\n        return VoiceRecorderImpl.hasAudioRecordingPermission();\n    }\n\n    /** Requests microphone permission through the browser. */\n    public requestAudioRecordingPermission(): Promise<GenericResponse> {\n        return VoiceRecorderImpl.requestAudioRecordingPermission();\n    }\n\n    /** Starts a recording session using MediaRecorder. */\n    public startRecording(options?: RecordingOptions): Promise<GenericResponse> {\n        return this.voiceRecorderImpl.startRecording(options);\n    }\n\n    /** Stops the recording session and returns the payload. */\n    public stopRecording(): Promise<RecordingData> {\n        return this.voiceRecorderImpl.stopRecording();\n    }\n\n    /** Pauses the recording session when supported. */\n    public pauseRecording(): Promise<GenericResponse> {\n        return this.voiceRecorderImpl.pauseRecording();\n    }\n\n    /** Resumes a paused recording session when supported. */\n    public resumeRecording(): Promise<GenericResponse> {\n        return this.voiceRecorderImpl.resumeRecording();\n    }\n\n    /** Returns the current recording state. */\n    public getCurrentStatus(): Promise<CurrentRecordingStatus> {\n        return this.voiceRecorderImpl.getCurrentStatus();\n    }\n}\n"]}

package/dist/esm/core/error-codes.d.ts

@@ -0,0 +1,4 @@
+/** Normalizes legacy error messages into canonical error codes. */
+export declare const toCanonicalErrorCode: (legacyMessage: string) => string;
+/** Adds a canonical `code` field to Error-like objects when possible. */
+export declare const attachCanonicalErrorCode: (error: unknown) => void;

package/dist/esm/core/error-codes.js

@@ -0,0 +1,21 @@
+/** Maps legacy error messages to canonical error codes. */
+const legacyToCanonical = {
+    CANNOT_RECORD_ON_THIS_PHONE: 'DEVICE_CANNOT_VOICE_RECORD',
+};
+/** Normalizes legacy error messages into canonical error codes. */
+export const toCanonicalErrorCode = (legacyMessage) => {
+    var _a;
+    return (_a = legacyToCanonical[legacyMessage]) !== null && _a !== void 0 ? _a : legacyMessage;
+};
+/** Adds a canonical `code` field to Error-like objects when possible. */
+export const attachCanonicalErrorCode = (error) => {
+    if (!error || typeof error !== 'object') {
+        return;
+    }
+    const messageValue = error.message;
+    if (typeof messageValue !== 'string') {
+        return;
+    }
+    error.code = toCanonicalErrorCode(messageValue);
+};
+//# sourceMappingURL=error-codes.js.map

package/dist/esm/core/error-codes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-codes.js","sourceRoot":"","sources":["../../../src/core/error-codes.ts"],"names":[],"mappings":"AAAA,2DAA2D;AAC3D,MAAM,iBAAiB,GAA2B;IAC9C,2BAA2B,EAAE,4BAA4B;CAC5D,CAAC;AAEF,mEAAmE;AACnE,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,aAAqB,EAAU,EAAE;;IAClE,OAAO,MAAA,iBAAiB,CAAC,aAAa,CAAC,mCAAI,aAAa,CAAC;AAC7D,CAAC,CAAC;AAEF,yEAAyE;AACzE,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,KAAc,EAAQ,EAAE;IAC7D,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACtC,OAAO;IACX,CAAC;IACD,MAAM,YAAY,GAAI,KAA+B,CAAC,OAAO,CAAC;IAC9D,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO;IACX,CAAC;IACA,KAA2B,CAAC,IAAI,GAAG,oBAAoB,CAAC,YAAY,CAAC,CAAC;AAC3E,CAAC,CAAC","sourcesContent":["/** Maps legacy error messages to canonical error codes. */\nconst legacyToCanonical: Record<string, string> = {\n    CANNOT_RECORD_ON_THIS_PHONE: 'DEVICE_CANNOT_VOICE_RECORD',\n};\n\n/** Normalizes legacy error messages into canonical error codes. */\nexport const toCanonicalErrorCode = (legacyMessage: string): string => {\n    return legacyToCanonical[legacyMessage] ?? legacyMessage;\n};\n\n/** Adds a canonical `code` field to Error-like objects when possible. */\nexport const attachCanonicalErrorCode = (error: unknown): void => {\n    if (!error || typeof error !== 'object') {\n        return;\n    }\n    const messageValue = (error as { message?: unknown }).message;\n    if (typeof messageValue !== 'string') {\n        return;\n    }\n    (error as { code?: string }).code = toCanonicalErrorCode(messageValue);\n};\n"]}

package/dist/esm/core/recording-contract.d.ts

@@ -0,0 +1,3 @@
+import type { RecordingData } from '../definitions';
+/** Normalizes recording payloads into a stable contract shape. */
+export declare const normalizeRecordingData: (data: RecordingData) => RecordingData;

package/dist/esm/core/recording-contract.js

@@ -0,0 +1,15 @@
+/** Normalizes recording payloads into a stable contract shape. */
+export const normalizeRecordingData = (data) => {
+    const { recordDataBase64, uri, msDuration, mimeType } = data.value;
+    const normalizedValue = { msDuration, mimeType };
+    const trimmedUri = typeof uri === 'string' && uri.length > 0 ? uri : undefined;
+    const trimmedBase64 = typeof recordDataBase64 === 'string' && recordDataBase64.length > 0 ? recordDataBase64 : undefined;
+    if (trimmedUri) {
+        normalizedValue.uri = trimmedUri;
+    }
+    else if (trimmedBase64) {
+        normalizedValue.recordDataBase64 = trimmedBase64;
+    }
+    return { value: normalizedValue };
+};
+//# sourceMappingURL=recording-contract.js.map

package/dist/esm/core/recording-contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recording-contract.js","sourceRoot":"","sources":["../../../src/core/recording-contract.ts"],"names":[],"mappings":"AAEA,kEAAkE;AAClE,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,IAAmB,EAAiB,EAAE;IACzE,MAAM,EAAE,gBAAgB,EAAE,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;IACnE,MAAM,eAAe,GAA4B,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC;IAC1E,MAAM,UAAU,GAAG,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;IAC/E,MAAM,aAAa,GAAG,OAAO,gBAAgB,KAAK,QAAQ,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,SAAS,CAAC;IAEzH,IAAI,UAAU,EAAE,CAAC;QACb,eAAe,CAAC,GAAG,GAAG,UAAU,CAAC;IACrC,CAAC;SAAM,IAAI,aAAa,EAAE,CAAC;QACvB,eAAe,CAAC,gBAAgB,GAAG,aAAa,CAAC;IACrD,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,eAAe,EAAmB,CAAC;AACvD,CAAC,CAAC","sourcesContent":["import type { RecordingData } from '../definitions';\n\n/** Normalizes recording payloads into a stable contract shape. */\nexport const normalizeRecordingData = (data: RecordingData): RecordingData => {\n    const { recordDataBase64, uri, msDuration, mimeType } = data.value;\n    const normalizedValue: Record<string, unknown> = { msDuration, mimeType };\n    const trimmedUri = typeof uri === 'string' && uri.length > 0 ? uri : undefined;\n    const trimmedBase64 = typeof recordDataBase64 === 'string' && recordDataBase64.length > 0 ? recordDataBase64 : undefined;\n\n    if (trimmedUri) {\n        normalizedValue.uri = trimmedUri;\n    } else if (trimmedBase64) {\n        normalizedValue.recordDataBase64 = trimmedBase64;\n    }\n\n    return { value: normalizedValue } as RecordingData;\n};\n"]}

package/dist/esm/core/response-format.d.ts

@@ -0,0 +1,8 @@
+/** Supported response shapes for plugin results. */
+export type ResponseFormat = 'legacy' | 'normalized';
+/** Default response shape when no config is provided. */
+export declare const DEFAULT_RESPONSE_FORMAT: ResponseFormat;
+/** Parses a user-provided response format into a supported value. */
+export declare const resolveResponseFormat: (value: unknown) => ResponseFormat;
+/** Reads the response format from a Capacitor plugin config object. */
+export declare const getResponseFormatFromConfig: (config: unknown) => ResponseFormat;

package/dist/esm/core/response-format.js

@@ -0,0 +1,17 @@
+/** Default response shape when no config is provided. */
+export const DEFAULT_RESPONSE_FORMAT = 'legacy';
+/** Parses a user-provided response format into a supported value. */
+export const resolveResponseFormat = (value) => {
+    if (typeof value === 'string' && value.toLowerCase() === 'normalized') {
+        return 'normalized';
+    }
+    return DEFAULT_RESPONSE_FORMAT;
+};
+/** Reads the response format from a Capacitor plugin config object. */
+export const getResponseFormatFromConfig = (config) => {
+    if (config && typeof config === 'object' && 'responseFormat' in config) {
+        return resolveResponseFormat(config.responseFormat);
+    }
+    return DEFAULT_RESPONSE_FORMAT;
+};
+//# sourceMappingURL=response-format.js.map

package/dist/esm/core/response-format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response-format.js","sourceRoot":"","sources":["../../../src/core/response-format.ts"],"names":[],"mappings":"AAGA,yDAAyD;AACzD,MAAM,CAAC,MAAM,uBAAuB,GAAmB,QAAQ,CAAC;AAEhE,qEAAqE;AACrE,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,KAAc,EAAkB,EAAE;IACpE,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,YAAY,EAAE,CAAC;QACpE,OAAO,YAAY,CAAC;IACxB,CAAC;IACD,OAAO,uBAAuB,CAAC;AACnC,CAAC,CAAC;AAEF,uEAAuE;AACvE,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,MAAe,EAAkB,EAAE;IAC3E,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,gBAAgB,IAAI,MAAM,EAAE,CAAC;QACrE,OAAO,qBAAqB,CAAE,MAAuC,CAAC,cAAc,CAAC,CAAC;IAC1F,CAAC;IACD,OAAO,uBAAuB,CAAC;AACnC,CAAC,CAAC","sourcesContent":["/** Supported response shapes for plugin results. */\nexport type ResponseFormat = 'legacy' | 'normalized';\n\n/** Default response shape when no config is provided. */\nexport const DEFAULT_RESPONSE_FORMAT: ResponseFormat = 'legacy';\n\n/** Parses a user-provided response format into a supported value. */\nexport const resolveResponseFormat = (value: unknown): ResponseFormat => {\n    if (typeof value === 'string' && value.toLowerCase() === 'normalized') {\n        return 'normalized';\n    }\n    return DEFAULT_RESPONSE_FORMAT;\n};\n\n/** Reads the response format from a Capacitor plugin config object. */\nexport const getResponseFormatFromConfig = (config: unknown): ResponseFormat => {\n    if (config && typeof config === 'object' && 'responseFormat' in config) {\n        return resolveResponseFormat((config as { responseFormat?: unknown }).responseFormat);\n    }\n    return DEFAULT_RESPONSE_FORMAT;\n};\n"]}

package/dist/esm/definitions.d.ts

@@ -1,3 +1,4 @@
+import type { PluginListenerHandle } from "@capacitor/core";
 import type { Directory } from "@capacitor/filesystem";
 /**
  * Represents a Base64 encoded string.
@@ -59,10 +60,18 @@ export interface GenericResponse {
  */
 export interface CurrentRecordingStatus {
     /**
-     * The current status of the recorder, which can be one of the following values: 'RECORDING', 'PAUSED', 'NONE'.
+     * The current status of the recorder, which can be one of the following values: 'RECORDING', 'PAUSED', 'INTERRUPTED', 'NONE'.
      */
-    status: 'RECORDING' | 'PAUSED' | 'NONE';
+    status: 'RECORDING' | 'PAUSED' | 'INTERRUPTED' | 'NONE';
 }
+/**
+ * Event payload for voiceRecordingInterrupted event (empty - no data).
+ */
+export type VoiceRecordingInterruptedEvent = Record<string, never>;
+/**
+ * Event payload for voiceRecordingInterruptionEnded event (empty - no data).
+ */
+export type VoiceRecordingInterruptionEndedEvent = Record<string, never>;
 /**
  * Interface for the VoiceRecorderPlugin which provides methods to record audio.
  */
@@ -110,6 +119,7 @@ export interface VoiceRecorderPlugin {
      * If the function `startRecording` has not been called beforehand, the promise will reject with `RECORDING_HAS_NOT_STARTED`.
      * If the recording has been stopped immediately after it has been started, the promise will reject with `EMPTY_RECORDING`.
      * In a case of unknown error, the promise will reject with `FAILED_TO_FETCH_RECORDING`.
+     * On iOS, if a recording interrupted by the system cannot be merged, the promise will reject with `FAILED_TO_MERGE_RECORDING`.
      * In case of success, the promise resolves to RecordingData containing the recording in base-64, the duration of the recording in milliseconds, and the MIME type.
      * @returns A promise that resolves to RecordingData.
      * @throws Error with one of the specified error codes if the recording cannot be stopped.
@@ -125,7 +135,7 @@ export interface VoiceRecorderPlugin {
      */
     pauseRecording(): Promise<GenericResponse>;
     /**
-     * Resumes a paused audio recording.
+     * Resumes a paused or interrupted audio recording.
      * If the recording has not started yet, the promise will reject with an error code `RECORDING_HAS_NOT_STARTED`.
      * On success, the promise will resolve to { value: true } if the resume was successful or { value: false } if the recording is already running.
      * On certain mobile OS versions, this function is not supported and will reject with `NOT_SUPPORTED_OS_VERSION`.
@@ -139,8 +149,31 @@ export interface VoiceRecorderPlugin {
      * `{ status: "NONE" }` if the plugin is idle and waiting to start a new recording.
      * `{ status: "RECORDING" }` if the plugin is in the middle of recording.
      * `{ status: "PAUSED" }` if the recording is paused.
+     * `{ status: "INTERRUPTED" }` if the recording was paused due to a system interruption.
      * @returns A promise that resolves to a CurrentRecordingStatus.
      * @throws Error if the status cannot be fetched.
      */
     getCurrentStatus(): Promise<CurrentRecordingStatus>;
+    /**
+     * Listen for audio recording interruptions (e.g., phone calls, other apps using microphone).
+     * Available on iOS and Android only.
+     *
+     * @param eventName The name of the event to listen for.
+     * @param listenerFunc The callback function to invoke when the event occurs.
+     * @returns A promise that resolves to a PluginListenerHandle.
+     */
+    addListener(eventName: 'voiceRecordingInterrupted', listenerFunc: (event: VoiceRecordingInterruptedEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Listen for audio recording interruption end events.
+     * Available on iOS and Android only.
+     *
+     * @param eventName The name of the event to listen for.
+     * @param listenerFunc The callback function to invoke when the event occurs.
+     * @returns A promise that resolves to a PluginListenerHandle.
+     */
+    addListener(eventName: 'voiceRecordingInterruptionEnded', listenerFunc: (event: VoiceRecordingInterruptionEndedEvent) => void): Promise<PluginListenerHandle>;
+    /**
+     * Remove all listeners for this plugin.
+     */
+    removeAllListeners(): Promise<void>;
 }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type {Directory} from \"@capacitor/filesystem\";\n\n/**\n * Represents a Base64 encoded string.\n */\nexport type Base64String = string;\n\n/**\n * Can be used to specify options for the recording.\n */\nexport interface RecordingOptions {\n    /**\n     * The capacitor filesystem directory where the recording should be saved.\n     *\n     * If not specified, the recording will be stored in a base64 string and returned in the `RecordingData` object.\n     * @see RecordingData\n     */\n    directory?: Directory;\n\n    /**\n     * An optional subdirectory in the specified directory where the recording should be saved.\n     */\n    subDirectory?: string;\n}\n\n/**\n * Interface representing the data of a recording.\n */\nexport interface RecordingData {\n    /**\n     * The value containing the recording details.\n     */\n    value: {\n        /**\n         * The recorded data as a Base64 encoded string.\n         */\n        recordDataBase64: Base64String;\n        /**\n         * The duration of the recording in milliseconds.\n         */\n        msDuration: number;\n        /**\n         * The MIME type of the recorded file.\n         */\n        mimeType: string;\n\n        /**\n         * The URI of the recording file.\n         */\n        uri?: string;\n    };\n}\n\n/**\n * Interface representing a generic response with a boolean value.\n */\nexport interface GenericResponse {\n    /**\n     * The result of the operation as a boolean value.\n     */\n    value: boolean;\n}\n\n/**\n * Interface representing the current status of the voice recorder.\n */\nexport interface CurrentRecordingStatus {\n    /**\n     * The current status of the recorder, which can be one of the following values: 'RECORDING', 'PAUSED', 'NONE'.\n     */\n    status: 'RECORDING' | 'PAUSED' | 'NONE';\n}\n\n/**\n * Interface for the VoiceRecorderPlugin which provides methods to record audio.\n */\nexport interface VoiceRecorderPlugin {\n    /**\n     * Checks if the current device can record audio.\n     * On mobile, this function will always resolve to `{ value: true }`.\n     * In a browser, it will resolve to `{ value: true }` or `{ value: false }` based on the browser's ability to record.\n     * This method does not take into account the permission status, only if the browser itself is capable of recording at all.\n     * @returns A promise that resolves to a GenericResponse.\n     * @throws Error with code \"COULD_NOT_QUERY_PERMISSION_STATUS\" if the device cannot query the permission status.\n     */\n    canDeviceVoiceRecord(): Promise<GenericResponse>;\n\n    /**\n     * Requests audio recording permission from the user.\n     * If the permission has already been provided, the promise will resolve with `{ value: true }`.\n     * Otherwise, the promise will resolve to `{ value: true }` or `{ value: false }` based on the user's response.\n     * @returns A promise that resolves to a GenericResponse.\n     * @throws Error if the permission request fails.\n     */\n    requestAudioRecordingPermission(): Promise<GenericResponse>;\n\n    /**\n     * Checks if audio recording permission has been granted.\n     * Will resolve to `{ value: true }` or `{ value: false }` based on the status of the permission.\n     * The web implementation of this plugin uses the Permissions API, which is not widespread.\n     * If the status of the permission cannot be checked, the promise will reject with `COULD_NOT_QUERY_PERMISSION_STATUS`.\n     * In that case, use `requestAudioRecordingPermission` or `startRecording` and capture any exception that is thrown.\n     * @returns A promise that resolves to a GenericResponse.\n     * @throws Error with code \"COULD_NOT_QUERY_PERMISSION_STATUS\" if the device cannot query the permission status.\n     */\n    hasAudioRecordingPermission(): Promise<GenericResponse>;\n\n    /**\n     * Starts audio recording.\n     * On success, the promise will resolve to { value: true }.\n     * On error, the promise will reject with one of the following error codes:\n     * \"MISSING_PERMISSION\", \"ALREADY_RECORDING\", \"MICROPHONE_BEING_USED\", \"DEVICE_CANNOT_VOICE_RECORD\", or \"FAILED_TO_RECORD\".\n     * @param options The options for the recording.\n     * @returns A promise that resolves to a GenericResponse.\n     * @throws Error with one of the specified error codes if the recording cannot be started.\n     */\n    startRecording(options?: RecordingOptions): Promise<GenericResponse>;\n\n    /**\n     * Stops audio recording.\n     * Will stop the recording that has been previously started.\n     * If the function `startRecording` has not been called beforehand, the promise will reject with `RECORDING_HAS_NOT_STARTED`.\n     * If the recording has been stopped immediately after it has been started, the promise will reject with `EMPTY_RECORDING`.\n     * In a case of unknown error, the promise will reject with `FAILED_TO_FETCH_RECORDING`.\n     * In case of success, the promise resolves to RecordingData containing the recording in base-64, the duration of the recording in milliseconds, and the MIME type.\n     * @returns A promise that resolves to RecordingData.\n     * @throws Error with one of the specified error codes if the recording cannot be stopped.\n     */\n    stopRecording(): Promise<RecordingData>;\n\n    /**\n     * Pauses the ongoing audio recording.\n     * If the recording has not started yet, the promise will reject with an error code `RECORDING_HAS_NOT_STARTED`.\n     * On success, the promise will resolve to { value: true } if the pause was successful or { value: false } if the recording is already paused.\n     * On certain mobile OS versions, this function is not supported and will reject with `NOT_SUPPORTED_OS_VERSION`.\n     * @returns A promise that resolves to a GenericResponse.\n     * @throws Error with one of the specified error codes if the recording cannot be paused.\n     */\n    pauseRecording(): Promise<GenericResponse>;\n\n    /**\n     * Resumes a paused audio recording.\n     * If the recording has not started yet, the promise will reject with an error code `RECORDING_HAS_NOT_STARTED`.\n     * On success, the promise will resolve to { value: true } if the resume was successful or { value: false } if the recording is already running.\n     * On certain mobile OS versions, this function is not supported and will reject with `NOT_SUPPORTED_OS_VERSION`.\n     * @returns A promise that resolves to a GenericResponse.\n     * @throws Error with one of the specified error codes if the recording cannot be resumed.\n     */\n    resumeRecording(): Promise<GenericResponse>;\n\n    /**\n     * Gets the current status of the voice recorder.\n     * Will resolve with one of the following values:\n     * `{ status: \"NONE\" }` if the plugin is idle and waiting to start a new recording.\n     * `{ status: \"RECORDING\" }` if the plugin is in the middle of recording.\n     * `{ status: \"PAUSED\" }` if the recording is paused.\n     * @returns A promise that resolves to a CurrentRecordingStatus.\n     * @throws Error if the status cannot be fetched.\n     */\n    getCurrentStatus(): Promise<CurrentRecordingStatus>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type {PluginListenerHandle} from \"@capacitor/core\";\nimport type {Directory} from \"@capacitor/filesystem\";\n\n/**\n * Represents a Base64 encoded string.\n */\nexport type Base64String = string;\n\n/**\n * Can be used to specify options for the recording.\n */\nexport interface RecordingOptions {\n    /**\n     * The capacitor filesystem directory where the recording should be saved.\n     *\n     * If not specified, the recording will be stored in a base64 string and returned in the `RecordingData` object.\n     * @see RecordingData\n     */\n    directory?: Directory;\n\n    /**\n     * An optional subdirectory in the specified directory where the recording should be saved.\n     */\n    subDirectory?: string;\n}\n\n/**\n * Interface representing the data of a recording.\n */\nexport interface RecordingData {\n    /**\n     * The value containing the recording details.\n     */\n    value: {\n        /**\n         * The recorded data as a Base64 encoded string.\n         */\n        recordDataBase64: Base64String;\n        /**\n         * The duration of the recording in milliseconds.\n         */\n        msDuration: number;\n        /**\n         * The MIME type of the recorded file.\n         */\n        mimeType: string;\n\n        /**\n         * The URI of the recording file.\n         */\n        uri?: string;\n    };\n}\n\n/**\n * Interface representing a generic response with a boolean value.\n */\nexport interface GenericResponse {\n    /**\n     * The result of the operation as a boolean value.\n     */\n    value: boolean;\n}\n\n/**\n * Interface representing the current status of the voice recorder.\n */\nexport interface CurrentRecordingStatus {\n    /**\n     * The current status of the recorder, which can be one of the following values: 'RECORDING', 'PAUSED', 'INTERRUPTED', 'NONE'.\n     */\n    status: 'RECORDING' | 'PAUSED' | 'INTERRUPTED' | 'NONE';\n}\n\n/**\n * Event payload for voiceRecordingInterrupted event (empty - no data).\n */\nexport type VoiceRecordingInterruptedEvent = Record<string, never>;\n\n/**\n * Event payload for voiceRecordingInterruptionEnded event (empty - no data).\n */\nexport type VoiceRecordingInterruptionEndedEvent = Record<string, never>;\n\n/**\n * Interface for the VoiceRecorderPlugin which provides methods to record audio.\n */\nexport interface VoiceRecorderPlugin {\n    /**\n     * Checks if the current device can record audio.\n     * On mobile, this function will always resolve to `{ value: true }`.\n     * In a browser, it will resolve to `{ value: true }` or `{ value: false }` based on the browser's ability to record.\n     * This method does not take into account the permission status, only if the browser itself is capable of recording at all.\n     * @returns A promise that resolves to a GenericResponse.\n     * @throws Error with code \"COULD_NOT_QUERY_PERMISSION_STATUS\" if the device cannot query the permission status.\n     */\n    canDeviceVoiceRecord(): Promise<GenericResponse>;\n\n    /**\n     * Requests audio recording permission from the user.\n     * If the permission has already been provided, the promise will resolve with `{ value: true }`.\n     * Otherwise, the promise will resolve to `{ value: true }` or `{ value: false }` based on the user's response.\n     * @returns A promise that resolves to a GenericResponse.\n     * @throws Error if the permission request fails.\n     */\n    requestAudioRecordingPermission(): Promise<GenericResponse>;\n\n    /**\n     * Checks if audio recording permission has been granted.\n     * Will resolve to `{ value: true }` or `{ value: false }` based on the status of the permission.\n     * The web implementation of this plugin uses the Permissions API, which is not widespread.\n     * If the status of the permission cannot be checked, the promise will reject with `COULD_NOT_QUERY_PERMISSION_STATUS`.\n     * In that case, use `requestAudioRecordingPermission` or `startRecording` and capture any exception that is thrown.\n     * @returns A promise that resolves to a GenericResponse.\n     * @throws Error with code \"COULD_NOT_QUERY_PERMISSION_STATUS\" if the device cannot query the permission status.\n     */\n    hasAudioRecordingPermission(): Promise<GenericResponse>;\n\n    /**\n     * Starts audio recording.\n     * On success, the promise will resolve to { value: true }.\n     * On error, the promise will reject with one of the following error codes:\n     * \"MISSING_PERMISSION\", \"ALREADY_RECORDING\", \"MICROPHONE_BEING_USED\", \"DEVICE_CANNOT_VOICE_RECORD\", or \"FAILED_TO_RECORD\".\n     * @param options The options for the recording.\n     * @returns A promise that resolves to a GenericResponse.\n     * @throws Error with one of the specified error codes if the recording cannot be started.\n     */\n    startRecording(options?: RecordingOptions): Promise<GenericResponse>;\n\n    /**\n     * Stops audio recording.\n     * Will stop the recording that has been previously started.\n     * If the function `startRecording` has not been called beforehand, the promise will reject with `RECORDING_HAS_NOT_STARTED`.\n     * If the recording has been stopped immediately after it has been started, the promise will reject with `EMPTY_RECORDING`.\n     * In a case of unknown error, the promise will reject with `FAILED_TO_FETCH_RECORDING`.\n     * On iOS, if a recording interrupted by the system cannot be merged, the promise will reject with `FAILED_TO_MERGE_RECORDING`.\n     * In case of success, the promise resolves to RecordingData containing the recording in base-64, the duration of the recording in milliseconds, and the MIME type.\n     * @returns A promise that resolves to RecordingData.\n     * @throws Error with one of the specified error codes if the recording cannot be stopped.\n     */\n    stopRecording(): Promise<RecordingData>;\n\n    /**\n     * Pauses the ongoing audio recording.\n     * If the recording has not started yet, the promise will reject with an error code `RECORDING_HAS_NOT_STARTED`.\n     * On success, the promise will resolve to { value: true } if the pause was successful or { value: false } if the recording is already paused.\n     * On certain mobile OS versions, this function is not supported and will reject with `NOT_SUPPORTED_OS_VERSION`.\n     * @returns A promise that resolves to a GenericResponse.\n     * @throws Error with one of the specified error codes if the recording cannot be paused.\n     */\n    pauseRecording(): Promise<GenericResponse>;\n\n    /**\n     * Resumes a paused or interrupted audio recording.\n     * If the recording has not started yet, the promise will reject with an error code `RECORDING_HAS_NOT_STARTED`.\n     * On success, the promise will resolve to { value: true } if the resume was successful or { value: false } if the recording is already running.\n     * On certain mobile OS versions, this function is not supported and will reject with `NOT_SUPPORTED_OS_VERSION`.\n     * @returns A promise that resolves to a GenericResponse.\n     * @throws Error with one of the specified error codes if the recording cannot be resumed.\n     */\n    resumeRecording(): Promise<GenericResponse>;\n\n    /**\n     * Gets the current status of the voice recorder.\n     * Will resolve with one of the following values:\n     * `{ status: \"NONE\" }` if the plugin is idle and waiting to start a new recording.\n     * `{ status: \"RECORDING\" }` if the plugin is in the middle of recording.\n     * `{ status: \"PAUSED\" }` if the recording is paused.\n     * `{ status: \"INTERRUPTED\" }` if the recording was paused due to a system interruption.\n     * @returns A promise that resolves to a CurrentRecordingStatus.\n     * @throws Error if the status cannot be fetched.\n     */\n    getCurrentStatus(): Promise<CurrentRecordingStatus>;\n\n    /**\n     * Listen for audio recording interruptions (e.g., phone calls, other apps using microphone).\n     * Available on iOS and Android only.\n     *\n     * @param eventName The name of the event to listen for.\n     * @param listenerFunc The callback function to invoke when the event occurs.\n     * @returns A promise that resolves to a PluginListenerHandle.\n     */\n    addListener(\n        eventName: 'voiceRecordingInterrupted',\n        listenerFunc: (event: VoiceRecordingInterruptedEvent) => void,\n    ): Promise<PluginListenerHandle>;\n\n    /**\n     * Listen for audio recording interruption end events.\n     * Available on iOS and Android only.\n     *\n     * @param eventName The name of the event to listen for.\n     * @param listenerFunc The callback function to invoke when the event occurs.\n     * @returns A promise that resolves to a PluginListenerHandle.\n     */\n    addListener(\n        eventName: 'voiceRecordingInterruptionEnded',\n        listenerFunc: (event: VoiceRecordingInterruptionEndedEvent) => void,\n    ): Promise<PluginListenerHandle>;\n\n    /**\n     * Remove all listeners for this plugin.\n     */\n    removeAllListeners(): Promise<void>;\n}\n"]}

package/dist/esm/platform/web/VoiceRecorderImpl.d.ts

@@ -0,0 +1,45 @@
+import type { CurrentRecordingStatus, GenericResponse, RecordingData, RecordingOptions } from '../../definitions';
+/** Preferred MIME types to probe in order of fallback. */
+declare const POSSIBLE_MIME_TYPES: {
+    'audio/aac': string;
+    'audio/webm;codecs=opus': string;
+    'audio/mp4': string;
+    'audio/webm': string;
+    'audio/ogg;codecs=opus': string;
+};
+/** Browser implementation backed by MediaRecorder and Capacitor Filesystem. */
+export declare class VoiceRecorderImpl {
+    /** Active MediaRecorder instance, if recording. */
+    private mediaRecorder;
+    /** Collected data chunks from MediaRecorder. */
+    private chunks;
+    /** Promise resolved when the recorder stops and payload is ready. */
+    private pendingResult;
+    /** Returns whether the browser can start a recording session. */
+    static canDeviceVoiceRecord(): Promise<GenericResponse>;
+    /** Starts a recording session using MediaRecorder. */
+    startRecording(options?: RecordingOptions): Promise<GenericResponse>;
+    /** Stops the current recording and resolves the pending payload. */
+    stopRecording(): Promise<RecordingData>;
+    /** Returns whether the browser has microphone permission. */
+    static hasAudioRecordingPermission(): Promise<GenericResponse>;
+    /** Requests microphone permission from the browser. */
+    static requestAudioRecordingPermission(): Promise<GenericResponse>;
+    /** Pauses the recording session when supported. */
+    pauseRecording(): Promise<GenericResponse>;
+    /** Resumes a paused recording session when supported. */
+    resumeRecording(): Promise<GenericResponse>;
+    /** Returns the current recording status from MediaRecorder. */
+    getCurrentStatus(): Promise<CurrentRecordingStatus>;
+    /** Returns the first supported MIME type, if any. */
+    static getSupportedMimeType<T extends keyof typeof POSSIBLE_MIME_TYPES>(): T | null;
+    /** Initializes MediaRecorder and wires up handlers. */
+    private onSuccessfullyStartedRecording;
+    /** Handles failures from getUserMedia. */
+    private onFailedToStartRecording;
+    /** Converts a Blob payload into a base64 string. */
+    private static blobToBase64;
+    /** Resets state for the next recording attempt. */
+    private prepareInstanceForNextOperation;
+}
+export {};

package/dist/esm/{VoiceRecorderImpl.js → platform/web/VoiceRecorderImpl.js}

@@ -1,8 +1,8 @@
 import { Filesystem } from '@capacitor/filesystem';
 import write_blob from 'capacitor-blob-writer';
-import getBlobDuration from "./helper/get-blob-duration";
+import getBlobDuration from './get-blob-duration';
 import { alreadyRecordingError, couldNotQueryPermissionStatusError, deviceCannotVoiceRecordError, emptyRecordingError, failedToFetchRecordingError, failedToRecordError, failureResponse, missingPermissionError, recordingHasNotStartedError, successResponse, } from './predefined-web-responses';
-// these mime types will be checked one by one in order until one of them is found to be supported by the current browser
+/** Preferred MIME types to probe in order of fallback. */
 const POSSIBLE_MIME_TYPES = {
     'audio/aac': '.aac',
     'audio/webm;codecs=opus': '.ogg',
@@ -10,13 +10,19 @@ const POSSIBLE_MIME_TYPES = {
     'audio/webm': '.ogg',
     'audio/ogg;codecs=opus': '.ogg',
 };
+/** Creates a promise that never resolves. */
 const neverResolvingPromise = () => new Promise(() => undefined);
+/** Browser implementation backed by MediaRecorder and Capacitor Filesystem. */
 export class VoiceRecorderImpl {
     constructor() {
+        /** Active MediaRecorder instance, if recording. */
         this.mediaRecorder = null;
+        /** Collected data chunks from MediaRecorder. */
         this.chunks = [];
+        /** Promise resolved when the recorder stops and payload is ready. */
         this.pendingResult = neverResolvingPromise();
     }
+    /** Returns whether the browser can start a recording session. */
     static async canDeviceVoiceRecord() {
         var _a;
         if (((_a = navigator === null || navigator === void 0 ? void 0 : navigator.mediaDevices) === null || _a === void 0 ? void 0 : _a.getUserMedia) == null || VoiceRecorderImpl.getSupportedMimeType() == null) {
@@ -26,6 +32,7 @@ export class VoiceRecorderImpl {
             return successResponse();
         }
     }
+    /** Starts a recording session using MediaRecorder. */
     async startRecording(options) {
         if (this.mediaRecorder != null) {
             throw alreadyRecordingError();
@@ -43,6 +50,7 @@ export class VoiceRecorderImpl {
             .then((stream) => this.onSuccessfullyStartedRecording(stream, options))
             .catch(this.onFailedToStartRecording.bind(this));
     }
+    /** Stops the current recording and resolves the pending payload. */
     async stopRecording() {
         if (this.mediaRecorder == null) {
             throw recordingHasNotStartedError();
@@ -59,6 +67,7 @@ export class VoiceRecorderImpl {
             this.prepareInstanceForNextOperation();
         }
     }
+    /** Returns whether the browser has microphone permission. */
     static async hasAudioRecordingPermission() {
         // Safari does not support navigator.permissions.query
         if (!navigator.permissions.query) {
@@ -78,6 +87,7 @@ export class VoiceRecorderImpl {
             throw couldNotQueryPermissionStatusError();
         });
     }
+    /** Requests microphone permission from the browser. */
     static async requestAudioRecordingPermission() {
         const havingPermission = await VoiceRecorderImpl.hasAudioRecordingPermission().catch(() => failureResponse());
         if (havingPermission.value) {
@@ -88,6 +98,7 @@ export class VoiceRecorderImpl {
             .then(() => successResponse())
             .catch(() => failureResponse());
     }
+    /** Pauses the recording session when supported. */
     pauseRecording() {
         if (this.mediaRecorder == null) {
             throw recordingHasNotStartedError();
@@ -100,6 +111,7 @@ export class VoiceRecorderImpl {
             return Promise.resolve(failureResponse());
         }
     }
+    /** Resumes a paused recording session when supported. */
     resumeRecording() {
         if (this.mediaRecorder == null) {
             throw recordingHasNotStartedError();
@@ -112,6 +124,7 @@ export class VoiceRecorderImpl {
             return Promise.resolve(failureResponse());
         }
     }
+    /** Returns the current recording status from MediaRecorder. */
     getCurrentStatus() {
         if (this.mediaRecorder == null) {
             return Promise.resolve({ status: 'NONE' });
@@ -126,12 +139,14 @@ export class VoiceRecorderImpl {
             return Promise.resolve({ status: 'NONE' });
         }
     }
+    /** Returns the first supported MIME type, if any. */
     static getSupportedMimeType() {
         if ((MediaRecorder === null || MediaRecorder === void 0 ? void 0 : MediaRecorder.isTypeSupported) == null)
             return null;
         const foundSupportedType = Object.keys(POSSIBLE_MIME_TYPES).find((type) => MediaRecorder.isTypeSupported(type));
         return foundSupportedType !== null && foundSupportedType !== void 0 ? foundSupportedType : null;
     }
+    /** Initializes MediaRecorder and wires up handlers. */
     onSuccessfullyStartedRecording(stream, options) {
         this.pendingResult = new Promise((resolve, reject) => {
             this.mediaRecorder = new MediaRecorder(stream);
@@ -179,10 +194,12 @@ export class VoiceRecorderImpl {
         });
         return successResponse();
     }
+    /** Handles failures from getUserMedia. */
     onFailedToStartRecording() {
         this.prepareInstanceForNextOperation();
         throw failedToRecordError();
     }
+    /** Converts a Blob payload into a base64 string. */
     static blobToBase64(blob) {
         return new Promise((resolve) => {
             const reader = new FileReader();
@@ -195,6 +212,7 @@ export class VoiceRecorderImpl {
             reader.readAsDataURL(blob);
         });
     }
+    /** Resets state for the next recording attempt. */
     prepareInstanceForNextOperation() {
         if (this.mediaRecorder != null && this.mediaRecorder.state === 'recording') {
             try {