instabug-cordova - npm Package Compare versions

Comparing version 11.7.0 to 12.1.0

CHANGELOG.md

@@ -0,1 +1,18 @@
+
+## 12.1.0 (2025-03-03)
+* Bumps Instabug iOS SDK to `v12.1.0`
+* Bumps Instabug Android SDK to `v12.1.0`
+
+### Changed
+
+- Add the new repro steps configuration API `Instabug.setReproStepsConfig`
+- Remove deprecated APIs `Instabug.setDebugEnabled` in favour of `debugLogsLevel` property of `Instabug.init`.
+- Adds the new `Instabug.init` API to start the SDK as follows:
+  ```js
+  Instabug.init({
+    token: '<APP_TOKEN>',
+    invocationEvents: [BugReporting.invocationEvents.button],
+    debugLogsLevel: ArgsRegistry.logLeve.verbose,
+  });
+  ```
 ## 11.7.0 (2023-02-02)
@@ -2,0 +19,0 @@

package.json

 {
   "name": "instabug-cordova",
   "description": "Cordova plugin for integrating the Instabug SDK.",
-  "version": "11.7.0",
+  "version": "12.1.0",
   "author": "Instabug (https://instabug.com)",
@@ -6,0 +6,0 @@ "repository": "github:Instabug/Instabug-Cordova",

src/modules/ArgsRegistry.ts

@@ -131,3 +131,10 @@ namespace ArgsRegistry {
   }
+
+  export enum logLeve {
+    none = "none",
+    debug = "debug",
+    error = "error",
+    verbose = "verbose",
+  }
 }
 export = ArgsRegistry;

src/modules/BugReporting.ts

@@ -29,3 +29,3 @@ /*
   }
-
+  
   export enum extendedBugReportMode {
@@ -32,0 +32,0 @@ enabledWithRequiredFields = "enabledWithRequiredFields",

src/modules/Instabug.ts

 import { exec } from "./IBGCordova";
 import registry from "./ArgsRegistry";
 import bugReporting from "./BugReporting";
+import ArgsRegistry from "./ArgsRegistry";
 
@@ -14,2 +15,3 @@ namespace Instabug {
   /**
+   * @deprecated This method is deprecated and will be removed in a future version. Use `init` instead.
    * Starts the SDK.
@@ -36,2 +38,27 @@ * This is the main SDK method that does all the magic. This is the only
 
+/**
+ * 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
+  );
+};
+
   /**
@@ -81,20 +108,42 @@ * Shows default Instabug prompt.
 
-  /**
-   * Sets whether user steps tracking is visual, non visual or disabled.
-   * User Steps tracking is enabled by default if it's available
-   * in your current plan.
-   *
-   * @param reproStepsMode an enum to set user steps tracking
-   * to be enabled, non visual or disabled.
-   * @param success callback on function success.
-   * @param error callback on function error.
-   */
-  export const setReproStepsMode = (
-    reproStepsMode: registry.reproStepsMode | `${registry.reproStepsMode}`,
-    success?: () => void,
-    error?: (err: any) => void
-  ) => {
-    exec("IBGPlugin", "setReproStepsMode", [reproStepsMode], success, error);
-  };
+/**
+ * Sets whether user steps tracking is visual, non visual or disabled.
+ * User Steps tracking is enabled by default if it's available
+ * in your current plan.
+ *
+ * @deprecated This method is deprecated and will be removed in a future version.
+ *             Use `setReproStepsConfig` instead.
+ *
+ * @param reproStepsMode an enum to set user steps tracking
+ * to be enabled, non visual or disabled.
+ * @param success callback on function success.
+ * @param error callback on function error.
+ */
+export const setReproStepsMode = (
+  reproStepsMode: registry.reproStepsMode | `${registry.reproStepsMode}`,
+  success?: () => void,
+  error?: (err: any) => void
+) => {
+  exec("IBGPlugin", "setReproStepsMode", [reproStepsMode], success, error);
+};
 
+/**
+ * Configures user steps tracking for bug, crash, and session replay issue types separately.
+ * User Steps tracking is enabled by default if it's available
+ * in your current plan.
+ *
+ * @param bugMode an enum to set user steps tracking for bug issues.
+ * @param crashMode an enum to set user steps tracking for crash issues.
+ * @param success callback on function success.
+ * @param error callback on function error.
+ */
+export const setReproStepsConfig = (
+  bugMode: registry.reproStepsMode | `${registry.reproStepsMode}`,
+  crashMode: registry.reproStepsMode | `${registry.reproStepsMode}`,
+  success?: () => void,
+  error?: (err: any) => void
+) => {
+  exec("IBGPlugin", "setReproStepsConfig", [bugMode, crashMode], success, error);
+};
+
   /**
@@ -364,18 +413,2 @@ * The session profiler is enabled by default and it attaches to the bug and
   /**
-   * 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.
@@ -382,0 +415,0 @@ * Use to change the SDK's UI to different language.

www/ArgsRegistry.d.ts

@@ -125,3 +125,9 @@ declare namespace ArgsRegistry {
     }
+    enum logLeve {
+        none = "none",
+        debug = "debug",
+        error = "error",
+        verbose = "verbose"
+    }
 }
 export = ArgsRegistry;

www/ArgsRegistry.js

@@ -134,3 +134,10 @@ "use strict";
     })(locale = ArgsRegistry.locale || (ArgsRegistry.locale = {}));
+    var logLeve;
+    (function (logLeve) {
+        logLeve["none"] = "none";
+        logLeve["debug"] = "debug";
+        logLeve["error"] = "error";
+        logLeve["verbose"] = "verbose";
+    })(logLeve = ArgsRegistry.logLeve || (ArgsRegistry.logLeve = {}));
 })(ArgsRegistry || (ArgsRegistry = {}));
 module.exports = ArgsRegistry;

www/Instabug.d.ts

 import registry from "./ArgsRegistry";
 import bugReporting from "./BugReporting";
+import ArgsRegistry from "./ArgsRegistry";
 declare namespace Instabug {
@@ -11,2 +12,3 @@ const welcomeMessageMode: typeof registry.welcomeMessageMode;
     /**
+     * @deprecated This method is deprecated and will be removed in a future version. Use `init` instead.
      * Starts the SDK.
@@ -26,2 +28,12 @@ * This is the main SDK method that does all the magic. This is the only
     /**
+     * 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.
+     */
+    const init: (token: string, invocationEvents: bugReporting.invocationEvents[], logLevel: ArgsRegistry.logLeve, success?: () => void, error?: ((err: any) => void) | undefined) => void;
+    /**
      * Shows default Instabug prompt.
@@ -58,2 +70,5 @@ *
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     *             Use `setReproStepsConfig` instead.
+     *
      * @param reproStepsMode an enum to set user steps tracking
@@ -66,2 +81,13 @@ * to be enabled, non visual or disabled.
     /**
+     * Configures user steps tracking for bug, crash, and session replay issue types separately.
+     * User Steps tracking is enabled by default if it's available
+     * in your current plan.
+     *
+     * @param bugMode an enum to set user steps tracking for bug issues.
+     * @param crashMode an enum to set user steps tracking for crash issues.
+     * @param success callback on function success.
+     * @param error callback on function error.
+     */
+    const setReproStepsConfig: (bugMode: registry.reproStepsMode | `${registry.reproStepsMode}`, crashMode: registry.reproStepsMode | `${registry.reproStepsMode}`, success?: () => void, error?: ((err: any) => void) | undefined) => void;
+    /**
      * The session profiler is enabled by default and it attaches to the bug and
@@ -221,11 +247,2 @@ * crash reports the following information during the last 60 seconds before the report is sent.
     /**
-     * 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.
-     */
-    const setDebugEnabled: (isDebugEnabled: boolean, success?: () => void, error?: ((err: any) => void) | undefined) => void;
-    /**
      * Sets the SDK's locale.
@@ -232,0 +249,0 @@ * Use to change the SDK's UI to different language.

www/Instabug.js

@@ -16,2 +16,3 @@ "use strict";
     /**
+     * @deprecated This method is deprecated and will be removed in a future version. Use `init` instead.
      * Starts the SDK.
@@ -33,2 +34,17 @@ * This is the main SDK method that does all the magic. This is the only
     /**
+     * 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.
+     */
+    Instabug.init = function (token, invocationEvents, logLevel, success, error) {
+        (0, IBGCordova_1.exec)("IBGPlugin", // Plugin name
+        "init", // Action name
+        [token, invocationEvents, logLevel], // Arguments
+        success, error);
+    };
+    /**
      * Shows default Instabug prompt.
@@ -71,2 +87,5 @@ *
      *
+     * @deprecated This method is deprecated and will be removed in a future version.
+     *             Use `setReproStepsConfig` instead.
+     *
      * @param reproStepsMode an enum to set user steps tracking
@@ -81,2 +100,15 @@ * to be enabled, non visual or disabled.
     /**
+     * Configures user steps tracking for bug, crash, and session replay issue types separately.
+     * User Steps tracking is enabled by default if it's available
+     * in your current plan.
+     *
+     * @param bugMode an enum to set user steps tracking for bug issues.
+     * @param crashMode an enum to set user steps tracking for crash issues.
+     * @param success callback on function success.
+     * @param error callback on function error.
+     */
+    Instabug.setReproStepsConfig = function (bugMode, crashMode, success, error) {
+        (0, IBGCordova_1.exec)("IBGPlugin", "setReproStepsConfig", [bugMode, crashMode], success, error);
+    };
+    /**
      * The session profiler is enabled by default and it attaches to the bug and
@@ -269,13 +301,2 @@ * crash reports the following information during the last 60 seconds before the report is sent.
     /**
-     * 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.
-     */
-    Instabug.setDebugEnabled = function (isDebugEnabled, success, error) {
-        (0, IBGCordova_1.exec)("IBGPlugin", "setDebugEnabled", [isDebugEnabled], success, error);
-    };
-    /**
      * Sets the SDK's locale.
@@ -282,0 +303,0 @@ * Use to change the SDK's UI to different language.

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

246770

4.56%

Lines of code

4177

3.62%

No dependency changes