Skip to content

v2.17.0: API Updates #255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Jira.js changelog

### 2.17.0

- JSDoc improvements
- Version 2, Version 3:
- `Component` interface renamed to `ProjectComponent`.
- `caseInsensitive` property added to `findGroups` method of `groups` API.
- `expand` property added to `getTrashedFieldsPaginated` method of `issueFields` API.
- `createNotificationScheme`, `getNotificationSchemeToProjectMappings`, `updateNotificationScheme`, `addNotifications`, `deleteNotificationScheme`, `removeNotificationFromNotificationScheme` methods added to `issueNotificationSchemes` API.
- `getPrecomputations`, `updatePrecomputations` methods added to `jql` API.
- `licenseMetrics` API added.
- `ProjectFeatures` interface renamed to `ContainerForProjectFeatures`.

### 2.16.1

- Agile
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,7 @@ Available groups:
- [jiraSettings](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-jira-settings/#api-group-jira-settings)
- [jql](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-jql/#api-group-jql)
- [labels](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-labels/#api-group-labels)
- [licenseMetrics](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-license-metrics/#api-group-license-metrics)
- [myself](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-myself/#api-group-myself)
- [permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-permissions/#api-group-permissions)
- [permissionSchemes](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-permission-schemes/#api-group-permission-schemes)
Expand Down Expand Up @@ -433,6 +434,7 @@ Available groups:
- [jiraSettings](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jira-settings/#api-group-jira-settings)
- [jql](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql/#api-group-jql)
- [labels](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-labels/#api-group-labels)
- [licenseMetrics](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics/#api-group-license-metrics)
- [myself](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-myself/#api-group-myself)
- [permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions/#api-group-permissions)
- [permissionSchemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permission-schemes/#api-group-permission-schemes)
Expand Down
485 changes: 269 additions & 216 deletions package-lock.json

Large diffs are not rendered by default.

21 changes: 11 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "jira.js",
"version": "2.16.1",
"version": "2.17.0",
"description": "jira.js is a powerful Node.JS/Browser module that allows you to interact with the Jira API very easily",
"main": "out/index.js",
"types": "out/index.d.ts",
Expand Down Expand Up @@ -51,28 +51,29 @@
}
},
"devDependencies": {
"@swc-node/register": "1.5.5",
"@swc-node/register": "^1.6.2",
"@swc/helpers": "^0.4.14",
"@types/express": "^4.17.17",
"@types/node": "^18.14.6",
"@types/node": "^18.15.10",
"@types/oauth": "^0.9.1",
"@types/sinon": "^10.0.13",
"@typescript-eslint/eslint-plugin": "^5.54.0",
"@typescript-eslint/parser": "^5.54.0",
"@typescript-eslint/eslint-plugin": "^5.56.0",
"@typescript-eslint/parser": "^5.56.0",
"ava": "^5.2.0",
"dotenv": "^16.0.3",
"eslint": "^8.35.0",
"eslint": "^8.36.0",
"eslint-config-airbnb": "^19.0.4",
"eslint-config-airbnb-typescript": "^17.0.0",
"eslint-import-resolver-typescript": "^3.5.3",
"eslint-plugin-import": "^2.27.5",
"eslint-plugin-sort-exports": "^0.8.0",
"prettier": "^2.8.4",
"prettier": "^2.8.7",
"prettier-plugin-jsdoc": "^0.4.2",
"sinon": "^15.0.1",
"sinon": "^15.0.3",
"ts-node": "^10.9.1",
"typedoc": "^0.23.26",
"typedoc": "^0.23.28",
"typedoc-plugin-extras": "^2.3.2",
"typescript": "^4.9.5"
"typescript": "^5.0.2"
},
"dependencies": {
"atlassian-jwt": "^2.0.2",
Expand Down
16 changes: 12 additions & 4 deletions src/version2/appProperties.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ export class AppProperties {
* Gets all the properties of an app.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** Only a
* Connect app whose key matches `addonKey` can make this request.
* Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps published on the
* Marketplace can access properties of Connect apps they were [migrated
* from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).
*/
async getAddonProperties<T = Models.PropertyKeys>(
parameters: Parameters.GetAddonProperties | string,
Expand All @@ -21,7 +23,9 @@ export class AppProperties {
* Gets all the properties of an app.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** Only a
* Connect app whose key matches `addonKey` can make this request.
* Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps published on the
* Marketplace can access properties of Connect apps they were [migrated
* from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).
*/
async getAddonProperties<T = Models.PropertyKeys>(
parameters: Parameters.GetAddonProperties | string,
Expand All @@ -45,7 +49,9 @@ export class AppProperties {
* Returns the key and value of an app's property.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** Only a
* Connect app whose key matches `addonKey` can make this request.
* Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps published on the
* Marketplace can access properties of Connect apps they were [migrated
* from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).
*/
async getAddonProperty<T = Models.EntityProperty>(
parameters: Parameters.GetAddonProperty,
Expand All @@ -55,7 +61,9 @@ export class AppProperties {
* Returns the key and value of an app's property.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** Only a
* Connect app whose key matches `addonKey` can make this request.
* Connect app whose key matches `addonKey` can make this request. Additionally, Forge apps published on the
* Marketplace can access properties of Connect apps they were [migrated
* from](https://developer.atlassian.com/platform/forge/build-a-connect-on-forge-app/).
*/
async getAddonProperty<T = Models.EntityProperty>(
parameters: Parameters.GetAddonProperty,
Expand Down
2 changes: 2 additions & 0 deletions src/version2/client/version2Client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ import {
JiraSettings,
JQL,
Labels,
LicenseMetrics,
Myself,
Permissions,
PermissionSchemes,
Expand Down Expand Up @@ -136,6 +137,7 @@ export class Version2Client extends BaseClient {
jiraSettings = new JiraSettings(this);
jql = new JQL(this);
labels = new Labels(this);
licenseMetrics = new LicenseMetrics(this);
myself = new Myself(this);
permissions = new Permissions(this);
permissionSchemes = new PermissionSchemes(this);
Expand Down
1 change: 1 addition & 0 deletions src/version2/groups.ts
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,7 @@ export class Groups {
exclude: parameters?.exclude,
excludeId: parameters?.excludeId,
maxResults: parameters?.maxResults,
caseInsensitive: parameters?.caseInsensitive,
userName: parameters?.userName,
},
};
Expand Down
23 changes: 12 additions & 11 deletions src/version2/index.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
export * from './announcementBanner';
export * from './applicationRoles';
export * from './appMigration';
export * from './appProperties';
export * from './applicationRoles';
export * from './auditRecords';
export * from './avatars';
export * from './dashboards';
export * from './dynamicModules';
export * from './filterSharing';
export * from './filters';
export * from './filterSharing';
export * from './groupAndUserPicker';
export * from './groups';
export * from './instanceInformation';
Expand All @@ -22,33 +22,34 @@ export * from './issueCustomFieldOptionsApps';
export * from './issueCustomFieldValuesApps';
export * from './issueFieldConfigurations';
export * from './issueFields';
export * from './issueLinkTypes';
export * from './issueLinks';
export * from './issueLinkTypes';
export * from './issueNavigatorSettings';
export * from './issueNotificationSchemes';
export * from './issuePriorities';
export * from './issueProperties';
export * from './issueRemoteLinks';
export * from './issueResolutions';
export * from './issues';
export * from './issueSearch';
export * from './issueSecurityLevel';
export * from './issueSecuritySchemes';
export * from './issueTypeProperties';
export * from './issueTypes';
export * from './issueTypeSchemes';
export * from './issueTypeScreenSchemes';
export * from './issueTypes';
export * from './issueVotes';
export * from './issueWatchers';
export * from './issueWorklogProperties';
export * from './issueWorklogs';
export * from './issues';
export * from './jQL';
export * from './jiraExpressions';
export * from './jiraSettings';
export * from './jQL';
export * from './labels';
export * from './licenseMetrics';
export * from './myself';
export * from './permissionSchemes';
export * from './permissions';
export * from './permissionSchemes';
export * from './projectAvatars';
export * from './projectCategories';
export * from './projectComponents';
Expand All @@ -59,30 +60,30 @@ export * from './projectPermissionSchemes';
export * from './projectProperties';
export * from './projectRoleActors';
export * from './projectRoles';
export * from './projects';
export * from './projectTypes';
export * from './projectVersions';
export * from './projects';
export * from './screens';
export * from './screenSchemes';
export * from './screenTabFields';
export * from './screenTabs';
export * from './screens';
export * from './serverInfo';
export * from './status';
export * from './tasks';
export * from './timeTracking';
export * from './uIModificationsApps';
export * from './userProperties';
export * from './userSearch';
export * from './users';
export * from './userSearch';
export * from './webhooks';
export * from './workflows';
export * from './workflowSchemeDrafts';
export * from './workflowSchemeProjectAssociations';
export * from './workflowSchemes';
export * from './workflowStatusCategories';
export * from './workflowStatuses';
export * from './workflowTransitionProperties';
export * from './workflowTransitionRules';
export * from './workflows';

export * as Version2Models from './models';
export * as Version2Parameters from './parameters';
Expand Down
1 change: 1 addition & 0 deletions src/version2/issueFields.ts
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,7 @@ export class IssueFields {
maxResults: parameters?.maxResults,
id: parameters?.id,
query: parameters?.query,
expand: parameters?.expand,
orderBy: parameters?.orderBy,
},
};
Expand Down
Loading