[MOB-9374] Migrate to TypeScript (#783)

* Remove typescript_validator

* Init TS structure

* Bypass Compiler Errors Temporarily

* Fix Example App

* Re-export NativeModules

* Format Files

* Convert ArgsRegistry to Namespace

* Add types to IBGEventEmitter

* Add types to InstabugUtils

* Move `FeatureRequests` to Typed Namespace

* Move `APM` to Typed Namespace

* Rename Native Modules JS Exports

* Move `BugReporting` to Typed Namespace

* Move `CrashReporting` to Typed Namespace

* Move `Instabug` to Typed Namespace

* Move `NetworkLogger` to Typed Namespace

* Move `Replies` to Typed Namespace

* Move `Surveys` to Typed Namespace

* Remove `index.d.ts`

* Change Constructors to Parameter Properties

* Add `@apollo/client` Types

* Add `react-native-navigation` Types

* Add `react-navigation` Types

* Refrence Enum types from `ArgsRegistry`

* Improve Doc Comments and Param Names

* Use Records

* Fix Types Errors

* Update Test Imports

* Update `tsconfig.json`

* Build SDK in Test/Publish CI Jobs

* Build SDK in E2E CI Jobs

* Export Models

* Use `ts-jest`

* Fix Failing Tests

* Replace Namespaces with Modules

* Change `InstabugConstants` to enum

* Replace `var` with `let` and `const`

* Improve types

* Remove unnecessary assignment

* Fix ArgsRegistry Metro Error

* Add Missing Args to XHRInterceptor

* Revert `setNetworkDataObfuscationHandler` Changes

* Change TS Out Directory

* Update Changelog

Author: TheBuggedYRN

.circleci/config.yml

@@ -17,11 +17,9 @@ jobs:
       - checkout:
           path: ~/project
 
-      - run: yarn
-
       - run:
-          name: Typescript Definitions Validation
-          command: node typescript_validator.js
+          name: Install Node Packages
+          command: yarn
 
       - run:
           name: jest tests
@@ -113,16 +111,16 @@ jobs:
           name: Build and run tests
           command: cd ios && xcodebuild  -allowProvisioningUpdates   -workspace InstabugSample.xcworkspace    -scheme InstabugSample    -sdk iphonesimulator    -destination 'platform=iOS Simulator,name=iPhone 13 Pro Max,OS=15.5'    test | xcpretty
           no_output_timeout: 30m
+
   e2e_ios:
     macos:
       xcode: 13.4.1
     resource_class: large  
-    working_directory: ~/project/example
+    working_directory: ~/project
     environment:
       FL_OUTPUT_DIR: output
     steps:
-      - checkout:
-          path: ~/project
+      - checkout
       - run:
           name: Install CocoaPods
           command: sudo gem install cocoapods
@@ -138,25 +136,34 @@ jobs:
       - run:
           name: Install Node Packages
           command: yarn
+      - run:
+          name: Build Project
+          command: yarn build
+      - run:
+          name: Install Example's Node Packages
+          working_directory: example
+          command: yarn
       - run:
           name: Install Pods
-          command: cd ios && pod install
+          working_directory: example/ios
+          command: pod install
       - run:
           name: Detox - Build Release App
+          working_directory: example
           command: detox build --configuration ios.sim.release --cleanup
       - run:
           name: Detox - Run E2E Tests
+          working_directory: example
           command: detox test --configuration ios.sim.release --cleanup
 
   e2e_android:
     executor:
       name: android/android-machine
       tag: "2022.03.1"
       resource-class: large
-    working_directory: ~/project/example/android
+    working_directory: ~/project
     steps:
-      - checkout:
-          path: ~/project
+      - checkout
       - run: 
           name: Install Yarn
           command: npm install --global yarn
@@ -166,6 +173,13 @@ jobs:
       - run:
           name: Install Node Packages
           command: yarn
+      - run:
+          name: Build Project
+          command: yarn build
+      - run:
+          name: Install Example's Node Packages
+          working_directory: example
+          command: yarn
       - android/create-avd:
           avd-name: Nexus_6P_API_27
           install: true
@@ -176,12 +190,12 @@ jobs:
           memory: 2048
           post-emulator-launch-assemble-command: |
               rm -rf ~/.gradle/caches
-              ./gradlew androidDependencies
-              cd ..
-              detox build -c android.emu.release
+              cd ~/project/example/android && ./gradlew androidDependencies
+              cd .. && detox build -c android.emu.release
       - run:
           name: Detox - Run E2E Tests
-          command: cd .. && detox test -c android.emu.release
+          working_directory: example
+          command: detox test -c android.emu.release
 
   publish:
     macos:
@@ -193,6 +207,7 @@ jobs:
       - run: git clone https://InstabugCI:$RELEASE_GITHUB_TOKEN@github.com/Instabug/Escape.git
       - run: cd Escape && swift build -c release
       - run: cd Escape/.build/release && cp -f Escape /usr/local/bin/escape
+      - run: cd project && yarn && yarn build
       - run: cd project && Escape react-native publish
 
 workflows:

.gitignore

@@ -32,6 +32,10 @@ xcuserdata/
 
 
 coverage/
+.jest/cache/
 *node_modules/
 *Pods/
 *Podfile.lock
+
+# Typescript build
+dist/

.npmignore

@@ -25,5 +25,4 @@ test/
 Dangerfile
 babel.config.js
 codecov.yml
-typescript_validator.js
 .prettierrc.js

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+
+* Adds first-class TypeScript support.
+
 ## 11.3.0 (2022-10-11)
 
 * Bumps Instabug Android SDK to v11.5.1

jest.config.js

@@ -0,0 +1,22 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'react-native',
+  testEnvironment: 'node',
+  cacheDirectory: '.jest/cache',
+  coverageDirectory: './coverage/',
+  clearMocks: true,
+  collectCoverage: true,
+  collectCoverageFrom: ['./src/**/*.(js|ts)'],
+  setupFilesAfterEnv: ['./tests/setup.js'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  modulePathIgnorePatterns: ['example'],
+  transform: {
+    '^.+\\.jsx$': 'babel-jest',
+    '^.+\\.tsx?$': [
+      'ts-jest',
+      {
+        tsconfig: 'tsconfig.json',
+      },
+    ],
+  },
+};

package.json

@@ -7,8 +7,9 @@
   "homepage": "https://www.instabug.com/platforms/react-native",
   "bugs": "https://github.com/Instabug/Instabug-React-Native/issues",
   "license": "MIT",
-  "main": "src/index.js",
-  "types": "src/index.d.ts",
+  "main": "dist/index",
+  "types": "dist/index.d.ts",
+  "react-native": "src/index.ts",
   "keywords": [
     "react-native",
     "instabug",
@@ -20,13 +21,19 @@
     "feedback"
   ],
   "scripts": {
-    "test": "jest"
+    "test": "jest",
+    "build": "tsc"
   },
   "peerDependencies": {
     "react": ">=16.8.6",
     "react-native": ">=0.60.0"
   },
   "devDependencies": {
+    "@apollo/client": "^3.7.0",
+    "@react-navigation/native": "^5.9.8",
+    "@types/jest": "^24.0.0",
+    "@types/node": "^18.7.23",
+    "@types/react-native": "^0.66.0",
     "babel-core": "7.0.0-bridge.0",
     "babel-jest": "^24.8.0",
     "esprima": "^4.0.1",
@@ -35,23 +42,11 @@
     "nock": "^13.2.9",
     "react": "^16.8.6",
     "react-native": "^0.60.0",
-    "typescript": "4.0.3",
+    "react-native-navigation": "7.29.0",
+    "react-navigation": "^4.4.4",
+    "ts-jest": "^24.0.0",
+    "typescript": "^4.8.4",
     "wait-for-expect": "^1.2.0",
     "xhr2": "^0.2.1"
-  },
-  "jest": {
-    "preset": "react-native",
-    "clearMocks": true,
-    "coverageDirectory": "./coverage/",
-    "collectCoverage": true,
-    "collectCoverageFrom": [
-      "./src/**/*.(js|ts)"
-    ],
-    "setupFilesAfterEnv": [
-      "./tests/setup.js"
-    ],
-    "modulePathIgnorePatterns": [
-      "example"
-    ]
   }
 }