@debugbundle/shared-types 2.5.0 → 3.0.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 (116) hide show
  1. package/README.md +17 -0
  2. package/dist/alert-notification-policy.d.ts +22 -40
  3. package/dist/alert-notification-policy.d.ts.map +1 -1
  4. package/dist/alert-notification-policy.js +1 -1
  5. package/dist/analytics-flows.d.ts +53 -588
  6. package/dist/analytics-flows.d.ts.map +1 -1
  7. package/dist/analytics-flows.js +4 -6
  8. package/dist/analytics-flows.js.map +1 -1
  9. package/dist/analytics-journey-samples.d.ts +70 -857
  10. package/dist/analytics-journey-samples.d.ts.map +1 -1
  11. package/dist/analytics-journey-samples.js +4 -4
  12. package/dist/analytics-product.d.ts +222 -853
  13. package/dist/analytics-product.d.ts.map +1 -1
  14. package/dist/analytics-product.js +9 -9
  15. package/dist/analytics-query.d.ts +13 -48
  16. package/dist/analytics-query.d.ts.map +1 -1
  17. package/dist/analytics-query.js +1 -1
  18. package/dist/analytics-saved-funnels.d.ts +21 -258
  19. package/dist/analytics-saved-funnels.d.ts.map +1 -1
  20. package/dist/analytics-saved-funnels.js +1 -1
  21. package/dist/analytics.d.ts +342 -2181
  22. package/dist/analytics.d.ts.map +1 -1
  23. package/dist/analytics.js +9 -9
  24. package/dist/browser-resource-context.d.ts +35 -129
  25. package/dist/browser-resource-context.d.ts.map +1 -1
  26. package/dist/browser-resource-routes.d.ts +6 -27
  27. package/dist/browser-resource-routes.d.ts.map +1 -1
  28. package/dist/bundle-evidence.d.ts +101 -0
  29. package/dist/bundle-evidence.d.ts.map +1 -0
  30. package/dist/bundle-evidence.js +69 -0
  31. package/dist/bundle-evidence.js.map +1 -0
  32. package/dist/capture-policy.d.ts +311 -319
  33. package/dist/capture-policy.d.ts.map +1 -1
  34. package/dist/capture-policy.js +70 -29
  35. package/dist/capture-policy.js.map +1 -1
  36. package/dist/capture-rule-evaluation.d.ts +53 -154
  37. package/dist/capture-rule-evaluation.d.ts.map +1 -1
  38. package/dist/capture-rule-evaluation.js +1 -1
  39. package/dist/capture-rule-schemas.d.ts +788 -3226
  40. package/dist/capture-rule-schemas.d.ts.map +1 -1
  41. package/dist/capture-rule-schemas.js +37 -34
  42. package/dist/capture-rule-schemas.js.map +1 -1
  43. package/dist/capture-rule-suggestions.d.ts +195 -1189
  44. package/dist/capture-rule-suggestions.d.ts.map +1 -1
  45. package/dist/diagnostic-capture-budget.d.ts +22 -0
  46. package/dist/diagnostic-capture-budget.d.ts.map +1 -0
  47. package/dist/diagnostic-capture-budget.js +195 -0
  48. package/dist/diagnostic-capture-budget.js.map +1 -0
  49. package/dist/diagnostic-context.d.ts +163 -0
  50. package/dist/diagnostic-context.d.ts.map +1 -0
  51. package/dist/diagnostic-context.js +117 -0
  52. package/dist/diagnostic-context.js.map +1 -0
  53. package/dist/event-envelope.d.ts +524 -4326
  54. package/dist/event-envelope.d.ts.map +1 -1
  55. package/dist/event-envelope.js +63 -8
  56. package/dist/event-envelope.js.map +1 -1
  57. package/dist/evidence-bounds.d.ts +9 -0
  58. package/dist/evidence-bounds.d.ts.map +1 -0
  59. package/dist/evidence-bounds.js +51 -0
  60. package/dist/evidence-bounds.js.map +1 -0
  61. package/dist/evidence-capabilities.d.ts +15 -0
  62. package/dist/evidence-capabilities.d.ts.map +1 -0
  63. package/dist/evidence-capabilities.js +29 -0
  64. package/dist/evidence-capabilities.js.map +1 -0
  65. package/dist/evidence-emission.d.ts +18 -0
  66. package/dist/evidence-emission.d.ts.map +1 -0
  67. package/dist/evidence-emission.js +83 -0
  68. package/dist/evidence-emission.js.map +1 -0
  69. package/dist/evidence-interpretation.d.ts +68 -0
  70. package/dist/evidence-interpretation.d.ts.map +1 -0
  71. package/dist/evidence-interpretation.js +177 -0
  72. package/dist/evidence-interpretation.js.map +1 -0
  73. package/dist/exception-evidence.d.ts +96 -0
  74. package/dist/exception-evidence.d.ts.map +1 -0
  75. package/dist/exception-evidence.js +145 -0
  76. package/dist/exception-evidence.js.map +1 -0
  77. package/dist/first-purchase-eligibility.d.ts +9 -0
  78. package/dist/first-purchase-eligibility.d.ts.map +1 -0
  79. package/dist/first-purchase-eligibility.js +16 -0
  80. package/dist/first-purchase-eligibility.js.map +1 -0
  81. package/dist/improvement-settings.d.ts +29 -48
  82. package/dist/improvement-settings.d.ts.map +1 -1
  83. package/dist/index.d.ts +323 -1834
  84. package/dist/index.d.ts.map +1 -1
  85. package/dist/index.js +22 -3
  86. package/dist/index.js.map +1 -1
  87. package/dist/ingestion-wire.d.ts +9 -0
  88. package/dist/ingestion-wire.d.ts.map +1 -0
  89. package/dist/ingestion-wire.js +56 -0
  90. package/dist/ingestion-wire.js.map +1 -0
  91. package/dist/json-schema.d.ts +4 -0
  92. package/dist/json-schema.d.ts.map +1 -0
  93. package/dist/json-schema.js +49 -0
  94. package/dist/json-schema.js.map +1 -0
  95. package/dist/notification-preferences.d.ts +505 -0
  96. package/dist/notification-preferences.d.ts.map +1 -0
  97. package/dist/notification-preferences.js +206 -0
  98. package/dist/notification-preferences.js.map +1 -0
  99. package/dist/notification-schedule.d.ts +4 -0
  100. package/dist/notification-schedule.d.ts.map +1 -0
  101. package/dist/notification-schedule.js +36 -0
  102. package/dist/notification-schedule.js.map +1 -0
  103. package/dist/project-color-tags.d.ts +20 -1
  104. package/dist/project-color-tags.d.ts.map +1 -1
  105. package/dist/public-status.d.ts +122 -568
  106. package/dist/public-status.d.ts.map +1 -1
  107. package/dist/public-status.js +8 -8
  108. package/dist/stack-frames.d.ts +11 -0
  109. package/dist/stack-frames.d.ts.map +1 -0
  110. package/dist/stack-frames.js +107 -0
  111. package/dist/stack-frames.js.map +1 -0
  112. package/dist/weekly-notification-groups.d.ts +8 -0
  113. package/dist/weekly-notification-groups.d.ts.map +1 -0
  114. package/dist/weekly-notification-groups.js +23 -0
  115. package/dist/weekly-notification-groups.js.map +1 -0
  116. package/package.json +2 -2
package/README.md CHANGED
@@ -4,6 +4,23 @@ Shared DebugBundle schemas, types, and constants.
4
4
 
5
5
  This package is the low-level contract layer used by the DebugBundle SDKs and core services. Most consumers should install `@debugbundle/sdk-node` or `@debugbundle/sdk-browser` instead of depending on this package directly.
6
6
 
7
+ ## Upgrading to 3.0
8
+
9
+ Version 3 uses Zod 4.6.7 or later. Direct consumers of the exported schema objects
10
+ must use Zod 4 types and APIs: refinements now remain on their object/string
11
+ schemas, and refined objects can be extended with `safeExtend()`. Replace Zod 3
12
+ `ZodEffects`/`innerType()` handling and three-parameter `ZodType` annotations with
13
+ their Zod 4 equivalents. The major version reflects this TypeScript/schema API
14
+ change. Event envelopes and Bundle v1 remain compatible, including legacy UUID
15
+ shape acceptance, optional fields, partial channel maps and nullable metadata.
16
+ Integer schemas now enforce JavaScript's safe integer range; avoid imprecise
17
+ numeric values. See the core repository's `spec/zod-v4-migration.md` for the
18
+ coordinated dependency and generated-schema migration.
19
+
20
+ The Node and Browser SDKs consume this dependency internally; their 3.2 capture
21
+ APIs and event formats remain compatible. The new bounded evidence and recovery
22
+ features still require a verified supporting receiver path.
23
+
7
24
  ## Install
8
25
 
9
26
  Published package:
@@ -2,52 +2,34 @@ import { z } from "zod";
2
2
  export declare const AlertEmailConfigSchema: z.ZodObject<{
3
3
  to: z.ZodString;
4
4
  aggregation_window_seconds: z.ZodOptional<z.ZodNumber>;
5
- }, "strict", z.ZodTypeAny, {
6
- to: string;
7
- aggregation_window_seconds?: number | undefined;
8
- }, {
9
- to: string;
10
- aggregation_window_seconds?: number | undefined;
11
- }>;
12
- export declare const AlertSlackConfigSchema: z.ZodUnion<[z.ZodObject<{
5
+ }, z.core.$strict>;
6
+ export declare const AlertSlackConfigSchema: z.ZodUnion<readonly [z.ZodObject<{
13
7
  webhook_url: z.ZodString;
14
- cooldown_scope: z.ZodOptional<z.ZodEnum<["incident", "project"]>>;
15
- }, "strict", z.ZodTypeAny, {
16
- webhook_url: string;
17
- cooldown_scope?: "incident" | "project" | undefined;
18
- }, {
19
- webhook_url: string;
20
- cooldown_scope?: "incident" | "project" | undefined;
21
- }>, z.ZodObject<{
8
+ cooldown_scope: z.ZodOptional<z.ZodEnum<{
9
+ incident: "incident";
10
+ project: "project";
11
+ }>>;
12
+ }, z.core.$strict>, z.ZodObject<{
22
13
  slack_destination_id: z.ZodString;
23
- cooldown_scope: z.ZodOptional<z.ZodEnum<["incident", "project"]>>;
24
- }, "strict", z.ZodTypeAny, {
25
- slack_destination_id: string;
26
- cooldown_scope?: "incident" | "project" | undefined;
27
- }, {
28
- slack_destination_id: string;
29
- cooldown_scope?: "incident" | "project" | undefined;
30
- }>]>;
14
+ cooldown_scope: z.ZodOptional<z.ZodEnum<{
15
+ incident: "incident";
16
+ project: "project";
17
+ }>>;
18
+ }, z.core.$strict>]>;
31
19
  export declare const AlertDiscordConfigSchema: z.ZodObject<{
32
20
  webhook_url: z.ZodString;
33
- cooldown_scope: z.ZodOptional<z.ZodEnum<["incident", "project"]>>;
34
- }, "strict", z.ZodTypeAny, {
35
- webhook_url: string;
36
- cooldown_scope?: "incident" | "project" | undefined;
37
- }, {
38
- webhook_url: string;
39
- cooldown_scope?: "incident" | "project" | undefined;
40
- }>;
21
+ cooldown_scope: z.ZodOptional<z.ZodEnum<{
22
+ incident: "incident";
23
+ project: "project";
24
+ }>>;
25
+ }, z.core.$strict>;
41
26
  export declare const AlertWebhookConfigSchema: z.ZodObject<{
42
27
  target_url: z.ZodString;
43
- cooldown_scope: z.ZodOptional<z.ZodEnum<["incident", "project"]>>;
44
- }, "strict", z.ZodTypeAny, {
45
- target_url: string;
46
- cooldown_scope?: "incident" | "project" | undefined;
47
- }, {
48
- target_url: string;
49
- cooldown_scope?: "incident" | "project" | undefined;
50
- }>;
28
+ cooldown_scope: z.ZodOptional<z.ZodEnum<{
29
+ incident: "incident";
30
+ project: "project";
31
+ }>>;
32
+ }, z.core.$strict>;
51
33
  /** A digest retains distinct incidents. Immediate-channel project cooldowns are opt-in,
52
34
  * scoped to the selected rule, environment and severity so an escalation still alerts. */
53
35
  export declare function resolveAlertNoisePolicy(input: {
@@ -1 +1 @@
1
- {"version":3,"file":"alert-notification-policy.d.ts","sourceRoot":"","sources":["../src/alert-notification-policy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,sBAAsB;;;;;;;;;EAKxB,CAAC;AAEZ,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;IAGjC,CAAC;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;EAE1B,CAAC;AACZ,eAAO,MAAM,wBAAwB;;;;;;;;;EAE1B,CAAC;AAEZ;0FAC0F;AAC1F,wBAAgB,uBAAuB,CAAC,KAAK,EAAE;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,GAAG;IAAE,gBAAgB,EAAE,MAAM,CAAC;IAAC,gBAAgB,EAAE,MAAM,CAAC;IAAC,0BAA0B,EAAE,MAAM,CAAA;CAAE,CAoB7F;AAED,sFAAsF;AACtF,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,EAC7C,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAUzB"}
1
+ {"version":3,"file":"alert-notification-policy.d.ts","sourceRoot":"","sources":["../src/alert-notification-policy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,sBAAsB;;;kBAKxB,CAAC;AAEZ,eAAO,MAAM,sBAAsB;;;;;;;;;;;;oBAGjC,CAAC;AACH,eAAO,MAAM,wBAAwB;;;;;;kBAE1B,CAAC;AACZ,eAAO,MAAM,wBAAwB;;;;;;kBAE1B,CAAC;AAEZ;0FAC0F;AAC1F,wBAAgB,uBAAuB,CAAC,KAAK,EAAE;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,eAAe,EAAE,MAAM,CAAC;IACxB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,GAAG;IAAE,gBAAgB,EAAE,MAAM,CAAC;IAAC,gBAAgB,EAAE,MAAM,CAAC;IAAC,0BAA0B,EAAE,MAAM,CAAA;CAAE,CAoB7F;AAED,sFAAsF;AACtF,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,EAC7C,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC5B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAUzB"}
@@ -8,7 +8,7 @@ export const AlertEmailConfigSchema = z
8
8
  const cooldownScope = z.enum(["incident", "project"]).optional();
9
9
  export const AlertSlackConfigSchema = z.union([
10
10
  z.object({ webhook_url: z.string().url().max(2000), cooldown_scope: cooldownScope }).strict(),
11
- z.object({ slack_destination_id: z.string().uuid(), cooldown_scope: cooldownScope }).strict()
11
+ z.object({ slack_destination_id: z.string().guid(), cooldown_scope: cooldownScope }).strict()
12
12
  ]);
13
13
  export const AlertDiscordConfigSchema = z
14
14
  .object({ webhook_url: z.string().url().max(2000), cooldown_scope: cooldownScope })