@proappstore/sdk 1.16.80 → 1.16.82
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/README.md +34 -1
- package/dist/actions.d.ts +31 -6
- package/dist/actions.d.ts.map +1 -1
- package/dist/actions.js +97 -23
- package/dist/actions.js.map +1 -1
- package/dist/auth.d.ts +8 -2
- package/dist/auth.d.ts.map +1 -1
- package/dist/auth.js +14 -3
- package/dist/auth.js.map +1 -1
- package/dist/index.d.ts +3 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +13 -4
- package/dist/index.js.map +1 -1
- package/dist/logs.d.ts +112 -6
- package/dist/logs.d.ts.map +1 -1
- package/dist/logs.js +362 -32
- package/dist/logs.js.map +1 -1
- package/dist/rooms.d.ts +21 -2
- package/dist/rooms.d.ts.map +1 -1
- package/dist/rooms.js +53 -3
- package/dist/rooms.js.map +1 -1
- package/dist/sdk-version.d.ts +7 -0
- package/dist/sdk-version.d.ts.map +1 -0
- package/dist/sdk-version.js +7 -0
- package/dist/sdk-version.js.map +1 -0
- package/dist/shell-resilience.d.ts.map +1 -1
- package/dist/shell-resilience.js +3 -7
- package/dist/shell-resilience.js.map +1 -1
- package/dist/telemetry-transport.d.ts +17 -0
- package/dist/telemetry-transport.d.ts.map +1 -1
- package/dist/telemetry-transport.js +23 -9
- package/dist/telemetry-transport.js.map +1 -1
- package/dist/trace.d.ts +56 -0
- package/dist/trace.d.ts.map +1 -0
- package/dist/trace.js +69 -0
- package/dist/trace.js.map +1 -0
- package/package.json +2 -2
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,uEAAuE;AACvE,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACrE,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAO9C,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE7D,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3C,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,uEAAuE;AACvE,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACrE,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,EAAE,EAAE,MAAM,SAAS,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAO9C,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE7D,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAK3C,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAMpD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAuBrC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGzC,iGAAiG;AACjG,wFAAwF;AACxF,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3F,0BAA0B;AAC1B,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAC7F,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAG1F,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAE5D,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAEzD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EACL,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,YAAY,EAAE,WAAW,EAC9D,QAAQ,EAAE,kBAAkB,EAAE,WAAW,EAAE,aAAa,EAAE,UAAU,EACpE,cAAc,GACf,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,MAAM,OAAO,WAAW;IACb,IAAI,CAAO;IACX,EAAE,CAAK;IACP,QAAQ,CAAW;IACnB,KAAK,CAAQ;IACb,KAAK,CAAQ;IACb,KAAK,CAAW;IAChB,YAAY,CAAkB;IAC9B,OAAO,CAAa;IACpB,EAAE,CAAW;IACb,OAAO,CAAU;IAC1B,wEAAwE;IAC/D,OAAO,CAAU;IACjB,IAAI,CAAO;IACX,aAAa,CAAgB;IAC7B,GAAG,CAAM;IACT,EAAE,CAAK;IACP,KAAK,CAAQ;IACb,KAAK,CAAQ;IACb,QAAQ,CAAW;IACnB,OAAO,CAAU;IACjB,OAAO,CAAU;IAC1B,6DAA6D;IACpD,MAAM,CAAS;IACxB,qFAAqF;IAC5E,IAAI,CAAO;IACpB,4FAA4F;IACnF,MAAM,CAAa;IAC5B,qDAAqD;IAC5C,KAAK,CAAS;IAEvB,YAAY,IAAoB;QAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,IAAI,gCAAgC,CAAC;QACpE,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QACpD,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,gBAAgB,IAAI,CAAC,KAAK,qBAAqB,CAAC,CAAC;QACxI,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7D,gFAAgF;QAChF,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC;QAC5E,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1D,IAAI,CAAC,YAAY,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACxE,IAAI,CAAC,OAAO,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC,EAAE,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QAC/F,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,aAAa,GAAG,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACvE,IAAI,CAAC,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7D,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAC/B,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACtE,IAAI,CAAC,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACzD,qEAAqE;QACrE,qEAAqE;QACrE,kCAAkC;QAClC,IAAI,IAAI,CAAC,KAAK,EAAE,IAAI,KAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC;gBAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAAC,CAAC;YAAC,MAAM,CAAC,CAAC,iDAAiD,CAAC,CAAC;QACzF,CAAC;QACD,+EAA+E;QAC/E,8EAA8E;QAC9E,8EAA8E;QAC9E,kBAAkB;QAClB,IAAI,IAAI,CAAC,UAAU,EAAE,IAAI,KAAK,KAAK,EAAE,CAAC;YACpC,IAAI,CAAC;gBAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAAC,CAAC;YAAC,MAAM,CAAC,CAAC,6CAA6C,CAAC,CAAC;QACpF,CAAC;QACD,yEAAyE;QACzE,+BAA+B;QAC/B,IAAI,UAAU,GAAkB,IAAI,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,EAAE,EAAE;YAC1B,MAAM,EAAE,GAAG,IAAI,EAAE,EAAE,IAAI,IAAI,CAAC;YAC5B,IAAI,UAAU,KAAK,IAAI,IAAI,EAAE,KAAK,UAAU;gBAAE,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3E,UAAU,GAAG,EAAE,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AAED,+EAA+E;AAC/E,MAAM,UAAU,OAAO,CAAC,IAAoB;IAC1C,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC;AAC/B,CAAC"}
|
package/dist/logs.d.ts
CHANGED
|
@@ -15,11 +15,16 @@
|
|
|
15
15
|
* SSR-safe.
|
|
16
16
|
* - **Silent.** No throw path, ever. A logger that breaks the app it observes is
|
|
17
17
|
* worse than no logger.
|
|
18
|
-
* - **Backs off instead of retrying.** The server answers 202 when an
|
|
19
|
-
* its budget;
|
|
18
|
+
* - **Backs off instead of retrying into a flood.** The server answers 202 when an
|
|
19
|
+
* app is over its budget; the SDK goes quiet (see `COOLDOWN_MS`). Only a
|
|
20
|
+
* transient failure (network, timeout, 5xx) is retried, a few times with
|
|
21
|
+
* backoff and within a TTL (#392); offline, the queue waits for `online`.
|
|
22
|
+
* - **Best effort.** The queue is bounded and lives in memory: a closed tab, a
|
|
23
|
+
* long outage or an over-budget app loses entries. `health()` says how many.
|
|
20
24
|
* - **Not a replacement for usage telemetry.** `app.usage` is unchanged; the two
|
|
21
25
|
* share only the transport.
|
|
22
26
|
*/
|
|
27
|
+
import type { CaptureContext } from './trace.js';
|
|
23
28
|
import { type TelemetryAuth } from './telemetry-transport.js';
|
|
24
29
|
export type LogLevel = 'debug' | 'info' | 'warn' | 'error';
|
|
25
30
|
/** Fixed, privacy-reviewed session diagnostics emitted by {@link Auth}. */
|
|
@@ -36,6 +41,36 @@ export type AuthTelemetryEvent = {
|
|
|
36
41
|
online: boolean | null;
|
|
37
42
|
visibility: 'visible' | 'hidden' | 'unknown';
|
|
38
43
|
};
|
|
44
|
+
export type { CaptureContext } from './trace.js';
|
|
45
|
+
/** Envelope version on every entry; the ingest allowlist keys on it. */
|
|
46
|
+
export declare const LOG_ENVELOPE_VERSION = 1;
|
|
47
|
+
/** What a breadcrumb records (#392). Anything else is ignored. */
|
|
48
|
+
export type BreadcrumbCategory = 'navigation' | 'ui' | 'network' | 'room' | 'auth' | 'action';
|
|
49
|
+
/** Primitive values only: a breadcrumb never carries an object, DOM node or form payload. */
|
|
50
|
+
export type BreadcrumbData = Record<string, string | number | boolean | null>;
|
|
51
|
+
export interface Breadcrumb {
|
|
52
|
+
ts: number;
|
|
53
|
+
category: BreadcrumbCategory;
|
|
54
|
+
message: string;
|
|
55
|
+
data?: BreadcrumbData;
|
|
56
|
+
}
|
|
57
|
+
/** Delivery health of `app.logs` (#392). Counts are since the logger started. */
|
|
58
|
+
export interface LogHealth {
|
|
59
|
+
/** Entries waiting to be sent. */
|
|
60
|
+
queued: number;
|
|
61
|
+
/** Entries the server accepted, or handed to `sendBeacon`. */
|
|
62
|
+
sent: number;
|
|
63
|
+
/** Entries lost: queue overflow, retries exhausted, over budget (202/429), unknown app (404). */
|
|
64
|
+
dropped: number;
|
|
65
|
+
/** Repeats folded into an earlier queued entry instead of sent again. */
|
|
66
|
+
duplicates: number;
|
|
67
|
+
/** Breadcrumbs held in memory. */
|
|
68
|
+
breadcrumbs: number;
|
|
69
|
+
/** True once the server said this app cannot accept logs (404). Permanent for the page. */
|
|
70
|
+
disabled: boolean;
|
|
71
|
+
/** Epoch ms until which nothing is sent (server backpressure), or null. */
|
|
72
|
+
quietUntil: number | null;
|
|
73
|
+
}
|
|
39
74
|
export interface MonitoringOptions {
|
|
40
75
|
/** Default true. Set false to disable auto-capture and the flush timer. */
|
|
41
76
|
auto?: boolean;
|
|
@@ -54,11 +89,26 @@ export declare function redactClient(input: string): string;
|
|
|
54
89
|
* session at all.
|
|
55
90
|
*/
|
|
56
91
|
export declare function readOrCreateClientId(): string | null;
|
|
57
|
-
/**
|
|
92
|
+
/**
|
|
93
|
+
* Serialize an unknown thrown value into a message + stack. An Error's `cause`
|
|
94
|
+
* chain (#392, up to five levels) is appended to the stack as `Caused by:`
|
|
95
|
+
* sections, so a wrapped failure keeps its root. Bounded; never throws.
|
|
96
|
+
*/
|
|
58
97
|
export declare function describeError(value: unknown): {
|
|
59
98
|
message: string;
|
|
60
99
|
stack?: string | undefined;
|
|
61
100
|
};
|
|
101
|
+
/** Category of a render error a React error boundary caught. */
|
|
102
|
+
export declare const REACT_ERROR_CATEGORY = "react.error-boundary";
|
|
103
|
+
/**
|
|
104
|
+
* The entry for a render error a React error boundary caught: the message and
|
|
105
|
+
* stack (with causes), the component stack and the path. Shared by ProShell's
|
|
106
|
+
* boundary and {@link Logs.captureReactError}, so both read the same.
|
|
107
|
+
*/
|
|
108
|
+
export declare function describeReactError(error: unknown, componentStack?: string | null): {
|
|
109
|
+
message: string;
|
|
110
|
+
data: Record<string, unknown>;
|
|
111
|
+
};
|
|
62
112
|
export declare class Logs {
|
|
63
113
|
private readonly appId;
|
|
64
114
|
private readonly apiBase;
|
|
@@ -78,6 +128,18 @@ export declare class Logs {
|
|
|
78
128
|
/** Guards against an error raised inside our own handler re-entering. */
|
|
79
129
|
private capturing;
|
|
80
130
|
private minLevel;
|
|
131
|
+
private onOnline;
|
|
132
|
+
/** In-memory only, never persisted (#392). */
|
|
133
|
+
private breadcrumbs;
|
|
134
|
+
/** Errors already recorded, so a caught-then-rethrown error is one event. */
|
|
135
|
+
private reported;
|
|
136
|
+
private stats;
|
|
137
|
+
/** A non-unload send is in flight: the next one waits for it. */
|
|
138
|
+
private sending;
|
|
139
|
+
private retryAttempt;
|
|
140
|
+
private retryStartedAt;
|
|
141
|
+
private retryAt;
|
|
142
|
+
private retryTimer;
|
|
81
143
|
constructor(appId: string, apiBase: string, auth: TelemetryAuth, options?: MonitoringOptions);
|
|
82
144
|
/** Begin auto-capture and periodic flushing. Idempotent. */
|
|
83
145
|
start(): void;
|
|
@@ -95,23 +157,67 @@ export declare class Logs {
|
|
|
95
157
|
captureAuthEvent(event: AuthTelemetryEvent): void;
|
|
96
158
|
/** Number of entries waiting to be sent. Exposed for tests and diagnostics. */
|
|
97
159
|
get pending(): number;
|
|
160
|
+
/** Delivery health: queued, sent and dropped entries, breadcrumbs, backpressure. */
|
|
161
|
+
health(): LogHealth;
|
|
162
|
+
/**
|
|
163
|
+
* Record a breadcrumb (#392): a short, redacted note of what happened before a
|
|
164
|
+
* failure. Kept in a bounded in-memory buffer (the newest 50) and attached to
|
|
165
|
+
* the next error entries; never persisted and never sent on its own. Only the
|
|
166
|
+
* listed categories are kept, and `data` keeps up to eight primitive values —
|
|
167
|
+
* do not pass form text, DOM content, tokens or user data.
|
|
168
|
+
*/
|
|
169
|
+
addBreadcrumb(category: BreadcrumbCategory, message: string, data?: BreadcrumbData): void;
|
|
170
|
+
/** Forget every breadcrumb. The SDK calls this when the signed-in user changes. */
|
|
171
|
+
clearBreadcrumbs(): void;
|
|
98
172
|
/**
|
|
99
173
|
* Queue one entry.
|
|
100
174
|
*
|
|
101
175
|
* Public so app code can record its own categories (`app.logs.capture('warn',
|
|
102
176
|
* 'checkout', ...)`), and so SDK primitives can report their own failures
|
|
103
|
-
* (platform#106's client half) without another queue.
|
|
177
|
+
* (platform#106's client half) without another queue. `context` (#390) joins
|
|
178
|
+
* the entry to a request: pass the trace and span ids the call was sent with.
|
|
179
|
+
*/
|
|
180
|
+
capture(level: LogLevel, category: string, message: string, data?: unknown, context?: CaptureContext): void;
|
|
181
|
+
/**
|
|
182
|
+
* Record a thrown value as an `error` entry: its name, message and stack
|
|
183
|
+
* (redacted like every entry), plus the request context when there is one.
|
|
184
|
+
* Category defaults to `exception`.
|
|
104
185
|
*/
|
|
105
|
-
|
|
106
|
-
|
|
186
|
+
captureException(error: unknown, context?: CaptureContext & {
|
|
187
|
+
category?: string;
|
|
188
|
+
}): void;
|
|
189
|
+
/**
|
|
190
|
+
* Record a render error your own React error boundary caught (#392). React
|
|
191
|
+
* does not pass a caught error to `window.onerror`, so call this from
|
|
192
|
+
* `componentDidCatch(error, info)`: `app.logs.captureReactError(error,
|
|
193
|
+
* info.componentStack)`. Same entry as ProShell's boundary (category
|
|
194
|
+
* `react.error-boundary`, stack with causes, component stack, path).
|
|
195
|
+
*/
|
|
196
|
+
captureReactError(error: unknown, componentStack?: string | null): void;
|
|
107
197
|
/** Fire-and-forget flush, safe on the unload path. */
|
|
108
198
|
flush(): void;
|
|
109
199
|
/** Await a flush. For tests and deliberate checkpoints. */
|
|
110
200
|
flushAsync(): Promise<void>;
|
|
201
|
+
private alreadyReported;
|
|
202
|
+
private markReported;
|
|
203
|
+
/** The newest breadcrumbs that fit the ingest size budget, on an object payload only. */
|
|
204
|
+
private withBreadcrumbs;
|
|
205
|
+
/** Drop the OLDEST on overflow: during a loop the newest entries are all the
|
|
206
|
+
* same fault, while the first entries include what preceded it. */
|
|
207
|
+
private trimQueue;
|
|
111
208
|
private safeData;
|
|
112
209
|
/** W3C traceparent trace-id, so a client entry can be lined up with the
|
|
113
210
|
* backend and data-worker records for the same logical request. */
|
|
114
211
|
private newTraceId;
|
|
115
212
|
private send;
|
|
213
|
+
private settle;
|
|
214
|
+
/**
|
|
215
|
+
* A transient failure: put the batch back and retry with backoff, a bounded
|
|
216
|
+
* number of times within {@link RETRY_TTL_MS}. Offline is a pause, not a
|
|
217
|
+
* failed attempt. One timer at most, so a failing endpoint cannot cause a
|
|
218
|
+
* retry storm, and the transport never logs, so it cannot recurse.
|
|
219
|
+
*/
|
|
220
|
+
private retryLater;
|
|
221
|
+
private resetRetry;
|
|
116
222
|
}
|
|
117
223
|
//# sourceMappingURL=logs.d.ts.map
|
package/dist/logs.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"logs.d.ts","sourceRoot":"","sources":["../src/logs.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"logs.d.ts","sourceRoot":"","sources":["../src/logs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAGH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAiB,KAAK,aAAa,EAAwB,MAAM,0BAA0B,CAAC;AAEnG,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAE3D,2EAA2E;AAC3E,MAAM,MAAM,kBAAkB,GAAG;IAC/B,QAAQ,EAAE,mBAAmB,GAAG,wBAAwB,CAAC;IACzD,MAAM,EAAE,SAAS,GAAG,mBAAmB,GAAG,yBAAyB,GAAG,YAAY,GAAG,eAAe,CAAC;IACrG,KAAK,EAAE,aAAa,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,mBAAmB,CAAC;IACrF,KAAK,EAAE,cAAc,GAAG,SAAS,GAAG,aAAa,CAAC;IAClD,4EAA4E;IAC5E,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,OAAO,GAAG,IAAI,CAAC;IACvB,UAAU,EAAE,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;CAC9C,CAAC;AAQF,YAAY,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAEjD,wEAAwE;AACxE,eAAO,MAAM,oBAAoB,IAAI,CAAC;AAgBtC,kEAAkE;AAClE,MAAM,MAAM,kBAAkB,GAAG,YAAY,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;AAG9F,6FAA6F;AAC7F,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC,CAAC;AAE9E,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB;AAED,iFAAiF;AACjF,MAAM,WAAW,SAAS;IACxB,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,8DAA8D;IAC9D,IAAI,EAAE,MAAM,CAAC;IACb,iGAAiG;IACjG,OAAO,EAAE,MAAM,CAAC;IAChB,yEAAyE;IACzE,UAAU,EAAE,MAAM,CAAC;IACnB,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,2FAA2F;IAC3F,QAAQ,EAAE,OAAO,CAAC;IAClB,2EAA2E;IAC3E,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,iBAAiB;IAChC,2EAA2E;IAC3E,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,8EAA8E;IAC9E,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,yFAAyF;IACzF,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAoED,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAIlD;AAMD;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,IAAI,MAAM,GAAG,IAAI,CAiBpD;AAcD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAqB7F;AAED,gEAAgE;AAChE,eAAO,MAAM,oBAAoB,yBAAyB,CAAC;AAE3D;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,CAUrI;AAaD,qBAAa,IAAI;IA6Bb,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,OAAO;IA/B1B,OAAO,CAAC,KAAK,CAAqB;IAClC,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,KAAK,CAA+C;IAC5D,OAAO,CAAC,OAAO,CAA0C;IACzD,OAAO,CAAC,WAAW,CAAqD;IACxE,OAAO,CAAC,UAAU,CAA6B;IAC/C,OAAO,CAAC,QAAQ,CAAuB;IACvC,sEAAsE;IACtE,OAAO,CAAC,UAAU,CAAK;IACvB,yEAAyE;IACzE,OAAO,CAAC,QAAQ,CAAS;IACzB,yEAAyE;IACzE,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,QAAQ,CAAW;IAC3B,OAAO,CAAC,QAAQ,CAA6B;IAC7C,8CAA8C;IAC9C,OAAO,CAAC,WAAW,CAAoB;IACvC,6EAA6E;IAC7E,OAAO,CAAC,QAAQ,CAAyB;IACzC,OAAO,CAAC,KAAK,CAA0C;IACvD,iEAAiE;IACjE,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,OAAO,CAAK;IACpB,OAAO,CAAC,UAAU,CAA8C;gBAG7C,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,aAAa,EACnB,OAAO,GAAE,iBAAsB;IAKlD,4DAA4D;IAC5D,KAAK,IAAI,IAAI;IAkDb,gFAAgF;IAChF,IAAI,IAAI,IAAI;IAwBZ,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI;IAI5C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI;IAI3C,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI;IAI3C,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,GAAG,IAAI;IAI5C;;;;OAIG;IACH,gBAAgB,CAAC,KAAK,EAAE,kBAAkB,GAAG,IAAI;IA8BjD,+EAA+E;IAC/E,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,oFAAoF;IACpF,MAAM,IAAI,SAAS;IAYnB;;;;;;OAMG;IACH,aAAa,CAAC,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,GAAG,IAAI;IAoBzF,mFAAmF;IACnF,gBAAgB,IAAI,IAAI;IAIxB;;;;;;;OAOG;IACH,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,IAAI;IA4C3G;;;;OAIG;IACH,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAYxF;;;;;;OAMG;IACH,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAWvE,sDAAsD;IACtD,KAAK,IAAI,IAAI;IAIb,2DAA2D;IACrD,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAIjC,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,YAAY;IAIpB,yFAAyF;IACzF,OAAO,CAAC,eAAe;IAWvB;wEACoE;IACpE,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,QAAQ;IAShB;wEACoE;IACpE,OAAO,CAAC,UAAU;YAWJ,IAAI;IA+BlB,OAAO,CAAC,MAAM;IA8Bd;;;;;OAKG;IACH,OAAO,CAAC,UAAU;IAsBlB,OAAO,CAAC,UAAU;CAKnB"}
|