n8n/packages/nodes-base/nodes/Jira/JiraTrigger.node.ts
Iván Ovejero 88dea330b9
refactor: Apply more eslint-plugin-n8n-nodes-base rules (#3534)
*  Update `lintfix` script

*  Run baseline `lintfix`

* 🔥 Remove unneeded exceptions (#3538)

* 🔥 Remove exceptions for `node-param-default-wrong-for-simplify`

* 🔥 Remove exceptions for `node-param-placeholder-miscased-id`

*  Update version

* 👕 Apply `node-param-placeholder-missing` (#3542)

* 👕 Apply `filesystem-wrong-cred-filename` (#3543)

* 👕 Apply `node-param-description-missing-from-dynamic-options` (#3545)

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply `node-class-description-empty-string` (#3546)

* 👕 Apply `node-class-description-icon-not-svg` (#3548)

* 👕 Apply `filesystem-wrong-node-filename` (#3549)

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Expand lintings to credentials (#3550)

* 👕 Apply `node-param-multi-options-type-unsorted-items` (#3552)

*  fix

*  Minor fixes

Co-authored-by: Michael Kret <michael.k@radency.com>

* 👕 Apply `node-param-description-wrong-for-dynamic-multi-options` (#3541)

*  Add new lint rule, node-param-description-wrong-for-dynamic-multi-options

*  Fix with updated linting rules

*  Minor fixes

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply `node-param-description-boolean-without-whether` (#3553)

*  fix

* Update packages/nodes-base/nodes/Clockify/ProjectDescription.ts

Co-authored-by: Iván Ovejero <ivov.src@gmail.com>

* 👕 Apply node-param-display-name-wrong-for-dynamic-multi-options (#3537)

* 👕 Add exceptions

* 👕 Add exception

* ✏️ Alphabetize rules

*  Restore `lintfix` command

Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
Co-authored-by: Omar Ajoue <krynble@gmail.com>
Co-authored-by: Michael Kret <michael.k@radency.com>
Co-authored-by: brianinoa <54530642+brianinoa@users.noreply.github.com>
Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com>
2022-06-20 07:54:01 -07:00

455 lines
9.7 KiB
TypeScript

import {
IHookFunctions,
IWebhookFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeType,
INodeTypeDescription,
IWebhookResponseData,
} from 'n8n-workflow';
import {
allEvents,
eventExists,
getId,
jiraSoftwareCloudApiRequest,
} from './GenericFunctions';
import * as queryString from 'querystring';
export class JiraTrigger implements INodeType {
description: INodeTypeDescription = {
displayName: 'Jira Trigger',
name: 'jiraTrigger',
icon: 'file:jira.svg',
group: ['trigger'],
version: 1,
description: 'Starts the workflow when Jira events occur',
defaults: {
name: 'Jira Trigger',
},
inputs: [],
outputs: ['main'],
credentials: [
{
name: 'jiraSoftwareCloudApi',
required: true,
displayOptions: {
show: {
jiraVersion: [
'cloud',
],
},
},
},
{
name: 'jiraSoftwareServerApi',
required: true,
displayOptions: {
show: {
jiraVersion: [
'server',
],
},
},
},
],
webhooks: [
{
name: 'default',
httpMethod: 'POST',
responseMode: 'onReceived',
path: 'webhook',
},
],
properties: [
{
displayName: 'Jira Version',
name: 'jiraVersion',
type: 'options',
options: [
{
name: 'Cloud',
value: 'cloud',
},
{
name: 'Server (Self Hosted)',
value: 'server',
},
],
default: 'cloud',
},
{
displayName: 'Events',
name: 'events',
type: 'multiOptions',
options: [
{
name: '*',
value: '*',
},
{
name: 'Board Configuration Changed',
value: 'board_configuration_changed',
},
{
name: 'Board Created',
value: 'board_created',
},
{
name: 'Board Deleted',
value: 'board_deleted',
},
{
name: 'Board Updated',
value: 'board_updated',
},
{
name: 'Comment Created',
value: 'comment_created',
},
{
name: 'Comment Deleted',
value: 'comment_deleted',
},
{
name: 'Comment Updated',
value: 'comment_updated',
},
{
name: 'Issue Created',
value: 'jira:issue_created',
},
{
name: 'Issue Deleted',
value: 'jira:issue_deleted',
},
{
name: 'Issue Link Created',
value: 'issuelink_created',
},
{
name: 'Issue Link Deleted',
value: 'issuelink_deleted',
},
{
name: 'Issue Updated',
value: 'jira:issue_updated',
},
{
name: 'Option Attachments Changed',
value: 'option_attachments_changed',
},
{
name: 'Option Issue Links Changed',
value: 'option_issuelinks_changed',
},
{
name: 'Option Subtasks Changed',
value: 'option_subtasks_changed',
},
{
name: 'Option Timetracking Changed',
value: 'option_timetracking_changed',
},
{
name: 'Option Unassigned Issues Changed',
value: 'option_unassigned_issues_changed',
},
{
name: 'Option Voting Changed',
value: 'option_voting_changed',
},
{
name: 'Option Watching Changed',
value: 'option_watching_changed',
},
{
name: 'Project Created',
value: 'project_created',
},
{
name: 'Project Deleted',
value: 'project_deleted',
},
{
name: 'Project Updated',
value: 'project_updated',
},
{
name: 'Sprint Closed',
value: 'sprint_closed',
},
{
name: 'Sprint Created',
value: 'sprint_created',
},
{
name: 'Sprint Deleted',
value: 'sprint_deleted',
},
{
name: 'Sprint Started',
value: 'sprint_started',
},
{
name: 'Sprint Updated',
value: 'sprint_updated',
},
{
name: 'User Created',
value: 'user_created',
},
{
name: 'User Deleted',
value: 'user_deleted',
},
{
name: 'User Updated',
value: 'user_updated',
},
{
name: 'Version Created',
value: 'jira:version_created',
},
{
name: 'Version Deleted',
value: 'jira:version_deleted',
},
{
name: 'Version Moved',
value: 'jira:version_moved',
},
{
name: 'Version Released',
value: 'jira:version_released',
},
{
name: 'Version Unreleased',
value: 'jira:version_unreleased',
},
{
name: 'Version Updated',
value: 'jira:version_updated',
},
{
name: 'Worklog Created',
value: 'worklog_created',
},
{
name: 'Worklog Deleted',
value: 'worklog_deleted',
},
{
name: 'Worklog Updated',
value: 'worklog_updated',
},
],
required: true,
default: [],
description: 'The events to listen to',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
options: [
{
displayName: 'Exclude Body',
name: 'excludeBody',
type: 'boolean',
default: false,
description: 'Whether a request with empty body will be sent to the URL. Leave unchecked if you want to receive JSON.',
},
{
displayName: 'Filter',
name: 'filter',
type: 'string',
typeOptions: {
alwaysOpenEditWindow: true,
},
default: '',
placeholder: 'Project = JRA AND resolution = Fixed',
description: 'You can specify a JQL query to send only events triggered by matching issues. The JQL filter only applies to events under the Issue and Comment columns.',
},
{
displayName: 'Include Fields',
name: 'includeFields',
type: 'multiOptions',
options: [
{
name: 'Attachment ID',
value: 'attachment.id',
},
{
name: 'Board ID',
value: 'board.id',
},
{
name: 'Comment ID',
value: 'comment.id',
},
{
name: 'Issue ID',
value: 'issue.id',
},
{
name: 'Merge Version ID',
value: 'mergeVersion.id',
},
{
name: 'Modified User Account ID',
value: 'modifiedUser.accountId',
},
{
name: 'Modified User Key',
value: 'modifiedUser.key',
},
{
name: 'Modified User Name',
value: 'modifiedUser.name',
},
{
name: 'Project ID',
value: 'project.id',
},
{
name: 'Project Key',
value: 'project.key',
},
{
name: 'Propery Key',
value: 'property.key',
},
{
name: 'Sprint ID',
value: 'sprint.id',
},
{
name: 'Version ID',
value: 'version.id',
},
{
name: 'Worklog ID',
value: 'worklog.id',
},
],
default: [],
},
],
},
],
};
// @ts-ignore (because of request)
webhookMethods = {
default: {
async checkExists(this: IHookFunctions): Promise<boolean> {
const webhookUrl = this.getNodeWebhookUrl('default') as string;
const webhookData = this.getWorkflowStaticData('node');
const events = this.getNodeParameter('events') as string[];
const endpoint = `/webhooks/1.0/webhook`;
const webhooks = await jiraSoftwareCloudApiRequest.call(this, endpoint, 'GET', {});
for (const webhook of webhooks) {
if (webhook.url === webhookUrl && eventExists(events, webhook.events)) {
webhookData.webhookId = getId(webhook.self);
return true;
}
}
return false;
},
async create(this: IHookFunctions): Promise<boolean> {
const webhookUrl = this.getNodeWebhookUrl('default') as string;
let events = this.getNodeParameter('events', []) as string[];
const additionalFields = this.getNodeParameter('additionalFields') as IDataObject;
const endpoint = `/webhooks/1.0/webhook`;
const webhookData = this.getWorkflowStaticData('node');
if (events.includes('*')) {
events = allEvents;
}
const body = {
name: `n8n-webhook:${webhookUrl}`,
url: webhookUrl,
events,
filters: {
},
excludeBody: false,
};
if (additionalFields.filter) {
body.filters = {
'issue-related-events-section': additionalFields.filter,
};
}
if (additionalFields.excludeBody) {
body.excludeBody = additionalFields.excludeBody as boolean;
}
if (additionalFields.includeFields) {
// tslint:disable-next-line: no-any
const parameters: any = {};
for (const field of additionalFields.includeFields as string[]) {
parameters[field] = '${' + field + '}';
}
body.url = `${body.url}?${queryString.unescape(queryString.stringify(parameters))}`;
}
const responseData = await jiraSoftwareCloudApiRequest.call(this, endpoint, 'POST', body);
webhookData.webhookId = getId(responseData.self);
return true;
},
async delete(this: IHookFunctions): Promise<boolean> {
const webhookData = this.getWorkflowStaticData('node');
if (webhookData.webhookId !== undefined) {
const endpoint = `/webhooks/1.0/webhook/${webhookData.webhookId}`;
const body = {};
try {
await jiraSoftwareCloudApiRequest.call(this, endpoint, 'DELETE', body);
} catch (error) {
return false;
}
// Remove from the static workflow data so that it is clear
// that no webhooks are registred anymore
delete webhookData.webhookId;
}
return true;
},
},
};
async webhook(this: IWebhookFunctions): Promise<IWebhookResponseData> {
const bodyData = this.getBodyData();
const queryData = this.getQueryData();
Object.assign(bodyData, queryData);
return {
workflowData: [
this.helpers.returnJsonArray(bodyData),
],
};
}
}