Merge pull request #526 from Instabug/feature/typescript-validation

[MOB-4605] Typescript Definition Validation

Author: ymabdallah

.circleci/config.yml

@@ -16,6 +16,10 @@ jobs:
 
       - run: yarn
 
+      - run:
+          name: Typescript Definitions Validation
+          command: node typescript_validator.js
+
       - run:
           name: jest tests
           command: |

index.d.ts

@@ -7,14 +7,24 @@ export namespace BugReporting {
   function setEnabled(isEnabled: boolean): void;
   function setInvocationEvents(invocationEvents: invocationEvent[]): void;
   function setInvocationOptions(invocationOptions: invocationOptions[]): void;
+  function setOptions(options: invocationOptions[]): void;
   function onInvokeHandler(handler: () => void): void;
-  function onReportSubmitHandler(preSendingHandler: () => void): void;
   function onSDKDismissedHandler(
     handler: (dismiss: dismissType, report: reportType) => void
   ): void;
   function setDidSelectPromptOptionHandler(
     didSelectPromptOptionHandler: () => void
   ): void;
+  function setFloatingButtonEdge(
+    floatingButtonEdge: number,
+    offsetFromTop: number
+  ): void;
+  function setEnabledAttachmentTypes(
+    screenshot: boolean,
+    extraScreenshot: boolean,
+    galleryImage: boolean,
+    screenRecording: boolean
+  ): void;
   function setShakingThresholdForiPhone(iPhoneShakingThreshold: number): void;
   function setShakingThresholdForiPad(iPadShakingThreshold: number): void;
   function setShakingThresholdForAndroid(androidThreshold: number): void;
@@ -24,8 +34,11 @@ export namespace BugReporting {
   function setReportTypes(types: reportType[]): void;
   function showWithOptions(type: reportType, options: option[]): void;
   function show(type: reportType, options: option[]): void;
-  function setAutoScreenRecordingEnabled(isEnabled: boolean): void;
-  function setViewHierarchyEnabled(isEnabled: boolean): void;
+  function setAutoScreenRecordingEnabled(autoScreenRecordingEnabled: boolean): void;
+  function setAutoScreenRecordingMaxDuration(
+    autoScreenRecordingMaxDuration: number
+  ): void;
+  function setViewHierarchyEnabled(viewHierarchyEnabled: boolean): void;
   enum invocationEvent {
     none,
     shake,
@@ -62,7 +75,7 @@ export namespace Chats {
 }
 export namespace CrashReporting {
   function setEnabled(isEnabled: boolean): void;
-  function reportJSException(Exception: object): void;
+  function reportJSException(errorObject: object): void;
 }
 export namespace FeatureRequests {
   function setEmailFieldRequired(
@@ -72,8 +85,6 @@ export namespace FeatureRequests {
   function setEnabled(isEnabled: boolean): void;
   function show(): void;
   enum actionTypes {
-    allActions,
-    reportBug,
     requestNewFeature,
     addCommentToFeature
   }
@@ -146,6 +157,14 @@ export namespace APM {
   function startUITrace(name: string): void;
   function endUITrace(): void;
   function setLogLevel(logLevel: logLevel): void;
+  enum logLevel {
+    none,
+    error,
+    warning,
+    info,
+    debug,
+    verbose,
+  }
 }
 export function startWithToken(
   token: string,
@@ -229,7 +248,7 @@ export function setDebugEnabled(isDebugEnabled: boolean): void;
 export function enable(): void;
 export function disable(): void;
 export function setEnableInAppNotificationSound(shouldPlaySound: boolean): void;
-export function reportJSException(Exception: object): void;
+export function reportJSException(errorObject: object): void;
 export function isRunningLive(runningLiveCallBack: () => void): void;
 export function setVideoRecordingFloatingButtonPosition(
   position: IBGPosition
@@ -293,14 +312,6 @@ export enum sdkDebugLogsLevel {
   sdkDebugLogsLevelError,
   sdkDebugLogsLevelNone,
 }
-export enum logLevel {
-  none,
-  error,
-  warning,
-  info,
-  debug,
-  verbose,
-}
 export enum extendedBugReportMode {
   enabledWithRequiredFields,
   enabledWithOptionalFields,
@@ -362,7 +373,7 @@ export enum strings {
   invalidCommentMessage,
   invalidCommentTitle,
   invocationHeader,
-  talkToUs,
+  startChats,
   reportQuestion,
   reportBug,
   reportFeedback,

index.js

@@ -251,10 +251,10 @@ const InstabugModule = {
    * Sets the color of UI elements indicating interactivity or call to action.
    * To use, import processColor and pass to it with argument the color hex
    * as argument.
-   * @param {color} primaryColor A color to set the UI elements of the SDK to.
+   * @param {color} color A color to set the UI elements of the SDK to.
    */
-  setPrimaryColor(primaryColor) {
-    Instabug.setPrimaryColor(processColor(primaryColor));
+  setPrimaryColor(color) {
+    Instabug.setPrimaryColor(processColor(color));
   },
 
   /**
@@ -646,7 +646,7 @@ const InstabugModule = {
    * @deprecated use {@link CrashReporting.reportJSException}
    * Send handled JS error object
    *
-   * @param errorObject   Error object to be sent to Instabug's servers
+   * @param errorObject Error object to be sent to Instabug's servers
    */
 
   reportJSException(errorObject) {

modules/APM.js

@@ -33,7 +33,7 @@ export default {
      * logLevelInfo will include logLevelInfo logs as well as logLevelWarning
      * and logLevelError logs.
 
-     * @param {logLevel} the printed logs priority.
+     * @param {logLevel} logLevel the printed logs priority.
      */
     setLogLevel(logLevel) {
         IBGAPM.setLogLevel(logLevel);

modules/CrashReporting.js

@@ -21,7 +21,7 @@ export default {
   /**
    * Send handled JS error object
    *
-   * @param errorObject   Error object to be sent to Instabug's servers
+   * @param errorObject Error object to be sent to Instabug's servers
    */
   reportJSException: function(errorObject) {
     let jsStackTrace = InstabugUtils.parseErrorStack(errorObject);

package.json

@@ -40,7 +40,9 @@
     "react": "^16.8.6",
     "react-native": "^0.59.8",
     "sinon": "^7.3.2",
-    "wait-for-expect": "^1.2.0"
+    "wait-for-expect": "^1.2.0",
+    "esprima": "^4.0.1",
+    "typescript": "^4.0.3"
   },
   "jest": {
     "preset": "react-native",