@chaos-maker/core 0.3.0 → 0.5.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 (33) hide show
  1. package/README.md +151 -11
  2. package/dist/chaos-config.schema.json +1314 -0
  3. package/dist/chaos-config.schema.notes.md +32 -0
  4. package/dist/chaos-maker.cjs +128 -4
  5. package/dist/chaos-maker.js +3839 -2017
  6. package/dist/chaos-maker.umd.js +128 -4
  7. package/dist/sw.js +1 -0
  8. package/dist/sw.mjs +1074 -0
  9. package/dist/types/ChaosMaker.d.ts +60 -1
  10. package/dist/types/builder.d.ts +37 -1
  11. package/dist/types/config.d.ts +141 -18
  12. package/dist/types/debug.d.ts +58 -0
  13. package/dist/types/errors.d.ts +14 -2
  14. package/dist/types/events.d.ts +65 -1
  15. package/dist/types/graphql.d.ts +54 -0
  16. package/dist/types/groups.d.ts +71 -0
  17. package/dist/types/index.d.ts +34 -5
  18. package/dist/types/interceptors/domAssailant.d.ts +2 -1
  19. package/dist/types/interceptors/eventSource.d.ts +42 -0
  20. package/dist/types/interceptors/networkFetch.d.ts +2 -1
  21. package/dist/types/interceptors/networkXHR.d.ts +2 -1
  22. package/dist/types/interceptors/websocket.d.ts +4 -3
  23. package/dist/types/presets.d.ts +63 -2
  24. package/dist/types/sw-bridge-source.d.ts +20 -0
  25. package/dist/types/sw.d.ts +104 -0
  26. package/dist/types/transport.d.ts +21 -0
  27. package/dist/types/utils.d.ts +46 -1
  28. package/dist/types/validation-deprecation.d.ts +7 -0
  29. package/dist/types/validation-format.d.ts +10 -0
  30. package/dist/types/validation-strip.d.ts +11 -0
  31. package/dist/types/validation-types.d.ts +34 -0
  32. package/dist/types/validation.d.ts +52 -0
  33. package/package.json +13 -6
package/dist/chaos-config.schema.notes.md ADDED
@@ -0,0 +1,32 @@
1
+ # Chaos Config JSON Schema — parity caveats
2
+
3
+ This file ships beside `chaos-config.schema.json`. The JSON Schema artifact is
4
+ generated from the canonical Zod schemas via `zod-to-json-schema`. Use it for:
5
+
6
+ - IDE autocomplete via `"$schema": "./chaos-config.schema.json"` in JSON
7
+ configs.
8
+ - External pre-commit linters that consume JSON Schema.
9
+ - Reference documentation for tools that cannot import a JS module.
10
+
11
+ **The runtime canonical validator is always `validateChaosConfig` from
12
+ `@chaos-maker/core`.** Do not use the JSON Schema as the sole validator
13
+ before injecting a config — Zod refinements that cannot translate to JSON
14
+ Schema will silently pass under JSON Schema and throw at runtime.
15
+
16
+ ## Refinements that do NOT translate
17
+
18
+ | Zod refinement | JSON Schema fate |
19
+ |---|---|
20
+ | `groupConfigList.superRefine` (duplicate group names after `.trim()`) | dropped — JSON Schema cannot express "duplicate after normalization". |
21
+ | `mutuallyExclusiveCounting` (`onNth` / `everyNth` / `afterN` mutual exclusion) | weakly approximated; some edge cases pass JSON Schema but fail Zod. |
22
+ | WebSocket close-code refinement (`1000` or `3000-4999`) | translated as ranges; verify with the runtime validator. |
23
+ | WebSocket `reason` UTF-8 byte length `<= 123` | dropped — JSON Schema string length counts code points, not UTF-8 bytes. |
24
+ | GraphQL operation RegExp `/g` / `/y` flag rejection | dropped — JSON Schema has no RegExp-flag introspection. |
25
+ | `graphqlOperation` accepting `RegExp` instances | rendered as `string` only; RegExp is not a JSON Schema type. |
26
+ | Preset-name `.trim()` deduplication (`presets` array transform) | dropped — schema represents input shape only. |
27
+
28
+ ## Recommended workflow
29
+
30
+ 1. Use the JSON Schema for IDE / `"$schema"` references and external linters.
31
+ 2. Use `validateChaosConfig` for actual gating in CI and at runtime.
32
+ 3. Treat any divergence as expected — fix the runtime, not the artifact.