@bugbug-io/sdk 14.15.1 → 14.17.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.
- package/README.md +30 -6
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4318 -4254
- package/dist/index.js.map +1 -1
- package/dist/modules/tags/tags.d.ts +11 -2
- package/dist/modules/tags/tags.d.ts.map +1 -1
- package/dist/modules/tags/tags.types.d.ts +2 -0
- package/dist/modules/tags/tags.types.d.ts.map +1 -1
- package/dist/services/apiClient/apiClient.d.ts.map +1 -1
- package/dist/services/apiClient/apiClient.utils.d.ts +5 -0
- package/dist/services/apiClient/apiClient.utils.d.ts.map +1 -1
- package/dist/testUtils/fakeFactory.d.ts +6 -1
- package/dist/testUtils/fakeFactory.d.ts.map +1 -1
- package/dist/types/errors.d.ts +7 -3
- package/dist/types/errors.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -81,15 +81,39 @@ Use `bugbug.tests`, `bugbug.suites`, `bugbug.tags`, `bugbug.profiles`, `bugbug.g
|
|
|
81
81
|
### Tags
|
|
82
82
|
|
|
83
83
|
```typescript
|
|
84
|
-
//
|
|
85
|
-
const page = await bugbug.tags.list({ page: 1, pageSize: 50 });
|
|
86
|
-
|
|
87
|
-
// Fetch every tag, including its color and test/suite usage counts
|
|
84
|
+
// All project tags, including colors and test/suite usage counts
|
|
88
85
|
const tags = await bugbug.tags.getAll();
|
|
86
|
+
const tag = await bugbug.tags.get('tag-uuid');
|
|
87
|
+
const created = await bugbug.tags.create({ name: 'smoke', color: '#6D28D9' });
|
|
88
|
+
await bugbug.tags.update(created.id, { name: 'critical' });
|
|
89
|
+
|
|
90
|
+
// Replace the complete direct assignment list, by tag name
|
|
91
|
+
await bugbug.tests.setTags('test-uuid', ['critical']);
|
|
92
|
+
await bugbug.suites.setTags('suite-uuid', ['critical']);
|
|
93
|
+
await bugbug.tests.setRunTags('test-run-uuid', ['critical']);
|
|
94
|
+
await bugbug.suites.setRunTags('suite-run-uuid', []); // inherited tags remain
|
|
95
|
+
|
|
96
|
+
// Only on explicit request: removes the tag and all its assignments project-wide
|
|
97
|
+
await bugbug.tags.delete(created.id);
|
|
89
98
|
```
|
|
90
99
|
|
|
91
|
-
|
|
92
|
-
|
|
100
|
+
List and reuse existing tags before creating new ones. Create only classifications
|
|
101
|
+
requested by the user or included in an approved plan, with a concrete filtering,
|
|
102
|
+
test-selection, or reporting purpose. Tags must not hold agent progress, selectors,
|
|
103
|
+
credentials, or working notes. Read each target before replacing tags to preserve
|
|
104
|
+
unrelated direct assignments. Missing assignment names can create project tags;
|
|
105
|
+
create approved missing tags explicitly first to control their colors.
|
|
106
|
+
|
|
107
|
+
New and changed colors are validated against `TAG_COLOR_PALETTE` (exported with
|
|
108
|
+
`TagColorSchema`); creation defaults to `#6D28D9`. Existing legacy colors remain
|
|
109
|
+
readable and are preserved when renaming without a color. Names are trimmed,
|
|
110
|
+
nonempty, limited to 64 characters, and cannot contain commas or control characters.
|
|
111
|
+
|
|
112
|
+
Renaming or recoloring affects every use, including historical runs. Changing
|
|
113
|
+
parent test/suite assignments does not rewrite earlier runs. Replacing run tags
|
|
114
|
+
changes direct assignments only; inherited tags remain even with an empty list.
|
|
115
|
+
Organization and user API tokens need an active `projectId` in SDK config or a
|
|
116
|
+
linked `bugbug.yaml`.
|
|
93
117
|
|
|
94
118
|
### Tests
|
|
95
119
|
|
package/dist/index.d.ts
CHANGED
|
@@ -55,7 +55,7 @@ export type { GetRunInboxOptions, ImportTestOptions, ListTestRunsOptions, ListTe
|
|
|
55
55
|
export { SuitesModule } from './modules/suites/suites';
|
|
56
56
|
export type { ListSuiteRunsOptions, ListSuitesOptions, RunSuiteBaseOptions, RunSuiteNoWatchProgressOptions, RunSuiteWatchProgressOptions, } from './modules/suites/suites.types';
|
|
57
57
|
export { TagsModule } from './modules/tags/tags';
|
|
58
|
-
export type { TagListItem } from './modules/tags/tags.types';
|
|
58
|
+
export type { TagCreateRequest, TagListItem, TagUpdateRequest } from './modules/tags/tags.types';
|
|
59
59
|
export { ProfilesModule } from './modules/profiles/profiles';
|
|
60
60
|
export { ConfigModule } from './modules/config/config';
|
|
61
61
|
export { GroupsModule } from './modules/groups/groups';
|
|
@@ -84,7 +84,7 @@ export type { RequestOrigin } from './types/errors';
|
|
|
84
84
|
export { SDK_ERROR_CODES } from './constants/sdk-error-codes';
|
|
85
85
|
export type { SdkErrorCode } from './constants/sdk-error-codes';
|
|
86
86
|
export type { ComponentsListQuery, ComponentsListResponse, DebugArtifact, DebugArtifactByType, DebugArtifactType, DebugArtifactsListResponse, Folder, FolderCreateRequest, FolderKind, FoldersListQuery, FoldersListResponse, FolderTreeNode, FolderUpdateRequest, Group, GroupCreateRequest, GroupPartialUpdateRequest, GroupUpdateRequest, GroupsListQuery, GroupsListResponse, ImportFormat, InsertGroup, InsertGroupResponse, IpAddressesResponse, Profile, ProfilesListQuery, ProfilesListResponse, ProjectSettings, RunMode, RunTag, RunTagAssignmentsUpdateRequest, RunSuiteRequest, RunSuiteResponse, RunTestRequest, RunTestResponse, Screenshot, Selector, SelectorsGroup, SelectorsPreset, ScreenSizeType, Status, StepCreateRequest, StepDetails, StepPatchRequest, StepRunDetails, StepSource, StepType, StepUpdateRequest, Suite, SuiteCreateRequest, SuitePartialUpdateRequest, SuiteRun, SuiteRunScreenshotsResponse, SuiteRunsListQuery, SuiteRunState, SuiteRunsListResponse, SuiteSummary, SuiteUpdateRequest, Tag, TagAssignmentsUpdateRequest, SuitesListQuery, SuitesListResponse, Test, TestCreateRequest, TestRun, TestRunScreenshotsResponse, TestRunsListQuery, TestRunState, TestRunsListResponse, TestSummary, TestUpdateRequest, TestsListQuery, TestsListResponse, UnlinkComponentRequest, UnlinkComponentResponse, UpdateStepPositionRequest, UpdateStepPositionResponse, UpdateStepWaitingCondition, Variable, CreatedVariable, CreateVariableRequest, UpdateVariableRequest, VariablesListResponse, VisualRegressionRefScreenshot, VisualRegressionRefScreenshotCreate, VisualRegressionRefScreenshotPatch, VisualRegressionResolveRequest, VisualRegressionRefScreenshotsListQuery, VisualRegressionRefScreenshotUpdate, VisualRegressionRefScreenshotsListResponse, StepErrorCode, } from '@bugbug-io/api-schema';
|
|
87
|
-
export { CursorSchema, DebugArtifactByTypeSchema, PageSizeSchema, RUN_MODES, RunModeSchema, SelectorsPresetSchema, ScreenSizeTypeSchema, StatusSchema, StepCreateSchema, StepErrorCodeSchema, StepSchema, StepTypeSchema, StepUpdateSchema, UuidSchema, } from '@bugbug-io/api-schema/schemas';
|
|
87
|
+
export { CursorSchema, DebugArtifactByTypeSchema, PageSizeSchema, RUN_MODES, RunModeSchema, SelectorsPresetSchema, ScreenSizeTypeSchema, StatusSchema, StepCreateSchema, StepErrorCodeSchema, StepSchema, StepTypeSchema, StepUpdateSchema, UuidSchema, TAG_COLOR_PALETTE, TagColorSchema, TagCreateSchema, TagNameSchema, TagNamesSchema, TagUpdateSchema, } from '@bugbug-io/api-schema/schemas';
|
|
88
88
|
export { STEP_ERROR_CODES } from '@bugbug-io/api-schema';
|
|
89
89
|
export type { ConnectivityStatus, SdkSystemInfo } from './types/sdk';
|
|
90
90
|
export { isCompletedStatus, isEditingStatus, isFailedStatus, isPassedStatus, isRunningStatus, } from './types/sdk';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,GAAG,SAAS,CAE5D;AAED,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,YAAY,EACV,YAAY,EACZ,cAAc,EACd,WAAW,EACX,WAAW,EACX,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AAExB,YAAY,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,YAAY,EACV,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,6BAA6B,EAC7B,2BAA2B,GAC5B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,YAAY,EACV,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,8BAA8B,EAC9B,4BAA4B,GAC7B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,YAAY,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,YAAY,GAAG,SAAS,CAE5D;AAED,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,YAAY,EACV,YAAY,EACZ,cAAc,EACd,WAAW,EACX,WAAW,EACX,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AAExB,YAAY,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,YAAY,EACV,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,kBAAkB,EAClB,6BAA6B,EAC7B,2BAA2B,GAC5B,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,YAAY,EACV,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,8BAA8B,EAC9B,4BAA4B,GAC7B,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,YAAY,EAAE,gBAAgB,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AACjG,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAC;AACrF,YAAY,EACV,eAAe,EACf,4BAA4B,GAC7B,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,YAAY,EACV,OAAO,EACP,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,YAAY,EACV,qBAAqB,EACrB,qBAAqB,GACtB,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,6CAA6C,CAAC;AACrF,OAAO,EACL,oCAAoC,EACpC,2CAA2C,GAC5C,MAAM,uDAAuD,CAAC;AAC/D,YAAY,EAAE,gCAAgC,EAAE,MAAM,uDAAuD,CAAC;AAC9G,YAAY,EACV,8BAA8B,EAC9B,+BAA+B,EAC/B,6BAA6B,GAC9B,MAAM,mDAAmD,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,YAAY,EACV,mBAAmB,EACnB,qBAAqB,EACrB,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,0BAA0B,EAC1B,0BAA0B,EAC1B,kCAAkC,GACnC,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,wBAAwB,EACxB,uBAAuB,EACvB,gBAAgB,GACjB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACL,oBAAoB,EACpB,4BAA4B,EAC5B,mBAAmB,EACnB,0BAA0B,GAC3B,MAAM,6BAA6B,CAAC;AAErC,OAAO,EACL,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,qBAAqB,EACrB,aAAa,EACb,cAAc,EACd,YAAY,EACZ,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,EACnB,uBAAuB,EACvB,uBAAuB,EACvB,SAAS,EACT,aAAa,EACb,qBAAqB,EACrB,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,uBAAuB,EACvB,eAAe,EACf,gBAAgB,EAChB,cAAc,EACd,cAAc,EACd,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,yBAAyB,EACzB,WAAW,GACZ,MAAM,gBAAgB,CAAC;AACxB,YAAY,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,YAAY,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAIhE,YAAY,EACV,mBAAmB,EACnB,sBAAsB,EACtB,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,0BAA0B,EAC1B,MAAM,EACN,mBAAmB,EACnB,UAAU,EACV,gBAAgB,EAChB,mBAAmB,EACnB,cAAc,EACd,mBAAmB,EACnB,KAAK,EACL,kBAAkB,EAClB,yBAAyB,EACzB,kBAAkB,EAClB,eAAe,EACf,kBAAkB,EAClB,YAAY,EACZ,WAAW,EACX,mBAAmB,EACnB,mBAAmB,EACnB,OAAO,EACP,iBAAiB,EACjB,oBAAoB,EACpB,eAAe,EACf,OAAO,EACP,MAAM,EACN,8BAA8B,EAC9B,eAAe,EACf,gBAAgB,EAChB,cAAc,EACd,eAAe,EACf,UAAU,EACV,QAAQ,EACR,cAAc,EACd,eAAe,EACf,cAAc,EACd,MAAM,EACN,iBAAiB,EACjB,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,UAAU,EACV,QAAQ,EACR,iBAAiB,EACjB,KAAK,EACL,kBAAkB,EAClB,yBAAyB,EACzB,QAAQ,EACR,2BAA2B,EAC3B,kBAAkB,EAClB,aAAa,EACb,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,GAAG,EACH,2BAA2B,EAC3B,eAAe,EACf,kBAAkB,EAClB,IAAI,EACJ,iBAAiB,EACjB,OAAO,EACP,0BAA0B,EAC1B,iBAAiB,EACjB,YAAY,EACZ,oBAAoB,EACpB,WAAW,EACX,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,0BAA0B,EAC1B,QAAQ,EACR,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACrB,6BAA6B,EAC7B,mCAAmC,EACnC,kCAAkC,EAClC,8BAA8B,EAC9B,uCAAuC,EACvC,mCAAmC,EACnC,0CAA0C,EAC1C,aAAa,GACd,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,YAAY,EACZ,yBAAyB,EACzB,cAAc,EACd,SAAS,EACT,aAAa,EACb,qBAAqB,EACrB,oBAAoB,EACpB,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,UAAU,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,aAAa,EACb,cAAc,EACd,eAAe,GAChB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAGzD,YAAY,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACrE,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,cAAc,EACd,eAAe,GAChB,MAAM,aAAa,CAAC"}
|