[MOB-11550] Introduce New Enums (#914)

Author: TheBuggedYRN

CHANGELOG.md

@@ -4,6 +4,7 @@
 - Bumps Instabug iOS SDK to v11.7.0
 - Adds monorepo support for source maps scripts
 - Fixes global error handler not being called.
+- Deprecates all module-enums (e.g. `Instabug.invocationEvent`) in favour of standalone-enums (e.g. `InvocationEvent`). See [#914](https://github.com/Instabug/Instabug-React-Native/pull/914) for more info and detailed list of Enums.
 - Deprecates Instabug.start in favour of Instabug.init that takes a configuration object for SDK initialization.
 - Deprecates Instabug.setDebugEnabled, Instabug.setSdkDebugLogsLevel, and APM.setLogLevel in favour of debugLogsLevel property, which can be passed to InstabugConfig while initializing the SDK using Instabug.init.
 - Deprecates the enums: sdkDebugLogsLevel and logLevel in favour of a new enum LogLevel.

example/src/App.tsx

@@ -1,7 +1,7 @@
 import React, { useEffect } from 'react';
 
 import { NavigationContainer } from '@react-navigation/native';
-import Instabug, { LogLevel } from 'instabug-reactnative';
+import Instabug, { InvocationEvent, LogLevel } from 'instabug-reactnative';
 import { NativeBaseProvider } from 'native-base';
 
 import { RootTabNavigator } from './navigation/RootTab';
@@ -12,8 +12,8 @@ export const App: React.FC = () => {
   useEffect(() => {
     Instabug.init({
       token: 'deb1910a7342814af4e4c9210c786f35',
-      invocationEvents: [Instabug.invocationEvent.floatingButton],
-      debugLogsLevel: LogLevel.Verbose,
+      invocationEvents: [InvocationEvent.floatingButton],
+      debugLogsLevel: LogLevel.verbose,
     });
   }, []);
 

example/src/screens/BugReportingScreen.tsx

@@ -1,6 +1,6 @@
 import React from 'react';
 
-import Instabug, { BugReporting } from 'instabug-reactnative';
+import Instabug, { BugReporting, InvocationOption, ReportType } from 'instabug-reactnative';
 
 import { ListTile } from '../components/ListTile';
 import { Screen } from '../components/Screen';
@@ -9,22 +9,12 @@ export const BugReportingScreen: React.FC = () => {
   return (
     <Screen>
       <ListTile title="Show" onPress={() => Instabug.show()} />
-      <ListTile
-        title="Send Bug Report"
-        onPress={() => BugReporting.show(BugReporting.reportType.bug, [])}
-      />
+      <ListTile title="Send Bug Report" onPress={() => BugReporting.show(ReportType.bug, [])} />
       <ListTile
         title="Send Feedback"
-        onPress={() =>
-          BugReporting.show(BugReporting.reportType.feedback, [
-            BugReporting.option.emailFieldHidden,
-          ])
-        }
-      />
-      <ListTile
-        title="Ask a Question"
-        onPress={() => BugReporting.show(BugReporting.reportType.question, [])}
+        onPress={() => BugReporting.show(ReportType.feedback, [InvocationOption.emailFieldHidden])}
       />
+      <ListTile title="Ask a Question" onPress={() => BugReporting.show(ReportType.question, [])} />
     </Screen>
   );
 };

example/src/screens/SettingsScreen.tsx

@@ -1,6 +1,6 @@
 import React, { useState } from 'react';
 
-import Instabug, { BugReporting } from 'instabug-reactnative';
+import Instabug, { BugReporting, ColorTheme, InvocationEvent } from 'instabug-reactnative';
 import { Input, InputGroup, InputLeftAddon } from 'native-base';
 
 import { ListTile } from '../components/ListTile';
@@ -18,23 +18,23 @@ export const SettingsScreen: React.FC = () => {
           items={[
             {
               label: 'None',
-              value: Instabug.invocationEvent.none,
+              value: InvocationEvent.none,
             },
             {
               label: 'Shake',
-              value: Instabug.invocationEvent.shake,
+              value: InvocationEvent.shake,
             },
             {
               label: 'Screenshot',
-              value: Instabug.invocationEvent.screenshot,
+              value: InvocationEvent.screenshot,
             },
             {
               label: 'Two fingers swipe left',
-              value: Instabug.invocationEvent.twoFingersSwipe,
+              value: InvocationEvent.twoFingersSwipe,
             },
             {
               label: 'Floating button',
-              value: Instabug.invocationEvent.floatingButton,
+              value: InvocationEvent.floatingButton,
               isInitial: true,
             },
           ]}
@@ -68,11 +68,11 @@ export const SettingsScreen: React.FC = () => {
           items={[
             {
               label: 'Light',
-              value: Instabug.colorTheme.light,
+              value: ColorTheme.light,
             },
             {
               label: 'Dark',
-              value: Instabug.colorTheme.dark,
+              value: ColorTheme.dark,
             },
           ]}
           onValueChange={Instabug.setColorTheme}

src/index.ts

@@ -13,6 +13,7 @@ import * as Replies from './modules/Replies';
 import type { Survey } from './modules/Surveys';
 import * as Surveys from './modules/Surveys';
 
+export * from './utils/Enums';
 export {
   Report,
   Trace,
@@ -24,8 +25,6 @@ export {
   Replies,
   Surveys,
 };
-export * from './utils/Enums';
-
 export type { InstabugConfig };
 export type { Survey };
 

src/models/InstabugConfig.ts

@@ -1,5 +1,5 @@
 import type { invocationEvent } from '../utils/ArgsRegistry';
-import type { LogLevel } from '../utils/Enums';
+import type { InvocationEvent, LogLevel } from '../utils/Enums';
 
 export interface InstabugConfig {
   /**
@@ -9,7 +9,7 @@ export interface InstabugConfig {
   /**
    * An array of events that invoke the SDK's UI.
    */
-  invocationEvents: invocationEvent[];
+  invocationEvents: invocationEvent[] | InvocationEvent[];
   /**
    * An optional LogLevel to indicate the verbosity of SDK logs. Default is Error.
    */

src/modules/BugReporting.ts

@@ -10,6 +10,15 @@ import {
   position,
   reportType,
 } from '../utils/ArgsRegistry';
+import type {
+  DismissType,
+  ExtendedBugReportMode,
+  FloatingButtonPosition,
+  InvocationEvent,
+  InvocationOption,
+  RecordingButtonPosition,
+  ReportType,
+} from '../utils/Enums';
 import IBGEventEmitter from '../utils/IBGEventEmitter';
 import InstabugConstants from '../utils/InstabugConstants';
 
@@ -28,7 +37,7 @@ export const setEnabled = (isEnabled: boolean) => {
  * Default is set by `Instabug.init`.
  * @param events Array of events that invokes the feedback form.
  */
-export const setInvocationEvents = (events: invocationEvent[]) => {
+export const setInvocationEvents = (events: invocationEvent[] | InvocationEvent[]) => {
   NativeBugReporting.setInvocationEvents(events);
 };
 
@@ -37,7 +46,7 @@ export const setInvocationEvents = (events: invocationEvent[]) => {
  * Default is set by `Instabug.init`.
  * @param options Array of invocation options
  */
-export const setOptions = (options: option[]) => {
+export const setOptions = (options: option[] | InvocationOption[]) => {
   NativeBugReporting.setOptions(options);
 };
 
@@ -59,7 +68,7 @@ export const onInvokeHandler = (handler: () => void) => {
  * @param handler A callback to get executed after dismissing the SDK.
  */
 export const onSDKDismissedHandler = (
-  handler: (dismissType: dismissType, reportType: reportType) => void,
+  handler: (dismissType: dismissType | DismissType, reportType: reportType | ReportType) => void,
 ) => {
   IBGEventEmitter.addListener(
     NativeBugReporting,
@@ -112,15 +121,15 @@ export const setShakingThresholdForAndroid = (threshold: number) => {
  * @param mode An enum to disable the extended bug report mode,
  * enable it with required or with optional fields.
  */
-export const setExtendedBugReportMode = (mode: extendedBugReportMode) => {
+export const setExtendedBugReportMode = (mode: extendedBugReportMode | ExtendedBugReportMode) => {
   NativeBugReporting.setExtendedBugReportMode(mode);
 };
 
 /**
  * Sets what type of reports, bug or feedback, should be invoked.
  * @param types Array of reportTypes
  */
-export const setReportTypes = (types: reportType[]) => {
+export const setReportTypes = (types: reportType[] | ReportType[]) => {
   NativeBugReporting.setReportTypes(types);
 };
 
@@ -129,7 +138,7 @@ export const setReportTypes = (types: reportType[]) => {
  * @param type
  * @param options
  */
-export const show = (type: reportType, options: option[]) => {
+export const show = (type: reportType | ReportType, options: option[] | InvocationOption[]) => {
   NativeBugReporting.show(type, options ?? []);
 };
 
@@ -162,7 +171,9 @@ export const setAutoScreenRecordingDurationIOS = (maxDuration: number) => {
  * @param buttonPosition is of type position `topLeft` to show on the top left
  * of screen, or `bottomRight` to show on the bottom right of screen.
  */
-export const setVideoRecordingFloatingButtonPosition = (buttonPosition: position) => {
+export const setVideoRecordingFloatingButtonPosition = (
+  buttonPosition: position | RecordingButtonPosition,
+) => {
   NativeBugReporting.setVideoRecordingFloatingButtonPosition(buttonPosition);
 };
 
@@ -198,7 +209,10 @@ export const setDidSelectPromptOptionHandler = (handler: (promptOption: string)
  * @param edge The screen edge to show the floating button onto. Default is `floatingButtonEdge.right`.
  * @param offset The offset of the floating button from the top of the screen. Default is 50.
  */
-export const setFloatingButtonEdge = (edge: floatingButtonEdge, offset: number) => {
+export const setFloatingButtonEdge = (
+  edge: floatingButtonEdge | FloatingButtonPosition,
+  offset: number,
+) => {
   NativeBugReporting.setFloatingButtonEdge(edge, offset);
 };
 
@@ -237,6 +251,9 @@ export const setDisclaimerText = (text: string) => {
  * @param limit int number of characters.
  * @param reportTypes (Optional) Array of reportType. If it's not passed, the limit will apply to all report types.
  */
-export const setCommentMinimumCharacterCount = (limit: number, reportTypes?: reportType[]) => {
+export const setCommentMinimumCharacterCount = (
+  limit: number,
+  reportTypes?: reportType[] | ReportType[],
+) => {
   NativeBugReporting.setCommentMinimumCharacterCount(limit, reportTypes ?? []);
 };

src/modules/FeatureRequests.ts

@@ -1,5 +1,6 @@
 import { NativeFeatureRequests } from '../native';
 import { actionTypes } from '../utils/ArgsRegistry';
+import type { ActionType } from '../utils/Enums';
 
 export { actionTypes };
 
@@ -20,7 +21,10 @@ export const setEnabled = (isEnabled: boolean) => {
  * @param isEmailFieldRequired A boolean to indicate whether email field is required or not.
  * @param types An enum that indicates which action types will have the isEmailFieldRequired
  */
-export const setEmailFieldRequired = (isEmailFieldRequired: boolean, types: actionTypes) => {
+export const setEmailFieldRequired = (
+  isEmailFieldRequired: boolean,
+  types: actionTypes | ActionType,
+) => {
   NativeFeatureRequests.setEmailFieldRequiredForFeatureRequests(isEmailFieldRequired, types);
 };
 

src/modules/Instabug.ts

@@ -22,7 +22,15 @@ import {
   strings,
   welcomeMessageMode,
 } from '../utils/ArgsRegistry';
-import { LogLevel } from '../utils/Enums';
+import {
+  ColorTheme,
+  InvocationEvent,
+  Locale,
+  LogLevel,
+  ReproStepsMode,
+  StringKey,
+  WelcomeMessageMode,
+} from '../utils/Enums';
 import IBGEventEmitter from '../utils/IBGEventEmitter';
 import InstabugConstants from '../utils/InstabugConstants';
 import InstabugUtils, { stringifyIfNotString } from '../utils/InstabugUtils';
@@ -65,7 +73,7 @@ export const setEnabled = (isEnabled: boolean) => {
  * @param token The token that identifies the app, you can find it on your dashboard.
  * @param invocationEvents The events that invokes the SDK's UI.
  */
-export const start = (token: string, invocationEvents: invocationEvent[]) => {
+export const start = (token: string, invocationEvents: invocationEvent[] | InvocationEvent[]) => {
   init({ token: token, invocationEvents: invocationEvents });
 };
 
@@ -83,7 +91,7 @@ export const init = (config: InstabugConfig) => {
   NativeInstabug.init(
     config.token,
     config.invocationEvents,
-    config.debugLogsLevel ?? LogLevel.Error,
+    config.debugLogsLevel ?? LogLevel.error,
   );
 
   _isFirstScreen = true;
@@ -159,15 +167,15 @@ export const setSdkDebugLogsLevel = (level: sdkDebugLogsLevel) => {
  * Defaults to the device's current locale.
  * @param sdkLocale A locale to set the SDK to.
  */
-export const setLocale = (sdkLocale: locale) => {
+export const setLocale = (sdkLocale: locale | Locale) => {
   NativeInstabug.setLocale(sdkLocale);
 };
 
 /**
  * Sets the color theme of the SDK's whole UI.
  * @param sdkTheme
  */
-export const setColorTheme = (sdkTheme: colorTheme) => {
+export const setColorTheme = (sdkTheme: colorTheme | ColorTheme) => {
   NativeInstabug.setColorTheme(sdkTheme);
 };
 
@@ -212,7 +220,7 @@ export const getTags = (callback: (tags: string[]) => void) => {
  * @param key Key of string to override.
  * @param string String value to override the default one.
  */
-export const setString = (key: strings, string: string) => {
+export const setString = (key: strings | StringKey, string: string) => {
   NativeInstabug.setString(string, key);
 };
 
@@ -350,7 +358,7 @@ export const clearLogs = () => {
  *
  * @param mode An enum to set user steps tracking to be enabled, non visual or disabled.
  */
-export const setReproStepsMode = (mode: reproStepsMode) => {
+export const setReproStepsMode = (mode: reproStepsMode | ReproStepsMode) => {
   NativeInstabug.setReproStepsMode(mode);
 };
 
@@ -463,15 +471,15 @@ export const isRunningLive = (callback: (isLive: boolean) => void) => {
  * Shows the welcome message in a specific mode.
  * @param mode An enum to set the welcome message mode to live, or beta.
  */
-export const showWelcomeMessage = (mode: welcomeMessageMode) => {
+export const showWelcomeMessage = (mode: welcomeMessageMode | WelcomeMessageMode) => {
   NativeInstabug.showWelcomeMessageWithMode(mode);
 };
 
 /**
  * Sets the welcome message mode to live, beta or disabled.
  * @param mode An enum to set the welcome message mode to live, beta or disabled.
  */
-export const setWelcomeMessageMode = (mode: welcomeMessageMode) => {
+export const setWelcomeMessageMode = (mode: welcomeMessageMode | WelcomeMessageMode) => {
   NativeInstabug.setWelcomeMessageMode(mode);
 };
 

src/native.ts

@@ -3,7 +3,9 @@ import {
   NativeModules as ReactNativeModules,
 } from 'react-native';
 
-export interface NativeModule extends ReactNativeModule, Record<string, any> {}
+export interface NativeModule extends ReactNativeModule, Record<string, any> {
+  getConstants: () => Record<string, any>;
+}
 
 interface InstabugNativeModules {
   IBGAPM: NativeModule;