@bugfender/rn-bugfender 1.1.3 → 2.0.0-alpha.0

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/package.json

@@ -1,25 +1,159 @@
 {
   "name": "@bugfender/rn-bugfender",
-  "version": "1.1.3",
+  "version": "2.0.0-alpha.0",
   "description": "React Native bindings for Bugfender SDK",
-  "main": "bugfender.js",
-  "directories": {
-    "example": "example"
-  },
+  "main": "lib/commonjs/index",
+  "module": "lib/module/index",
+  "types": "lib/typescript/index.d.ts",
+  "react-native": "src/index",
+  "source": "src/index",
+  "files": [
+    "README.md",
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "RnBugfender.podspec",
+    "!lib/typescript/example",
+    "!android/build",
+    "!ios/build",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__"
+  ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/bugfender/rn-bugfender.git"
+    "test": "jest",
+    "typescript": "tsc --noEmit",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "prepare": "bob build",
+    "release": "release-it",
+    "example": "yarn --cwd example",
+    "pods": "cd example && pod-install --quiet",
+    "bootstrap": "yarn example && yarn && yarn pods"
   },
   "keywords": [
     "bugfender",
     "logging",
     "debug"
   ],
-  "author": "Bugfender",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bugfender/rn-bugfender.git",
+    "baseUrl": "https://github.com/bugfender/rn-bugfender.git"
+  },
+  "author": {
+    "name": "Bugfender"
+  },
   "license": "ISC",
+  "readmeFilename": "README.md",
+  "bugs": {
+    "url": "https://github.com/bugfender/rn-bugfender/issues"
+  },
   "homepage": "https://github.com/bugfender/rn-bugfender.git#readme",
-  "dependencies": {}
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^11.0.0",
+    "@react-native-community/eslint-config": "^2.0.0",
+    "@release-it/conventional-changelog": "^2.0.0",
+    "@types/jest": "^26.0.0",
+    "@types/react": "^16.9.19",
+    "@types/react-native": "0.62.13",
+    "commitlint": "^11.0.0",
+    "eslint": "^7.2.0",
+    "eslint-config-prettier": "^7.0.0",
+    "eslint-plugin-prettier": "^3.1.3",
+    "husky": "^6.0.0",
+    "jest": "^26.0.1",
+    "pod-install": "^0.1.0",
+    "prettier": "^2.0.5",
+    "react": "16.13.1",
+    "react-native": "0.63.4",
+    "react-native-builder-bob": "^0.18.0",
+    "release-it": "^14.2.2",
+    "typescript": "^4.1.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": "angular"
+      }
+    }
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native-community",
+      "prettier"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "error",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "dependencies": {
+    "@bugfender/sdk": "^2.0.0-alpha.0",
+    "util": "^0.12.4"
+  }
 }