@bugbug-io/api-schema 13.39.1

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 (62) hide show
  1. package/README.md +39 -0
  2. package/dist/generated/v2.d.ts +7989 -0
  3. package/dist/generated/v2.d.ts.map +1 -0
  4. package/dist/generated/v2.js +6 -0
  5. package/dist/generated/v2.js.map +1 -0
  6. package/dist/index.d.ts +12 -0
  7. package/dist/index.d.ts.map +1 -0
  8. package/dist/index.js +11 -0
  9. package/dist/index.js.map +1 -0
  10. package/dist/schemas/_paginated.d.ts +16 -0
  11. package/dist/schemas/_paginated.d.ts.map +1 -0
  12. package/dist/schemas/_paginated.js +12 -0
  13. package/dist/schemas/_paginated.js.map +1 -0
  14. package/dist/schemas/common.d.ts +7 -0
  15. package/dist/schemas/common.d.ts.map +1 -0
  16. package/dist/schemas/common.js +12 -0
  17. package/dist/schemas/common.js.map +1 -0
  18. package/dist/schemas/enums.d.ts +34 -0
  19. package/dist/schemas/enums.d.ts.map +1 -0
  20. package/dist/schemas/enums.js +160 -0
  21. package/dist/schemas/enums.js.map +1 -0
  22. package/dist/schemas/index.d.ts +10 -0
  23. package/dist/schemas/index.d.ts.map +1 -0
  24. package/dist/schemas/index.js +10 -0
  25. package/dist/schemas/index.js.map +1 -0
  26. package/dist/schemas/profiles.d.ts +48 -0
  27. package/dist/schemas/profiles.d.ts.map +1 -0
  28. package/dist/schemas/profiles.js +12 -0
  29. package/dist/schemas/profiles.js.map +1 -0
  30. package/dist/schemas/projects.d.ts +64 -0
  31. package/dist/schemas/projects.d.ts.map +1 -0
  32. package/dist/schemas/projects.js +14 -0
  33. package/dist/schemas/projects.js.map +1 -0
  34. package/dist/schemas/runs.d.ts +524 -0
  35. package/dist/schemas/runs.d.ts.map +1 -0
  36. package/dist/schemas/runs.js +101 -0
  37. package/dist/schemas/runs.js.map +1 -0
  38. package/dist/schemas/selectors.d.ts +308 -0
  39. package/dist/schemas/selectors.d.ts.map +1 -0
  40. package/dist/schemas/selectors.js +43 -0
  41. package/dist/schemas/selectors.js.map +1 -0
  42. package/dist/schemas/steps.d.ts +22022 -0
  43. package/dist/schemas/steps.d.ts.map +1 -0
  44. package/dist/schemas/steps.js +384 -0
  45. package/dist/schemas/steps.js.map +1 -0
  46. package/dist/schemas/suites.d.ts +133 -0
  47. package/dist/schemas/suites.d.ts.map +1 -0
  48. package/dist/schemas/suites.js +30 -0
  49. package/dist/schemas/suites.js.map +1 -0
  50. package/dist/schemas/tests.d.ts +62 -0
  51. package/dist/schemas/tests.d.ts.map +1 -0
  52. package/dist/schemas/tests.js +22 -0
  53. package/dist/schemas/tests.js.map +1 -0
  54. package/dist/step-error-codes.d.ts +11 -0
  55. package/dist/step-error-codes.d.ts.map +1 -0
  56. package/dist/step-error-codes.js +81 -0
  57. package/dist/step-error-codes.js.map +1 -0
  58. package/dist/types.d.ts +124 -0
  59. package/dist/types.d.ts.map +1 -0
  60. package/dist/types.js +7 -0
  61. package/dist/types.js.map +1 -0
  62. package/package.json +91 -0
package/README.md ADDED
@@ -0,0 +1,39 @@
1
+ <div align="center">
2
+
3
+ ![BugBug Logo](https://bugbug.io/favicon-96x96.png)
4
+
5
+ # BugBug API Schema
6
+
7
+ **Generated API types and schemas for BugBug**
8
+
9
+ TypeScript types and Zod schemas for the [BugBug](https://bugbug.io) API, generated from the OpenAPI specification.
10
+
11
+ </div>
12
+
13
+ ## Features
14
+
15
+ - **OpenAPI-derived types**: TypeScript types generated from the BugBug API schema
16
+ - **Zod schemas**: Runtime validation for tests, suites, runs, profiles, steps, selectors, and enums
17
+ - **Single source of truth**: Shared contracts consumed by the SDK, CLI, and MCP server
18
+
19
+ ## Schemas
20
+
21
+ Import grouped schemas via subpath exports:
22
+
23
+ - `@bugbug-io/api-schema/schemas/steps`
24
+ - `@bugbug-io/api-schema/schemas/selectors`
25
+ - `@bugbug-io/api-schema/schemas/tests`
26
+ - `@bugbug-io/api-schema/schemas/suites`
27
+ - `@bugbug-io/api-schema/schemas/profiles`
28
+ - `@bugbug-io/api-schema/schemas/runs`
29
+ - `@bugbug-io/api-schema/schemas/enums`
30
+
31
+ ## Syncing
32
+
33
+ Regenerate types and schemas from the API:
34
+
35
+ - `npm run sync` — sync OpenAPI schema from production
36
+ - `npm run sync:stage` — sync from staging
37
+ - `npm run sync:dev` — sync from local backend
38
+ - `npm run sync:step-error-codes` — sync step error codes
39
+ - `npm run sync:all` — sync everything