n8n/packages/nodes-base/nodes/Phantombuster/Phantombuster.node.ts
Iván Ovejero 2b74b6238e
Deprecate step size and node color (#2586)
* 🔥 Deprecate numberStepSize

* 🔥 Deprecate color in non-FA nodes

*  Minor node name fixes

* 📦 Update package-lock.json

*  Restore Merge node color

* 👕 Fix lint
2021-12-23 13:30:35 +01:00

280 lines
7.3 KiB
TypeScript

import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
ILoadOptionsFunctions,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import {
phantombusterApiRequest,
validateJSON,
} from './GenericFunctions';
import {
agentFields,
agentOperations,
} from './AgentDescription';
// import {
// sentenceCase,
// } from 'change-case';
export class Phantombuster implements INodeType {
description: INodeTypeDescription = {
displayName: 'Phantombuster',
name: 'phantombuster',
icon: 'file:phantombuster.png',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Phantombuster API',
defaults: {
name: 'Phantombuster',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'phantombusterApi',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Agent',
value: 'agent',
},
],
default: 'agent',
description: 'The resource to operate on.',
},
...agentOperations,
...agentFields,
],
};
methods = {
loadOptions: {
async getAgents(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const returnData: INodePropertyOptions[] = [];
const responseData = await phantombusterApiRequest.call(
this,
'GET',
'/agents/fetch-all',
);
for (const item of responseData) {
returnData.push({
name: item.name,
value: item.id,
});
}
return returnData;
},
// Get all the arguments to display them to user so that he can
// select them easily
// async getArguments(
// this: ILoadOptionsFunctions,
// ): Promise<INodePropertyOptions[]> {
// const returnData: INodePropertyOptions[] = [];
// const agentId = this.getCurrentNodeParameter('agentId') as string;
// const { argument } = await phantombusterApiRequest.call(
// this,
// 'GET',
// '/agents/fetch',
// {},
// { id: agentId },
// );
// for (const key of Object.keys(JSON.parse(argument))) {
// returnData.push({
// name: sentenceCase(key),
// value: key,
// });
// }
// return returnData;
// },
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: IDataObject[] = [];
const length = (items.length as unknown) as number;
const qs: IDataObject = {};
let responseData;
const resource = this.getNodeParameter('resource', 0) as string;
const operation = this.getNodeParameter('operation', 0) as string;
for (let i = 0; i < length; i++) {
try {
if (resource === 'agent') {
//https://hub.phantombuster.com/reference#post_agents-delete-1
if (operation === 'delete') {
const agentId = this.getNodeParameter('agentId', i) as string;
responseData = await phantombusterApiRequest.call(
this,
'POST',
'/agents/delete',
{ id: agentId },
);
responseData = { success: true };
}
//https://hub.phantombuster.com/reference#get_agents-fetch-1
if (operation === 'get') {
const agentId = this.getNodeParameter('agentId', i) as string;
responseData = await phantombusterApiRequest.call(
this,
'GET',
'/agents/fetch',
{},
{ id: agentId },
);
}
//https://hub.phantombuster.com/reference#get_agents-fetch-output-1
if (operation === 'getOutput') {
const agentId = this.getNodeParameter('agentId', i) as string;
const resolveData = this.getNodeParameter('resolveData', i) as boolean;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
Object.assign(qs, additionalFields);
qs.id = agentId;
responseData = await phantombusterApiRequest.call(
this,
'GET',
'/agents/fetch-output',
{},
qs,
);
if (resolveData === true) {
const { resultObject } = await phantombusterApiRequest.call(
this,
'GET',
'/containers/fetch-result-object',
{},
{ id: responseData.containerId },
);
if (resultObject === null) {
responseData = {};
} else {
responseData = JSON.parse(resultObject);
}
}
}
//https://api.phantombuster.com/api/v2/agents/fetch-all
if (operation === 'getAll') {
const returnAll = this.getNodeParameter('returnAll', i) as boolean;
responseData = await phantombusterApiRequest.call(
this,
'GET',
'/agents/fetch-all',
);
if (returnAll === false) {
const limit = this.getNodeParameter('limit', 0) as number;
responseData = responseData.splice(0, limit);
}
}
//https://hub.phantombuster.com/reference#post_agents-launch-1
if (operation === 'launch') {
const agentId = this.getNodeParameter('agentId', i) as string;
const jsonParameters = this.getNodeParameter('jsonParameters', i) as boolean;
const resolveData = this.getNodeParameter('resolveData', i) as boolean;
const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject;
const body: IDataObject = {
id: agentId,
};
if (jsonParameters) {
if (additionalFields.argumentsJson) {
body.arguments = validateJSON(this, additionalFields.argumentsJson as string, 'Arguments');
delete additionalFields.argumentsJson;
}
if (additionalFields.bonusArgumentJson) {
body.bonusArgument = validateJSON(this, additionalFields.bonusArgumentJson as string, 'Bonus Argument');
delete additionalFields.bonusArgumentJson;
}
} else {
const argumentParameters = ((additionalFields.argumentsUi as IDataObject || {}).argumentValues as IDataObject[]) || [];
body.arguments = argumentParameters.reduce((object, currentValue) => {
object[currentValue.key as string] = currentValue.value;
return object;
}, {});
delete additionalFields.argumentsUi;
const bonusParameters = ((additionalFields.bonusArgumentUi as IDataObject || {}).bonusArgumentValue as IDataObject[]) || [];
body.bonusArgument = bonusParameters.reduce((object, currentValue) => {
object[currentValue.key as string] = currentValue.value;
return object;
}, {});
delete additionalFields.bonusArgumentUi;
}
Object.assign(body, additionalFields);
responseData = await phantombusterApiRequest.call(
this,
'POST',
'/agents/launch',
body,
);
if (resolveData === true) {
responseData = await phantombusterApiRequest.call(
this,
'GET',
'/containers/fetch',
{},
{ id: responseData.containerId },
);
}
}
}
if (Array.isArray(responseData)) {
returnData.push.apply(returnData, responseData as IDataObject[]);
} else if (responseData !== undefined) {
returnData.push(responseData as IDataObject);
}
} catch (error) {
if (this.continueOnFail()) {
returnData.push({ error: error.message });
continue;
}
throw error;
}
}
return [this.helpers.returnJsonArray(returnData)];
}
}