@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.
- package/README.md +39 -0
- package/dist/generated/v2.d.ts +7989 -0
- package/dist/generated/v2.d.ts.map +1 -0
- package/dist/generated/v2.js +6 -0
- package/dist/generated/v2.js.map +1 -0
- package/dist/index.d.ts +12 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +11 -0
- package/dist/index.js.map +1 -0
- package/dist/schemas/_paginated.d.ts +16 -0
- package/dist/schemas/_paginated.d.ts.map +1 -0
- package/dist/schemas/_paginated.js +12 -0
- package/dist/schemas/_paginated.js.map +1 -0
- package/dist/schemas/common.d.ts +7 -0
- package/dist/schemas/common.d.ts.map +1 -0
- package/dist/schemas/common.js +12 -0
- package/dist/schemas/common.js.map +1 -0
- package/dist/schemas/enums.d.ts +34 -0
- package/dist/schemas/enums.d.ts.map +1 -0
- package/dist/schemas/enums.js +160 -0
- package/dist/schemas/enums.js.map +1 -0
- package/dist/schemas/index.d.ts +10 -0
- package/dist/schemas/index.d.ts.map +1 -0
- package/dist/schemas/index.js +10 -0
- package/dist/schemas/index.js.map +1 -0
- package/dist/schemas/profiles.d.ts +48 -0
- package/dist/schemas/profiles.d.ts.map +1 -0
- package/dist/schemas/profiles.js +12 -0
- package/dist/schemas/profiles.js.map +1 -0
- package/dist/schemas/projects.d.ts +64 -0
- package/dist/schemas/projects.d.ts.map +1 -0
- package/dist/schemas/projects.js +14 -0
- package/dist/schemas/projects.js.map +1 -0
- package/dist/schemas/runs.d.ts +524 -0
- package/dist/schemas/runs.d.ts.map +1 -0
- package/dist/schemas/runs.js +101 -0
- package/dist/schemas/runs.js.map +1 -0
- package/dist/schemas/selectors.d.ts +308 -0
- package/dist/schemas/selectors.d.ts.map +1 -0
- package/dist/schemas/selectors.js +43 -0
- package/dist/schemas/selectors.js.map +1 -0
- package/dist/schemas/steps.d.ts +22022 -0
- package/dist/schemas/steps.d.ts.map +1 -0
- package/dist/schemas/steps.js +384 -0
- package/dist/schemas/steps.js.map +1 -0
- package/dist/schemas/suites.d.ts +133 -0
- package/dist/schemas/suites.d.ts.map +1 -0
- package/dist/schemas/suites.js +30 -0
- package/dist/schemas/suites.js.map +1 -0
- package/dist/schemas/tests.d.ts +62 -0
- package/dist/schemas/tests.d.ts.map +1 -0
- package/dist/schemas/tests.js +22 -0
- package/dist/schemas/tests.js.map +1 -0
- package/dist/step-error-codes.d.ts +11 -0
- package/dist/step-error-codes.d.ts.map +1 -0
- package/dist/step-error-codes.js +81 -0
- package/dist/step-error-codes.js.map +1 -0
- package/dist/types.d.ts +124 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +7 -0
- package/dist/types.js.map +1 -0
- package/package.json +91 -0
package/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+

|
|
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
|