@flareapp/js 1.0.0-beta.1 → 1.0.0-beta.3

package/dist/index.d.mts

@@ -0,0 +1,114 @@
+declare namespace Flare {
+    type BeforeEvaluate = (error: Error) => Error | false | Promise<Error | false>;
+    type BeforeSubmit = (report: ErrorReport) => ErrorReport | false | Promise<ErrorReport | false>;
+    type Config = {
+        key: string;
+        reportingUrl: string;
+        maxGlowsPerReport: number;
+        maxReportsPerMinute: number;
+        stage?: string;
+    };
+    type ErrorReport = {
+        notifier: string;
+        exception_class: string;
+        seen_at: number;
+        message: string;
+        language: 'javascript';
+        glows: Array<Flare.Glow>;
+        context: Flare.Context;
+        stacktrace: Array<Flare.StackFrame>;
+        sourcemap_version_id: string;
+        solutions: Array<Flare.Solution>;
+        stage?: string;
+    };
+    interface SolutionProviderExtraParameters {
+    }
+    type SolutionProvider = {
+        canSolve: (error: Error, extraParameters?: SolutionProviderExtraParameters) => boolean | Promise<boolean>;
+        getSolutions: (error: Error, extraParameters?: SolutionProviderExtraParameters) => Array<Flare.Solution> | Promise<Array<Flare.Solution>>;
+    };
+    type Solution = {
+        class: string;
+        title: string;
+        description: string;
+        links: {
+            [label: string]: string;
+        };
+        action_description?: string;
+        is_runnable?: boolean;
+    };
+    type Context = {
+        request?: {
+            url?: String;
+            useragent?: String;
+            referrer?: String;
+            readyState?: String;
+        };
+        request_data?: {
+            queryString: {
+                [key: string]: string;
+            };
+        };
+        cookies?: {
+            [key: string]: string;
+        };
+        [key: string]: any;
+    };
+    type StackFrame = {
+        line_number: number;
+        column_number: number;
+        method: string;
+        file: string;
+        code_snippet: {
+            [key: number]: string;
+        };
+        trimmed_column_number: number | null;
+        class: string;
+    };
+    type Glow = {
+        time: number;
+        microtime: number;
+        name: String;
+        message_level: MessageLevel;
+        meta_data: Array<Object>;
+    };
+    type MessageLevel = 'info' | 'debug' | 'warning' | 'error' | 'critical';
+}
+
+declare class FlareClient {
+    version: string;
+    config: Flare.Config;
+    private glows;
+    private context;
+    beforeEvaluate: Flare.BeforeEvaluate;
+    beforeSubmit: Flare.BeforeSubmit;
+    private reportedErrorsTimestamps;
+    private solutionProviders;
+    private sourcemapVersion;
+    debug: boolean;
+    stage: string | undefined;
+    light(key?: string, debug?: boolean): FlareClient;
+    glow(name: string, level?: Flare.MessageLevel, metaData?: Array<object>): FlareClient;
+    addContext(name: string, value: any): FlareClient;
+    addContextGroup(groupName: string, value: object): FlareClient;
+    registerSolutionProvider(provider: Flare.SolutionProvider): FlareClient;
+    reportMessage(message: string, context?: Flare.Context, exceptionClass?: string): void;
+    report(error: Error, context?: Flare.Context, extraSolutionParameters?: Flare.SolutionProviderExtraParameters): void;
+    createReport(error: Error, context?: Flare.Context, extraSolutionParameters?: Flare.SolutionProviderExtraParameters): Promise<Flare.ErrorReport | false>;
+    private sendReport;
+    private maxReportsPerMinuteReached;
+    test(): FlareClient;
+}
+
+type CodeSnippet = {
+    [key: number]: string;
+};
+type ReaderResponse = {
+    codeSnippet: CodeSnippet;
+    trimmedColumnNumber: number | null;
+};
+declare function readLinesFromFile(fileText: string, lineNumber: number, columnNumber?: number, maxSnippetLineLength?: number, maxSnippetLines?: number): ReaderResponse;
+
+declare const flare: FlareClient;
+
+export { flare, readLinesFromFile };

package/dist/index.d.ts

@@ -0,0 +1,114 @@
+declare namespace Flare {
+    type BeforeEvaluate = (error: Error) => Error | false | Promise<Error | false>;
+    type BeforeSubmit = (report: ErrorReport) => ErrorReport | false | Promise<ErrorReport | false>;
+    type Config = {
+        key: string;
+        reportingUrl: string;
+        maxGlowsPerReport: number;
+        maxReportsPerMinute: number;
+        stage?: string;
+    };
+    type ErrorReport = {
+        notifier: string;
+        exception_class: string;
+        seen_at: number;
+        message: string;
+        language: 'javascript';
+        glows: Array<Flare.Glow>;
+        context: Flare.Context;
+        stacktrace: Array<Flare.StackFrame>;
+        sourcemap_version_id: string;
+        solutions: Array<Flare.Solution>;
+        stage?: string;
+    };
+    interface SolutionProviderExtraParameters {
+    }
+    type SolutionProvider = {
+        canSolve: (error: Error, extraParameters?: SolutionProviderExtraParameters) => boolean | Promise<boolean>;
+        getSolutions: (error: Error, extraParameters?: SolutionProviderExtraParameters) => Array<Flare.Solution> | Promise<Array<Flare.Solution>>;
+    };
+    type Solution = {
+        class: string;
+        title: string;
+        description: string;
+        links: {
+            [label: string]: string;
+        };
+        action_description?: string;
+        is_runnable?: boolean;
+    };
+    type Context = {
+        request?: {
+            url?: String;
+            useragent?: String;
+            referrer?: String;
+            readyState?: String;
+        };
+        request_data?: {
+            queryString: {
+                [key: string]: string;
+            };
+        };
+        cookies?: {
+            [key: string]: string;
+        };
+        [key: string]: any;
+    };
+    type StackFrame = {
+        line_number: number;
+        column_number: number;
+        method: string;
+        file: string;
+        code_snippet: {
+            [key: number]: string;
+        };
+        trimmed_column_number: number | null;
+        class: string;
+    };
+    type Glow = {
+        time: number;
+        microtime: number;
+        name: String;
+        message_level: MessageLevel;
+        meta_data: Array<Object>;
+    };
+    type MessageLevel = 'info' | 'debug' | 'warning' | 'error' | 'critical';
+}
+
+declare class FlareClient {
+    version: string;
+    config: Flare.Config;
+    private glows;
+    private context;
+    beforeEvaluate: Flare.BeforeEvaluate;
+    beforeSubmit: Flare.BeforeSubmit;
+    private reportedErrorsTimestamps;
+    private solutionProviders;
+    private sourcemapVersion;
+    debug: boolean;
+    stage: string | undefined;
+    light(key?: string, debug?: boolean): FlareClient;
+    glow(name: string, level?: Flare.MessageLevel, metaData?: Array<object>): FlareClient;
+    addContext(name: string, value: any): FlareClient;
+    addContextGroup(groupName: string, value: object): FlareClient;
+    registerSolutionProvider(provider: Flare.SolutionProvider): FlareClient;
+    reportMessage(message: string, context?: Flare.Context, exceptionClass?: string): void;
+    report(error: Error, context?: Flare.Context, extraSolutionParameters?: Flare.SolutionProviderExtraParameters): void;
+    createReport(error: Error, context?: Flare.Context, extraSolutionParameters?: Flare.SolutionProviderExtraParameters): Promise<Flare.ErrorReport | false>;
+    private sendReport;
+    private maxReportsPerMinuteReached;
+    test(): FlareClient;
+}
+
+type CodeSnippet = {
+    [key: number]: string;
+};
+type ReaderResponse = {
+    codeSnippet: CodeSnippet;
+    trimmedColumnNumber: number | null;
+};
+declare function readLinesFromFile(fileText: string, lineNumber: number, columnNumber?: number, maxSnippetLineLength?: number, maxSnippetLines?: number): ReaderResponse;
+
+declare const flare: FlareClient;
+
+export { flare, readLinesFromFile };

package/dist/index.js

@@ -0,0 +1,532 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  flare: () => flare,
+  readLinesFromFile: () => readLinesFromFile
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/build.ts
+var build_default = {
+  // Injected during build
+  clientVersion: false ? "?" : '"1.0.0-beta.3"',
+  // 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/util/index.ts
+function assert(value, message, debug) {
+  if (debug && !value) {
+    console.error(
+      `Flare JavaScript client v${build_default.clientVersion}: ${message}`
+    );
+  }
+  return !!value;
+}
+function flatJsonStringify(json) {
+  let cache = [];
+  const flattenedStringifiedJson = JSON.stringify(json, function(_, value) {
+    if (typeof value === "object" && value !== null) {
+      if (cache.indexOf(value) !== -1) {
+        try {
+          return JSON.parse(JSON.stringify(value));
+        } catch (error) {
+          return;
+        }
+      }
+      cache.push(value);
+    }
+    return value;
+  });
+  cache = null;
+  return flattenedStringifiedJson;
+}
+function now() {
+  return Math.round(Date.now() / 1e3);
+}
+function flattenOnce(array) {
+  return array.reduce((flat, toFlatten) => {
+    return flat.concat(toFlatten);
+  }, []);
+}
+
+// src/context/cookie.ts
+function cookie() {
+  if (!window.document.cookie) {
+    return {};
+  }
+  return {
+    cookies: window.document.cookie.split("; ").reduce(
+      (cookies, cookie2) => {
+        const [cookieName, cookieValue] = cookie2.split(/=/);
+        cookies[cookieName] = cookieValue;
+        return cookies;
+      },
+      {}
+    )
+  };
+}
+
+// src/context/request.ts
+function request() {
+  return {
+    request: {
+      url: window.document.location.href,
+      useragent: window.navigator.userAgent,
+      referrer: window.document.referrer,
+      readyState: window.document.readyState
+    }
+  };
+}
+
+// src/context/requestData.ts
+function requestData() {
+  if (!window.location.search) {
+    return {};
+  }
+  const queryString = {};
+  new URLSearchParams(window.location.search).forEach((value, key) => {
+    queryString[key] = value;
+  });
+  return { request_data: { queryString } };
+}
+
+// src/context/index.ts
+function collectContext(additionalContext) {
+  if (typeof window === "undefined") {
+    return additionalContext;
+  }
+  return {
+    ...cookie(),
+    ...request(),
+    ...requestData(),
+    ...additionalContext
+  };
+}
+
+// src/stacktrace/index.ts
+var import_error_stack_parser = __toESM(require("error-stack-parser"));
+
+// src/stacktrace/fileReader.ts
+var cachedFiles = {};
+function getCodeSnippet(url, lineNumber, columnNumber) {
+  return new Promise((resolve) => {
+    if (!url || !lineNumber) {
+      return resolve({
+        codeSnippet: {
+          0: `Could not read from file: missing file URL or line number. URL: ${url} lineNumber: ${lineNumber}`
+        },
+        trimmedColumnNumber: null
+      });
+    }
+    readFile(url).then((fileText) => {
+      if (!fileText) {
+        return resolve({
+          codeSnippet: {
+            0: `Could not read from file: Error while opening file at URL ${url}`
+          },
+          trimmedColumnNumber: null
+        });
+      }
+      return resolve(
+        readLinesFromFile(fileText, lineNumber, columnNumber)
+      );
+    });
+  });
+}
+function readFile(url) {
+  if (cachedFiles[url]) {
+    return Promise.resolve(cachedFiles[url]);
+  }
+  return fetch(url).then((response) => {
+    if (response.status !== 200) {
+      return null;
+    }
+    return response.text();
+  }).catch(() => null);
+}
+function readLinesFromFile(fileText, lineNumber, columnNumber, maxSnippetLineLength = 1e3, maxSnippetLines = 40) {
+  const codeSnippet = {};
+  let trimmedColumnNumber = null;
+  const lines = fileText.split("\n");
+  for (let i = -maxSnippetLines / 2; i <= maxSnippetLines / 2; i++) {
+    const currentLineIndex = lineNumber + i;
+    if (currentLineIndex >= 0 && lines[currentLineIndex]) {
+      const displayLine = currentLineIndex + 1;
+      if (lines[currentLineIndex].length > maxSnippetLineLength) {
+        if (columnNumber && columnNumber + maxSnippetLineLength / 2 > maxSnippetLineLength) {
+          codeSnippet[displayLine] = lines[currentLineIndex].substr(
+            columnNumber - Math.round(maxSnippetLineLength / 2),
+            maxSnippetLineLength
+          );
+          if (displayLine === lineNumber) {
+            trimmedColumnNumber = Math.round(
+              maxSnippetLineLength / 2
+            );
+          }
+          continue;
+        }
+        codeSnippet[displayLine] = lines[currentLineIndex].substr(0, maxSnippetLineLength) + "\u2026";
+        continue;
+      }
+      codeSnippet[displayLine] = lines[currentLineIndex];
+    }
+  }
+  return { codeSnippet, trimmedColumnNumber };
+}
+
+// src/stacktrace/index.ts
+function createStackTrace(error) {
+  return new Promise((resolve) => {
+    if (!hasStack(error)) {
+      assert(
+        false,
+        "Couldn't generate stacktrace of below error:",
+        flare.debug
+      );
+      if (flare.debug) {
+        console.error(error);
+      }
+      return resolve([
+        {
+          line_number: 0,
+          column_number: 0,
+          method: "unknown",
+          file: "unknown",
+          code_snippet: {
+            0: "Could not read from file: stacktrace missing"
+          },
+          trimmed_column_number: null,
+          class: "unknown"
+        }
+      ]);
+    }
+    Promise.all(
+      import_error_stack_parser.default.parse(error).map((frame) => {
+        return new Promise((resolve2) => {
+          getCodeSnippet(
+            frame.fileName,
+            frame.lineNumber,
+            frame.columnNumber
+          ).then((snippet) => {
+            resolve2({
+              line_number: frame.lineNumber || 1,
+              column_number: frame.columnNumber || 1,
+              method: frame.functionName || "Anonymous or unknown function",
+              file: frame.fileName || "Unknown file",
+              code_snippet: snippet.codeSnippet,
+              trimmed_column_number: snippet.trimmedColumnNumber,
+              class: ""
+            });
+          });
+        });
+      })
+    ).then(resolve);
+  });
+}
+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;
+    this.config = {
+      key: "",
+      reportingUrl: "https://flareapp.io/api/reports",
+      maxGlowsPerReport: 30,
+      maxReportsPerMinute: 500
+    };
+    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;
+    }
+    this.config.key = key;
+    return this;
+  }
+  glow(name, level = "info", metaData = []) {
+    const time = now();
+    this.glows.push({
+      name,
+      message_level: level,
+      meta_data: metaData,
+      time,
+      microtime: time
+    });
+    if (this.glows.length > this.config.maxGlowsPerReport) {
+      this.glows = this.glows.slice(
+        this.glows.length - this.config.maxGlowsPerReport
+      );
+    }
+    return this;
+  }
+  addContext(name, value) {
+    this.context.context[name] = value;
+    return this;
+  }
+  addContextGroup(groupName, value) {
+    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
+    )) {
+      return this;
+    }
+    this.solutionProviders.push(provider);
+    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);
+    });
+  }
+  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) : {}
+        );
+      }
+    );
+  }
+  createReport(error, context = {}, extraSolutionParameters = {}) {
+    if (!assert(error, "No error provided.", this.debug)) {
+      return Promise.resolve(false);
+    }
+    const seenAt = now();
+    return Promise.all([
+      getSolutions(
+        this.solutionProviders,
+        error,
+        extraSolutionParameters
+      ),
+      createStackTrace(error)
+    ]).then((result) => {
+      const [solutions, stacktrace] = result;
+      assert(
+        stacktrace.length,
+        "Couldn't generate stacktrace of this error: " + error,
+        this.debug
+      );
+      return {
+        notifier: `Flare JavaScript client v${build_default.clientVersion}`,
+        exception_class: error.constructor && error.constructor.name ? error.constructor.name : "undefined",
+        seen_at: seenAt,
+        message: error.message,
+        language: "javascript",
+        glows: this.glows,
+        context: collectContext({ ...context, ...this.context }),
+        stacktrace,
+        sourcemap_version_id: this.sourcemapVersion,
+        solutions,
+        stage: this.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
+    )) {
+      return;
+    }
+    if (this.maxReportsPerMinuteReached()) {
+      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());
+      }
+    );
+  }
+  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;
+  }
+  test() {
+    this.report(new Error("The Flare client is set up correctly!"));
+    return this;
+  }
+};
+
+// src/browserClient/index.ts
+function catchWindowErrors() {
+  if (typeof window === "undefined") {
+    return;
+  }
+  const flare2 = window.flare;
+  if (!window || !flare2) {
+    return;
+  }
+  const originalOnerrorHandler = window.onerror;
+  const originalOnunhandledrejectionHandler = window.onunhandledrejection;
+  window.onerror = (_1, _2, _3, _4, error) => {
+    if (error) {
+      flare2.report(error);
+    }
+    if (typeof originalOnerrorHandler === "function") {
+      originalOnerrorHandler(_1, _2, _3, _4, error);
+    }
+  };
+  window.onunhandledrejection = (error) => {
+    if (error.reason instanceof Error) {
+      flare2.report(error.reason);
+    }
+    if (typeof originalOnunhandledrejectionHandler === "function") {
+      originalOnunhandledrejectionHandler(error);
+    }
+  };
+}
+
+// src/index.ts
+var flare = new FlareClient();
+if (typeof window !== "undefined" && window) {
+  window.flare = flare;
+}
+catchWindowErrors();
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  flare,
+  readLinesFromFile
+});

package/dist/index.mjs

@@ -0,0 +1,494 @@
+// src/build.ts
+var build_default = {
+  // Injected during build
+  clientVersion: false ? "?" : '"1.0.0-beta.3"',
+  // 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/util/index.ts
+function assert(value, message, debug) {
+  if (debug && !value) {
+    console.error(
+      `Flare JavaScript client v${build_default.clientVersion}: ${message}`
+    );
+  }
+  return !!value;
+}
+function flatJsonStringify(json) {
+  let cache = [];
+  const flattenedStringifiedJson = JSON.stringify(json, function(_, value) {
+    if (typeof value === "object" && value !== null) {
+      if (cache.indexOf(value) !== -1) {
+        try {
+          return JSON.parse(JSON.stringify(value));
+        } catch (error) {
+          return;
+        }
+      }
+      cache.push(value);
+    }
+    return value;
+  });
+  cache = null;
+  return flattenedStringifiedJson;
+}
+function now() {
+  return Math.round(Date.now() / 1e3);
+}
+function flattenOnce(array) {
+  return array.reduce((flat, toFlatten) => {
+    return flat.concat(toFlatten);
+  }, []);
+}
+
+// src/context/cookie.ts
+function cookie() {
+  if (!window.document.cookie) {
+    return {};
+  }
+  return {
+    cookies: window.document.cookie.split("; ").reduce(
+      (cookies, cookie2) => {
+        const [cookieName, cookieValue] = cookie2.split(/=/);
+        cookies[cookieName] = cookieValue;
+        return cookies;
+      },
+      {}
+    )
+  };
+}
+
+// src/context/request.ts
+function request() {
+  return {
+    request: {
+      url: window.document.location.href,
+      useragent: window.navigator.userAgent,
+      referrer: window.document.referrer,
+      readyState: window.document.readyState
+    }
+  };
+}
+
+// src/context/requestData.ts
+function requestData() {
+  if (!window.location.search) {
+    return {};
+  }
+  const queryString = {};
+  new URLSearchParams(window.location.search).forEach((value, key) => {
+    queryString[key] = value;
+  });
+  return { request_data: { queryString } };
+}
+
+// src/context/index.ts
+function collectContext(additionalContext) {
+  if (typeof window === "undefined") {
+    return additionalContext;
+  }
+  return {
+    ...cookie(),
+    ...request(),
+    ...requestData(),
+    ...additionalContext
+  };
+}
+
+// src/stacktrace/index.ts
+import ErrorStackParser from "error-stack-parser";
+
+// src/stacktrace/fileReader.ts
+var cachedFiles = {};
+function getCodeSnippet(url, lineNumber, columnNumber) {
+  return new Promise((resolve) => {
+    if (!url || !lineNumber) {
+      return resolve({
+        codeSnippet: {
+          0: `Could not read from file: missing file URL or line number. URL: ${url} lineNumber: ${lineNumber}`
+        },
+        trimmedColumnNumber: null
+      });
+    }
+    readFile(url).then((fileText) => {
+      if (!fileText) {
+        return resolve({
+          codeSnippet: {
+            0: `Could not read from file: Error while opening file at URL ${url}`
+          },
+          trimmedColumnNumber: null
+        });
+      }
+      return resolve(
+        readLinesFromFile(fileText, lineNumber, columnNumber)
+      );
+    });
+  });
+}
+function readFile(url) {
+  if (cachedFiles[url]) {
+    return Promise.resolve(cachedFiles[url]);
+  }
+  return fetch(url).then((response) => {
+    if (response.status !== 200) {
+      return null;
+    }
+    return response.text();
+  }).catch(() => null);
+}
+function readLinesFromFile(fileText, lineNumber, columnNumber, maxSnippetLineLength = 1e3, maxSnippetLines = 40) {
+  const codeSnippet = {};
+  let trimmedColumnNumber = null;
+  const lines = fileText.split("\n");
+  for (let i = -maxSnippetLines / 2; i <= maxSnippetLines / 2; i++) {
+    const currentLineIndex = lineNumber + i;
+    if (currentLineIndex >= 0 && lines[currentLineIndex]) {
+      const displayLine = currentLineIndex + 1;
+      if (lines[currentLineIndex].length > maxSnippetLineLength) {
+        if (columnNumber && columnNumber + maxSnippetLineLength / 2 > maxSnippetLineLength) {
+          codeSnippet[displayLine] = lines[currentLineIndex].substr(
+            columnNumber - Math.round(maxSnippetLineLength / 2),
+            maxSnippetLineLength
+          );
+          if (displayLine === lineNumber) {
+            trimmedColumnNumber = Math.round(
+              maxSnippetLineLength / 2
+            );
+          }
+          continue;
+        }
+        codeSnippet[displayLine] = lines[currentLineIndex].substr(0, maxSnippetLineLength) + "\u2026";
+        continue;
+      }
+      codeSnippet[displayLine] = lines[currentLineIndex];
+    }
+  }
+  return { codeSnippet, trimmedColumnNumber };
+}
+
+// src/stacktrace/index.ts
+function createStackTrace(error) {
+  return new Promise((resolve) => {
+    if (!hasStack(error)) {
+      assert(
+        false,
+        "Couldn't generate stacktrace of below error:",
+        flare.debug
+      );
+      if (flare.debug) {
+        console.error(error);
+      }
+      return resolve([
+        {
+          line_number: 0,
+          column_number: 0,
+          method: "unknown",
+          file: "unknown",
+          code_snippet: {
+            0: "Could not read from file: stacktrace missing"
+          },
+          trimmed_column_number: null,
+          class: "unknown"
+        }
+      ]);
+    }
+    Promise.all(
+      ErrorStackParser.parse(error).map((frame) => {
+        return new Promise((resolve2) => {
+          getCodeSnippet(
+            frame.fileName,
+            frame.lineNumber,
+            frame.columnNumber
+          ).then((snippet) => {
+            resolve2({
+              line_number: frame.lineNumber || 1,
+              column_number: frame.columnNumber || 1,
+              method: frame.functionName || "Anonymous or unknown function",
+              file: frame.fileName || "Unknown file",
+              code_snippet: snippet.codeSnippet,
+              trimmed_column_number: snippet.trimmedColumnNumber,
+              class: ""
+            });
+          });
+        });
+      })
+    ).then(resolve);
+  });
+}
+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;
+    this.config = {
+      key: "",
+      reportingUrl: "https://flareapp.io/api/reports",
+      maxGlowsPerReport: 30,
+      maxReportsPerMinute: 500
+    };
+    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;
+    }
+    this.config.key = key;
+    return this;
+  }
+  glow(name, level = "info", metaData = []) {
+    const time = now();
+    this.glows.push({
+      name,
+      message_level: level,
+      meta_data: metaData,
+      time,
+      microtime: time
+    });
+    if (this.glows.length > this.config.maxGlowsPerReport) {
+      this.glows = this.glows.slice(
+        this.glows.length - this.config.maxGlowsPerReport
+      );
+    }
+    return this;
+  }
+  addContext(name, value) {
+    this.context.context[name] = value;
+    return this;
+  }
+  addContextGroup(groupName, value) {
+    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
+    )) {
+      return this;
+    }
+    this.solutionProviders.push(provider);
+    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);
+    });
+  }
+  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) : {}
+        );
+      }
+    );
+  }
+  createReport(error, context = {}, extraSolutionParameters = {}) {
+    if (!assert(error, "No error provided.", this.debug)) {
+      return Promise.resolve(false);
+    }
+    const seenAt = now();
+    return Promise.all([
+      getSolutions(
+        this.solutionProviders,
+        error,
+        extraSolutionParameters
+      ),
+      createStackTrace(error)
+    ]).then((result) => {
+      const [solutions, stacktrace] = result;
+      assert(
+        stacktrace.length,
+        "Couldn't generate stacktrace of this error: " + error,
+        this.debug
+      );
+      return {
+        notifier: `Flare JavaScript client v${build_default.clientVersion}`,
+        exception_class: error.constructor && error.constructor.name ? error.constructor.name : "undefined",
+        seen_at: seenAt,
+        message: error.message,
+        language: "javascript",
+        glows: this.glows,
+        context: collectContext({ ...context, ...this.context }),
+        stacktrace,
+        sourcemap_version_id: this.sourcemapVersion,
+        solutions,
+        stage: this.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
+    )) {
+      return;
+    }
+    if (this.maxReportsPerMinuteReached()) {
+      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());
+      }
+    );
+  }
+  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;
+  }
+  test() {
+    this.report(new Error("The Flare client is set up correctly!"));
+    return this;
+  }
+};
+
+// src/browserClient/index.ts
+function catchWindowErrors() {
+  if (typeof window === "undefined") {
+    return;
+  }
+  const flare2 = window.flare;
+  if (!window || !flare2) {
+    return;
+  }
+  const originalOnerrorHandler = window.onerror;
+  const originalOnunhandledrejectionHandler = window.onunhandledrejection;
+  window.onerror = (_1, _2, _3, _4, error) => {
+    if (error) {
+      flare2.report(error);
+    }
+    if (typeof originalOnerrorHandler === "function") {
+      originalOnerrorHandler(_1, _2, _3, _4, error);
+    }
+  };
+  window.onunhandledrejection = (error) => {
+    if (error.reason instanceof Error) {
+      flare2.report(error.reason);
+    }
+    if (typeof originalOnunhandledrejectionHandler === "function") {
+      originalOnunhandledrejectionHandler(error);
+    }
+  };
+}
+
+// src/index.ts
+var flare = new FlareClient();
+if (typeof window !== "undefined" && window) {
+  window.flare = flare;
+}
+catchWindowErrors();
+export {
+  flare,
+  readLinesFromFile
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flareapp/js",
-    "version": "1.0.0-beta.1",
+    "version": "1.0.0-beta.3",
     "description": "JavaScript client for flareapp.io",
     "homepage": "https://flareapp.io",
     "bugs": {

package/tests/index.test.ts

@@ -1,50 +0,0 @@
-// @ts-nocheck
-import { flare } from '../src/index';
-import { expect, test } from 'vitest';
-
-test('properly lights', (done) => {
-    const projectKey = 'aprojectkey';
-
-    flare.light(projectKey);
-
-    expect(flare.config.key).toBe(projectKey);
-});
-
-test('can create glows', (done) => {
-    flare.glow('glowName', undefined, undefined);
-
-    expect(flare.glows.length).toBe(1);
-
-    expect(flare.glows[0]).toMatchObject({
-        name: 'glowName',
-        message_level: 'info',
-        meta_data: [],
-    });
-
-    expect(typeof flare.glows[0].microtime).toBe('number');
-    expect(typeof flare.glows[0].time).toBe('number');
-});
-
-test.todo('can register solution providers');
-
-test.todo('can use solution providers properly');
-
-test.todo('can use async solution providers properly');
-
-test.todo('can build an error report from an error');
-
-test.todo('can create custom context and context groups');
-
-test.todo('can throttle when too many reports are being sent');
-
-test.todo('can stop a report from being submitted by using beforeSubmit');
-
-test.todo('can use an async beforeSubmit');
-
-test.todo('can edit a report using beforeSubmit and still send it');
-
-test.todo('can stop an error from being evaluated by using beforeEvaluate');
-
-test.todo('can use an async beforeEvaluate');
-
-test.todo('can check out an error using beforeEvaluate and still send it');