@flareapp/js 1.0.1 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/index.d.mts +97 -102
  2. package/dist/index.d.ts +97 -102
  3. package/dist/index.js +184 -212
  4. package/dist/index.mjs +182 -210
  5. package/package.json +1 -1
  6. package/src/Flare.ts +208 -0
  7. package/src/api/Api.ts +27 -0
  8. package/src/api/index.ts +1 -0
  9. package/src/{browserClient/index.ts → browser/catchWindowErrors.ts} +2 -3
  10. package/src/browser/index.ts +1 -0
  11. package/src/context/collectContext.ts +18 -0
  12. package/src/context/cookie.ts +1 -1
  13. package/src/context/index.ts +1 -17
  14. package/src/env/index.ts +12 -0
  15. package/src/index.ts +8 -5
  16. package/src/solutions/getSolutions.ts +35 -0
  17. package/src/solutions/index.ts +1 -44
  18. package/src/stacktrace/createStackTrace.ts +59 -0
  19. package/src/stacktrace/fileReader.ts +7 -21
  20. package/src/stacktrace/index.ts +1 -71
  21. package/src/types.ts +66 -82
  22. package/src/util/assert.ts +9 -0
  23. package/src/util/assertKey.ts +11 -0
  24. package/src/util/assertSolutionProvider.ts +12 -0
  25. package/src/util/flatJsonStringify.ts +22 -0
  26. package/src/util/flattenOnce.ts +5 -0
  27. package/src/util/index.ts +6 -44
  28. package/src/util/now.ts +3 -0
  29. package/tsconfig.json +1 -1
  30. package/src/FlareClient.ts +0 -285
  31. package/src/build.ts +0 -16
  32. package/src/module.d.ts +0 -3
package/dist/index.d.mts CHANGED
@@ -1,114 +1,109 @@
1
- declare namespace Flare {
2
- type BeforeEvaluate = (error: Error) => Error | false | Promise<Error | false>;
3
- type BeforeSubmit = (report: ErrorReport) => ErrorReport | false | Promise<ErrorReport | false>;
4
- type Config = {
5
- key: string;
6
- reportingUrl: string;
7
- maxGlowsPerReport: number;
8
- maxReportsPerMinute: number;
9
- stage?: string;
10
- };
11
- type ErrorReport = {
12
- notifier: string;
13
- exception_class: string;
14
- seen_at: number;
15
- message: string;
16
- language: 'javascript';
17
- glows: Array<Flare.Glow>;
18
- context: Flare.Context;
19
- stacktrace: Array<Flare.StackFrame>;
20
- sourcemap_version_id: string;
21
- solutions: Array<Flare.Solution>;
22
- stage?: string;
23
- };
24
- interface SolutionProviderExtraParameters {
25
- }
26
- type SolutionProvider = {
27
- canSolve: (error: Error, extraParameters?: SolutionProviderExtraParameters) => boolean | Promise<boolean>;
28
- getSolutions: (error: Error, extraParameters?: SolutionProviderExtraParameters) => Array<Flare.Solution> | Promise<Array<Flare.Solution>>;
1
+ type Config = {
2
+ key: string | null;
3
+ version: string;
4
+ sourcemapVersion: string;
5
+ stage: string;
6
+ maxGlowsPerReport: number;
7
+ reportBrowserExtensionErrors: boolean;
8
+ reportingUrl: string;
9
+ debug: boolean;
10
+ beforeEvaluate: (error: Error) => Error | false | null | Promise<Error | false | null>;
11
+ beforeSubmit: (report: Report) => Report | false | null | Promise<Report | false | null>;
12
+ };
13
+ type Report = {
14
+ notifier: string;
15
+ exception_class: string;
16
+ seen_at: number;
17
+ message: string;
18
+ language: 'javascript';
19
+ glows: Glow[];
20
+ context: Context;
21
+ stacktrace: StackFrame[];
22
+ sourcemap_version_id: string;
23
+ solutions: Solution[];
24
+ stage?: string;
25
+ };
26
+ interface SolutionProviderExtraParameters {
27
+ }
28
+ type SolutionProvider = {
29
+ canSolve: (error: Error, extraParameters?: SolutionProviderExtraParameters) => boolean | Promise<boolean>;
30
+ getSolutions: (error: Error, extraParameters?: SolutionProviderExtraParameters) => Solution[] | Promise<Solution[]>;
31
+ };
32
+ type Solution = {
33
+ class: string;
34
+ title: string;
35
+ description: string;
36
+ links: {
37
+ [label: string]: string;
29
38
  };
30
- type Solution = {
31
- class: string;
32
- title: string;
33
- description: string;
34
- links: {
35
- [label: string]: string;
36
- };
37
- action_description?: string;
38
- is_runnable?: boolean;
39
+ action_description?: string;
40
+ is_runnable?: boolean;
41
+ };
42
+ type Context = {
43
+ request?: {
44
+ url?: String;
45
+ useragent?: String;
46
+ referrer?: String;
47
+ readyState?: String;
39
48
  };
40
- type Context = {
41
- request?: {
42
- url?: String;
43
- useragent?: String;
44
- referrer?: String;
45
- readyState?: String;
46
- };
47
- request_data?: {
48
- queryString: {
49
- [key: string]: string;
50
- };
51
- };
52
- cookies?: {
49
+ request_data?: {
50
+ queryString: {
53
51
  [key: string]: string;
54
52
  };
55
- [key: string]: any;
56
53
  };
57
- type StackFrame = {
58
- line_number: number;
59
- column_number: number;
60
- method: string;
61
- file: string;
62
- code_snippet: {
63
- [key: number]: string;
64
- };
65
- trimmed_column_number: number | null;
66
- class: string;
54
+ cookies?: {
55
+ [key: string]: string;
67
56
  };
68
- type Glow = {
69
- time: number;
70
- microtime: number;
71
- name: String;
72
- message_level: MessageLevel;
73
- meta_data: Array<Object>;
57
+ [key: string]: any;
58
+ };
59
+ type StackFrame = {
60
+ line_number: number;
61
+ column_number: number;
62
+ method: string;
63
+ file: string;
64
+ code_snippet: {
65
+ [key: number]: string;
74
66
  };
75
- type MessageLevel = 'info' | 'debug' | 'warning' | 'error' | 'critical';
76
- }
67
+ trimmed_column_number: number | null;
68
+ class: string;
69
+ };
70
+ type Glow = {
71
+ time: number;
72
+ microtime: number;
73
+ name: String;
74
+ message_level: MessageLevel;
75
+ meta_data: object | object[];
76
+ };
77
+ type MessageLevel = 'info' | 'debug' | 'warning' | 'error' | 'critical';
77
78
 
78
- declare class FlareClient {
79
- version: string;
80
- config: Flare.Config;
81
- private glows;
82
- private context;
83
- beforeEvaluate: Flare.BeforeEvaluate;
84
- beforeSubmit: Flare.BeforeSubmit;
85
- private reportedErrorsTimestamps;
86
- private solutionProviders;
87
- private sourcemapVersion;
88
- debug: boolean;
89
- stage: string | undefined;
90
- light(key?: string, debug?: boolean): FlareClient;
91
- glow(name: string, level?: Flare.MessageLevel, metaData?: Array<object>): FlareClient;
92
- addContext(name: string, value: any): FlareClient;
93
- addContextGroup(groupName: string, value: object): FlareClient;
94
- registerSolutionProvider(provider: Flare.SolutionProvider): FlareClient;
95
- reportMessage(message: string, context?: Flare.Context, exceptionClass?: string): void;
96
- report(error: Error, context?: Flare.Context, extraSolutionParameters?: Flare.SolutionProviderExtraParameters): void;
97
- createReport(error: Error, context?: Flare.Context, extraSolutionParameters?: Flare.SolutionProviderExtraParameters): Promise<Flare.ErrorReport | false>;
98
- private sendReport;
99
- private maxReportsPerMinuteReached;
100
- test(): FlareClient;
79
+ declare class Api {
80
+ report(report: Report, url: string, key: string | null, reportBrowserExtensionErrors: boolean): Promise<void>;
101
81
  }
102
82
 
103
- type CodeSnippet = {
104
- [key: number]: string;
105
- };
106
- type ReaderResponse = {
107
- codeSnippet: CodeSnippet;
108
- trimmedColumnNumber: number | null;
109
- };
110
- declare function readLinesFromFile(fileText: string, lineNumber: number, columnNumber?: number, maxSnippetLineLength?: number, maxSnippetLines?: number): ReaderResponse;
83
+ declare class Flare {
84
+ api: Api;
85
+ config: Config;
86
+ glows: Glow[];
87
+ context: Context;
88
+ solutionProviders: SolutionProvider[];
89
+ constructor(api?: Api);
90
+ light(key?: string, debug?: boolean): Flare;
91
+ configure(config: Partial<Config>): Flare;
92
+ test(): Promise<void>;
93
+ glow(name: string, level?: MessageLevel, data?: object | object[]): Flare;
94
+ clearGlows(): Flare;
95
+ addContext(name: string, value: any): Flare;
96
+ addContextGroup(groupName: string, value: object): Flare;
97
+ registerSolutionProvider(solutionProvider: SolutionProvider): Flare;
98
+ report(error: Error, context?: Context, extraSolutionParameters?: SolutionProviderExtraParameters): Promise<void>;
99
+ reportMessage(message: string, context?: Context, exceptionClass?: string): Promise<void>;
100
+ createReportFromError(error: Error, context?: Context, extraSolutionParameters?: SolutionProviderExtraParameters): Promise<Report | false>;
101
+ sendReport(report: Report): Promise<void>;
102
+ set beforeEvaluate(beforeEvaluate: Config['beforeEvaluate']);
103
+ set beforeSubmit(beforeSubmit: Config['beforeSubmit']);
104
+ set stage(stage: string | undefined);
105
+ }
111
106
 
112
- declare const flare: FlareClient;
107
+ declare const flare: Flare;
113
108
 
114
- export { flare, readLinesFromFile };
109
+ export { Flare, flare };
package/dist/index.d.ts CHANGED
@@ -1,114 +1,109 @@
1
- declare namespace Flare {
2
- type BeforeEvaluate = (error: Error) => Error | false | Promise<Error | false>;
3
- type BeforeSubmit = (report: ErrorReport) => ErrorReport | false | Promise<ErrorReport | false>;
4
- type Config = {
5
- key: string;
6
- reportingUrl: string;
7
- maxGlowsPerReport: number;
8
- maxReportsPerMinute: number;
9
- stage?: string;
10
- };
11
- type ErrorReport = {
12
- notifier: string;
13
- exception_class: string;
14
- seen_at: number;
15
- message: string;
16
- language: 'javascript';
17
- glows: Array<Flare.Glow>;
18
- context: Flare.Context;
19
- stacktrace: Array<Flare.StackFrame>;
20
- sourcemap_version_id: string;
21
- solutions: Array<Flare.Solution>;
22
- stage?: string;
23
- };
24
- interface SolutionProviderExtraParameters {
25
- }
26
- type SolutionProvider = {
27
- canSolve: (error: Error, extraParameters?: SolutionProviderExtraParameters) => boolean | Promise<boolean>;
28
- getSolutions: (error: Error, extraParameters?: SolutionProviderExtraParameters) => Array<Flare.Solution> | Promise<Array<Flare.Solution>>;
1
+ type Config = {
2
+ key: string | null;
3
+ version: string;
4
+ sourcemapVersion: string;
5
+ stage: string;
6
+ maxGlowsPerReport: number;
7
+ reportBrowserExtensionErrors: boolean;
8
+ reportingUrl: string;
9
+ debug: boolean;
10
+ beforeEvaluate: (error: Error) => Error | false | null | Promise<Error | false | null>;
11
+ beforeSubmit: (report: Report) => Report | false | null | Promise<Report | false | null>;
12
+ };
13
+ type Report = {
14
+ notifier: string;
15
+ exception_class: string;
16
+ seen_at: number;
17
+ message: string;
18
+ language: 'javascript';
19
+ glows: Glow[];
20
+ context: Context;
21
+ stacktrace: StackFrame[];
22
+ sourcemap_version_id: string;
23
+ solutions: Solution[];
24
+ stage?: string;
25
+ };
26
+ interface SolutionProviderExtraParameters {
27
+ }
28
+ type SolutionProvider = {
29
+ canSolve: (error: Error, extraParameters?: SolutionProviderExtraParameters) => boolean | Promise<boolean>;
30
+ getSolutions: (error: Error, extraParameters?: SolutionProviderExtraParameters) => Solution[] | Promise<Solution[]>;
31
+ };
32
+ type Solution = {
33
+ class: string;
34
+ title: string;
35
+ description: string;
36
+ links: {
37
+ [label: string]: string;
29
38
  };
30
- type Solution = {
31
- class: string;
32
- title: string;
33
- description: string;
34
- links: {
35
- [label: string]: string;
36
- };
37
- action_description?: string;
38
- is_runnable?: boolean;
39
+ action_description?: string;
40
+ is_runnable?: boolean;
41
+ };
42
+ type Context = {
43
+ request?: {
44
+ url?: String;
45
+ useragent?: String;
46
+ referrer?: String;
47
+ readyState?: String;
39
48
  };
40
- type Context = {
41
- request?: {
42
- url?: String;
43
- useragent?: String;
44
- referrer?: String;
45
- readyState?: String;
46
- };
47
- request_data?: {
48
- queryString: {
49
- [key: string]: string;
50
- };
51
- };
52
- cookies?: {
49
+ request_data?: {
50
+ queryString: {
53
51
  [key: string]: string;
54
52
  };
55
- [key: string]: any;
56
53
  };
57
- type StackFrame = {
58
- line_number: number;
59
- column_number: number;
60
- method: string;
61
- file: string;
62
- code_snippet: {
63
- [key: number]: string;
64
- };
65
- trimmed_column_number: number | null;
66
- class: string;
54
+ cookies?: {
55
+ [key: string]: string;
67
56
  };
68
- type Glow = {
69
- time: number;
70
- microtime: number;
71
- name: String;
72
- message_level: MessageLevel;
73
- meta_data: Array<Object>;
57
+ [key: string]: any;
58
+ };
59
+ type StackFrame = {
60
+ line_number: number;
61
+ column_number: number;
62
+ method: string;
63
+ file: string;
64
+ code_snippet: {
65
+ [key: number]: string;
74
66
  };
75
- type MessageLevel = 'info' | 'debug' | 'warning' | 'error' | 'critical';
76
- }
67
+ trimmed_column_number: number | null;
68
+ class: string;
69
+ };
70
+ type Glow = {
71
+ time: number;
72
+ microtime: number;
73
+ name: String;
74
+ message_level: MessageLevel;
75
+ meta_data: object | object[];
76
+ };
77
+ type MessageLevel = 'info' | 'debug' | 'warning' | 'error' | 'critical';
77
78
 
78
- declare class FlareClient {
79
- version: string;
80
- config: Flare.Config;
81
- private glows;
82
- private context;
83
- beforeEvaluate: Flare.BeforeEvaluate;
84
- beforeSubmit: Flare.BeforeSubmit;
85
- private reportedErrorsTimestamps;
86
- private solutionProviders;
87
- private sourcemapVersion;
88
- debug: boolean;
89
- stage: string | undefined;
90
- light(key?: string, debug?: boolean): FlareClient;
91
- glow(name: string, level?: Flare.MessageLevel, metaData?: Array<object>): FlareClient;
92
- addContext(name: string, value: any): FlareClient;
93
- addContextGroup(groupName: string, value: object): FlareClient;
94
- registerSolutionProvider(provider: Flare.SolutionProvider): FlareClient;
95
- reportMessage(message: string, context?: Flare.Context, exceptionClass?: string): void;
96
- report(error: Error, context?: Flare.Context, extraSolutionParameters?: Flare.SolutionProviderExtraParameters): void;
97
- createReport(error: Error, context?: Flare.Context, extraSolutionParameters?: Flare.SolutionProviderExtraParameters): Promise<Flare.ErrorReport | false>;
98
- private sendReport;
99
- private maxReportsPerMinuteReached;
100
- test(): FlareClient;
79
+ declare class Api {
80
+ report(report: Report, url: string, key: string | null, reportBrowserExtensionErrors: boolean): Promise<void>;
101
81
  }
102
82
 
103
- type CodeSnippet = {
104
- [key: number]: string;
105
- };
106
- type ReaderResponse = {
107
- codeSnippet: CodeSnippet;
108
- trimmedColumnNumber: number | null;
109
- };
110
- declare function readLinesFromFile(fileText: string, lineNumber: number, columnNumber?: number, maxSnippetLineLength?: number, maxSnippetLines?: number): ReaderResponse;
83
+ declare class Flare {
84
+ api: Api;
85
+ config: Config;
86
+ glows: Glow[];
87
+ context: Context;
88
+ solutionProviders: SolutionProvider[];
89
+ constructor(api?: Api);
90
+ light(key?: string, debug?: boolean): Flare;
91
+ configure(config: Partial<Config>): Flare;
92
+ test(): Promise<void>;
93
+ glow(name: string, level?: MessageLevel, data?: object | object[]): Flare;
94
+ clearGlows(): Flare;
95
+ addContext(name: string, value: any): Flare;
96
+ addContextGroup(groupName: string, value: object): Flare;
97
+ registerSolutionProvider(solutionProvider: SolutionProvider): Flare;
98
+ report(error: Error, context?: Context, extraSolutionParameters?: SolutionProviderExtraParameters): Promise<void>;
99
+ reportMessage(message: string, context?: Context, exceptionClass?: string): Promise<void>;
100
+ createReportFromError(error: Error, context?: Context, extraSolutionParameters?: SolutionProviderExtraParameters): Promise<Report | false>;
101
+ sendReport(report: Report): Promise<void>;
102
+ set beforeEvaluate(beforeEvaluate: Config['beforeEvaluate']);
103
+ set beforeSubmit(beforeSubmit: Config['beforeSubmit']);
104
+ set stage(stage: string | undefined);
105
+ }
111
106
 
112
- declare const flare: FlareClient;
107
+ declare const flare: Flare;
113
108
 
114
- export { flare, readLinesFromFile };
109
+ export { Flare, flare };