[MOB-9124] Migrate to TS (#163)

* Add tsconfig.json

* Add types/cordova and typescript dev dependencies

* Migrate ArgsRegistry to TS

* Migrate BugReporting to TS

* Migrate FeatureRequests to TS

* Migrate Instabug module to TS

* Migrate Replies to TS

* Migrate Surveys to TS

* Migrate Index to TS

* Use ArgsRegistry for some enums on Android

* Use ArgsRegistry for some enums on iOS

* Ignore compiled JS files

* Add types field

* Add scripts field

* Compile TS project in test jobs

* Update index.ts syntax to work with Ionic

* Use string literals for some enums

* Update some tsconfig properties

* Fix setString key type

* Trigger IntelliSense in sample app

* Add a wrapper function for cordova.exec

* Make success and error callbacks optional

* Update CHANGELOG.md

* Exit CI steps if adding platform failed

* Revert "Exit CI steps if adding platform failed"

This reverts commit 43e9d36.

Author: DavidMina96

.circleci/config.yml

@@ -6,7 +6,7 @@ orbs:
 jobs:
 
    test_android:
-    working_directory: ~/project/example
+    working_directory: ~/project
     executor:
       name: android/android-machine
       resource-class: xlarge
@@ -17,27 +17,36 @@ jobs:
       - run:
           name: Install Cordova CLI
           command: npm install -g cordova
+      - run:
+          name: Install Node Packages
+          command: yarn
+      - run:
+          name: Compile TS Project
+          command: yarn build
       - run:
           name: Install Android Platform
+          working_directory: example
           command: cordova platform add android || true
       - run:
           name: Install Plugins
+          working_directory: example
           command: cordova plugins add --link ../ tests
       - run:
           name: Install Build Tools v30.0.3
-          command: sdkmanager "build-tools;30.0.3"
+          working_directory: example
+          command: sdkmanager "build-tools;30.0.3" 
       - android/start-emulator-and-run-tests:
-          run-tests-working-directory: platforms/android
+          run-tests-working-directory: example/platforms/android
           system-image: system-images;android-30;google_apis;x86
           additional-avd-args: -d "Nexus 5"
-          post-emulator-launch-assemble-command: cordova build android
+          post-emulator-launch-assemble-command: cd example && cordova build android
           test-command: ./gradlew app:connectedAndroidTest
       - android/run-tests:
-          working-directory: platforms/android
+          working-directory: example/platforms/android
           test-command: ./gradlew test
 
    test_ios:
-    working_directory: ~/project/example
+    working_directory: ~/project
     macos:
       xcode: 13.3.0
     steps:
@@ -46,18 +55,27 @@ jobs:
       - run:
           name: Install Cordova CLI
           command: npm install -g cordova
+      - run:
+          name: Install Node Packages
+          command: yarn
+      - run:
+          name: Compile TS Project
+          command: yarn build
       - run:
           name: Install iOS Platform
+          working_directory: example
           command: cordova platform add ios || true
       - run:
           name: Install Plugins
+          working_directory: example
           command: cordova plugins add --link ../ tests
       - run:
           name: Build iOS App
+          working_directory: example
           command: cordova build ios
       - run:
           name: Run Tests
-          working_directory: platforms/ios
+          working_directory: example/platforms/ios
           command: |
               xcodebuild -allowProvisioningUpdates \
                          -workspace InstabugExample.xcworkspace \

.gitignore

@@ -9,3 +9,4 @@
 
 local.properties
 node_modules/
+www/

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+
+* Adds TypeScript support
+
 ## v11.0.1 (2022-08-24)
 
 * Fixes ArgsRegistry import on iOS

example/www/js/index.js

@@ -1,7 +1,9 @@
 document.addEventListener("deviceready", onDeviceReady, false);
 
 function onDeviceReady() {
+  /** @type {import('instabug-cordova/www/Instabug')} */
   var Instabug = cordova.require("instabug-cordova.Instabug");
+  /** @type {import('instabug-cordova/www/BugReporting')} */
   var BugReporting = cordova.require("instabug-cordova.BugReporting");
 
   console.log("Running cordova-" + cordova.platformId + "@" + cordova.version);

package.json

@@ -8,6 +8,7 @@
   "bugs": "https://github.com/Instabug/Instabug-Cordova/issues",
   "license": "Apache 2.0 License",
   "main": "www/index.js",
+  "types": "www/index.d.ts",
   "keywords": [
     "ecosystem:cordova",
     "cordova",
@@ -18,5 +19,13 @@
     "errors",
     "exceptions",
     "logging"
-  ]
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepack": "yarn build"
+  },
+  "devDependencies": {
+    "@types/cordova": "^0.0.34",
+    "typescript": "^4.8.2"
+  }
 }

plugin.xml

@@ -22,6 +22,7 @@
 
     <!-- js -->
     <js-module src="www/ArgsRegistry.js" />
+    <js-module src="www/IBGCordova.js" />
     <js-module src="www/Instabug.js" name="Instabug">
         <clobbers target="InstabugLib.Instabug" />
     </js-module>

src/android/IBGPlugin.java

@@ -1056,15 +1056,10 @@ public void setSessionProfilerEnabled(final CallbackContext callbackContext, JSO
      *                        visual or disabled.
      */
     public void setReproStepsMode(final CallbackContext callbackContext, JSONArray args) {
-        String reproStepsMode = args.optString(0);
         try {
-            if (reproStepsMode.equals("enabledWithNoScreenshots")) {
-                Instabug.setReproStepsState(State.ENABLED_WITH_NO_SCREENSHOTS);
-            } else if (reproStepsMode.equals("enabled")) {
-                Instabug.setReproStepsState(State.ENABLED);
-            } else if (reproStepsMode.equals("disabled")) {
-                Instabug.setReproStepsState(State.DISABLED);
-            }
+            final String reproStepsMode = args.optString(0);
+            final State parsedMode = ArgsRegistry.reproStepsModes.get(reproStepsMode);
+            Instabug.setReproStepsState(parsedMode);
             callbackContext.success();
         } catch (IllegalStateException e) {
             callbackContext.error(errorMsg);
@@ -1153,10 +1148,10 @@ public void setShouldShowSurveysWelcomeScreen(final CallbackContext callbackCont
      * @param callbackContext Used when calling back into JavaScript
      */
     public void setLocale(final CallbackContext callbackContext, JSONArray args) {
-        String locale = args.optString(0);
         try {
-            InstabugLocale instabugLocale = parseLocale(locale);
-            Instabug.setLocale(new Locale(instabugLocale.getCode(), instabugLocale.getCountry()));
+            final String locale = args.optString(0);
+            final InstabugLocale parsedLocale = ArgsRegistry.locales.get(locale);
+            Instabug.setLocale(new Locale(parsedLocale.getCode(), parsedLocale.getCountry()));
             callbackContext.success();
         } catch (IllegalStateException e) {
             callbackContext.error(errorMsg);
@@ -1201,52 +1196,6 @@ public static int parseInvocationOption(String invocationOption) {
         } else return -1;
     }
 
-    /**
-     * Convenience method for converting string to Locale.
-     *
-     * @param locale
-     *        String shortcode for locale
-     */
-    public static InstabugLocale parseLocale(String locale) {
-        if ("arabic".equals(locale)) {
-            return InstabugLocale.ARABIC;
-        } else if ("azerbaijani".equals(locale)) {
-            return InstabugLocale.AZERBAIJANI;
-        } else if ("chineseSimplified".equals(locale)) {
-            return InstabugLocale.SIMPLIFIED_CHINESE;
-        } else if ("chineseTraditional".equals(locale)) {
-            return InstabugLocale.TRADITIONAL_CHINESE;
-        } else if ("danish".equals(locale)) {
-            return InstabugLocale.DANISH;
-        } else if ("english".equals(locale)) {
-            return InstabugLocale.ENGLISH;
-        } else if ("french".equals(locale)) {
-            return InstabugLocale.FRENCH;
-        } else if ("german".equals(locale)) {
-            return InstabugLocale.GERMAN;
-        } else if ("italian".equals(locale)) {
-            return InstabugLocale.ITALIAN;
-        } else if ("japanese".equals(locale)) {
-            return InstabugLocale.JAPANESE;
-        } else if ("korean".equals(locale)) {
-            return InstabugLocale.KOREAN;
-        } else if ("polish".equals(locale)) {
-            return InstabugLocale.POLISH;
-        } else if ("portugueseBrazil".equals(locale)) {
-            return InstabugLocale.PORTUGUESE_BRAZIL;
-        } else if ("russian".equals(locale)) {
-            return InstabugLocale.RUSSIAN;
-        } else if ("spanish".equals(locale)) {
-            return InstabugLocale.SPANISH;
-        } else if ("swedish".equals(locale)) {
-            return InstabugLocale.SWEDISH;
-        } else if ("turkish".equals(locale)) {
-            return InstabugLocale.TURKISH;
-        } else if ("czech".equals(locale)) {
-            return InstabugLocale.CZECH;
-        } else return InstabugLocale.ENGLISH;
-    }
-
     /**
      * Convenience method for converting string to InvocationOption.
      *

src/android/util/ArgsRegistry.java

@@ -7,6 +7,8 @@
 import com.instabug.library.invocation.util.InstabugFloatingButtonEdge;
 import com.instabug.library.invocation.util.InstabugVideoRecordingButtonPosition;
 import com.instabug.library.ui.onboarding.WelcomeMessage;
+import com.instabug.library.visualusersteps.State;
+import com.instabug.library.internal.module.InstabugLocale;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -111,4 +113,32 @@ public ArrayList<T> getAll(ArrayList<String> keys) {
         put("reproStepsListEmptyStateDescription", Key.REPRO_STEPS_LIST_EMPTY_STATE_DESCRIPTION);
         put("reproStepsListItemTitle", Key.REPRO_STEPS_LIST_ITEM_NUMBERING_TITLE);
     }};
+
+    public static final ArgsMap<State> reproStepsModes = new ArgsMap<State>() {{
+        put("enabled", State.ENABLED);
+        put("disabled", State.DISABLED);
+        put("enabledWithNoScreenshots", State.ENABLED_WITH_NO_SCREENSHOTS);
+    }};
+
+    public static final ArgsMap<InstabugLocale> locales = new ArgsMap<InstabugLocale>() {{
+        put("arabic", InstabugLocale.ARABIC);
+        put("azerbaijani", InstabugLocale.AZERBAIJANI);
+        put("chineseSimplified", InstabugLocale.SIMPLIFIED_CHINESE);
+        put("chineseTraditional", InstabugLocale.TRADITIONAL_CHINESE);
+        put("danish", InstabugLocale.DANISH);
+        put("dutch", InstabugLocale.NETHERLANDS);
+        put("english", InstabugLocale.ENGLISH);
+        put("french", InstabugLocale.FRENCH);
+        put("german", InstabugLocale.GERMAN);
+        put("italian", InstabugLocale.ITALIAN);
+        put("japanese", InstabugLocale.JAPANESE);
+        put("korean", InstabugLocale.KOREAN);
+        put("polish", InstabugLocale.POLISH);
+        put("portugueseBrazil", InstabugLocale.PORTUGUESE_BRAZIL);
+        put("russian", InstabugLocale.RUSSIAN);
+        put("spanish", InstabugLocale.SPANISH);
+        put("swedish", InstabugLocale.SWEDISH);
+        put("turkish", InstabugLocale.TURKISH);
+        put("czech", InstabugLocale.CZECH);
+    }};
 }