@flareapp/js 2.0.0-rc.1 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flareapp/js",
-    "version": "2.0.0-rc.1",
+    "version": "2.0.0",
     "description": "JavaScript client for flareapp.io",
     "homepage": "https://flareapp.io",
     "bugs": {
@@ -11,29 +11,47 @@
         "url": "git+https://github.com/spatie/flare-client-js.git"
     },
     "license": "MIT",
-    "author": "adriaan@spatie.be",
-    "main": "./dist/index.js",
+    "author": {
+        "name": "Spatie",
+        "email": "info@spatie.be"
+    },
+    "contributors": [
+        "Adriaan Marain <adriaan@spatie.be>",
+        "Alex Vanderbist <alex@spatie.be>",
+        "Dries Heyninck <dries@spatie.be>",
+        "Freek Van der Herten <freek@spatie.be>",
+        "Sebastian De Deyne <sebastian@spatie.be>",
+        "Sébastien Henau <seba@spatie.be>"
+    ],
+    "main": "./dist/index.cjs",
     "module": "./dist/index.mjs",
-    "types": "./dist/index.d.ts",
+    "types": "./dist/index.d.cts",
     "exports": {
         ".": {
-            "require": "./dist/index.js",
-            "import": "./dist/index.mjs"
+            "import": {
+                "types": "./dist/index.d.mts",
+                "default": "./dist/index.mjs"
+            },
+            "require": {
+                "types": "./dist/index.d.cts",
+                "default": "./dist/index.cjs"
+            }
         }
     },
     "scripts": {
         "prepublishOnly": "npm run build",
-        "build": "tsup src/index.ts --format cjs,esm --dts --env.FLARE_JS_CLIENT_VERSION=\\\"$(node -p \"require('./package.json').version\")\\\" --clean",
+        "build": "tsdown src/index.ts --format cjs,esm --dts --env.FLARE_JS_CLIENT_VERSION=$(node -p \"require('./package.json').version\") --clean",
         "test": "vitest run",
-        "typescript": "tsc"
+        "typescript": "tsc --noEmit",
+        "release": "release-it"
     },
     "dependencies": {
         "error-stack-parser": "^2.0.2"
     },
     "devDependencies": {
-        "tsup": "^8.0.1",
-        "typescript": "^5.3.3",
-        "vitest": "^1.0.4"
+        "tsdown": "^0.20.3",
+        "typescript": "^5.7.0",
+        "vitest": "^4.0.18"
     },
     "publishConfig": {
         "access": "public"

package/dist/index.d.ts

@@ -1,109 +0,0 @@
-type Config = {
-    key: string;
-    version: string;
-    sourcemapVersion: string;
-    stage: string;
-    maxGlowsPerReport: number;
-    reportBrowserExtensionErrors: boolean;
-    reportingUrl: string;
-    debug: boolean;
-    beforeEvaluate: (error: Error) => Error | false | null | Promise<Error | false | null>;
-    beforeSubmit: (report: Report) => Report | false | null | Promise<Report | false | null>;
-};
-type Report = {
-    notifier: string;
-    exception_class: string;
-    seen_at: number;
-    message: string;
-    language: 'javascript';
-    glows: Glow[];
-    context: Context;
-    stacktrace: StackFrame[];
-    sourcemap_version_id: string;
-    solutions: Solution[];
-    stage?: string;
-};
-interface SolutionProviderExtraParameters {
-}
-type SolutionProvider = {
-    canSolve: (error: Error, extraParameters?: SolutionProviderExtraParameters) => boolean | Promise<boolean>;
-    getSolutions: (error: Error, extraParameters?: SolutionProviderExtraParameters) => Solution[] | Promise<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: object | object[];
-};
-type MessageLevel = 'info' | 'debug' | 'warning' | 'error' | 'critical';
-
-declare class Api {
-    report(report: Report, url: string, key: string, reportBrowserExtensionErrors: boolean): Promise<void>;
-}
-
-declare class Flare {
-    http: Api;
-    config: Config;
-    glows: Glow[];
-    context: Context;
-    solutionProviders: SolutionProvider[];
-    constructor(http?: Api);
-    light(key?: string, debug?: boolean): Flare;
-    configure(config: Partial<Config>): Flare;
-    test(): Promise<void>;
-    glow(name: string, level?: MessageLevel, data?: object | object[]): Flare;
-    clearGlows(): Flare;
-    addContext(name: string, value: any): Flare;
-    addContextGroup(groupName: string, value: object): Flare;
-    registerSolutionProvider(solutionProvider: SolutionProvider): Flare;
-    report(error: Error, context?: Context, extraSolutionParameters?: SolutionProviderExtraParameters): Promise<void>;
-    reportMessage(message: string, context?: Context, exceptionClass?: string): Promise<void>;
-    createReportFromError(error: Error, context?: Context, extraSolutionParameters?: SolutionProviderExtraParameters): Promise<Report | false>;
-    sendReport(report: Report): Promise<void>;
-    set beforeEvaluate(beforeEvaluate: Config['beforeEvaluate']);
-    set beforeSubmit(beforeSubmit: Config['beforeSubmit']);
-    set stage(stage: string | undefined);
-}
-
-declare const flare: Flare;
-
-export { Flare, flare };

package/dist/index.js

@@ -1,504 +0,0 @@
-"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,
-  flare: () => flare
-});
-module.exports = __toCommonJS(src_exports);
-
-// 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/assert.ts
-function assert(value, message, debug) {
-  if (debug && !value) {
-    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) {
-    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;
-}
-
-// 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) {
-    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/collectContext.ts
-function collectContext(additionalContext) {
-  if (typeof window === "undefined") {
-    return additionalContext;
-  }
-  return {
-    ...cookie(),
-    ...request(),
-    ...requestData(),
-    ...additionalContext
-  };
-}
-
-// 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
-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/createStackTrace.ts
-function createStackTrace(error, debug) {
-  return new Promise((resolve) => {
-    if (!hasStack(error)) {
-      assert(false, "Couldn't generate stacktrace of below error:", debug);
-      if (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/Flare.ts
-var Flare = class {
-  constructor(http = new Api()) {
-    this.http = http;
-    this.config = {
-      key: KEY,
-      version: CLIENT_VERSION,
-      sourcemapVersion: SOURCEMAP_VERSION,
-      stage: "",
-      maxGlowsPerReport: 30,
-      reportingUrl: "https://reporting.flareapp.io/api/reports",
-      reportBrowserExtensionErrors: false,
-      debug: false,
-      beforeEvaluate: (error) => error,
-      beforeSubmit: (report) => report
-    };
-    this.glows = [];
-    this.context = { context: {} };
-    this.solutionProviders = [];
-  }
-  light(key = KEY, debug = false) {
-    this.config.key = key;
-    this.config.debug = debug;
-    return this;
-  }
-  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: data,
-      time,
-      microtime: time
-    });
-    if (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;
-  }
-  addContextGroup(groupName, value) {
-    this.context[groupName] = value;
-    return this;
-  }
-  registerSolutionProvider(solutionProvider) {
-    if (!assertSolutionProvider(solutionProvider, this.config.debug)) {
-      return this;
-    }
-    this.solutionProviders.push(solutionProvider);
-    return this;
-  }
-  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);
-  }
-  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
-    });
-  }
-  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, this.config.debug)
-    ]).then((result) => {
-      const [solutions, stacktrace] = result;
-      assert(stacktrace.length, "Couldn't generate stacktrace of this error: " + error, this.config.debug);
-      return {
-        notifier: `Flare JavaScript client v${CLIENT_VERSION}`,
-        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.config.sourcemapVersion,
-        solutions,
-        stage: this.config.stage
-      };
-    });
-  }
-  async sendReport(report) {
-    if (!assertKey(this.config.key, this.config.debug)) {
-      return;
-    }
-    const reportToSubmit = await this.config.beforeSubmit(report);
-    if (!reportToSubmit) {
-      return;
-    }
-    return this.http.report(
-      reportToSubmit,
-      this.config.reportingUrl,
-      this.config.key,
-      this.config.reportBrowserExtensionErrors
-    );
-  }
-  // Deprecated, the following methods exist for backwards compatibility.
-  set beforeEvaluate(beforeEvaluate) {
-    this.config.beforeEvaluate = beforeEvaluate ?? "";
-  }
-  set beforeSubmit(beforeSubmit) {
-    this.config.beforeSubmit = beforeSubmit ?? "";
-  }
-  set stage(stage) {
-    this.config.stage = stage ?? "";
-  }
-};
-
-// src/browser/catchWindowErrors.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 Flare();
-if (typeof window !== "undefined" && window) {
-  window.flare = flare;
-  catchWindowErrors();
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  Flare,
-  flare
-});