@flareapp/js 2.0.0-rc.1 → 2.0.0

package/dist/index.d.cts

@@ -0,0 +1,122 @@
+//#region src/types.d.ts
+type MessageLevel = 'debug' | 'info' | 'notice' | 'warning' | 'error' | 'critical' | 'alert' | 'emergency';
+type AttributeValue = string | number | boolean | null | AttributeValue[] | {
+  [key: string]: AttributeValue;
+};
+type Attributes = Record<string, AttributeValue>;
+type Config = {
+  key: string | null;
+  version: string;
+  sourcemapVersionId: string;
+  stage: string;
+  maxGlowsPerReport: number;
+  reportBrowserExtensionErrors: boolean;
+  ingestUrl: string;
+  debug: boolean;
+  urlDenylist: RegExp;
+  replaceDefaultUrlDenylist: boolean;
+  sampleRate: number;
+  beforeEvaluate: (error: Error) => Error | false | null | Promise<Error | false | null>;
+  beforeSubmit: (report: Report) => Report | false | null | Promise<Report | false | null>;
+};
+type StackFrame = {
+  file: string;
+  lineNumber: number;
+  columnNumber?: number;
+  method?: string;
+  class?: string;
+  codeSnippet?: {
+    [line: number]: string;
+  };
+  isApplicationFrame?: boolean;
+  arguments?: unknown[];
+};
+type SpanEvent = {
+  type: string;
+  startTimeUnixNano: number;
+  endTimeUnixNano: number | null;
+  attributes: Attributes;
+};
+type OverriddenGrouping = 'exception_class' | 'exception_message' | 'exception_message_and_class' | 'full_stacktrace_and_exception_class_and_code';
+type Report = {
+  exceptionClass?: string | null;
+  message?: string | null;
+  code?: string;
+  seenAtUnixNano: number;
+  isLog?: boolean;
+  level?: MessageLevel;
+  sourcemapVersionId?: string;
+  trackingUuid?: string;
+  handled?: boolean;
+  openFrameIndex?: number;
+  applicationPath?: string;
+  overriddenGrouping?: OverriddenGrouping | null;
+  stacktrace: StackFrame[];
+  events: SpanEvent[];
+  attributes: Attributes;
+};
+type Glow = {
+  time: number;
+  microtime: number;
+  name: string;
+  messageLevel: MessageLevel;
+  metaData: Record<string, unknown> | Record<string, unknown>[];
+};
+type EntryPointHandler = {
+  identifier?: string;
+  name?: string;
+  type?: string;
+};
+type SdkInfo = {
+  name: string;
+  version: string;
+};
+type Framework = {
+  name: string;
+  version?: string;
+};
+//#endregion
+//#region src/api/Api.d.ts
+declare class Api {
+  report(report: Report, url: string, key: string | null, reportBrowserExtensionErrors: boolean, debug?: boolean): Promise<void>;
+}
+//#endregion
+//#region src/Flare.d.ts
+declare class Flare {
+  api: Api;
+  private _config;
+  private _glows;
+  private pendingAttributes;
+  private entryPoint;
+  private sdkInfo;
+  private framework;
+  constructor(api?: Api);
+  get config(): Readonly<Config>;
+  get glows(): readonly Glow[];
+  light(key?: string, debug?: boolean): Flare;
+  configure(config: Partial<Config>): Flare;
+  test(): Promise<void>;
+  glow(name: string, level?: MessageLevel, data?: Record<string, unknown> | Record<string, unknown>[]): Flare;
+  clearGlows(): Flare;
+  addContext(name: string, value: AttributeValue): Flare;
+  addContextGroup(groupName: string, value: Record<string, AttributeValue>): Flare;
+  setEntryPoint(handler: EntryPointHandler): Flare;
+  setSdkInfo(info: SdkInfo): Flare;
+  setFramework(framework: Framework): Flare;
+  report(error: Error, attributes?: Attributes): Promise<void>;
+  reportUnhandledRejection(message: string, attributes?: Attributes): Promise<void>;
+  reportMessage(message: string, level?: MessageLevel, attributes?: Attributes): Promise<void>;
+  createReportFromError(error: Error, attributes?: Attributes, seenAtUnixNano?: number): Promise<Report | false>;
+  private buildReport;
+  sendReport(report: Report): Promise<void>;
+}
+//#endregion
+//#region src/util/redactUrl.d.ts
+declare const DEFAULT_URL_DENYLIST: RegExp;
+declare function resolveDenylist(custom?: RegExp, replaceDefault?: boolean, defaultDenylist?: RegExp): RegExp;
+declare function redactFullPath(fullPath: string, denylist?: RegExp): string;
+//#endregion
+//#region src/index.d.ts
+declare const flare: Flare;
+//#endregion
+export { type AttributeValue, type Attributes, type Config, DEFAULT_URL_DENYLIST, type EntryPointHandler, Flare, type Framework, type Glow, type MessageLevel, type OverriddenGrouping, type Report, type SdkInfo, type SpanEvent, type StackFrame, flare, redactFullPath, resolveDenylist };

package/dist/index.d.mts

@@ -1,109 +1,122 @@
+//#region src/types.d.ts
+type MessageLevel = 'debug' | 'info' | 'notice' | 'warning' | 'error' | 'critical' | 'alert' | 'emergency';
+type AttributeValue = string | number | boolean | null | AttributeValue[] | {
+  [key: string]: AttributeValue;
+};
+type Attributes = Record<string, AttributeValue>;
 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>;
+  key: string | null;
+  version: string;
+  sourcemapVersionId: string;
+  stage: string;
+  maxGlowsPerReport: number;
+  reportBrowserExtensionErrors: boolean;
+  ingestUrl: string;
+  debug: boolean;
+  urlDenylist: RegExp;
+  replaceDefaultUrlDenylist: boolean;
+  sampleRate: number;
+  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;
+type StackFrame = {
+  file: string;
+  lineNumber: number;
+  columnNumber?: number;
+  method?: string;
+  class?: string;
+  codeSnippet?: {
+    [line: number]: string;
+  };
+  isApplicationFrame?: boolean;
+  arguments?: unknown[];
 };
-interface SolutionProviderExtraParameters {
-}
-type SolutionProvider = {
-    canSolve: (error: Error, extraParameters?: SolutionProviderExtraParameters) => boolean | Promise<boolean>;
-    getSolutions: (error: Error, extraParameters?: SolutionProviderExtraParameters) => Solution[] | Promise<Solution[]>;
+type SpanEvent = {
+  type: string;
+  startTimeUnixNano: number;
+  endTimeUnixNano: number | null;
+  attributes: Attributes;
 };
-type Solution = {
-    class: string;
-    title: string;
-    description: string;
-    links: {
-        [label: string]: string;
-    };
-    action_description?: string;
-    is_runnable?: boolean;
+type OverriddenGrouping = 'exception_class' | 'exception_message' | 'exception_message_and_class' | 'full_stacktrace_and_exception_class_and_code';
+type Report = {
+  exceptionClass?: string | null;
+  message?: string | null;
+  code?: string;
+  seenAtUnixNano: number;
+  isLog?: boolean;
+  level?: MessageLevel;
+  sourcemapVersionId?: string;
+  trackingUuid?: string;
+  handled?: boolean;
+  openFrameIndex?: number;
+  applicationPath?: string;
+  overriddenGrouping?: OverriddenGrouping | null;
+  stacktrace: StackFrame[];
+  events: SpanEvent[];
+  attributes: Attributes;
 };
-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 Glow = {
+  time: number;
+  microtime: number;
+  name: string;
+  messageLevel: MessageLevel;
+  metaData: Record<string, unknown> | Record<string, unknown>[];
 };
-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 EntryPointHandler = {
+  identifier?: string;
+  name?: string;
+  type?: string;
 };
-type Glow = {
-    time: number;
-    microtime: number;
-    name: String;
-    message_level: MessageLevel;
-    meta_data: object | object[];
+type SdkInfo = {
+  name: string;
+  version: string;
+};
+type Framework = {
+  name: string;
+  version?: string;
 };
-type MessageLevel = 'info' | 'debug' | 'warning' | 'error' | 'critical';
-
+//#endregion
+//#region src/api/Api.d.ts
 declare class Api {
-    report(report: Report, url: string, key: string, reportBrowserExtensionErrors: boolean): Promise<void>;
+  report(report: Report, url: string, key: string | null, reportBrowserExtensionErrors: boolean, debug?: boolean): Promise<void>;
 }
-
+//#endregion
+//#region src/Flare.d.ts
 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);
+  api: Api;
+  private _config;
+  private _glows;
+  private pendingAttributes;
+  private entryPoint;
+  private sdkInfo;
+  private framework;
+  constructor(api?: Api);
+  get config(): Readonly<Config>;
+  get glows(): readonly Glow[];
+  light(key?: string, debug?: boolean): Flare;
+  configure(config: Partial<Config>): Flare;
+  test(): Promise<void>;
+  glow(name: string, level?: MessageLevel, data?: Record<string, unknown> | Record<string, unknown>[]): Flare;
+  clearGlows(): Flare;
+  addContext(name: string, value: AttributeValue): Flare;
+  addContextGroup(groupName: string, value: Record<string, AttributeValue>): Flare;
+  setEntryPoint(handler: EntryPointHandler): Flare;
+  setSdkInfo(info: SdkInfo): Flare;
+  setFramework(framework: Framework): Flare;
+  report(error: Error, attributes?: Attributes): Promise<void>;
+  reportUnhandledRejection(message: string, attributes?: Attributes): Promise<void>;
+  reportMessage(message: string, level?: MessageLevel, attributes?: Attributes): Promise<void>;
+  createReportFromError(error: Error, attributes?: Attributes, seenAtUnixNano?: number): Promise<Report | false>;
+  private buildReport;
+  sendReport(report: Report): Promise<void>;
 }
-
+//#endregion
+//#region src/util/redactUrl.d.ts
+declare const DEFAULT_URL_DENYLIST: RegExp;
+declare function resolveDenylist(custom?: RegExp, replaceDefault?: boolean, defaultDenylist?: RegExp): RegExp;
+declare function redactFullPath(fullPath: string, denylist?: RegExp): string;
+//#endregion
+//#region src/index.d.ts
 declare const flare: Flare;
-
-export { Flare, flare };
+//#endregion
+export { type AttributeValue, type Attributes, type Config, DEFAULT_URL_DENYLIST, type EntryPointHandler, Flare, type Framework, type Glow, type MessageLevel, type OverriddenGrouping, type Report, type SdkInfo, type SpanEvent, type StackFrame, flare, redactFullPath, resolveDenylist };