chore: adding and configuring jest file

Author: Mhp23

README.md

@@ -112,6 +112,18 @@ const styles = StyleSheet.create({
 
 To become more familiar with the usage of the library, check out the [example project](./example/).
 
+## Testing
+
+To mock the package's methods and components using the default mock configuration provided, follow these steps:
+
+- Create a file named `@mhpdev/react-native-speech.ts` inside your `__mocks__` directory.
+
+- Copy the following code into that file:
+
+  ```ts
+  export * from '@mhpdev/react-native-speech/jest';
+  ```
+
 ## Contributing
 
 See the [contributing guide](./docs/CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

jest/index.ts

@@ -0,0 +1,46 @@
+import {createElement} from 'react';
+import type {
+  VoiceProps,
+  EventProps,
+  VoiceOptions,
+  ProgressEventProps,
+} from '../src/NativeSpeech';
+import type {
+  HighlightedTextProps,
+  HighlightedSegmentArgs,
+  HighlightedSegmentProps,
+} from '../src/components/types';
+
+class SpeechMock {
+  static reset = jest.fn<void, []>();
+  static stop = jest.fn<Promise<void>, []>();
+  static pause = jest.fn<Promise<boolean>, []>();
+  static resume = jest.fn<Promise<boolean>, []>();
+  static speak = jest.fn<Promise<void>, [string]>();
+  static isSpeaking = jest.fn<Promise<boolean>, []>();
+  static initialize = jest.fn<void, [VoiceOptions]>();
+  static getAvailableVoices = jest.fn<Promise<VoiceProps[]>, [string?]>();
+  static speakWithOptions = jest.fn<Promise<void>, [string, VoiceOptions]>();
+  static onError = jest.fn();
+  static onStart = jest.fn();
+  static onFinish = jest.fn();
+  static onPause = jest.fn();
+  static onResume = jest.fn();
+  static onStopped = jest.fn();
+  static onProgress = jest.fn();
+}
+
+export const HighlightedText: React.FC<HighlightedTextProps> = props => {
+  return createElement('HighlightedText', props, props.text);
+};
+
+export default SpeechMock;
+export type {
+  VoiceProps,
+  EventProps,
+  VoiceOptions,
+  ProgressEventProps,
+  HighlightedTextProps,
+  HighlightedSegmentArgs,
+  HighlightedSegmentProps,
+};

package.json

@@ -9,6 +9,7 @@
   "files": [
     "src",
     "lib",
+    "jest",
     "android",
     "ios",
     "cpp",