Merge pull request #135 from huextrat/fix/types

fix(ts): export types
mkuczera · Sep 17, 2024 · d1516d5 · d1516d5
2 parents 65c8b10 + 16508f2
commit d1516d5
Show file tree

Hide file tree

Showing 8 changed files with 37 additions and 136 deletions.
diff --git a/@types/global.d.ts b/@types/global.d.ts
diff --git a/package.json b/package.json
@@ -5,7 +5,9 @@
   "license": "MIT",
   "source": "src/index.ts",
   "main": "./lib/commonjs/index.js",
+  "react-native": "src/index.ts",
   "module": "./lib/module/index.js",
+  "types": "lib/typescript/index.d.ts",
   "scripts": {
     "typecheck": "tsc --noEmit --project tsconfig.test.json",
     "test": "jest",
@@ -61,7 +63,7 @@
   "codegenConfig": {
     "name": "RNHapticFeedbackSpec",
     "type": "modules",
-    "jsSrcsDir": "src",
+    "jsSrcsDir": "./src/codegenSpec",
     "android": {
       "javaPackageName": "com.mkuczera"
     }
@@ -100,25 +102,9 @@
     "source": "src",
     "output": "lib",
     "targets": [
-      [
-        "commonjs",
-        {
-          "esm": true
-        }
-      ],
-      [
-        "module",
-        {
-          "esm": true
-        }
-      ],
-      [
-        "typescript",
-        {
-          "project": "tsconfig.build.json",
-          "esm": true
-        }
-      ]
+      "commonjs",
+      "module",
+      "typescript"
     ]
   }
 }
diff --git a/setupTests.js b/setupTests.js
@@ -1,5 +1,4 @@
 global.__DEV__ = true;
-global.__turboModuleProxy = null;
 
 jest.mock("react-native/Libraries/BatchedBridge/NativeModules", () => ({
   RNHapticFeedback: {

diff --git a/src/NativeHapticFeedback.ts b/src/NativeHapticFeedback.ts
diff --git a/src/__tests__/index.test.tsx b/src/__tests__/index.test.tsx
@@ -1,31 +1,13 @@
-import { NativeModules } from "react-native";
-import { trigger } from "../index";
+import RNHapticFeedback from "../index";
 import { HapticFeedbackTypes } from "../types";
 
-jest.mock("../NativeHapticFeedback", () => ({
-  default: {
-    trigger: jest.fn(),
-  },
-}));
-
-const NativeHapticFeedbackMock = require("../NativeHapticFeedback").default;
+const NativeHapticFeedbackMock = require("../codegenSpec/NativeHapticFeedback").default;
 
 describe("RNReactNativeHapticFeedback", () => {
-  beforeAll(() => {
-    global.__turboModuleProxy = null;
-    NativeModules.RNHapticFeedback = {
-      trigger: jest.fn(),
-    };
-  });
-
-  afterEach(() => {
-    jest.clearAllMocks();
-  });
-
   it("should trigger haptic feedback with default options using NativeModules when turbo module is not used", () => {
-    trigger(HapticFeedbackTypes.selection);
+    RNHapticFeedback.trigger(HapticFeedbackTypes.selection);
 
-    expect(NativeModules.RNHapticFeedback.trigger).toHaveBeenCalledWith(
+    expect(NativeHapticFeedbackMock.trigger).toHaveBeenCalledWith(
       "selection",
       {
         enableVibrateFallback: false,
@@ -35,16 +17,12 @@ describe("RNReactNativeHapticFeedback", () => {
   });
 
   it("should trigger haptic feedback with turbo module when enabled", () => {
-    global.__turboModuleProxy = true;
-
-    trigger(HapticFeedbackTypes.selection);
+    RNHapticFeedback.trigger(HapticFeedbackTypes.selection);
 
     expect(NativeHapticFeedbackMock.trigger).toHaveBeenCalledWith("selection", {
       enableVibrateFallback: false,
       ignoreAndroidSystemSettings: false,
     });
-
-    global.__turboModuleProxy = null;
   });
 
   it("should pass the correct options", () => {
@@ -53,38 +31,11 @@ describe("RNReactNativeHapticFeedback", () => {
       ignoreAndroidSystemSettings: true,
     };
 
-    trigger(HapticFeedbackTypes.selection, options);
+    RNHapticFeedback.trigger(HapticFeedbackTypes.selection, options);
 
-    expect(NativeModules.RNHapticFeedback.trigger).toHaveBeenCalledWith(
+    expect(NativeHapticFeedbackMock.trigger).toHaveBeenCalledWith(
       "selection",
       options,
     );
   });
-
-  it("should handle the case when options is a boolean", () => {
-    // @ts-expect-error - we're testing the case when options is a boolean for deprecated behavior
-    trigger(HapticFeedbackTypes.selection, true);
-
-    expect(NativeModules.RNHapticFeedback.trigger).toHaveBeenCalledWith(
-      "selection",
-      {
-        enableVibrateFallback: true,
-        ignoreAndroidSystemSettings: false,
-      },
-    );
-  });
-
-  it("should warn when haptic feedback module is not available", () => {
-    delete NativeModules.RNHapticFeedback;
-
-    const warnSpy = jest.spyOn(console, "warn").mockImplementation(() => {});
-
-    trigger(HapticFeedbackTypes.selection);
-
-    expect(warnSpy).toHaveBeenCalledWith(
-      "RNReactNativeHapticFeedback is not available",
-    );
-
-    warnSpy.mockRestore();
-  });
 });
diff --git a/src/codegenSpec/NativeHapticFeedback.ts b/src/codegenSpec/NativeHapticFeedback.ts
@@ -0,0 +1,14 @@
+import type { TurboModule } from 'react-native';
+import { TurboModuleRegistry } from 'react-native';
+
+export interface Spec extends TurboModule {
+  trigger(
+    type: string,
+    options?: {
+      enableVibrateFallback?: boolean;
+      ignoreAndroidSystemSettings?: boolean;
+    },
+  ): void;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>("RNHapticFeedback");
diff --git a/src/index.ts b/src/index.ts
@@ -1,49 +1,26 @@
-import { NativeModules } from "react-native";
+import NativeHapticFeedback from './codegenSpec/NativeHapticFeedback';
 import { HapticFeedbackTypes } from "./types";
 import type { HapticOptions } from "./types";
 
-import type { Spec } from "./NativeHapticFeedback";
-export * from "./types";
-
 const defaultOptions = {
   enableVibrateFallback: false,
   ignoreAndroidSystemSettings: false,
 };
 
-class RNReactNativeHapticFeedback {
-  static trigger = (
+const RNHapticFeedback = {
+  trigger(
     type:
       | keyof typeof HapticFeedbackTypes
       | HapticFeedbackTypes = HapticFeedbackTypes.selection,
     options: HapticOptions = {},
-  ) => {
-    const triggerOptions = createTriggerOptions(options);
-
+  ) {
     try {
-      const isTurboModuleEnabled = global.__turboModuleProxy != null;
-      const hapticFeedback = isTurboModuleEnabled
-        ? (require("./NativeHapticFeedback").default as Spec)
-        : NativeModules.RNHapticFeedback;
-
-      hapticFeedback.trigger(type, triggerOptions);
+      NativeHapticFeedback.trigger(type, { ...defaultOptions, ...options });
     } catch {
       console.warn("RNReactNativeHapticFeedback is not available");
     }
-  };
-}
-
-const createTriggerOptions = (options: HapticOptions) => {
-  // if options is a boolean we're using an api <=1.6 and we should pass use it to set the enableVibrateFallback option
-  if (typeof options === "boolean") {
-    return {
-      ...defaultOptions,
-      enableVibrateFallback: options,
-    };
-  } else {
-    return { ...defaultOptions, ...options };
   }
-};
-
-export const trigger = RNReactNativeHapticFeedback.trigger;
+}
 
-export default RNReactNativeHapticFeedback;
+export const { trigger } = RNHapticFeedback;
+export default RNHapticFeedback;
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,17 +1,12 @@
 {
   "compilerOptions": {
-    "rootDir": ".",
-    "paths": {
-      "react-native-haptic-feedback": ["./src/index"]
-    },
     "allowUnreachableCode": false,
     "allowUnusedLabels": false,
     "esModuleInterop": true,
     "forceConsistentCasingInFileNames": true,
     "jsx": "react-jsx",
-    "lib": ["ESNext"],
     "module": "ESNext",
-    "moduleResolution": "Bundler",
+    "moduleResolution": "node",
     "noEmit": true,
     "noFallthroughCasesInSwitch": true,
     "noImplicitReturns": true,
@@ -25,8 +20,6 @@
     "strict": true,
     "target": "ESNext",
     "verbatimModuleSyntax": true,
-    "types": ["node"],
-    "typeRoots": ["./node_modules/@types", "./@types"],
   },
-  "exclude": ["node_modules"]
+  "include": ["./src/"]
 }