import type { OptionsWithUri } from 'request'; import type { IDataObject, IExecuteFunctions, IExecuteSingleFunctions, ILoadOptionsFunctions, IOAuth2Options, } from 'n8n-workflow'; import { NodeOperationError } from 'n8n-workflow'; import get from 'lodash.get'; export async function slackApiRequest( this: IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions, method: string, resource: string, body: object = {}, query: object = {}, headers: {} | undefined = undefined, option: {} = {}, // tslint:disable-next-line:no-any ): Promise { const authenticationMethod = this.getNodeParameter('authentication', 0, 'accessToken') as string; let options: OptionsWithUri = { method, headers: headers ?? { 'Content-Type': 'application/json; charset=utf-8', }, body, qs: query, uri: `https://slack.com/api${resource}`, json: true, }; options = Object.assign({}, options, option); if (Object.keys(body).length === 0) { delete options.body; } if (Object.keys(query).length === 0) { delete options.qs; } const oAuth2Options: IOAuth2Options = { tokenType: 'Bearer', property: 'authed_user.access_token', }; const credentialType = authenticationMethod === 'accessToken' ? 'slackApi' : 'slackOAuth2Api'; const response = await this.helpers.requestWithAuthentication.call( this, credentialType, options, { oauth2: oAuth2Options, }, ); if (response.ok === false) { if (response.error === 'paid_teams_only') { throw new NodeOperationError( this.getNode(), `Your current Slack plan does not include the resource '${ this.getNodeParameter('resource', 0) as string }'`, { description: 'Hint: Upgrade to a Slack plan that includes the functionality you want to use.', }, ); } else if (response.error === 'missing_scope') { throw new NodeOperationError( this.getNode(), 'Your Slack credential is missing required Oauth Scopes', { description: `Add the following scope(s) to your Slack App: ${response.needed}`, }, ); } throw new NodeOperationError( this.getNode(), 'Slack error response: ' + JSON.stringify(response.error), ); } if (response.ts !== undefined) { Object.assign(response, { message_timestamp: response.ts }); delete response.ts; } return response; } export async function slackApiRequestAllItems( this: IExecuteFunctions | ILoadOptionsFunctions, propertyName: string, method: string, endpoint: string, // tslint:disable-next-line:no-any body: any = {}, query: IDataObject = {}, // tslint:disable-next-line:no-any ): Promise { const returnData: IDataObject[] = []; let responseData; query.page = 1; //if the endpoint uses legacy pagination use count //https://api.slack.com/docs/pagination#classic if (endpoint.includes('files.list')) { query.count = 100; } else { query.limit = 100; } do { responseData = await slackApiRequest.call(this, method, endpoint, body as IDataObject, query); query.cursor = get(responseData, 'response_metadata.next_cursor'); query.page++; returnData.push.apply( returnData, (responseData[propertyName].matches as IDataObject[]) ?? responseData[propertyName], ); } while ( (responseData.response_metadata?.next_cursor !== undefined && responseData.response_metadata.next_cursor !== '' && responseData.response_metadata.next_cursor !== null) || (responseData.paging?.pages !== undefined && responseData.paging.page !== undefined && responseData.paging.page < responseData.paging.pages) || (responseData[propertyName].paging?.pages !== undefined && responseData[propertyName].paging.page !== undefined && responseData[propertyName].paging.page < responseData[propertyName].paging.pages) ); return returnData; } // tslint:disable-next-line:no-any export function validateJSON(json: string | undefined): any { let result; try { result = JSON.parse(json!); } catch (exception) { result = undefined; } return result; }