@bugfender/rn-bugfender 1.1.4 → 2.0.0

package/lib/module/string-formatter.js

@@ -0,0 +1,45 @@
+import { format } from "util";
+export class StringFormatter {
+  format(parameters) {
+    const [, ...textParams] = parameters;
+    let [textFormat] = parameters;
+    let text;
+
+    try {
+      // Our sanitizer gives better results, try with it first
+      textFormat = this.toString(textFormat);
+    } catch {
+      // Fallback to `format`
+      textFormat = format(textFormat);
+    }
+
+    if (textParams.length > 0) {
+      text = format(textFormat, ...textParams);
+    } else {
+      text = textFormat;
+    }
+
+    return text;
+  }
+
+  toString(value) {
+    // Depending on the type we prefer to do `String` or `stringify`
+    const isToString = ['string', 'symbol', 'bigint', 'function'].includes(typeof value) || value instanceof Error;
+
+    if (isToString) {
+      try {
+        return String(value);
+      } catch {
+        return JSON.stringify(value);
+      }
+    } else {
+      try {
+        return JSON.stringify(value);
+      } catch {
+        return String(value);
+      }
+    }
+  }
+
+}
+//# sourceMappingURL=string-formatter.js.map

package/lib/module/string-formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["string-formatter.ts"],"names":["format","StringFormatter","parameters","textParams","textFormat","text","toString","length","value","isToString","includes","Error","String","JSON","stringify"],"mappings":"AAAA,SAAQA,MAAR,QAAqB,MAArB;AAEA,OAAO,MAAMC,eAAN,CAAsB;AACpBD,EAAAA,MAAM,CAACE,UAAD,EAAgC;AAC3C,UAAM,GAAG,GAAGC,UAAN,IAAoBD,UAA1B;AACA,QAAI,CAACE,UAAD,IAAeF,UAAnB;AACA,QAAIG,IAAJ;;AAEA,QAAI;AACF;AACAD,MAAAA,UAAU,GAAG,KAAKE,QAAL,CAAcF,UAAd,CAAb;AACD,KAHD,CAGE,MAAM;AACN;AACAA,MAAAA,UAAU,GAAGJ,MAAM,CAACI,UAAD,CAAnB;AACD;;AAED,QAAID,UAAU,CAACI,MAAX,GAAoB,CAAxB,EAA2B;AACzBF,MAAAA,IAAI,GAAGL,MAAM,CAACI,UAAD,EAAa,GAAGD,UAAhB,CAAb;AACD,KAFD,MAEO;AACLE,MAAAA,IAAI,GAAGD,UAAP;AACD;;AAED,WAAOC,IAAP;AACD;;AAEOC,EAAAA,QAAQ,CAACE,KAAD,EAAyB;AACvC;AACA,UAAMC,UAAU,GAAG,CAAC,QAAD,EAAW,QAAX,EAAqB,QAArB,EAA+B,UAA/B,EAA2CC,QAA3C,CAAoD,OAAOF,KAA3D,KAAqEA,KAAK,YAAYG,KAAzG;;AAEA,QAAIF,UAAJ,EAAgB;AACd,UAAI;AACF,eAAOG,MAAM,CAACJ,KAAD,CAAb;AACD,OAFD,CAEE,MAAM;AACN,eAAOK,IAAI,CAACC,SAAL,CAAeN,KAAf,CAAP;AACD;AACF,KAND,MAMO;AACL,UAAI;AACF,eAAOK,IAAI,CAACC,SAAL,CAAeN,KAAf,CAAP;AACD,OAFD,CAEE,MAAM;AACN,eAAOI,MAAM,CAACJ,KAAD,CAAb;AACD;AACF;AACF;;AAxC0B","sourcesContent":["import {format} from \"util\";\n\nexport class StringFormatter {\n  public format(parameters: unknown[]): string {\n    const [, ...textParams] = parameters;\n    let [textFormat] = parameters as string[];\n    let text: string;\n\n    try {\n      // Our sanitizer gives better results, try with it first\n      textFormat = this.toString(textFormat);\n    } catch {\n      // Fallback to `format`\n      textFormat = format(textFormat);\n    }\n\n    if (textParams.length > 0) {\n      text = format(textFormat, ...textParams);\n    } else {\n      text = textFormat;\n    }\n\n    return text;\n  }\n\n  private toString(value: unknown): string {\n    // Depending on the type we prefer to do `String` or `stringify`\n    const isToString = ['string', 'symbol', 'bigint', 'function'].includes(typeof value) || value instanceof Error;\n\n    if (isToString) {\n      try {\n        return String(value);\n      } catch {\n        return JSON.stringify(value);\n      }\n    } else {\n      try {\n        return JSON.stringify(value);\n      } catch {\n        return String(value);\n      }\n    }\n  }\n}\n"]}

package/lib/module/types/device.js

@@ -0,0 +1,2 @@
+
+//# sourceMappingURL=device.js.map

package/lib/module/types/device.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","sourcesContent":[]}

package/lib/module/types/log.js

@@ -0,0 +1,24 @@
+/**
+ * Log Levels
+ *
+ * Check the main README to see how to access the `LogLevel` enum.
+ */
+export let LogLevel;
+/**
+ * @hidden
+ */
+
+(function (LogLevel) {
+  LogLevel[LogLevel["Debug"] = 0] = "Debug";
+  LogLevel[LogLevel["Warning"] = 1] = "Warning";
+  LogLevel[LogLevel["Error"] = 2] = "Error";
+  LogLevel[LogLevel["Trace"] = 3] = "Trace";
+  LogLevel[LogLevel["Info"] = 4] = "Info";
+  LogLevel[LogLevel["Fatal"] = 5] = "Fatal";
+})(LogLevel || (LogLevel = {}));
+
+export const LOG_LEVELS = [LogLevel.Debug, LogLevel.Warning, LogLevel.Error, LogLevel.Trace, LogLevel.Info, LogLevel.Fatal];
+/**
+ * @hidden
+ */
+//# sourceMappingURL=log.js.map

package/lib/module/types/log.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["log.ts"],"names":["LogLevel","LOG_LEVELS","Debug","Warning","Error","Trace","Info","Fatal"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA,WAAYA,QAAZ;AASA;AACA;AACA;;WAXYA,Q;AAAAA,EAAAA,Q,CAAAA,Q;AAAAA,EAAAA,Q,CAAAA,Q;AAAAA,EAAAA,Q,CAAAA,Q;AAAAA,EAAAA,Q,CAAAA,Q;AAAAA,EAAAA,Q,CAAAA,Q;AAAAA,EAAAA,Q,CAAAA,Q;GAAAA,Q,KAAAA,Q;;AAYZ,OAAO,MAAMC,UAAsB,GAAG,CACpCD,QAAQ,CAACE,KAD2B,EAEpCF,QAAQ,CAACG,OAF2B,EAGpCH,QAAQ,CAACI,KAH2B,EAIpCJ,QAAQ,CAACK,KAJ2B,EAKpCL,QAAQ,CAACM,IAL2B,EAMpCN,QAAQ,CAACO,KAN2B,CAA/B;AASP;AACA;AACA","sourcesContent":["/**\n * Log Levels\n *\n * Check the main README to see how to access the `LogLevel` enum.\n */\nexport enum LogLevel {\n  Debug = 0,\n  Warning = 1,\n  Error = 2,\n  Trace = 3,\n  Info = 4,\n  Fatal = 5,\n}\n\n/**\n * @hidden\n */\nexport const LOG_LEVELS: LogLevel[] = [\n  LogLevel.Debug,\n  LogLevel.Warning,\n  LogLevel.Error,\n  LogLevel.Trace,\n  LogLevel.Info,\n  LogLevel.Fatal,\n];\n\n/**\n * @hidden\n */\nexport interface ILogEntryShort {\n  /** Date ISO */\n  x: string;\n  /** Text */\n  t: string;\n  /** Method */\n  m: string;\n  /** Absolute Time */\n  at: number;\n  /** Tag */\n  tg: string;\n  /** File */\n  f: string;\n  /** Line */\n  l: number;\n  /** Level */\n  ll: number;\n  /** URL */\n  u: string;\n}\n\n/**\n * Log Entry object interface\n */\nexport interface ILogEntry {\n  /** The line number where the log was triggered from */\n  line?: number;\n\n  /** The log's level based on LogLevel constant */\n  level?: LogLevel;\n\n  /** The log's tag */\n  tag?: string;\n\n  /** The method name where the log was triggered from */\n  method?: string;\n\n  /** The file name where the log was triggered from */\n  file?: string;\n\n  /** The log's text content */\n  text?: string;\n\n  /** The log's origin URL. This attribute is ignored on Android & iOS */\n  url?: string;\n}\n"]}

package/lib/module/types/sdk-options.js

@@ -0,0 +1,47 @@
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import { removeUndefinedAttributes } from "../utilities";
+export class SDKOptionsBuilder {
+  constructor(commonOptions) {
+    _defineProperty(this, "commonOptions", void 0);
+
+    _defineProperty(this, "nativeOptions", void 0);
+
+    _defineProperty(this, "webOptions", void 0);
+
+    this.commonOptions = commonOptions;
+  }
+
+  native(nativeOptions) {
+    this.nativeOptions = nativeOptions;
+    return this;
+  }
+
+  web(webOptions) {
+    this.webOptions = webOptions;
+    return this;
+  }
+
+  build() {
+    var _this$webOptions, _this$webOptions2, _this$webOptions3, _this$nativeOptions;
+
+    const options = {
+      appKey: this.commonOptions.appKey,
+      apiURL: this.commonOptions.apiURL,
+      baseURL: this.commonOptions.baseURL,
+      overrideConsoleMethods: this.commonOptions.overrideConsoleMethods,
+      printToConsole: this.commonOptions.printToConsole,
+      logUIEvents: this.commonOptions.logUIEvents,
+      registerErrorHandler: this.commonOptions.registerErrorHandler,
+      deviceName: this.commonOptions.deviceName,
+      logBrowserEvents: (_this$webOptions = this.webOptions) === null || _this$webOptions === void 0 ? void 0 : _this$webOptions.logBrowserEvents,
+      build: (_this$webOptions2 = this.webOptions) === null || _this$webOptions2 === void 0 ? void 0 : _this$webOptions2.build,
+      version: (_this$webOptions3 = this.webOptions) === null || _this$webOptions3 === void 0 ? void 0 : _this$webOptions3.version,
+      enableLogcatLogging: (_this$nativeOptions = this.nativeOptions) === null || _this$nativeOptions === void 0 ? void 0 : _this$nativeOptions.enableLogcatLogging
+    };
+    removeUndefinedAttributes(options);
+    return options;
+  }
+
+}
+//# sourceMappingURL=sdk-options.js.map

package/lib/module/types/sdk-options.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["sdk-options.ts"],"names":["removeUndefinedAttributes","SDKOptionsBuilder","constructor","commonOptions","native","nativeOptions","web","webOptions","build","options","appKey","apiURL","baseURL","overrideConsoleMethods","printToConsole","logUIEvents","registerErrorHandler","deviceName","logBrowserEvents","version","enableLogcatLogging"],"mappings":";;AAAA,SAAQA,yBAAR,QAAwC,cAAxC;AAqCA,OAAO,MAAMC,iBAAN,CAAwB;AAK7BC,EAAAA,WAAW,CAACC,aAAD,EAAmC;AAAA;;AAAA;;AAAA;;AAC5C,SAAKA,aAAL,GAAqBA,aAArB;AACD;;AAEMC,EAAAA,MAAM,CAACC,aAAD,EAAsD;AACjE,SAAKA,aAAL,GAAqBA,aAArB;AACA,WAAO,IAAP;AACD;;AAEMC,EAAAA,GAAG,CAACC,UAAD,EAAgD;AACxD,SAAKA,UAAL,GAAkBA,UAAlB;AACA,WAAO,IAAP;AACD;;AAEMC,EAAAA,KAAK,GAAgB;AAAA;;AAC1B,UAAMC,OAAoB,GAAG;AAC3BC,MAAAA,MAAM,EAAE,KAAKP,aAAL,CAAmBO,MADA;AAE3BC,MAAAA,MAAM,EAAE,KAAKR,aAAL,CAAmBQ,MAFA;AAG3BC,MAAAA,OAAO,EAAE,KAAKT,aAAL,CAAmBS,OAHD;AAI3BC,MAAAA,sBAAsB,EAAE,KAAKV,aAAL,CAAmBU,sBAJhB;AAK3BC,MAAAA,cAAc,EAAE,KAAKX,aAAL,CAAmBW,cALR;AAM3BC,MAAAA,WAAW,EAAE,KAAKZ,aAAL,CAAmBY,WANL;AAO3BC,MAAAA,oBAAoB,EAAE,KAAKb,aAAL,CAAmBa,oBAPd;AAQ3BC,MAAAA,UAAU,EAAE,KAAKd,aAAL,CAAmBc,UARJ;AAS3BC,MAAAA,gBAAgB,sBAAE,KAAKX,UAAP,qDAAE,iBAAiBW,gBATR;AAU3BV,MAAAA,KAAK,uBAAE,KAAKD,UAAP,sDAAE,kBAAiBC,KAVG;AAW3BW,MAAAA,OAAO,uBAAE,KAAKZ,UAAP,sDAAE,kBAAiBY,OAXC;AAY3BC,MAAAA,mBAAmB,yBAAE,KAAKf,aAAP,wDAAE,oBAAoBe;AAZd,KAA7B;AAeApB,IAAAA,yBAAyB,CAACS,OAAD,CAAzB;AAEA,WAAOA,OAAP;AACD;;AAtC4B","sourcesContent":["import {removeUndefinedAttributes} from \"../utilities\";\n\nexport interface ISDKCommonOptions {\n  /** The app key to log into */\n  appKey: string;\n  /** Base URL to Bugfender API */\n  apiURL?: string;\n  /** Base URL to Bugfender web dashboard */\n  baseURL?: string;\n  /** Override default `window.console` so it also logs to Bugfender. Defaults to `true`. */\n  overrideConsoleMethods?: boolean;\n  /** Print also with `window.console` when Bugfender logging methods are called. Defaults to `true`. */\n  printToConsole?: boolean;\n  /** Register a handler for most common UI events to report them to Bugfender. Defaults to `true`. */\n  logUIEvents?: boolean;\n  /** Register error handler for uncaught errors that reports a crash to Bugfender. Defaults to `true`. */\n  registerErrorHandler?: boolean;\n  /** Sets the name for the device. If the Device Name is not set, then the platform standard device name will be automatically sent */\n  deviceName?: string;\n}\n\nexport interface ISDKWebOptions {\n  /** Register a handler for most common browser events to report them to Bugfender (Web specific). Defaults to `true`. */\n  logBrowserEvents?: boolean;\n  /** App build identifier (Web specific) */\n  build?: string;\n  /** App version identifier (Web specific) */\n  version?: string;\n}\n\nexport interface ISDKNativeOptions {\n  /** Logs all logs written via Logcat (Android specific). Defaults to `false`. */\n  enableLogcatLogging?: boolean;\n}\n\nexport type ISDKOptions = ISDKCommonOptions & ISDKNativeOptions & ISDKWebOptions;\n\nexport class SDKOptionsBuilder {\n  private commonOptions: ISDKCommonOptions;\n  private nativeOptions?: ISDKNativeOptions;\n  private webOptions?: ISDKWebOptions;\n\n  constructor(commonOptions: ISDKCommonOptions) {\n    this.commonOptions = commonOptions;\n  }\n\n  public native(nativeOptions: ISDKNativeOptions): SDKOptionsBuilder {\n    this.nativeOptions = nativeOptions;\n    return this;\n  }\n\n  public web(webOptions: ISDKWebOptions): SDKOptionsBuilder {\n    this.webOptions = webOptions;\n    return this;\n  }\n\n  public build(): ISDKOptions {\n    const options: ISDKOptions = {\n      appKey: this.commonOptions.appKey,\n      apiURL: this.commonOptions.apiURL,\n      baseURL: this.commonOptions.baseURL,\n      overrideConsoleMethods: this.commonOptions.overrideConsoleMethods,\n      printToConsole: this.commonOptions.printToConsole,\n      logUIEvents: this.commonOptions.logUIEvents,\n      registerErrorHandler: this.commonOptions.registerErrorHandler,\n      deviceName: this.commonOptions.deviceName,\n      logBrowserEvents: this.webOptions?.logBrowserEvents,\n      build: this.webOptions?.build,\n      version: this.webOptions?.version,\n      enableLogcatLogging: this.nativeOptions?.enableLogcatLogging,\n    };\n\n    removeUndefinedAttributes(options);\n\n    return options;\n  }\n}\n"]}

package/lib/module/user-feedback.js

@@ -0,0 +1,22 @@
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+/**
+ * Options object for `Bugfender.getUserFeedback` with customised modal strings.
+ */
+export class DefaultUserFeedbackOptions {
+  constructor() {
+    _defineProperty(this, "title", 'Feedback');
+
+    _defineProperty(this, "hint", 'Please insert your feedback here and click send');
+
+    _defineProperty(this, "subjectPlaceholder", 'Subject…');
+
+    _defineProperty(this, "feedbackPlaceholder", 'Your feedback…');
+
+    _defineProperty(this, "submitLabel", 'Send');
+
+    _defineProperty(this, "closeLabel", 'Close');
+  }
+
+}
+//# sourceMappingURL=user-feedback.js.map

package/lib/module/user-feedback.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["user-feedback.ts"],"names":["DefaultUserFeedbackOptions"],"mappings":";;AAAA;AACA;AACA;AAgBA,OAAO,MAAMA,0BAAN,CAA0E;AAAA;AAAA,mCAChE,UADgE;;AAAA,kCAEjE,iDAFiE;;AAAA,gDAGnD,UAHmD;;AAAA,iDAIlD,gBAJkD;;AAAA,yCAK1D,MAL0D;;AAAA,wCAM3D,OAN2D;AAAA;;AAAA","sourcesContent":["/**\n * Options object for `Bugfender.getUserFeedback` with customised modal strings.\n */\nexport interface UserFeedbackOptions {\n  /** Default: `Feedback`. */\n  title?: string;\n  /** Default `Please insert your feedback here and click send`. */\n  hint?: string;\n  /** Default: `Subject…`. */\n  subjectPlaceholder?: string;\n  /** Default: `Your feedback…`. */\n  feedbackPlaceholder?: string;\n  /** Default: `Send`. */\n  submitLabel?: string;\n  /** Default: `Close`. This attribute is only used on iOS */\n  closeLabel?: string;\n}\n\nexport class DefaultUserFeedbackOptions implements Required<UserFeedbackOptions> {\n  public title = 'Feedback';\n  public hint = 'Please insert your feedback here and click send';\n  public subjectPlaceholder = 'Subject…';\n  public feedbackPlaceholder = 'Your feedback…';\n  public submitLabel = 'Send';\n  public closeLabel = 'Close';\n}\n\nexport interface UserFeedbackResult {\n  /** `true` if the user has sent the feedback. `false` if she has closed the modal without sending it. */\n  isSent: boolean;\n  /** If the feedback was sent this will contain the Bugfender URL for the feedback. */\n  feedbackURL?: string;\n}\n"]}

package/lib/module/utilities.js

@@ -0,0 +1,11 @@
+export function removeUndefinedAttributes(object) {
+  Object.entries(object).forEach(_ref => {
+    let [key, value] = _ref;
+
+    if (value === undefined) {
+      // @ts-ignore
+      delete object[key];
+    }
+  });
+}
+//# sourceMappingURL=utilities.js.map

package/lib/module/utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["utilities.ts"],"names":["removeUndefinedAttributes","object","Object","entries","forEach","key","value","undefined"],"mappings":"AAAA,OAAO,SAASA,yBAAT,CAAmCC,MAAnC,EAAgD;AACrDC,EAAAA,MAAM,CAACC,OAAP,CAAeF,MAAf,EAAuBG,OAAvB,CAA+B,QAAkB;AAAA,QAAjB,CAACC,GAAD,EAAMC,KAAN,CAAiB;;AAC/C,QAAIA,KAAK,KAAKC,SAAd,EAAyB;AACvB;AACA,aAAON,MAAM,CAACI,GAAD,CAAb;AACD;AACF,GALD;AAMD","sourcesContent":["export function removeUndefinedAttributes(object: any) {\n  Object.entries(object).forEach(([key, value]) => {\n    if (value === undefined) {\n      // @ts-ignore\n      delete object[key];\n    }\n  });\n}\n"]}

package/lib/typescript/bugfender.d.ts

@@ -0,0 +1,163 @@
+import type { ISDKOptions } from './types/sdk-options';
+import type { UserFeedbackOptions, UserFeedbackResult } from './user-feedback';
+import type { DeviceKeyValue } from './types/device';
+import type { ILogEntry } from './types/log';
+declare const RnBugfender: any;
+declare class BugfenderClass {
+    private stringFormatter;
+    private overrideConsoleMethods;
+    private printToConsole;
+    private sdkOptions;
+    private initialized;
+    init(options: ISDKOptions): Promise<void>;
+    /**
+     * @returns Bugfender dashboard URL for the device
+     */
+    getDeviceURL(): Promise<string>;
+    /**
+     * @returns Bugfender dashboard URL for the current session
+     */
+    getSessionURL(): Promise<string>;
+    /**
+     * Show a modal which asks for feedback. Once the user closes the modal or sends the feedback
+     * the returned promise resolves with the result.
+     *
+     * ```typescript
+     * Bugfender.getUserFeedback().then((result) => {
+     *     if (result.isSent) {
+     *         // User sent the feedback
+     *         // `result.feedbackURL` contains the Bugfender feedback URL
+     *     } else {
+     *         // User closed the modal without sending the feedback
+     *     }
+     * });
+     * ```
+     *
+     * @param options Options object to configure modal strings
+     * @returns Promise which resolves once the user closes the modal or sends the feedback
+     */
+    getUserFeedback(options?: UserFeedbackOptions): Promise<UserFeedbackResult>;
+    /**
+     * @param obj A JavaScript value to output
+     * @param objs List of optional JavaScript values to output
+     */
+    log(obj: unknown, ...objs: unknown[]): void;
+    /**
+     * String message with optional substitutions. This mimicks que the `window.console` template messages. [Learn more in MDN](https://developer.mozilla.org/en-US/docs/Web/API/console#Using_string_substitutions).
+     *
+     * @param msg Message with optional `%` placeholders
+     * @param subst Optional substitutions list
+     */
+    log(msg: string, ...subst: unknown[]): void;
+    /**
+     * @param obj A JavaScript value to output
+     * @param objs List of optional JavaScript values to output
+     */
+    warn(obj: unknown, ...objs: unknown[]): void;
+    /**
+     * String message with optional substitutions. This mimicks que the `window.console` template messages. [Learn more in MDN](https://developer.mozilla.org/en-US/docs/Web/API/console#Using_string_substitutions).
+     *
+     * @param msg Message with optional `%` placeholders
+     * @param subst Optional substitutions list
+     */
+    warn(msg: string, ...subst: unknown[]): void;
+    /**
+     * @param obj A JavaScript value to output
+     * @param objs List of optional JavaScript values to output
+     */
+    error(obj: unknown, ...objs: unknown[]): void;
+    /**
+     * String message with optional substitutions. This mimicks que the `window.console` template messages. [Learn more in MDN](https://developer.mozilla.org/en-US/docs/Web/API/console#Using_string_substitutions).
+     *
+     * @param msg Message with optional `%` placeholders
+     * @param subst Optional substitutions list
+     */
+    error(msg: string, ...subst: unknown[]): void;
+    /**
+     * @param obj A JavaScript value to output
+     * @param objs List of optional JavaScript values to output
+     */
+    trace(obj: unknown, ...objs: unknown[]): void;
+    /**
+     * String message with optional substitutions. This mimicks que the `window.console` template messages. [Learn more in MDN](https://developer.mozilla.org/en-US/docs/Web/API/console#Using_string_substitutions).
+     *
+     * @param msg Message with optional `%` placeholders
+     * @param subst Optional substitutions list
+     */
+    trace(msg: string, ...subst: unknown[]): void;
+    /**
+     * @param obj A JavaScript value to output
+     * @param objs List of optional JavaScript values to output
+     */
+    info(obj: unknown, ...objs: unknown[]): void;
+    /**
+     * String message with optional substitutions. This mimicks que the `window.console` template messages. [Learn more in MDN](https://developer.mozilla.org/en-US/docs/Web/API/console#Using_string_substitutions).
+     *
+     * @param msg Message with optional `%` placeholders
+     * @param subst Optional substitutions list
+     */
+    info(msg: string, ...subst: unknown[]): void;
+    /**
+     * @param obj A JavaScript value to output
+     * @param objs List of optional JavaScript values to output
+     */
+    fatal(obj: unknown, ...objs: unknown[]): void;
+    /**
+     * String message with optional substitutions. This mimicks que the `window.console` template messages. [Learn more in MDN](https://developer.mozilla.org/en-US/docs/Web/API/console#Using_string_substitutions).
+     *
+     * @param msg Message with optional `%` placeholders
+     * @param subst Optional substitutions list
+     */
+    fatal(msg: string, ...subst: unknown[]): void;
+    /**
+     * Remove a device associated key-value pair. [Learn more](https://bugfender.com/blog/associated-device-information/).
+     *
+     * @param key Key identifier
+     */
+    removeDeviceKey(key: string): void;
+    /**
+     * Use this method if you need more control over the data sent while logging. See `ILogEntry` interface reference to see all the accepted properties.
+     *
+     * @param log Log object that complies with `ILogEntry` interface.
+     */
+    sendLog(log: ILogEntry): void;
+    /**
+     * Send an issue.
+     *
+     * @param title - Title
+     * @param text - Text content
+     * @returns Bugfender dashboard URL for the issue.
+     */
+    sendIssue(title: string, text: string): Promise<string>;
+    /**
+     * Send a crash report.
+     *
+     * @param title - Title
+     * @param text - Text content
+     * @returns Bugfender dashboard URL for the crash.
+     */
+    sendCrash(title: string, text: string): Promise<string>;
+    /**
+     * Send an user feedback.
+     *
+     * @param title - Title/Subject
+     * @param text - Feedback text
+     * @returns Bugfender dashboard URL for the feedback.
+     */
+    sendUserFeedback(title: string, text: string): Promise<string>;
+    /**
+     * Set a device associated key-value pair. [Learn more](https://bugfender.com/blog/associated-device-information/).
+     *
+     * @param key Key identifier.
+     * @param value Value.
+     */
+    setDeviceKey(key: string, value: DeviceKeyValue): void;
+    /**
+     * Synchronizes all logs and issues with the server once, regardless if this device is enabled or not.
+     *
+     * Logs and issues are synchronized only once. After that, the logs are again sent according to the enabled flag
+     * in the Bugfender Console.
+     */
+    forceSendOnce(): void;
+}
+export { BugfenderClass, RnBugfender };

package/lib/typescript/index.d.ts

@@ -0,0 +1,5 @@
+import { LogLevel } from './types/log';
+import { SDKOptionsBuilder } from './types/sdk-options';
+import { BugfenderClass } from './bugfender';
+declare const Bugfender: BugfenderClass;
+export { Bugfender, LogLevel, SDKOptionsBuilder };

package/lib/typescript/index.web.d.ts

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

package/lib/typescript/override-console-methods.d.ts

@@ -0,0 +1,10 @@
+import type { StringFormatter } from "./string-formatter";
+/**
+ * Overrides the `window.console` methods in order to execute the Bugfender equivalent logging
+ * methods while keeping the original browser functionality.
+ */
+export declare class OverrideConsoleMethods {
+    protected window: Window;
+    constructor(window: Window);
+    init(stringFormatter: StringFormatter): void;
+}

package/lib/typescript/print-to-console.d.ts

@@ -0,0 +1,14 @@
+import type { ILogEntry } from "./types/log";
+export declare class PrintToConsole {
+    protected readonly console: Console;
+    protected printToConsole: boolean;
+    constructor(console: Console);
+    init(printToConsole: boolean): void;
+    error(...parameters: unknown[]): void;
+    info(...parameters: unknown[]): void;
+    log(...parameters: unknown[]): void;
+    debug(...parameters: unknown[]): void;
+    trace(...parameters: unknown[]): void;
+    warn(...parameters: unknown[]): void;
+    printLog(log: ILogEntry): void;
+}

package/lib/typescript/sdk-options.d.ts

@@ -0,0 +1,16 @@
+import type { ISDKOptions } from "./types/sdk-options";
+export declare class SDKOptions {
+    protected rules: {
+        appKey: string[];
+        apiURL: string[];
+        baseURL: string[];
+        overrideConsoleMethods: string[];
+        printToConsole: string[];
+        logBrowserEvents: string[];
+        logUIEvents: string[];
+        registerErrorHandler: string[];
+        version: string[];
+    };
+    init(options: ISDKOptions): ISDKOptions;
+    protected validate(options: ISDKOptions): void;
+}

package/lib/typescript/string-formatter.d.ts

@@ -0,0 +1,4 @@
+export declare class StringFormatter {
+    format(parameters: unknown[]): string;
+    private toString;
+}

package/lib/typescript/types/device.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Device Key Value
+ */
+export declare type DeviceKeyValue = string | number | boolean;

package/lib/typescript/types/log.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Log Levels
+ *
+ * Check the main README to see how to access the `LogLevel` enum.
+ */
+export declare enum LogLevel {
+    Debug = 0,
+    Warning = 1,
+    Error = 2,
+    Trace = 3,
+    Info = 4,
+    Fatal = 5
+}
+/**
+ * @hidden
+ */
+export declare const LOG_LEVELS: LogLevel[];
+/**
+ * @hidden
+ */
+export interface ILogEntryShort {
+    /** Date ISO */
+    x: string;
+    /** Text */
+    t: string;
+    /** Method */
+    m: string;
+    /** Absolute Time */
+    at: number;
+    /** Tag */
+    tg: string;
+    /** File */
+    f: string;
+    /** Line */
+    l: number;
+    /** Level */
+    ll: number;
+    /** URL */
+    u: string;
+}
+/**
+ * Log Entry object interface
+ */
+export interface ILogEntry {
+    /** The line number where the log was triggered from */
+    line?: number;
+    /** The log's level based on LogLevel constant */
+    level?: LogLevel;
+    /** The log's tag */
+    tag?: string;
+    /** The method name where the log was triggered from */
+    method?: string;
+    /** The file name where the log was triggered from */
+    file?: string;
+    /** The log's text content */
+    text?: string;
+    /** The log's origin URL. This attribute is ignored on Android & iOS */
+    url?: string;
+}

package/lib/typescript/types/sdk-options.d.ts

@@ -0,0 +1,40 @@
+export interface ISDKCommonOptions {
+    /** The app key to log into */
+    appKey: string;
+    /** Base URL to Bugfender API */
+    apiURL?: string;
+    /** Base URL to Bugfender web dashboard */
+    baseURL?: string;
+    /** Override default `window.console` so it also logs to Bugfender. Defaults to `true`. */
+    overrideConsoleMethods?: boolean;
+    /** Print also with `window.console` when Bugfender logging methods are called. Defaults to `true`. */
+    printToConsole?: boolean;
+    /** Register a handler for most common UI events to report them to Bugfender. Defaults to `true`. */
+    logUIEvents?: boolean;
+    /** Register error handler for uncaught errors that reports a crash to Bugfender. Defaults to `true`. */
+    registerErrorHandler?: boolean;
+    /** Sets the name for the device. If the Device Name is not set, then the platform standard device name will be automatically sent */
+    deviceName?: string;
+}
+export interface ISDKWebOptions {
+    /** Register a handler for most common browser events to report them to Bugfender (Web specific). Defaults to `true`. */
+    logBrowserEvents?: boolean;
+    /** App build identifier (Web specific) */
+    build?: string;
+    /** App version identifier (Web specific) */
+    version?: string;
+}
+export interface ISDKNativeOptions {
+    /** Logs all logs written via Logcat (Android specific). Defaults to `false`. */
+    enableLogcatLogging?: boolean;
+}
+export declare type ISDKOptions = ISDKCommonOptions & ISDKNativeOptions & ISDKWebOptions;
+export declare class SDKOptionsBuilder {
+    private commonOptions;
+    private nativeOptions?;
+    private webOptions?;
+    constructor(commonOptions: ISDKCommonOptions);
+    native(nativeOptions: ISDKNativeOptions): SDKOptionsBuilder;
+    web(webOptions: ISDKWebOptions): SDKOptionsBuilder;
+    build(): ISDKOptions;
+}

package/lib/typescript/user-feedback.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Options object for `Bugfender.getUserFeedback` with customised modal strings.
+ */
+export interface UserFeedbackOptions {
+    /** Default: `Feedback`. */
+    title?: string;
+    /** Default `Please insert your feedback here and click send`. */
+    hint?: string;
+    /** Default: `Subject…`. */
+    subjectPlaceholder?: string;
+    /** Default: `Your feedback…`. */
+    feedbackPlaceholder?: string;
+    /** Default: `Send`. */
+    submitLabel?: string;
+    /** Default: `Close`. This attribute is only used on iOS */
+    closeLabel?: string;
+}
+export declare class DefaultUserFeedbackOptions implements Required<UserFeedbackOptions> {
+    title: string;
+    hint: string;
+    subjectPlaceholder: string;
+    feedbackPlaceholder: string;
+    submitLabel: string;
+    closeLabel: string;
+}
+export interface UserFeedbackResult {
+    /** `true` if the user has sent the feedback. `false` if she has closed the modal without sending it. */
+    isSent: boolean;
+    /** If the feedback was sent this will contain the Bugfender URL for the feedback. */
+    feedbackURL?: string;
+}

package/lib/typescript/utilities.d.ts

@@ -0,0 +1 @@
+export declare function removeUndefinedAttributes(object: any): void;