Skip to content

Commit 5d9a19b

Browse files
MrRefactoringMrRefactoring
authored
v2.17.0: API Updates (MrRefactoring#255)
* Updates for Version 2 API * dependencies updates * Version 3 API updates * v2.17.0
1 parent a3b7bad commit 5d9a19b

File tree

96 files changed

+1668
-431
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+1668
-431
lines changed

‎CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# Jira.js changelog
22

3+
### 2.17.0
4+
5+
- JSDoc improvements
6+
- Version 2, Version 3:
7+
- `Component` interface renamed to `ProjectComponent`.
8+
- `caseInsensitive` property added to `findGroups` method of `groups` API.
9+
- `expand` property added to `getTrashedFieldsPaginated` method of `issueFields` API.
10+
- `createNotificationScheme`, `getNotificationSchemeToProjectMappings`, `updateNotificationScheme`, `addNotifications`, `deleteNotificationScheme`, `removeNotificationFromNotificationScheme` methods added to `issueNotificationSchemes` API.
11+
- `getPrecomputations`, `updatePrecomputations` methods added to `jql` API.
12+
- `licenseMetrics` API added.
13+
- `ProjectFeatures` interface renamed to `ContainerForProjectFeatures`.
14+
315
### 2.16.1
416

517
- Agile

‎README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -344,6 +344,7 @@ Available groups:
344344
- [jiraSettings](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-jira-settings/#api-group-jira-settings)
345345
- [jql](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-jql/#api-group-jql)
346346
- [labels](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-labels/#api-group-labels)
347+
- [licenseMetrics](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-license-metrics/#api-group-license-metrics)
347348
- [myself](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-myself/#api-group-myself)
348349
- [permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-permissions/#api-group-permissions)
349350
- [permissionSchemes](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-permission-schemes/#api-group-permission-schemes)
@@ -433,6 +434,7 @@ Available groups:
433434
- [jiraSettings](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings/#api-group-jira-settings)
434435
- [jql](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql/#api-group-jql)
435436
- [labels](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels/#api-group-labels)
437+
- [licenseMetrics](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics/#api-group-license-metrics)
436438
- [myself](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-myself/#api-group-myself)
437439
- [permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions/#api-group-permissions)
438440
- [permissionSchemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#api-group-permission-schemes)

‎package-lock.json

Lines changed: 269 additions & 216 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "jira.js",
3-
"version": "2.16.1",
3+
"version": "2.17.0",
44
"description": "jira.js is a powerful Node.JS/Browser module that allows you to interact with the Jira API very easily",
55
"main": "out/index.js",
66
"types": "out/index.d.ts",
@@ -51,28 +51,29 @@
5151
}
5252
},
5353
"devDependencies": {
54-
"@swc-node/register": "1.5.5",
54+
"@swc-node/register": "^1.6.2",
55+
"@swc/helpers": "^0.4.14",
5556
"@types/express": "^4.17.17",
56-
"@types/node": "^18.14.6",
57+
"@types/node": "^18.15.10",
5758
"@types/oauth": "^0.9.1",
5859
"@types/sinon": "^10.0.13",
59-
"@typescript-eslint/eslint-plugin": "^5.54.0",
60-
"@typescript-eslint/parser": "^5.54.0",
60+
"@typescript-eslint/eslint-plugin": "^5.56.0",
61+
"@typescript-eslint/parser": "^5.56.0",
6162
"ava": "^5.2.0",
6263
"dotenv": "^16.0.3",
63-
"eslint": "^8.35.0",
64+
"eslint": "^8.36.0",
6465
"eslint-config-airbnb": "^19.0.4",
6566
"eslint-config-airbnb-typescript": "^17.0.0",
6667
"eslint-import-resolver-typescript": "^3.5.3",
6768
"eslint-plugin-import": "^2.27.5",
6869
"eslint-plugin-sort-exports": "^0.8.0",
69-
"prettier": "^2.8.4",
70+
"prettier": "^2.8.7",
7071
"prettier-plugin-jsdoc": "^0.4.2",
71-
"sinon": "^15.0.1",
72+
"sinon": "^15.0.3",
7273
"ts-node": "^10.9.1",
73-
"typedoc": "^0.23.26",
74+
"typedoc": "^0.23.28",
7475
"typedoc-plugin-extras": "^2.3.2",
75-
"typescript": "^4.9.5"
76+
"typescript": "^5.0.2"
7677
},
7778
"dependencies": {
7879
"atlassian-jwt": "^2.0.2",

‎src/version2/appProperties.ts

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ export class AppProperties {
1111
* Gets all the properties of an app.
1212
*
1313
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** Only a
14-
* Connect app whose key matches `addonKey` can make this request.
14+
* Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps published on the
15+
* Marketplace can access properties of Connect apps they were [migrated
16+
* from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).
1517
*/
1618
async getAddonProperties<T = Models.PropertyKeys>(
1719
parameters: Parameters.GetAddonProperties | string,
@@ -21,7 +23,9 @@ export class AppProperties {
2123
* Gets all the properties of an app.
2224
*
2325
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** Only a
24-
* Connect app whose key matches `addonKey` can make this request.
26+
* Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps published on the
27+
* Marketplace can access properties of Connect apps they were [migrated
28+
* from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).
2529
*/
2630
async getAddonProperties<T = Models.PropertyKeys>(
2731
parameters: Parameters.GetAddonProperties | string,
@@ -45,7 +49,9 @@ export class AppProperties {
4549
* Returns the key and value of an app's property.
4650
*
4751
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** Only a
48-
* Connect app whose key matches `addonKey` can make this request.
52+
* Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps published on the
53+
* Marketplace can access properties of Connect apps they were [migrated
54+
* from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).
4955
*/
5056
async getAddonProperty<T = Models.EntityProperty>(
5157
parameters: Parameters.GetAddonProperty,
@@ -55,7 +61,9 @@ export class AppProperties {
5561
* Returns the key and value of an app's property.
5662
*
5763
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** Only a
58-
* Connect app whose key matches `addonKey` can make this request.
64+
* Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps published on the
65+
* Marketplace can access properties of Connect apps they were [migrated
66+
* from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).
5967
*/
6068
async getAddonProperty<T = Models.EntityProperty>(
6169
parameters: Parameters.GetAddonProperty,

‎src/version2/client/version2Client.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ import {
4848
JiraSettings,
4949
JQL,
5050
Labels,
51+
LicenseMetrics,
5152
Myself,
5253
Permissions,
5354
PermissionSchemes,
@@ -136,6 +137,7 @@ export class Version2Client extends BaseClient {
136137
jiraSettings = new JiraSettings(this);
137138
jql = new JQL(this);
138139
labels = new Labels(this);
140+
licenseMetrics = new LicenseMetrics(this);
139141
myself = new Myself(this);
140142
permissions = new Permissions(this);
141143
permissionSchemes = new PermissionSchemes(this);

‎src/version2/groups.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,7 @@ export class Groups {
310310
exclude: parameters?.exclude,
311311
excludeId: parameters?.excludeId,
312312
maxResults: parameters?.maxResults,
313+
caseInsensitive: parameters?.caseInsensitive,
313314
userName: parameters?.userName,
314315
},
315316
};

‎src/version2/index.ts

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
export * from './announcementBanner';
2+
export * from './applicationRoles';
23
export * from './appMigration';
34
export * from './appProperties';
4-
export * from './applicationRoles';
55
export * from './auditRecords';
66
export * from './avatars';
77
export * from './dashboards';
88
export * from './dynamicModules';
9-
export * from './filterSharing';
109
export * from './filters';
10+
export * from './filterSharing';
1111
export * from './groupAndUserPicker';
1212
export * from './groups';
1313
export * from './instanceInformation';
@@ -22,33 +22,34 @@ export * from './issueCustomFieldOptionsApps';
2222
export * from './issueCustomFieldValuesApps';
2323
export * from './issueFieldConfigurations';
2424
export * from './issueFields';
25-
export * from './issueLinkTypes';
2625
export * from './issueLinks';
26+
export * from './issueLinkTypes';
2727
export * from './issueNavigatorSettings';
2828
export * from './issueNotificationSchemes';
2929
export * from './issuePriorities';
3030
export * from './issueProperties';
3131
export * from './issueRemoteLinks';
3232
export * from './issueResolutions';
33+
export * from './issues';
3334
export * from './issueSearch';
3435
export * from './issueSecurityLevel';
3536
export * from './issueSecuritySchemes';
3637
export * from './issueTypeProperties';
38+
export * from './issueTypes';
3739
export * from './issueTypeSchemes';
3840
export * from './issueTypeScreenSchemes';
39-
export * from './issueTypes';
4041
export * from './issueVotes';
4142
export * from './issueWatchers';
4243
export * from './issueWorklogProperties';
4344
export * from './issueWorklogs';
44-
export * from './issues';
45-
export * from './jQL';
4645
export * from './jiraExpressions';
4746
export * from './jiraSettings';
47+
export * from './jQL';
4848
export * from './labels';
49+
export * from './licenseMetrics';
4950
export * from './myself';
50-
export * from './permissionSchemes';
5151
export * from './permissions';
52+
export * from './permissionSchemes';
5253
export * from './projectAvatars';
5354
export * from './projectCategories';
5455
export * from './projectComponents';
@@ -59,30 +60,30 @@ export * from './projectPermissionSchemes';
5960
export * from './projectProperties';
6061
export * from './projectRoleActors';
6162
export * from './projectRoles';
63+
export * from './projects';
6264
export * from './projectTypes';
6365
export * from './projectVersions';
64-
export * from './projects';
66+
export * from './screens';
6567
export * from './screenSchemes';
6668
export * from './screenTabFields';
6769
export * from './screenTabs';
68-
export * from './screens';
6970
export * from './serverInfo';
7071
export * from './status';
7172
export * from './tasks';
7273
export * from './timeTracking';
7374
export * from './uIModificationsApps';
7475
export * from './userProperties';
75-
export * from './userSearch';
7676
export * from './users';
77+
export * from './userSearch';
7778
export * from './webhooks';
79+
export * from './workflows';
7880
export * from './workflowSchemeDrafts';
7981
export * from './workflowSchemeProjectAssociations';
8082
export * from './workflowSchemes';
8183
export * from './workflowStatusCategories';
8284
export * from './workflowStatuses';
8385
export * from './workflowTransitionProperties';
8486
export * from './workflowTransitionRules';
85-
export * from './workflows';
8687

8788
export * as Version2Models from './models';
8889
export * as Version2Parameters from './parameters';

‎src/version2/issueFields.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,7 @@ export class IssueFields {
181181
maxResults: parameters?.maxResults,
182182
id: parameters?.id,
183183
query: parameters?.query,
184+
expand: parameters?.expand,
184185
orderBy: parameters?.orderBy,
185186
},
186187
};

0 commit comments

Comments
 (0)