Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mossop/bugzilla-ts
A NodeJS module to access Bugzilla instances through the REST API.
https://github.com/mossop/bugzilla-ts
api bugzilla javascript typescript
Last synced: 26 days ago
JSON representation
A NodeJS module to access Bugzilla instances through the REST API.
- Host: GitHub
- URL: https://github.com/mossop/bugzilla-ts
- Owner: Mossop
- License: mit
- Created: 2021-02-18T16:24:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-13T06:58:31.000Z (over 1 year ago)
- Last Synced: 2023-03-13T23:25:25.841Z (over 1 year ago)
- Topics: api, bugzilla, javascript, typescript
- Language: TypeScript
- Homepage:
- Size: 1.18 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Bugzilla | [](https://www.npmjs.com/package/bugzilla) [](https://github.com/Mossop/bugzilla-ts/actions/workflows/build.yml) [](https://codecov.io/gh/Mossop/bugzilla-ts)
Typesafe access to [Bugzilla's REST API](https://bugzilla.readthedocs.io/en/latest/api/index.html).
Very early work in progress, getting info from a bug or searching bugs is the main priority right
now.
# Tests
Some basic tests now exist. `npm test` will run the main tests. `npm run itest` will run some
integration tests against a real Bugzilla instance however you must have docker installed
in order to run these.
# API
## Creating the API instance
```javascript
import BugzillaAPI from "bugzilla";
let api = new BugzillaAPI("https://bugzilla.mozilla.org", "");
await api.version();
```
Or for username/password authentication:
```javascript
import BugzillaAPI from "bugzilla";
let api = new BugzillaAPI(
"https://bugzilla.mozilla.org",
"",
"",
);
await api.version();
```
## Retrieving bugs by ID
```javascript
let bugs = await api.getBugs([123456, 123457]);
```
## Querying bugs
You can use a `quicksearch` string:
```javascript
let bugs = await api.quicksearch("severity:blocker,critical");
```
Or any advanced search which can be passed in a number of ways:
```javascript
// You can just pass a full advanced search url:
let bugs = await api.advancedSearch(
"https://bugzilla.mozilla.org/buglist.cgi?email1=dtownsend%40mozilla.com&emailassigned_to1=1&resolution=---&emailtype1=exact&list_id=15603348",
);
// Or just the query string part:
let bugs = await api.advancedSearch(
"email1=dtownsend%40mozilla.com&emailassigned_to1=1&resolution=---&emailtype1=exact&list_id=15603348",
);
// Or as a record:
let bugs = await api.advancedSearch({
email1: "[email protected]",
emailassigned_to1: "1",
resolution: "---",
emailtype1: "exact",
});
```
## Filtering bug fields
To reduce bandwidth or improve performance it is possible to filter the fields returned by functions
that return bugs:
```javascript
// To only retrieve certain fields.
let bug = await api.getBugs([123456]).include(["id", "product", "component"]);
// Or to filter out certain fields.
let bug = await api.getBugs([123456]).exclude(["cc_detail"]);
```
Assuming you use a static array the returned types will correctly reflect to available fields.
Currently the `_all`, `_default`, `_extra` and `_custom` special field shortcuts are not currently
supported.
Custom fields are not currently returned.
## Retrieving comments by ID
```javascript
// .getComment() accepts one parameter, ID of comment, as number
let comment = await api.getComment(123456);
```
Return value is Comment object.
## Retrieving all comments of bug
```javascript
// .getBugComments() accepts one parameter, ID of bug, as number
let comments = await api.getBugComments(123456);
```
Return value is array of Comment objects.
## Creating comments
```javascript
let comment = await api.createComment(
123456,
"This is new comment on bug #123456",
{ is_private: false },
);
```
Returned value is ID of the newly-created comment.
## Creating bugs
```javascript
let bug = await api.createBug({
product: "TestProduct",
component: "TestComponent",
version: "unspecified",
summary: "'This is a test bug - please disregard",
alias: "SomeAlias",
op_sys: "All",
priority: "P1",
rep_platform: "All",
});
```
Returned value is ID of the newly-created bug.
## Updating bugs
Example of adding email address on cc list of bug #123456:
```javascript
let response = await api.updateBug(123456, {
id_or_alias: 123456,
cc: { add: "[email protected]" },
});
```
Returned value is same as described in Bugzilla [docs](https://bugzilla.readthedocs.io/en/latest/api/core/v1/bug.html#update-bug).
## Retrieving attachments by ID
```javascript
// .getAttachment() accepts one parameter, ID of attachment, as number
let attachment = await api.getAttachment(123456);
```
Return value is Attachment object.
## Retrieving all attachments of bug
```javascript
// .getBugsAttachments() accepts one parameter, ID of bug, as number
let attachments = await api.getBugAttachments(123456);
```
Return value is array of Attachment objects.
## Creating attachments
```javascript
let attachment = await api.createAttachment(123456, {
ids: [123456, 123457];
data: Buffer.from('Attachment content');
file_name: "Attachment name";
summary: "Attachment summary";
content_type: "text/plain";
is_private?: false;
});
```
Returned value is an array of IDs of the newly-created attachments.
## Updating attachments
Example of changing content type of attachment #123456:
```javascript
let response = await api.updateAttachment(123456, {
attachment_id: 123456,
content_type: "text/plain",
});
```
Returned value is same as described in Bugzilla [docs](https://bugzilla.readthedocs.io/en/latest/api/core/v1/attachment.html#update-attachment).