n8n/packages/nodes-base/nodes/Slack/GenericFunctions.ts

114 lines
3.4 KiB
TypeScript
Raw Normal View History

2020-03-05 15:25:18 -08:00
import {
OptionsWithUri,
} from 'request';
2020-03-05 15:25:18 -08:00
import {
IExecuteFunctions,
IExecuteSingleFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
2020-03-05 15:25:18 -08:00
import {
IDataObject,
IOAuth2Options,
} from 'n8n-workflow';
import * as _ from 'lodash';
2020-03-05 15:25:18 -08:00
2020-03-08 15:22:33 -07:00
export async function slackApiRequest(this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: object = {}, query: object = {}, headers: {} | undefined = undefined, option: {} = {}): Promise<any> { // tslint:disable-line:no-any
2020-03-05 15:25:18 -08:00
const authenticationMethod = this.getNodeParameter('authentication', 0, 'accessToken') as string;
2020-03-08 15:22:33 -07:00
let options: OptionsWithUri = {
2020-03-05 15:25:18 -08:00
method,
2020-03-08 15:22:33 -07:00
headers: headers || {
2020-03-05 15:25:18 -08:00
'Content-Type': 'application/json; charset=utf-8'
},
body,
qs: query,
uri: `https://slack.com/api${resource}`,
json: true
};
2020-03-08 15:22:33 -07:00
options = Object.assign({}, options, option);
2020-03-05 15:25:18 -08:00
if (Object.keys(body).length === 0) {
delete options.body;
}
if (Object.keys(query).length === 0) {
delete options.qs;
}
try {
2020-10-01 23:50:37 -07:00
let response: any; // tslint:disable-line:no-any
2020-03-05 15:25:18 -08:00
if (authenticationMethod === 'accessToken') {
const credentials = this.getCredentials('slackApi');
if (credentials === undefined) {
throw new Error('No credentials got returned!');
}
options.headers!.Authorization = `Bearer ${credentials.accessToken}`;
//@ts-ignore
2020-10-01 23:50:37 -07:00
response = await this.helpers.request(options);
2020-03-05 15:25:18 -08:00
} else {
const oAuth2Options: IOAuth2Options = {
tokenType: 'Bearer',
property: 'authed_user.access_token',
};
2020-03-05 15:25:18 -08:00
//@ts-ignore
2020-10-01 23:50:37 -07:00
response = await this.helpers.requestOAuth2.call(this, 'slackOAuth2Api', options, oAuth2Options);
2020-03-05 15:25:18 -08:00
}
2020-10-01 23:50:37 -07:00
if (response.ok === false) {
throw new Error('Slack error response: ' + JSON.stringify(response));
}
return response;
2020-03-05 15:25:18 -08:00
} catch (error) {
if (error.statusCode === 401) {
// Return a clear error
throw new Error('The Slack credentials are not valid!');
}
if (error.response && error.response.body && error.response.body.message) {
// Try to return the error prettier
throw new Error(`Slack error response [${error.statusCode}]: ${error.response.body.message}`);
}
// If that data does not exist for some reason return the actual error
throw error;
}
}
2020-03-15 07:51:49 -07:00
export async function slackApiRequestAllItems(this: IExecuteFunctions | ILoadOptionsFunctions, propertyName: string ,method: string, endpoint: string, body: any = {}, query: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
2020-03-05 15:25:18 -08:00
const returnData: IDataObject[] = [];
let responseData;
2020-03-08 15:22:33 -07:00
query.page = 1;
query.count = 100;
2020-03-05 15:25:18 -08:00
do {
responseData = await slackApiRequest.call(this, method, endpoint, body, query);
query.cursor = encodeURIComponent(_.get(responseData, 'response_metadata.next_cursor'));
2020-03-08 15:22:33 -07:00
query.page++;
2020-03-05 15:25:18 -08:00
returnData.push.apply(returnData, responseData[propertyName]);
} while (
2020-03-08 15:22:33 -07:00
(responseData.response_metadata !== undefined &&
2020-03-05 15:25:18 -08:00
responseData.response_metadata.mext_cursor !== undefined &&
2020-03-15 07:51:49 -07:00
responseData.response_metadata.next_cursor !== '' &&
2020-03-08 15:22:33 -07:00
responseData.response_metadata.next_cursor !== null) ||
(responseData.paging !== undefined &&
responseData.paging.pages !== undefined &&
responseData.paging.page !== undefined &&
responseData.paging.page < responseData.paging.pages
)
2020-03-05 15:25:18 -08:00
);
return returnData;
}
export function validateJSON(json: string | undefined): any { // tslint:disable-line:no-any
let result;
try {
result = JSON.parse(json!);
} catch (exception) {
result = undefined;
}
return result;
}