@flareapp/js 1.0.1 → 2.0.0-rc.1

package/dist/index.js

@@ -30,29 +30,43 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  flare: () => flare,
-  readLinesFromFile: () => readLinesFromFile
+  Flare: () => Flare,
+  flare: () => flare
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/build.ts
-var build_default = {
-  // Injected during build
-  clientVersion: false ? "?" : '"1.0.1"',
-  // Optionally injected by flare-vite-plugin-sourcemap-uploader
-  flareJsKey: typeof FLARE_JS_KEY === "undefined" ? "" : FLARE_JS_KEY,
-  sourcemapVersion: typeof FLARE_SOURCEMAP_VERSION === "undefined" ? "" : FLARE_SOURCEMAP_VERSION
-};
+// src/env/index.ts
+var CLIENT_VERSION = false ? "?" : '"2.0.0-rc.1"';
+var KEY = typeof FLARE_JS_KEY === "undefined" ? "" : FLARE_JS_KEY;
+var SOURCEMAP_VERSION = typeof FLARE_SOURCEMAP_VERSION === "undefined" ? "" : FLARE_SOURCEMAP_VERSION;
 
-// src/util/index.ts
+// src/util/assert.ts
 function assert(value, message, debug) {
   if (debug && !value) {
-    console.error(
-      `Flare JavaScript client v${build_default.clientVersion}: ${message}`
-    );
+    console.error(`Flare JavaScript client v${CLIENT_VERSION}: ${message}`);
   }
   return !!value;
 }
+
+// src/util/assertKey.ts
+function assertKey(key, debug) {
+  return assert(
+    key,
+    "The client was not yet initialised with an API key. Run client.light('<flare-project-key>') when you initialise your app. If you are running in dev mode and didn't run the light command on purpose, you can ignore this error.",
+    debug
+  );
+}
+
+// src/util/assertSolutionProvider.ts
+function assertSolutionProvider(solutionProvider, debug) {
+  return assert("canSolve" in solutionProvider, "A solution provider without a [canSolve] property was added.", debug) && assert(
+    "getSolutions" in solutionProvider,
+    "A solution provider without a [getSolutions] property was added.",
+    debug
+  );
+}
+
+// src/util/flatJsonStringify.ts
 function flatJsonStringify(json) {
   let cache = [];
   const flattenedStringifiedJson = JSON.stringify(json, function(_, value) {
@@ -71,15 +85,45 @@ function flatJsonStringify(json) {
   cache = null;
   return flattenedStringifiedJson;
 }
-function now() {
-  return Math.round(Date.now() / 1e3);
-}
+
+// src/util/flattenOnce.ts
 function flattenOnce(array) {
   return array.reduce((flat, toFlatten) => {
     return flat.concat(toFlatten);
   }, []);
 }
 
+// src/util/now.ts
+function now() {
+  return Math.round(Date.now() / 1e3);
+}
+
+// src/api/Api.ts
+var Api = class {
+  report(report, url, key, reportBrowserExtensionErrors) {
+    return fetch(url, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        "X-Api-Token": key,
+        "X-Requested-With": "XMLHttpRequest",
+        "X-Report-Browser-Extension-Errors": JSON.stringify(reportBrowserExtensionErrors)
+      },
+      body: flatJsonStringify({
+        ...report,
+        key
+      })
+    }).then(
+      (response) => {
+        if (response.status !== 204) {
+          console.error(`Received response with status ${response.status} from Flare`);
+        }
+      },
+      (error) => console.error(error)
+    );
+  }
+};
+
 // src/context/cookie.ts
 function cookie() {
   if (!window.document.cookie) {
@@ -121,7 +165,7 @@ function requestData() {
   return { request_data: { queryString } };
 }
 
-// src/context/index.ts
+// src/context/collectContext.ts
 function collectContext(additionalContext) {
   if (typeof window === "undefined") {
     return additionalContext;
@@ -134,7 +178,33 @@ function collectContext(additionalContext) {
   };
 }
 
-// src/stacktrace/index.ts
+// src/solutions/getSolutions.ts
+function getSolutions(solutionProviders, error, extraSolutionParameters = {}) {
+  return new Promise((resolve) => {
+    const canSolves = solutionProviders.reduce(
+      (canSolves2, provider) => {
+        canSolves2.push(Promise.resolve(provider.canSolve(error, extraSolutionParameters)));
+        return canSolves2;
+      },
+      []
+    );
+    Promise.all(canSolves).then((resolvedCanSolves) => {
+      const solutionPromises = [];
+      resolvedCanSolves.forEach((canSolve, i) => {
+        if (canSolve) {
+          solutionPromises.push(
+            Promise.resolve(solutionProviders[i].getSolutions(error, extraSolutionParameters))
+          );
+        }
+      });
+      Promise.all(solutionPromises).then((solutions) => {
+        resolve(flattenOnce(solutions));
+      });
+    });
+  });
+}
+
+// src/stacktrace/createStackTrace.ts
 var import_error_stack_parser = __toESM(require("error-stack-parser"));
 
 // src/stacktrace/fileReader.ts
@@ -158,9 +228,7 @@ function getCodeSnippet(url, lineNumber, columnNumber) {
           trimmedColumnNumber: null
         });
       }
-      return resolve(
-        readLinesFromFile(fileText, lineNumber, columnNumber)
-      );
+      return resolve(readLinesFromFile(fileText, lineNumber, columnNumber));
     });
   });
 }
@@ -190,9 +258,7 @@ function readLinesFromFile(fileText, lineNumber, columnNumber, maxSnippetLineLen
             maxSnippetLineLength
           );
           if (displayLine === lineNumber) {
-            trimmedColumnNumber = Math.round(
-              maxSnippetLineLength / 2
-            );
+            trimmedColumnNumber = Math.round(maxSnippetLineLength / 2);
           }
           continue;
         }
@@ -205,16 +271,12 @@ function readLinesFromFile(fileText, lineNumber, columnNumber, maxSnippetLineLen
   return { codeSnippet, trimmedColumnNumber };
 }
 
-// src/stacktrace/index.ts
-function createStackTrace(error) {
+// src/stacktrace/createStackTrace.ts
+function createStackTrace(error, debug) {
   return new Promise((resolve) => {
     if (!hasStack(error)) {
-      assert(
-        false,
-        "Couldn't generate stacktrace of below error:",
-        flare.debug
-      );
-      if (flare.debug) {
+      assert(false, "Couldn't generate stacktrace of below error:", debug);
+      if (debug) {
         console.error(error);
       }
       return resolve([
@@ -234,11 +296,7 @@ function createStackTrace(error) {
     Promise.all(
       import_error_stack_parser.default.parse(error).map((frame) => {
         return new Promise((resolve2) => {
-          getCodeSnippet(
-            frame.fileName,
-            frame.lineNumber,
-            frame.columnNumber
-          ).then((snippet) => {
+          getCodeSnippet(frame.fileName, frame.lineNumber, frame.columnNumber).then((snippet) => {
             resolve2({
               line_number: frame.lineNumber || 1,
               column_number: frame.columnNumber || 1,
@@ -258,93 +316,56 @@ function hasStack(err) {
   return !!err && (!!err.stack || !!err.stacktrace || !!err["opera#sourceloc"]) && typeof (err.stack || err.stacktrace || err["opera#sourceloc"]) === "string" && err.stack !== `${err.name}: ${err.message}`;
 }
 
-// src/solutions/index.ts
-function getSolutions(solutionProviders, error, extraSolutionParameters = {}) {
-  return new Promise((resolve) => {
-    const canSolves = solutionProviders.reduce(
-      (canSolves2, provider) => {
-        canSolves2.push(
-          Promise.resolve(
-            provider.canSolve(error, extraSolutionParameters)
-          )
-        );
-        return canSolves2;
-      },
-      []
-    );
-    Promise.all(canSolves).then((resolvedCanSolves) => {
-      const solutionPromises = [];
-      resolvedCanSolves.forEach((canSolve, i) => {
-        if (canSolve) {
-          solutionPromises.push(
-            Promise.resolve(
-              solutionProviders[i].getSolutions(
-                error,
-                extraSolutionParameters
-              )
-            )
-          );
-        }
-      });
-      Promise.all(solutionPromises).then((solutions) => {
-        resolve(flattenOnce(solutions));
-      });
-    });
-  });
-}
-
-// src/FlareClient.ts
-var FlareClient = class {
-  constructor() {
-    this.version = build_default.clientVersion;
+// src/Flare.ts
+var Flare = class {
+  constructor(http = new Api()) {
+    this.http = http;
     this.config = {
-      key: "",
-      reportingUrl: "https://reporting.flareapp.io/api/reports",
+      key: KEY,
+      version: CLIENT_VERSION,
+      sourcemapVersion: SOURCEMAP_VERSION,
+      stage: "",
       maxGlowsPerReport: 30,
-      maxReportsPerMinute: 500
+      reportingUrl: "https://reporting.flareapp.io/api/reports",
+      reportBrowserExtensionErrors: false,
+      debug: false,
+      beforeEvaluate: (error) => error,
+      beforeSubmit: (report) => report
     };
     this.glows = [];
     this.context = { context: {} };
-    this.beforeEvaluate = (error) => error;
-    this.beforeSubmit = (report) => report;
-    this.reportedErrorsTimestamps = [];
     this.solutionProviders = [];
-    this.sourcemapVersion = build_default.sourcemapVersion;
-    this.debug = false;
-    this.stage = void 0;
   }
-  light(key = build_default.flareJsKey, debug = false) {
-    this.debug = debug;
-    if (!assert(
-      key && typeof key === "string",
-      "An empty or incorrect Flare key was passed, errors will not be reported.",
-      this.debug
-    ) || !assert(
-      Promise,
-      "ES6 promises are not supported in this environment, errors will not be reported.",
-      this.debug
-    )) {
-      return this;
-    }
+  light(key = KEY, debug = false) {
     this.config.key = key;
+    this.config.debug = debug;
     return this;
   }
-  glow(name, level = "info", metaData = []) {
+  configure(config) {
+    this.config = { ...this.config, ...config };
+    return this;
+  }
+  test() {
+    return this.report(new Error("The Flare client is set up correctly!"));
+  }
+  glow(name, level = "info", data = []) {
     const time = now();
     this.glows.push({
       name,
       message_level: level,
-      meta_data: metaData,
+      meta_data: data,
       time,
       microtime: time
     });
     if (this.glows.length > this.config.maxGlowsPerReport) {
-      this.glows = this.glows.slice(
-        this.glows.length - this.config.maxGlowsPerReport
-      );
+      this.glows = this.glows.slice(this.glows.length - this.config.maxGlowsPerReport);
     }
     return this;
   }
+  clearGlows() {
+    this.glows = [];
+    return this;
+  }
   addContext(name, value) {
     this.context.context[name] = value;
     return this;
@@ -353,74 +374,54 @@ var FlareClient = class {
     this.context[groupName] = value;
     return this;
   }
-  registerSolutionProvider(provider) {
-    if (!assert(
-      "canSolve" in provider,
-      "A solution provider without a [canSolve] property was added.",
-      this.debug
-    ) || !assert(
-      "getSolutions" in provider,
-      "A solution provider without a [getSolutions] property was added.",
-      this.debug
-    )) {
+  registerSolutionProvider(solutionProvider) {
+    if (!assertSolutionProvider(solutionProvider, this.config.debug)) {
       return this;
     }
-    this.solutionProviders.push(provider);
+    this.solutionProviders.push(solutionProvider);
     return this;
   }
-  reportMessage(message, context = {}, exceptionClass = "Log") {
-    const seenAt = now();
-    createStackTrace(Error()).then((stacktrace) => {
-      stacktrace.shift();
-      const report = {
-        notifier: `Flare JavaScript client v${build_default.clientVersion}`,
-        exception_class: exceptionClass,
-        seen_at: seenAt,
-        message,
-        language: "javascript",
-        glows: this.glows,
-        context: collectContext({ ...context, ...this.context }),
-        stacktrace,
-        sourcemap_version_id: this.sourcemapVersion,
-        solutions: [],
-        stage: this.stage
-      };
-      this.sendReport(report);
-    });
+  async report(error, context = {}, extraSolutionParameters = {}) {
+    const errorToReport = await this.config.beforeEvaluate(error);
+    if (!errorToReport) {
+      return;
+    }
+    const report = await this.createReportFromError(error, context, extraSolutionParameters);
+    if (!report) {
+      return;
+    }
+    return this.sendReport(report);
   }
-  report(error, context = {}, extraSolutionParameters = {}) {
-    Promise.resolve(this.beforeEvaluate(error)).then(
-      (reportReadyForEvaluation) => {
-        if (!reportReadyForEvaluation) {
-          return;
-        }
-        this.createReport(error, context, extraSolutionParameters).then(
-          (report) => report ? this.sendReport(report) : {}
-        );
-      }
-    );
+  async reportMessage(message, context = {}, exceptionClass = "Log") {
+    const stackTrace = await createStackTrace(Error(), this.config.debug);
+    stackTrace.shift();
+    this.sendReport({
+      notifier: `Flare JavaScript client v${CLIENT_VERSION}`,
+      exception_class: exceptionClass,
+      seen_at: now(),
+      message,
+      language: "javascript",
+      glows: this.glows,
+      context: collectContext({ ...context, ...this.context }),
+      stacktrace: stackTrace,
+      sourcemap_version_id: this.config.sourcemapVersion,
+      solutions: [],
+      stage: this.config.stage
+    });
   }
-  createReport(error, context = {}, extraSolutionParameters = {}) {
-    if (!assert(error, "No error provided.", this.debug)) {
+  createReportFromError(error, context = {}, extraSolutionParameters = {}) {
+    if (!assert(error, "No error provided.", this.config.debug)) {
       return Promise.resolve(false);
     }
     const seenAt = now();
     return Promise.all([
-      getSolutions(
-        this.solutionProviders,
-        error,
-        extraSolutionParameters
-      ),
-      createStackTrace(error)
+      getSolutions(this.solutionProviders, error, extraSolutionParameters),
+      createStackTrace(error, this.config.debug)
     ]).then((result) => {
       const [solutions, stacktrace] = result;
-      assert(
-        stacktrace.length,
-        "Couldn't generate stacktrace of this error: " + error,
-        this.debug
-      );
+      assert(stacktrace.length, "Couldn't generate stacktrace of this error: " + error, this.config.debug);
       return {
-        notifier: `Flare JavaScript client v${build_default.clientVersion}`,
+        notifier: `Flare JavaScript client v${CLIENT_VERSION}`,
         exception_class: error.constructor && error.constructor.name ? error.constructor.name : "undefined",
         seen_at: seenAt,
         message: error.message,
@@ -428,69 +429,40 @@ var FlareClient = class {
         glows: this.glows,
         context: collectContext({ ...context, ...this.context }),
         stacktrace,
-        sourcemap_version_id: this.sourcemapVersion,
+        sourcemap_version_id: this.config.sourcemapVersion,
         solutions,
-        stage: this.stage
+        stage: this.config.stage
       };
     });
   }
-  sendReport(report) {
-    if (!assert(
-      this.config.key,
-      "The client was not yet initialised with an API key. Run client.light('<flare-project-key>') when you initialise your app. If you are running in dev mode and didn't run the light command on purpose, you can ignore this error.",
-      this.debug
-    )) {
+  async sendReport(report) {
+    if (!assertKey(this.config.key, this.config.debug)) {
       return;
     }
-    if (this.maxReportsPerMinuteReached()) {
+    const reportToSubmit = await this.config.beforeSubmit(report);
+    if (!reportToSubmit) {
       return;
     }
-    Promise.resolve(this.beforeSubmit(report)).then(
-      (reportReadyForSubmit) => {
-        if (!reportReadyForSubmit) {
-          return;
-        }
-        fetch(this.config.reportingUrl, {
-          method: "POST",
-          headers: {
-            "Content-Type": "application/json",
-            "X-Requested-With": "XMLHttpRequest",
-            "x-api-token": this.config.key
-          },
-          body: flatJsonStringify({
-            ...reportReadyForSubmit,
-            key: this.config.key
-          })
-        }).then(
-          (response) => {
-            if (response.status !== 204) {
-              console.error(
-                `Received response with status ${response.status} from Flare`
-              );
-            }
-          },
-          (error) => console.error(error)
-        );
-        this.reportedErrorsTimestamps.push(Date.now());
-      }
+    return this.http.report(
+      reportToSubmit,
+      this.config.reportingUrl,
+      this.config.key,
+      this.config.reportBrowserExtensionErrors
     );
   }
-  maxReportsPerMinuteReached() {
-    if (this.reportedErrorsTimestamps.length >= this.config.maxReportsPerMinute) {
-      const nErrorsBack = this.reportedErrorsTimestamps[this.reportedErrorsTimestamps.length - this.config.maxReportsPerMinute];
-      if (nErrorsBack > Date.now() - 60 * 1e3) {
-        return true;
-      }
-    }
-    return false;
+  // Deprecated, the following methods exist for backwards compatibility.
+  set beforeEvaluate(beforeEvaluate) {
+    this.config.beforeEvaluate = beforeEvaluate ?? "";
   }
-  test() {
-    this.report(new Error("The Flare client is set up correctly!"));
-    return this;
+  set beforeSubmit(beforeSubmit) {
+    this.config.beforeSubmit = beforeSubmit ?? "";
+  }
+  set stage(stage) {
+    this.config.stage = stage ?? "";
   }
 };
 
-// src/browserClient/index.ts
+// src/browser/catchWindowErrors.ts
 function catchWindowErrors() {
   if (typeof window === "undefined") {
     return;
@@ -520,13 +492,13 @@ function catchWindowErrors() {
 }
 
 // src/index.ts
-var flare = new FlareClient();
+var flare = new Flare();
 if (typeof window !== "undefined" && window) {
   window.flare = flare;
+  catchWindowErrors();
 }
-catchWindowErrors();
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  flare,
-  readLinesFromFile
+  Flare,
+  flare
 });