fix: [AND] deprecate start api and introduce init

Author: AyaMahmoud148

example/www/js/index.js

@@ -1,19 +1,18 @@
+
 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");
-
+  var ArgsRegistry = cordova.require("instabug-cordova.ArgsRegistry")
   console.log("Running cordova-" + cordova.platformId + "@" + cordova.version);
   document.getElementById("deviceready").classList.add("ready");
+  Instabug.init({
+    token: 'cb518c145decef204b0735cb7efa6016',
+    invocationEvents: [BugReporting.invocationEvents.button],
+    debugLogsLevel: ArgsRegistry.logLeve.verbose,
+  });
 
-  // Initialize Instabug SDK
-  Instabug.start(
-    "cb518c145decef204b0735cb7efa6016",
-    [BugReporting.invocationEvents.button],
-    () => console.log("Instabug initialized."),
-    (error) => console.log("Instabug could not be initialized - " + error)
-  );
 }

example/yarn.lock

@@ -239,6 +239,8 @@ fill-range@^7.0.1:
 
 fs-extra@^10.1.0:
   version "10.1.0"
+  resolved "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz"
+  integrity sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==
   dependencies:
     graceful-fs "^4.2.0"
     jsonfile "^6.0.1"

src/android/IBGPlugin.java

@@ -29,6 +29,7 @@
 import com.instabug.library.invocation.util.InstabugFloatingButtonEdge;
 import com.instabug.library.invocation.util.InstabugVideoRecordingButtonPosition;
 import com.instabug.library.logging.InstabugLog;
+import com.instabug.library.LogLevel;
 import com.instabug.library.model.Report;
 import com.instabug.library.ui.onboarding.WelcomeMessage;
 import com.instabug.survey.callbacks.*;
@@ -135,6 +136,44 @@ public void start(final CallbackContext callbackContext, JSONArray args) {
             callbackContext.error(errorMsg);
         }
     }
+    /**
+     * Initializes Instabug.
+     *
+     * @param callbackContext Used when calling back into JavaScript
+     */
+    public void init(final CallbackContext callbackContext, JSONArray args) {
+        if (args == null || args.length() == 0) {
+            callbackContext.error("Initialization parameters are required.");
+            return;
+        }
+    
+        try {
+            JSONObject options = args.getJSONObject(0); // Extract the JSON object from the array
+    
+            String token = options.optString("token");
+            JSONArray invocationEventsArray = options.optJSONArray("invocationEvents");
+            String logLevel = options.optString("debugLogsLevel", "none"); // Default to "none" if missing
+        
+            String[] invocationEventsNames = toStringArray(invocationEventsArray);
+            InstabugInvocationEvent[] invocationEvents = new InstabugInvocationEvent[invocationEventsNames.length];
+    
+            for (int i = 0; i < invocationEventsNames.length; i++) {
+                invocationEvents[i] = parseInvocationEvent(invocationEventsNames[i]);
+            }
+    
+            final Application application = (Application) context.getApplicationContext();
+            new Instabug.Builder(application, token)
+                    .setInvocationEvents(invocationEvents)
+                    .setSdkDebugLogsLevel(parseLogLevel(logLevel)) // Set the log level properly
+                    .build();
+    
+            callbackContext.success();
+        } catch (JSONException e) {
+            callbackContext.error("Invalid JSON format: " + e.getMessage());
+        } catch (IllegalStateException e) {
+            callbackContext.error(errorMsg);
+        }
+    }
 
     public final void show(final CallbackContext callbackContext) {
         try {
@@ -1196,7 +1235,18 @@ public static InstabugInvocationEvent parseInvocationEvent(String event) {
         } else
             return null;
     }
-
+    public static int parseLogLevel(String log) {
+        if ("none".equals(log)) {
+            return LogLevel.NONE;
+        } else if ("debug".equals(log)) {
+            return LogLevel.DEBUG;
+        } else if ("error".equals(log)) {
+            return LogLevel.ERROR;
+        } else if ("verbose".equals(log)) {
+            return LogLevel.VERBOSE;
+        }else
+            return -1;
+    }
     /**
      * Convenience method for converting string to InvocationOption.
      *

src/modules/ArgsRegistry.ts

@@ -128,5 +128,12 @@ namespace ArgsRegistry {
     swedish = "swedish",
     turkish = "turkish",
   }
+
+  export enum logLeve {
+    none = "none",
+    debug = "debug",
+    error = "error",
+    verbose = "verbose",
+  }
 }
 export = ArgsRegistry;

src/modules/BugReporting.ts

@@ -26,7 +26,7 @@ namespace BugReporting {
     swipe = "swipe",
     none = "none",
   }
-
+  
   export enum extendedBugReportMode {
     enabledWithRequiredFields = "enabledWithRequiredFields",
     enabledWithOptionalFields = "enabledWithOptionalFields",

src/modules/Instabug.ts

@@ -1,6 +1,7 @@
 import { exec } from "./IBGCordova";
 import registry from "./ArgsRegistry";
 import bugReporting from "./BugReporting";
+import ArgsRegistry from "./ArgsRegistry";
 
 namespace Instabug {
   export const welcomeMessageMode = registry.welcomeMessageMode;
@@ -11,6 +12,7 @@ namespace Instabug {
   export const locale = registry.locale;
 
   /**
+   * @deprecated This method is deprecated and will be removed in a future version. Use `init` instead.
    * Starts the SDK.
    * This is the main SDK method that does all the magic. This is the only
    * method that SHOULD be called.
@@ -32,6 +34,31 @@ namespace Instabug {
     exec("IBGPlugin", "start", [token, invocationEvents], success, error);
   };
 
+/**
+ * Initializes the Instabug SDK with additional configurations.
+ *
+ * @param token The token that identifies the app, available on your dashboard.
+ * @param invocationEvents An array of invocation events that trigger the SDK's UI.
+ * @param logLevel The level of detail in logs that you want to print.
+ * @param success Callback on function success.
+ * @param error Callback on function error.
+ */
+export const init = (
+  token: string,
+  invocationEvents: bugReporting.invocationEvents[],
+  logLevel: ArgsRegistry.logLeve,
+  success?: () => void,
+  error?: (err: any) => void
+) => {
+  exec(
+    "IBGPlugin", // Plugin name
+    "init", // Action name
+    [token, invocationEvents, logLevel], // Arguments
+    success,
+    error
+  );
+};
+
   /**
    * Shows default Instabug prompt.
    *
@@ -379,22 +406,6 @@ export const setReproStepsConfig = (
     exec("IBGPlugin", "logOut", [], success, error);
   };
 
-  /**
-   * Enable/Disable debug logs from Instabug SDK
-   * Default state: disabled
-   *
-   * @param isDebugEnabled a boolean to control whether debug logs should be printed or not into LogCat.
-   * @param success callback on function success.
-   * @param error callback on function error.
-   */
-  export const setDebugEnabled = (
-    isDebugEnabled: boolean,
-    success?: () => void,
-    error?: (err: any) => void
-  ) => {
-    exec("IBGPlugin", "setDebugEnabled", [isDebugEnabled], success, error);
-  };
-
   /**
    * Sets the SDK's locale.
    * Use to change the SDK's UI to different language.