Merge pull request #45 from bugfender/feature/add-bugfender-types-pckg

Add `@bugfender/types` and use the provided types & helpers

Author: Fran Montiel

.nvmrc

@@ -0,0 +1 @@
+16.15

package.json

@@ -115,17 +115,19 @@
       "prettier"
     ],
     "rules": {
-      "prettier/prettier": [
-        "error",
-        {
-          "quoteProps": "consistent",
-          "singleQuote": true,
-          "tabWidth": 2,
-          "trailingComma": "es5",
-          "useTabs": false
+      "prettier/prettier": "off"
+    },
+    "overrides": [
+      {
+        "files": [
+          "*.ts",
+          "*.tsx"
+        ],
+        "rules": {
+          "no-dupe-class-members": "off"
         }
-      ]
-    }
+      }
+    ]
   },
   "eslintIgnore": [
     "node_modules/",
@@ -153,7 +155,7 @@
     ]
   },
   "dependencies": {
-    "@bugfender/sdk": "^2.1.0",
-    "util": "^0.12.4"
+    "@bugfender/common": "1.0.0-alpha.0",
+    "@bugfender/sdk": "^2.1.0"
   }
 }

src/bugfender.ts

@@ -1,12 +1,8 @@
 import { NativeModules, Platform } from 'react-native';
+import { BugfenderFacade, DeviceKeyValue, LogEntry, LogLevel, PrintToConsole, UserFeedbackResult, format } from '@bugfender/common';
 import type { ISDKOptions } from './types/sdk-options';
-import type { UserFeedbackOptions, UserFeedbackResult } from './user-feedback';
+import type { UserFeedbackOptions } from './user-feedback';
 import { DefaultUserFeedbackOptions } from './user-feedback';
-import type { DeviceKeyValue } from './types/device';
-import type { ILogEntry } from './types/log';
-import { StringFormatter } from './string-formatter';
-import { LogLevel } from './types/log';
-import { PrintToConsole } from './print-to-console';
 import { SDKOptions } from './sdk-options';
 
 const LINKING_ERROR =
@@ -26,8 +22,7 @@ const RnBugfender = NativeModules.RnBugfender
     }
   );
 
-class BugfenderClass {
-  private stringFormatter = new StringFormatter();
+class BugfenderClass implements BugfenderFacade {
   private overrideConsoleMethods =
     new (require('./override-console-methods').OverrideConsoleMethods)(window);
   private printToConsole = new PrintToConsole(global.console);
@@ -56,7 +51,7 @@ class BugfenderClass {
         : RnBugfender.init(validatedOptions.appKey, validatedOptions.printToConsole ?? false);
 
       if (validatedOptions.overrideConsoleMethods) {
-        this.overrideConsoleMethods.init(this.stringFormatter);
+        this.overrideConsoleMethods.init();
       }
 
       this.printToConsole.init(validatedOptions.printToConsole ?? true);
@@ -160,7 +155,7 @@ class BugfenderClass {
   public log(...parameters: unknown[]): void {
     this.printToConsole.log(...parameters);
 
-    let message = this.stringFormatter.format([...parameters]);
+    let message = format([...parameters]);
     RnBugfender.debug('', message);
   }
 
@@ -179,7 +174,7 @@ class BugfenderClass {
   public warn(...parameters: unknown[]): void {
     this.printToConsole.warn(...parameters);
 
-    let message = this.stringFormatter.format([...parameters]);
+    let message = format([...parameters]);
     RnBugfender.warning('', message);
   }
 
@@ -198,7 +193,7 @@ class BugfenderClass {
   public error(...parameters: unknown[]): void {
     this.printToConsole.error(...parameters);
 
-    let message = this.stringFormatter.format([...parameters]);
+    let message = format([...parameters]);
     RnBugfender.error('', message);
   }
 
@@ -217,7 +212,7 @@ class BugfenderClass {
   public trace(...parameters: unknown[]): void {
     this.printToConsole.trace(...parameters);
 
-    let message = this.stringFormatter.format([...parameters]);
+    let message = format([...parameters]);
     RnBugfender.trace('', message);
   }
 
@@ -236,7 +231,7 @@ class BugfenderClass {
   public info(...parameters: unknown[]): void {
     this.printToConsole.info(...parameters);
 
-    let message = this.stringFormatter.format([...parameters]);
+    let message = format([...parameters]);
     RnBugfender.info('', message);
   }
 
@@ -255,7 +250,7 @@ class BugfenderClass {
   public fatal(...parameters: unknown[]): void {
     this.printToConsole.error(...parameters);
 
-    let message = this.stringFormatter.format([...parameters]);
+    let message = format([...parameters]);
     RnBugfender.fatal('', message);
   }
 
@@ -274,7 +269,7 @@ class BugfenderClass {
    *
    * @param log Log object that complies with `ILogEntry` interface.
    */
-  public sendLog(log: ILogEntry): void {
+  public sendLog(log: LogEntry): void {
     this.printToConsole.printLog(log);
 
     RnBugfender.log(

src/index.tsx

@@ -1,4 +1,4 @@
-import { LogLevel } from './types/log';
+import { LogLevel } from '@bugfender/common';
 import { SDKOptionsBuilder } from './types/sdk-options';
 import { BugfenderClass } from './bugfender';
 

src/index.web.tsx

@@ -1,5 +1,5 @@
-import { LogLevel } from './types/log';
 import { SDKOptionsBuilder } from './types/sdk-options';
 import { Bugfender } from '@bugfender/sdk';
+import type { LogLevel } from '@bugfender/common';
 
 export { Bugfender, LogLevel, SDKOptionsBuilder };

src/override-console-methods.ts

@@ -1,6 +1,5 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
+import {format} from '@bugfender/common';
 import {RnBugfender} from "./bugfender";
-import type {StringFormatter} from "./string-formatter";
 
 /**
  * Overrides the `window.console` methods in order to execute the Bugfender equivalent logging
@@ -12,39 +11,39 @@ export class OverrideConsoleMethods {
   ) {
   }
 
-  public init(stringFormatter: StringFormatter): void {
+  public init(): void {
 
     (this.window as any).console = function (console: Console) {
       return {
         ...console,
         log: function (...parameters: unknown[]) {
           console.log(...parameters);
-          let message = stringFormatter.format([...parameters]);
+          let message = format([...parameters]);
           RnBugfender.debug('', message);
         },
         debug: function (...parameters: unknown[]) {
           console.debug(...parameters);
-          let message = stringFormatter.format([...parameters]);
+          let message = format([...parameters]);
           RnBugfender.debug('', message);
         },
         trace: function (...parameters: unknown[]) {
           console.trace(...parameters);
-          let message = stringFormatter.format([...parameters]);
+          let message = format([...parameters]);
           RnBugfender.trace('', message);
         },
         info: function (...parameters: unknown[]) {
           console.info(...parameters);
-          let message = stringFormatter.format([...parameters]);
+          let message = format([...parameters]);
           RnBugfender.info('', message);
         },
         warn: function (...parameters: unknown[]) {
           console.warn(...parameters);
-          let message = stringFormatter.format([...parameters]);
+          let message = format([...parameters]);
           RnBugfender.warning('', message);
         },
         error: function (...parameters: unknown[]) {
           console.error(...parameters);
-          let message = stringFormatter.format([...parameters]);
+          let message = format([...parameters]);
           RnBugfender.error('', message);
         },
       };

src/print-to-console.ts

@@ -1,8 +1,8 @@
 import type {ISDKOptions} from "./types/sdk-options";
-import {removeUndefinedAttributes} from "./utilities";
+import {prepareOptions, validate, ValidationRules} from "@bugfender/common";
 
 export class SDKOptions {
-  protected rules = {
+  protected rules: ValidationRules = {
     appKey: ['required', 'string'],
     apiURL: ['string', 'url'],
     baseURL: ['string', 'url'],
@@ -15,11 +15,11 @@ export class SDKOptions {
   };
 
   public init(options: ISDKOptions): ISDKOptions {
-    // Validate user provided options
-    this.validate(options);
+    // Prepare options
+    options = prepareOptions(options);
 
-    options = { ...options };
-    removeUndefinedAttributes(options);
+    // Validate user provided options
+    validate(options, this.rules);
 
     // Set default values if needed
     return {
@@ -32,33 +32,4 @@ export class SDKOptions {
       ...options,
     };
   }
-
-  protected validate(options: ISDKOptions): void {
-    const urlValidator = new RegExp(/^http(s)?:\/\//i);
-
-    Object.entries(this.rules).forEach(([key, rules]) => {
-      // @ts-ignore
-      const value = options[key];
-
-      rules.forEach(rule => {
-        if (rule === 'required') {
-          if (typeof value === 'undefined') {
-            throw new Error(`Bugfender requires '${key}' option to initialize.`)
-          }
-        } else if (rule === 'string') {
-          if (!['string', 'undefined'].includes(typeof value)) {
-            throw new Error(`'${key}' option must be a string.`);
-          }
-        } else if (rule === 'url') {
-          if (typeof value !== 'undefined' && !urlValidator.test(value)) {
-            throw new Error(`'${key}' option must be a valid URL.`);
-          }
-        } else if (rule === 'boolean') {
-          if (!['boolean', 'undefined'].includes(typeof value)) {
-            throw new Error(`'${key}' option must be a boolean.`);
-          }
-        }
-      })
-    });
-  }
 }