@merittdev/horus-lens 0.2.0 → 0.3.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.
- package/dist/browser.cjs +99 -2
- package/dist/browser.cjs.map +1 -1
- package/dist/browser.d.cts +2 -2
- package/dist/browser.d.ts +2 -2
- package/dist/browser.js +2 -2
- package/dist/{chunk-JXSK4JG4.js → chunk-LIYEDZV7.js} +99 -2
- package/dist/chunk-LIYEDZV7.js.map +1 -0
- package/dist/{chunk-UT7E5LCG.js → chunk-PNY6BL4C.js} +4 -3
- package/dist/{chunk-UT7E5LCG.js.map → chunk-PNY6BL4C.js.map} +1 -1
- package/dist/index.cjs +99 -1
- package/dist/index.cjs.map +1 -1
- package/dist/{index.d-QzZn4EMM.d.cts → index.d-BYG_Mjs-.d.cts} +31 -1
- package/dist/{index.d-Cyvb07sp.d.cts → index.d-DTx4C384.d.cts} +18 -1
- package/dist/{index.d-Cyvb07sp.d.ts → index.d-DTx4C384.d.ts} +18 -1
- package/dist/{index.d-BtnbCqUx.d.ts → index.d-Dyzc1E9T.d.ts} +31 -1
- package/dist/index.d.cts +60 -3
- package/dist/index.d.ts +60 -3
- package/dist/index.js +3 -1
- package/dist/lens.min.js +24 -24
- package/dist/lens.min.js.map +1 -1
- package/dist/react.cjs +100 -3
- package/dist/react.cjs.map +1 -1
- package/dist/react.d.cts +2 -2
- package/dist/react.d.ts +2 -2
- package/dist/react.js +3 -3
- package/dist/react.js.map +1 -1
- package/package.json +4 -3
- package/dist/chunk-JXSK4JG4.js.map +0 -1
|
@@ -1,4 +1,22 @@
|
|
|
1
|
-
import { A as AppContext, R as ReportMetadata, T as TargetElement, a as Annotation } from './index.d-
|
|
1
|
+
import { A as AppContext, R as ReportMetadata, T as TargetElement, a as Annotation, b as ReportTrigger } from './index.d-DTx4C384.cjs';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Opt-in automatic error capture. When enabled, unhandled errors and promise
|
|
5
|
+
* rejections submit a report by themselves, carrying the same rolling
|
|
6
|
+
* replay/console/network context the overlay would. Screenshots are never
|
|
7
|
+
* captured (no user intent, and a raster is a poor fit for a background report).
|
|
8
|
+
*/
|
|
9
|
+
interface AutoCaptureErrorOptions {
|
|
10
|
+
/** Master switch. Auto-capture is DISABLED unless this is `true`. */
|
|
11
|
+
errors?: boolean;
|
|
12
|
+
/** Fraction of eligible errors to report, 0..1. Default `1` (all). */
|
|
13
|
+
sampleRate?: number;
|
|
14
|
+
/**
|
|
15
|
+
* Raw error messages matching any entry are skipped. Strings match by
|
|
16
|
+
* substring (`message.includes`), RegExps by `.test`.
|
|
17
|
+
*/
|
|
18
|
+
ignore?: (string | RegExp)[];
|
|
19
|
+
}
|
|
2
20
|
|
|
3
21
|
/** A sub-region to crop to, in DOCUMENT CSS pixels (same units as the DOM). */
|
|
4
22
|
interface ScreenshotCrop {
|
|
@@ -39,6 +57,12 @@ interface LensConfig {
|
|
|
39
57
|
beforeSend?: (metadata: ReportMetadata) => ReportMetadata | null;
|
|
40
58
|
/** Capture a page screenshot on submit (best-effort). Default `true`. */
|
|
41
59
|
screenshot?: boolean;
|
|
60
|
+
/**
|
|
61
|
+
* Opt-in automatic capture. DISABLED by default; set `autoCapture.errors`
|
|
62
|
+
* to `true` to have unhandled errors submit a report by themselves with the
|
|
63
|
+
* rolling replay/console/network context (no screenshot, no user intent).
|
|
64
|
+
*/
|
|
65
|
+
autoCapture?: AutoCaptureErrorOptions;
|
|
42
66
|
debug?: boolean;
|
|
43
67
|
}
|
|
44
68
|
/**
|
|
@@ -78,6 +102,11 @@ interface SubmitReportInput {
|
|
|
78
102
|
annotationComposite?: AnnotationComposite;
|
|
79
103
|
/** Selective data opt-outs; each flag defaults to `true`. */
|
|
80
104
|
include?: SubmitReportIncludes;
|
|
105
|
+
/**
|
|
106
|
+
* What caused this submit. Defaults to `'user'` (overlay submit). Programmatic
|
|
107
|
+
* callers may pass `'api'`; the auto-capture engine passes `'error'`.
|
|
108
|
+
*/
|
|
109
|
+
trigger?: ReportTrigger;
|
|
81
110
|
}
|
|
82
111
|
declare class LensClient {
|
|
83
112
|
private readonly accessId;
|
|
@@ -85,6 +114,7 @@ declare class LensClient {
|
|
|
85
114
|
private readonly replayWindowMs;
|
|
86
115
|
private readonly debug;
|
|
87
116
|
private readonly screenshotEnabled;
|
|
117
|
+
private readonly autoCapture?;
|
|
88
118
|
private readonly beforeSend?;
|
|
89
119
|
private app;
|
|
90
120
|
private readonly consoleBuffer;
|
|
@@ -114,6 +114,18 @@ declare const AnnotationSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
114
114
|
strokeWidth: z.ZodOptional<z.ZodNumber>;
|
|
115
115
|
}, z.core.$strip>], "kind">;
|
|
116
116
|
type Annotation = z.infer<typeof AnnotationSchema>;
|
|
117
|
+
/**
|
|
118
|
+
* What caused the report to be submitted:
|
|
119
|
+
* - `user` — an explicit submit from the overlay UI.
|
|
120
|
+
* - `api` — a programmatic `useLens().report()` / `client.submitReport()`.
|
|
121
|
+
* - `error` — an unhandled error auto-captured by the SDK (no user intent).
|
|
122
|
+
*/
|
|
123
|
+
declare const ReportTriggerSchema: z.ZodEnum<{
|
|
124
|
+
error: "error";
|
|
125
|
+
user: "user";
|
|
126
|
+
api: "api";
|
|
127
|
+
}>;
|
|
128
|
+
type ReportTrigger = z.infer<typeof ReportTriggerSchema>;
|
|
117
129
|
declare const ReportMetadataSchema: z.ZodObject<{
|
|
118
130
|
comment: z.ZodOptional<z.ZodString>;
|
|
119
131
|
annotations: z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
@@ -291,6 +303,11 @@ declare const ReportMetadataSchema: z.ZodObject<{
|
|
|
291
303
|
startedAt: z.ZodNumber;
|
|
292
304
|
error: z.ZodOptional<z.ZodString>;
|
|
293
305
|
}, z.core.$strip>>>;
|
|
306
|
+
trigger: z.ZodOptional<z.ZodEnum<{
|
|
307
|
+
error: "error";
|
|
308
|
+
user: "user";
|
|
309
|
+
api: "api";
|
|
310
|
+
}>>;
|
|
294
311
|
sdk: z.ZodObject<{
|
|
295
312
|
name: z.ZodString;
|
|
296
313
|
version: z.ZodString;
|
|
@@ -298,4 +315,4 @@ declare const ReportMetadataSchema: z.ZodObject<{
|
|
|
298
315
|
}, z.core.$strip>;
|
|
299
316
|
type ReportMetadata = z.infer<typeof ReportMetadataSchema>;
|
|
300
317
|
|
|
301
|
-
export type { AppContext as A, ReportMetadata as R, TargetElement as T, Annotation as a };
|
|
318
|
+
export type { AppContext as A, ReportMetadata as R, TargetElement as T, Annotation as a, ReportTrigger as b };
|
|
@@ -114,6 +114,18 @@ declare const AnnotationSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
|
114
114
|
strokeWidth: z.ZodOptional<z.ZodNumber>;
|
|
115
115
|
}, z.core.$strip>], "kind">;
|
|
116
116
|
type Annotation = z.infer<typeof AnnotationSchema>;
|
|
117
|
+
/**
|
|
118
|
+
* What caused the report to be submitted:
|
|
119
|
+
* - `user` — an explicit submit from the overlay UI.
|
|
120
|
+
* - `api` — a programmatic `useLens().report()` / `client.submitReport()`.
|
|
121
|
+
* - `error` — an unhandled error auto-captured by the SDK (no user intent).
|
|
122
|
+
*/
|
|
123
|
+
declare const ReportTriggerSchema: z.ZodEnum<{
|
|
124
|
+
error: "error";
|
|
125
|
+
user: "user";
|
|
126
|
+
api: "api";
|
|
127
|
+
}>;
|
|
128
|
+
type ReportTrigger = z.infer<typeof ReportTriggerSchema>;
|
|
117
129
|
declare const ReportMetadataSchema: z.ZodObject<{
|
|
118
130
|
comment: z.ZodOptional<z.ZodString>;
|
|
119
131
|
annotations: z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
@@ -291,6 +303,11 @@ declare const ReportMetadataSchema: z.ZodObject<{
|
|
|
291
303
|
startedAt: z.ZodNumber;
|
|
292
304
|
error: z.ZodOptional<z.ZodString>;
|
|
293
305
|
}, z.core.$strip>>>;
|
|
306
|
+
trigger: z.ZodOptional<z.ZodEnum<{
|
|
307
|
+
error: "error";
|
|
308
|
+
user: "user";
|
|
309
|
+
api: "api";
|
|
310
|
+
}>>;
|
|
294
311
|
sdk: z.ZodObject<{
|
|
295
312
|
name: z.ZodString;
|
|
296
313
|
version: z.ZodString;
|
|
@@ -298,4 +315,4 @@ declare const ReportMetadataSchema: z.ZodObject<{
|
|
|
298
315
|
}, z.core.$strip>;
|
|
299
316
|
type ReportMetadata = z.infer<typeof ReportMetadataSchema>;
|
|
300
317
|
|
|
301
|
-
export type { AppContext as A, ReportMetadata as R, TargetElement as T, Annotation as a };
|
|
318
|
+
export type { AppContext as A, ReportMetadata as R, TargetElement as T, Annotation as a, ReportTrigger as b };
|
|
@@ -1,4 +1,22 @@
|
|
|
1
|
-
import { A as AppContext, R as ReportMetadata, T as TargetElement, a as Annotation } from './index.d-
|
|
1
|
+
import { A as AppContext, R as ReportMetadata, T as TargetElement, a as Annotation, b as ReportTrigger } from './index.d-DTx4C384.js';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Opt-in automatic error capture. When enabled, unhandled errors and promise
|
|
5
|
+
* rejections submit a report by themselves, carrying the same rolling
|
|
6
|
+
* replay/console/network context the overlay would. Screenshots are never
|
|
7
|
+
* captured (no user intent, and a raster is a poor fit for a background report).
|
|
8
|
+
*/
|
|
9
|
+
interface AutoCaptureErrorOptions {
|
|
10
|
+
/** Master switch. Auto-capture is DISABLED unless this is `true`. */
|
|
11
|
+
errors?: boolean;
|
|
12
|
+
/** Fraction of eligible errors to report, 0..1. Default `1` (all). */
|
|
13
|
+
sampleRate?: number;
|
|
14
|
+
/**
|
|
15
|
+
* Raw error messages matching any entry are skipped. Strings match by
|
|
16
|
+
* substring (`message.includes`), RegExps by `.test`.
|
|
17
|
+
*/
|
|
18
|
+
ignore?: (string | RegExp)[];
|
|
19
|
+
}
|
|
2
20
|
|
|
3
21
|
/** A sub-region to crop to, in DOCUMENT CSS pixels (same units as the DOM). */
|
|
4
22
|
interface ScreenshotCrop {
|
|
@@ -39,6 +57,12 @@ interface LensConfig {
|
|
|
39
57
|
beforeSend?: (metadata: ReportMetadata) => ReportMetadata | null;
|
|
40
58
|
/** Capture a page screenshot on submit (best-effort). Default `true`. */
|
|
41
59
|
screenshot?: boolean;
|
|
60
|
+
/**
|
|
61
|
+
* Opt-in automatic capture. DISABLED by default; set `autoCapture.errors`
|
|
62
|
+
* to `true` to have unhandled errors submit a report by themselves with the
|
|
63
|
+
* rolling replay/console/network context (no screenshot, no user intent).
|
|
64
|
+
*/
|
|
65
|
+
autoCapture?: AutoCaptureErrorOptions;
|
|
42
66
|
debug?: boolean;
|
|
43
67
|
}
|
|
44
68
|
/**
|
|
@@ -78,6 +102,11 @@ interface SubmitReportInput {
|
|
|
78
102
|
annotationComposite?: AnnotationComposite;
|
|
79
103
|
/** Selective data opt-outs; each flag defaults to `true`. */
|
|
80
104
|
include?: SubmitReportIncludes;
|
|
105
|
+
/**
|
|
106
|
+
* What caused this submit. Defaults to `'user'` (overlay submit). Programmatic
|
|
107
|
+
* callers may pass `'api'`; the auto-capture engine passes `'error'`.
|
|
108
|
+
*/
|
|
109
|
+
trigger?: ReportTrigger;
|
|
81
110
|
}
|
|
82
111
|
declare class LensClient {
|
|
83
112
|
private readonly accessId;
|
|
@@ -85,6 +114,7 @@ declare class LensClient {
|
|
|
85
114
|
private readonly replayWindowMs;
|
|
86
115
|
private readonly debug;
|
|
87
116
|
private readonly screenshotEnabled;
|
|
117
|
+
private readonly autoCapture?;
|
|
88
118
|
private readonly beforeSend?;
|
|
89
119
|
private app;
|
|
90
120
|
private readonly consoleBuffer;
|
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { A as AppContext$1, R as ReportMetadata$1, T as TargetElement$1, a as Annotation$1 } from './index.d-
|
|
2
|
+
import { A as AppContext$1, R as ReportMetadata$1, T as TargetElement$1, a as Annotation$1, b as ReportTrigger$1 } from './index.d-DTx4C384.cjs';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* Key model (mirrors Stripe/GTM):
|
|
@@ -241,6 +241,18 @@ declare const ReportStatusSchema: z.ZodEnum<{
|
|
|
241
241
|
resolved: "resolved";
|
|
242
242
|
}>;
|
|
243
243
|
type ReportStatus = z.infer<typeof ReportStatusSchema>;
|
|
244
|
+
/**
|
|
245
|
+
* What caused the report to be submitted:
|
|
246
|
+
* - `user` — an explicit submit from the overlay UI.
|
|
247
|
+
* - `api` — a programmatic `useLens().report()` / `client.submitReport()`.
|
|
248
|
+
* - `error` — an unhandled error auto-captured by the SDK (no user intent).
|
|
249
|
+
*/
|
|
250
|
+
declare const ReportTriggerSchema: z.ZodEnum<{
|
|
251
|
+
error: "error";
|
|
252
|
+
user: "user";
|
|
253
|
+
api: "api";
|
|
254
|
+
}>;
|
|
255
|
+
type ReportTrigger = z.infer<typeof ReportTriggerSchema>;
|
|
244
256
|
declare const ReportMetadataSchema: z.ZodObject<{
|
|
245
257
|
comment: z.ZodOptional<z.ZodString>;
|
|
246
258
|
annotations: z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
@@ -418,6 +430,11 @@ declare const ReportMetadataSchema: z.ZodObject<{
|
|
|
418
430
|
startedAt: z.ZodNumber;
|
|
419
431
|
error: z.ZodOptional<z.ZodString>;
|
|
420
432
|
}, z.core.$strip>>>;
|
|
433
|
+
trigger: z.ZodOptional<z.ZodEnum<{
|
|
434
|
+
error: "error";
|
|
435
|
+
user: "user";
|
|
436
|
+
api: "api";
|
|
437
|
+
}>>;
|
|
421
438
|
sdk: z.ZodObject<{
|
|
422
439
|
name: z.ZodString;
|
|
423
440
|
version: z.ZodString;
|
|
@@ -613,6 +630,11 @@ declare const ReportSchema: z.ZodObject<{
|
|
|
613
630
|
startedAt: z.ZodNumber;
|
|
614
631
|
error: z.ZodOptional<z.ZodString>;
|
|
615
632
|
}, z.core.$strip>>>;
|
|
633
|
+
trigger: z.ZodOptional<z.ZodEnum<{
|
|
634
|
+
error: "error";
|
|
635
|
+
user: "user";
|
|
636
|
+
api: "api";
|
|
637
|
+
}>>;
|
|
616
638
|
sdk: z.ZodObject<{
|
|
617
639
|
name: z.ZodString;
|
|
618
640
|
version: z.ZodString;
|
|
@@ -881,6 +903,11 @@ declare const FinalizeReportRequestSchema: z.ZodObject<{
|
|
|
881
903
|
startedAt: z.ZodNumber;
|
|
882
904
|
error: z.ZodOptional<z.ZodString>;
|
|
883
905
|
}, z.core.$strip>>>;
|
|
906
|
+
trigger: z.ZodOptional<z.ZodEnum<{
|
|
907
|
+
error: "error";
|
|
908
|
+
user: "user";
|
|
909
|
+
api: "api";
|
|
910
|
+
}>>;
|
|
884
911
|
sdk: z.ZodObject<{
|
|
885
912
|
name: z.ZodString;
|
|
886
913
|
version: z.ZodString;
|
|
@@ -940,7 +967,25 @@ declare const ApiErrorSchema: z.ZodObject<{
|
|
|
940
967
|
type ApiError = z.infer<typeof ApiErrorSchema>;
|
|
941
968
|
|
|
942
969
|
declare const SDK_NAME = "@merittdev/horus-lens";
|
|
943
|
-
declare const SDK_VERSION
|
|
970
|
+
declare const SDK_VERSION: string;
|
|
971
|
+
|
|
972
|
+
/**
|
|
973
|
+
* Opt-in automatic error capture. When enabled, unhandled errors and promise
|
|
974
|
+
* rejections submit a report by themselves, carrying the same rolling
|
|
975
|
+
* replay/console/network context the overlay would. Screenshots are never
|
|
976
|
+
* captured (no user intent, and a raster is a poor fit for a background report).
|
|
977
|
+
*/
|
|
978
|
+
interface AutoCaptureErrorOptions {
|
|
979
|
+
/** Master switch. Auto-capture is DISABLED unless this is `true`. */
|
|
980
|
+
errors?: boolean;
|
|
981
|
+
/** Fraction of eligible errors to report, 0..1. Default `1` (all). */
|
|
982
|
+
sampleRate?: number;
|
|
983
|
+
/**
|
|
984
|
+
* Raw error messages matching any entry are skipped. Strings match by
|
|
985
|
+
* substring (`message.includes`), RegExps by `.test`.
|
|
986
|
+
*/
|
|
987
|
+
ignore?: (string | RegExp)[];
|
|
988
|
+
}
|
|
944
989
|
|
|
945
990
|
/** A sub-region to crop to, in DOCUMENT CSS pixels (same units as the DOM). */
|
|
946
991
|
interface ScreenshotCrop {
|
|
@@ -981,6 +1026,12 @@ interface LensConfig {
|
|
|
981
1026
|
beforeSend?: (metadata: ReportMetadata$1) => ReportMetadata$1 | null;
|
|
982
1027
|
/** Capture a page screenshot on submit (best-effort). Default `true`. */
|
|
983
1028
|
screenshot?: boolean;
|
|
1029
|
+
/**
|
|
1030
|
+
* Opt-in automatic capture. DISABLED by default; set `autoCapture.errors`
|
|
1031
|
+
* to `true` to have unhandled errors submit a report by themselves with the
|
|
1032
|
+
* rolling replay/console/network context (no screenshot, no user intent).
|
|
1033
|
+
*/
|
|
1034
|
+
autoCapture?: AutoCaptureErrorOptions;
|
|
984
1035
|
debug?: boolean;
|
|
985
1036
|
}
|
|
986
1037
|
/**
|
|
@@ -1020,6 +1071,11 @@ interface SubmitReportInput {
|
|
|
1020
1071
|
annotationComposite?: AnnotationComposite;
|
|
1021
1072
|
/** Selective data opt-outs; each flag defaults to `true`. */
|
|
1022
1073
|
include?: SubmitReportIncludes;
|
|
1074
|
+
/**
|
|
1075
|
+
* What caused this submit. Defaults to `'user'` (overlay submit). Programmatic
|
|
1076
|
+
* callers may pass `'api'`; the auto-capture engine passes `'error'`.
|
|
1077
|
+
*/
|
|
1078
|
+
trigger?: ReportTrigger$1;
|
|
1023
1079
|
}
|
|
1024
1080
|
declare class LensClient {
|
|
1025
1081
|
private readonly accessId;
|
|
@@ -1027,6 +1083,7 @@ declare class LensClient {
|
|
|
1027
1083
|
private readonly replayWindowMs;
|
|
1028
1084
|
private readonly debug;
|
|
1029
1085
|
private readonly screenshotEnabled;
|
|
1086
|
+
private readonly autoCapture?;
|
|
1030
1087
|
private readonly beforeSend?;
|
|
1031
1088
|
private app;
|
|
1032
1089
|
private readonly consoleBuffer;
|
|
@@ -1057,4 +1114,4 @@ declare class LensClient {
|
|
|
1057
1114
|
private warn;
|
|
1058
1115
|
}
|
|
1059
1116
|
|
|
1060
|
-
export { ACCESS_ID_PREFIX, ACCESS_SECRET_PREFIX, type Annotation, AnnotationSchema, type ApiError, ApiErrorSchema, type AppContext, AppContextSchema, type AssetKind, AssetKindSchema, type AssetRef, AssetRefSchema, type AttachAssetRequest, AttachAssetRequestSchema, type ConsoleEntry, ConsoleEntrySchema, type ConsoleLevel, ConsoleLevelSchema, type EnvContext, EnvContextSchema, type ErrorEntry, ErrorEntrySchema, type FinalizeReportRequest, FinalizeReportRequestSchema, type FinalizeReportResponse, FinalizeReportResponseSchema, type InitiateReportRequest, InitiateReportRequestSchema, type InitiateReportResponse, InitiateReportResponseSchema, LensClient, type LensConfig, type ListReportsQuery, ListReportsQuerySchema, type NetworkEntry, NetworkEntrySchema, type Report, type ReportMetadata, ReportMetadataSchema, ReportSchema, type ReportStatus, ReportStatusSchema, type ReportSummary, ReportSummarySchema, SDK_NAME, SDK_VERSION, type TargetElement, TargetElementSchema, isAccessId, isAccessSecret };
|
|
1117
|
+
export { ACCESS_ID_PREFIX, ACCESS_SECRET_PREFIX, type Annotation, AnnotationSchema, type ApiError, ApiErrorSchema, type AppContext, AppContextSchema, type AssetKind, AssetKindSchema, type AssetRef, AssetRefSchema, type AttachAssetRequest, AttachAssetRequestSchema, type ConsoleEntry, ConsoleEntrySchema, type ConsoleLevel, ConsoleLevelSchema, type EnvContext, EnvContextSchema, type ErrorEntry, ErrorEntrySchema, type FinalizeReportRequest, FinalizeReportRequestSchema, type FinalizeReportResponse, FinalizeReportResponseSchema, type InitiateReportRequest, InitiateReportRequestSchema, type InitiateReportResponse, InitiateReportResponseSchema, LensClient, type LensConfig, type ListReportsQuery, ListReportsQuerySchema, type NetworkEntry, NetworkEntrySchema, type Report, type ReportMetadata, ReportMetadataSchema, ReportSchema, type ReportStatus, ReportStatusSchema, type ReportSummary, ReportSummarySchema, type ReportTrigger, ReportTriggerSchema, SDK_NAME, SDK_VERSION, type TargetElement, TargetElementSchema, isAccessId, isAccessSecret };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { A as AppContext$1, R as ReportMetadata$1, T as TargetElement$1, a as Annotation$1 } from './index.d-
|
|
2
|
+
import { A as AppContext$1, R as ReportMetadata$1, T as TargetElement$1, a as Annotation$1, b as ReportTrigger$1 } from './index.d-DTx4C384.js';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* Key model (mirrors Stripe/GTM):
|
|
@@ -241,6 +241,18 @@ declare const ReportStatusSchema: z.ZodEnum<{
|
|
|
241
241
|
resolved: "resolved";
|
|
242
242
|
}>;
|
|
243
243
|
type ReportStatus = z.infer<typeof ReportStatusSchema>;
|
|
244
|
+
/**
|
|
245
|
+
* What caused the report to be submitted:
|
|
246
|
+
* - `user` — an explicit submit from the overlay UI.
|
|
247
|
+
* - `api` — a programmatic `useLens().report()` / `client.submitReport()`.
|
|
248
|
+
* - `error` — an unhandled error auto-captured by the SDK (no user intent).
|
|
249
|
+
*/
|
|
250
|
+
declare const ReportTriggerSchema: z.ZodEnum<{
|
|
251
|
+
error: "error";
|
|
252
|
+
user: "user";
|
|
253
|
+
api: "api";
|
|
254
|
+
}>;
|
|
255
|
+
type ReportTrigger = z.infer<typeof ReportTriggerSchema>;
|
|
244
256
|
declare const ReportMetadataSchema: z.ZodObject<{
|
|
245
257
|
comment: z.ZodOptional<z.ZodString>;
|
|
246
258
|
annotations: z.ZodDefault<z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
@@ -418,6 +430,11 @@ declare const ReportMetadataSchema: z.ZodObject<{
|
|
|
418
430
|
startedAt: z.ZodNumber;
|
|
419
431
|
error: z.ZodOptional<z.ZodString>;
|
|
420
432
|
}, z.core.$strip>>>;
|
|
433
|
+
trigger: z.ZodOptional<z.ZodEnum<{
|
|
434
|
+
error: "error";
|
|
435
|
+
user: "user";
|
|
436
|
+
api: "api";
|
|
437
|
+
}>>;
|
|
421
438
|
sdk: z.ZodObject<{
|
|
422
439
|
name: z.ZodString;
|
|
423
440
|
version: z.ZodString;
|
|
@@ -613,6 +630,11 @@ declare const ReportSchema: z.ZodObject<{
|
|
|
613
630
|
startedAt: z.ZodNumber;
|
|
614
631
|
error: z.ZodOptional<z.ZodString>;
|
|
615
632
|
}, z.core.$strip>>>;
|
|
633
|
+
trigger: z.ZodOptional<z.ZodEnum<{
|
|
634
|
+
error: "error";
|
|
635
|
+
user: "user";
|
|
636
|
+
api: "api";
|
|
637
|
+
}>>;
|
|
616
638
|
sdk: z.ZodObject<{
|
|
617
639
|
name: z.ZodString;
|
|
618
640
|
version: z.ZodString;
|
|
@@ -881,6 +903,11 @@ declare const FinalizeReportRequestSchema: z.ZodObject<{
|
|
|
881
903
|
startedAt: z.ZodNumber;
|
|
882
904
|
error: z.ZodOptional<z.ZodString>;
|
|
883
905
|
}, z.core.$strip>>>;
|
|
906
|
+
trigger: z.ZodOptional<z.ZodEnum<{
|
|
907
|
+
error: "error";
|
|
908
|
+
user: "user";
|
|
909
|
+
api: "api";
|
|
910
|
+
}>>;
|
|
884
911
|
sdk: z.ZodObject<{
|
|
885
912
|
name: z.ZodString;
|
|
886
913
|
version: z.ZodString;
|
|
@@ -940,7 +967,25 @@ declare const ApiErrorSchema: z.ZodObject<{
|
|
|
940
967
|
type ApiError = z.infer<typeof ApiErrorSchema>;
|
|
941
968
|
|
|
942
969
|
declare const SDK_NAME = "@merittdev/horus-lens";
|
|
943
|
-
declare const SDK_VERSION
|
|
970
|
+
declare const SDK_VERSION: string;
|
|
971
|
+
|
|
972
|
+
/**
|
|
973
|
+
* Opt-in automatic error capture. When enabled, unhandled errors and promise
|
|
974
|
+
* rejections submit a report by themselves, carrying the same rolling
|
|
975
|
+
* replay/console/network context the overlay would. Screenshots are never
|
|
976
|
+
* captured (no user intent, and a raster is a poor fit for a background report).
|
|
977
|
+
*/
|
|
978
|
+
interface AutoCaptureErrorOptions {
|
|
979
|
+
/** Master switch. Auto-capture is DISABLED unless this is `true`. */
|
|
980
|
+
errors?: boolean;
|
|
981
|
+
/** Fraction of eligible errors to report, 0..1. Default `1` (all). */
|
|
982
|
+
sampleRate?: number;
|
|
983
|
+
/**
|
|
984
|
+
* Raw error messages matching any entry are skipped. Strings match by
|
|
985
|
+
* substring (`message.includes`), RegExps by `.test`.
|
|
986
|
+
*/
|
|
987
|
+
ignore?: (string | RegExp)[];
|
|
988
|
+
}
|
|
944
989
|
|
|
945
990
|
/** A sub-region to crop to, in DOCUMENT CSS pixels (same units as the DOM). */
|
|
946
991
|
interface ScreenshotCrop {
|
|
@@ -981,6 +1026,12 @@ interface LensConfig {
|
|
|
981
1026
|
beforeSend?: (metadata: ReportMetadata$1) => ReportMetadata$1 | null;
|
|
982
1027
|
/** Capture a page screenshot on submit (best-effort). Default `true`. */
|
|
983
1028
|
screenshot?: boolean;
|
|
1029
|
+
/**
|
|
1030
|
+
* Opt-in automatic capture. DISABLED by default; set `autoCapture.errors`
|
|
1031
|
+
* to `true` to have unhandled errors submit a report by themselves with the
|
|
1032
|
+
* rolling replay/console/network context (no screenshot, no user intent).
|
|
1033
|
+
*/
|
|
1034
|
+
autoCapture?: AutoCaptureErrorOptions;
|
|
984
1035
|
debug?: boolean;
|
|
985
1036
|
}
|
|
986
1037
|
/**
|
|
@@ -1020,6 +1071,11 @@ interface SubmitReportInput {
|
|
|
1020
1071
|
annotationComposite?: AnnotationComposite;
|
|
1021
1072
|
/** Selective data opt-outs; each flag defaults to `true`. */
|
|
1022
1073
|
include?: SubmitReportIncludes;
|
|
1074
|
+
/**
|
|
1075
|
+
* What caused this submit. Defaults to `'user'` (overlay submit). Programmatic
|
|
1076
|
+
* callers may pass `'api'`; the auto-capture engine passes `'error'`.
|
|
1077
|
+
*/
|
|
1078
|
+
trigger?: ReportTrigger$1;
|
|
1023
1079
|
}
|
|
1024
1080
|
declare class LensClient {
|
|
1025
1081
|
private readonly accessId;
|
|
@@ -1027,6 +1083,7 @@ declare class LensClient {
|
|
|
1027
1083
|
private readonly replayWindowMs;
|
|
1028
1084
|
private readonly debug;
|
|
1029
1085
|
private readonly screenshotEnabled;
|
|
1086
|
+
private readonly autoCapture?;
|
|
1030
1087
|
private readonly beforeSend?;
|
|
1031
1088
|
private app;
|
|
1032
1089
|
private readonly consoleBuffer;
|
|
@@ -1057,4 +1114,4 @@ declare class LensClient {
|
|
|
1057
1114
|
private warn;
|
|
1058
1115
|
}
|
|
1059
1116
|
|
|
1060
|
-
export { ACCESS_ID_PREFIX, ACCESS_SECRET_PREFIX, type Annotation, AnnotationSchema, type ApiError, ApiErrorSchema, type AppContext, AppContextSchema, type AssetKind, AssetKindSchema, type AssetRef, AssetRefSchema, type AttachAssetRequest, AttachAssetRequestSchema, type ConsoleEntry, ConsoleEntrySchema, type ConsoleLevel, ConsoleLevelSchema, type EnvContext, EnvContextSchema, type ErrorEntry, ErrorEntrySchema, type FinalizeReportRequest, FinalizeReportRequestSchema, type FinalizeReportResponse, FinalizeReportResponseSchema, type InitiateReportRequest, InitiateReportRequestSchema, type InitiateReportResponse, InitiateReportResponseSchema, LensClient, type LensConfig, type ListReportsQuery, ListReportsQuerySchema, type NetworkEntry, NetworkEntrySchema, type Report, type ReportMetadata, ReportMetadataSchema, ReportSchema, type ReportStatus, ReportStatusSchema, type ReportSummary, ReportSummarySchema, SDK_NAME, SDK_VERSION, type TargetElement, TargetElementSchema, isAccessId, isAccessSecret };
|
|
1117
|
+
export { ACCESS_ID_PREFIX, ACCESS_SECRET_PREFIX, type Annotation, AnnotationSchema, type ApiError, ApiErrorSchema, type AppContext, AppContextSchema, type AssetKind, AssetKindSchema, type AssetRef, AssetRefSchema, type AttachAssetRequest, AttachAssetRequestSchema, type ConsoleEntry, ConsoleEntrySchema, type ConsoleLevel, ConsoleLevelSchema, type EnvContext, EnvContextSchema, type ErrorEntry, ErrorEntrySchema, type FinalizeReportRequest, FinalizeReportRequestSchema, type FinalizeReportResponse, FinalizeReportResponseSchema, type InitiateReportRequest, InitiateReportRequestSchema, type InitiateReportResponse, InitiateReportResponseSchema, LensClient, type LensConfig, type ListReportsQuery, ListReportsQuerySchema, type NetworkEntry, NetworkEntrySchema, type Report, type ReportMetadata, ReportMetadataSchema, ReportSchema, type ReportStatus, ReportStatusSchema, type ReportSummary, ReportSummarySchema, type ReportTrigger, ReportTriggerSchema, SDK_NAME, SDK_VERSION, type TargetElement, TargetElementSchema, isAccessId, isAccessSecret };
|
package/dist/index.js
CHANGED
|
@@ -22,12 +22,13 @@ import {
|
|
|
22
22
|
ReportSchema,
|
|
23
23
|
ReportStatusSchema,
|
|
24
24
|
ReportSummarySchema,
|
|
25
|
+
ReportTriggerSchema,
|
|
25
26
|
SDK_NAME,
|
|
26
27
|
SDK_VERSION,
|
|
27
28
|
TargetElementSchema,
|
|
28
29
|
isAccessId,
|
|
29
30
|
isAccessSecret
|
|
30
|
-
} from "./chunk-
|
|
31
|
+
} from "./chunk-LIYEDZV7.js";
|
|
31
32
|
export {
|
|
32
33
|
ACCESS_ID_PREFIX,
|
|
33
34
|
ACCESS_SECRET_PREFIX,
|
|
@@ -52,6 +53,7 @@ export {
|
|
|
52
53
|
ReportSchema,
|
|
53
54
|
ReportStatusSchema,
|
|
54
55
|
ReportSummarySchema,
|
|
56
|
+
ReportTriggerSchema,
|
|
55
57
|
SDK_NAME,
|
|
56
58
|
SDK_VERSION,
|
|
57
59
|
TargetElementSchema,
|