Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 74a59f0

Browse files
MrRefactoringMrRefactoring
authoredJan 2, 2025··
Merge branch 'release/v5.0.0' into feature/esm
2 parents 4449679 + a650eb1 commit 74a59f0

File tree

10 files changed

+893
-1153
lines changed

10 files changed

+893
-1153
lines changed
 

‎CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Jira.js changelog
22

3+
### 4.0.3
4+
5+
- **Bug Fix:** Fixed an issue with the `Users.createUser` method by adding the required `products` property. Thanks to [Appelberg-s](https://github.com/Appelberg-s) for the [fix](https://github.com/MrRefactoring/jira.js/commit/362918093c20036049db334743e2a0f5f41cbcd4#diff-6960050bc2a3d9ffad9eb5e307145969dc4a38eb5434eebf39da545fd18e01b7R12).
6+
- **Documentation Update:** Corrected an error in `README.md`. Thanks to [Maurice de Bruyn](https://github.com/ueberBrot) for the [contribution](https://github.com/MrRefactoring/jira.js/commit/fb6151e1a0c7953b9447aaaf99caea5c2f93bb96).
7+
- **Dependencies:** Updated all dependencies to their latest versions.
8+
39
### 4.0.2
410

511
- `getAllProjects` in README and examples replaced to `searchProjects`. Thanks to [Alexander Pivovarov](https://github.com/bladerunner2020) for reporting [the issue](https://github.com/MrRefactoring/jira.js/issues/323).

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ If the original error is required, you can get it from the `cause` property of t
140140
try {
141141
const users = await this.client.userSearch.findUsers({ query: email });
142142
// ...
143-
} catch (error: uknown) {
143+
} catch (error: unknown) {
144144
if (error instanceof HttpException) {
145145
console.log(error.message);
146146
console.log(error.cause); // original error (AxiosError | Error)

‎assets/favicon.svg

+15
Loading

‎package-lock.json

+838-1,109
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+6-22
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "jira.js",
3-
"version": "4.0.2",
3+
"version": "4.0.3",
44
"description": "A comprehensive JavaScript/TypeScript library designed for both Node.JS and browsers, facilitating seamless interaction with the Atlassian Jira API.",
55
"main": "out/index.cjs",
66
"types": "out/index.d.ts",
@@ -34,7 +34,7 @@
3434
"lint:src:files": "npm run lint:base -- src/*.ts",
3535
"lint:base": "eslint --ext .ts",
3636
"lint:fix": "npm run lint:tests -- --fix && npm run lint:examples -- --fix && npm run lint:src:agile -- --fix && npm run lint:src:clients -- --fix && npm run lint:src:services -- --fix && npm run lint:src:version2 -- --fix && npm run lint:src:version3 -- --fix && npm run lint:src:serviceDesk -- --fix && npm run lint:src:files -- --fix",
37-
"doc": "typedoc --name \"Jira.js - Jira Cloud API library\" --out docs ./src/index.ts --plugin typedoc-plugin-extras --footerDate --footerTime --footerTypedocVersion --favicon https://svgshare.com/i/bHF.svg",
37+
"doc": "typedoc --name \"Jira.js - Jira Cloud API library\" --out docs ./src/index.ts --favicon ./assets/favicon.svg",
3838
"test": "npm run test:unit && npm run test:integration",
3939
"test:unit": "vitest run tests/unit --maxWorkers=8 --sequence.concurrent",
4040
"test:integration": "vitest run tests/integration --bail=1 --no-file-parallelism --max-concurrency 1 -c vitest.config.mts --hookTimeout 100000 --testTimeout 100000",
@@ -54,32 +54,16 @@
5454
"code:formatting": "npm run replace:all && npm run prettier && npm run lint:fix"
5555
},
5656
"devDependencies": {
57-
"@rollup/plugin-typescript": "^11.1.6",
58-
"@swc-node/register": "^1.9.1",
59-
"@swc/helpers": "^0.5.11",
60-
"@types/node": "^18.19.33",
6157
"@types/sinon": "^17.0.3",
62-
"@typescript-eslint/eslint-plugin": "^8.6.0",
63-
"@typescript-eslint/parser": "^8.6.0",
64-
"dotenv": "^16.4.5",
58+
"@typescript-eslint/eslint-plugin": "^8.19.0",
59+
"@typescript-eslint/parser": "^8.19.0",
60+
"dotenv": "^16.4.7",
6561
"eslint": "^8.57.1",
6662
"eslint-config-airbnb-base": "^15.0.0",
67-
"eslint-config-prettier": "^9.1.0",
68-
"eslint-import-resolver-typescript": "^3.6.3",
69-
"eslint-plugin-import": "^2.30.0",
70-
"prettier": "^3.3.3",
71-
"prettier-plugin-jsdoc": "^1.3.0",
72-
"rollup": "^4.18.0",
73-
"sinon": "^19.0.2",
74-
"typedoc": "^0.26.10",
75-
"typedoc-plugin-extras": "^3.1.0",
76-
"typescript": "^5.6.3",
77-
"vite-tsconfig-paths": "^5.0.1",
78-
"vitest": "^2.1.3"
7963
},
8064
"dependencies": {
8165
"axios": "^1.7.7",
82-
"form-data": "^4.0.0",
66+
"formdata-node": "^6.0.3",
8367
"tslib": "^2.7.0"
8468
},
8569
"type": "module"

‎src/serviceDesk/serviceDesk.ts

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import FormData from 'form-data';
2-
import * as Models from './models/index.js';
3-
import * as Parameters from './parameters/index.js';
4-
import type { Callback } from '../callback.js';
5-
import type { Client } from '../clients/index.js';
6-
import type { RequestConfig } from '../requestConfig.js';
1+
import { FormData } from 'formdata-node';
2+
import * as Models from './models';
3+
import * as Parameters from './parameters';
4+
import { Callback } from '../callback';
5+
import { Client } from '../clients';
6+
import { RequestConfig } from '../requestConfig';
77

88
export class ServiceDesk {
99
constructor(private client: Client) {}
@@ -124,7 +124,6 @@ export class ServiceDesk {
124124
headers: {
125125
'X-Atlassian-Token': 'no-check',
126126
'Content-Type': 'multipart/form-data',
127-
...formData.getHeaders?.(),
128127
},
129128
data: formData,
130129
};

‎src/version2/issueAttachments.ts

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import FormData from 'form-data';
2-
import type { Callback } from '../callback.js';
3-
import type { Client } from '../clients/index.js';
4-
import type { RequestConfig } from '../requestConfig.js';
5-
import * as Models from './models/index.js';
6-
import * as Parameters from './parameters/index.js';
1+
import { FormData } from 'formdata-node';
2+
import * as Models from './models';
3+
import * as Parameters from './parameters';
4+
import { Callback } from '../callback';
5+
import { Client } from '../clients';
6+
import { RequestConfig } from '../requestConfig';
77

88
export class IssueAttachments {
99
constructor(private client: Client) {}
@@ -433,7 +433,6 @@ export class IssueAttachments {
433433
headers: {
434434
'X-Atlassian-Token': 'no-check',
435435
'Content-Type': 'multipart/form-data',
436-
...formData.getHeaders?.(),
437436
},
438437
data: formData,
439438
maxBodyLength: Infinity,

‎src/version3/issueAttachments.ts

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
import FormData from 'form-data';
2-
import type { Callback } from '../callback.js';
3-
import type { Client } from '../clients/index.js';
4-
import type { RequestConfig } from '../requestConfig.js';
5-
import * as Models from './models/index.js';
6-
import * as Parameters from './parameters/index.js';
1+
import { FormData } from 'formdata-node';
2+
import * as Models from './models';
3+
import * as Parameters from './parameters';
4+
import { Callback } from '../callback';
5+
import { Client } from '../clients';
6+
import { RequestConfig } from '../requestConfig';
77

88
export class IssueAttachments {
99
constructor(private client: Client) {}
@@ -433,7 +433,6 @@ export class IssueAttachments {
433433
headers: {
434434
'X-Atlassian-Token': 'no-check',
435435
'Content-Type': 'multipart/form-data',
436-
...formData.getHeaders?.(),
437436
},
438437
data: formData,
439438
maxBodyLength: Infinity,

‎src/version3/models/newUserDetails.ts

+6
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,10 @@ export interface NewUserDetails {
44
self?: string;
55
/** The email address for the user. */
66
emailAddress: string;
7+
/**
8+
* Products the new user has access to. Valid products are: jira-core, jira-servicedesk, jira-product-discovery,
9+
* jira-software. To create a user without product access, set this field to be an empty array. Defaults to
10+
* ['jira-core', 'jira-servicedesk', 'jira-product-discovery', 'jira-software'].
11+
*/
12+
products?: ('jira-core' | 'jira-servicedesk' | 'jira-product-discovery' | 'jira-software' | string)[];
713
}

‎src/version3/users.ts

+3
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@ export class Users {
7373
method: 'POST',
7474
data: {
7575
emailAddress: parameters.emailAddress,
76+
products: parameters.products
77+
? parameters.products
78+
: ['jira-core', 'jira-servicedesk', 'jira-product-discovery', 'jira-software'],
7679
self: parameters.self,
7780
},
7881
};

0 commit comments

Comments
 (0)
Please sign in to comment.