n8n/packages/nodes-base/nodes/Facebook/FacebookGraphApi.node.ts
Elias Meire 100d9bc087
refactor: Add IRequestOptions type to helpers.request for more type safety (no-changelog) (#8563)
Co-authored-by: कारतोफ्फेलस्क्रिप्ट™ <aditya@netroy.in>
2024-02-14 16:29:09 +01:00

454 lines
11 KiB
TypeScript

import type {
IDataObject,
IExecuteFunctions,
IHttpRequestMethods,
INodeExecutionData,
INodeType,
INodeTypeDescription,
IRequestOptions,
JsonObject,
} from 'n8n-workflow';
import { NodeApiError, NodeOperationError } from 'n8n-workflow';
export class FacebookGraphApi implements INodeType {
description: INodeTypeDescription = {
displayName: 'Facebook Graph API',
name: 'facebookGraphApi',
icon: 'file:facebook.svg',
group: ['transform'],
version: 1,
description: 'Interacts with Facebook using the Graph API',
defaults: {
name: 'Facebook Graph API',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'facebookGraphApi',
required: true,
},
],
properties: [
{
displayName: 'Host URL',
name: 'hostUrl',
type: 'options',
options: [
{
name: 'Default',
value: 'graph.facebook.com',
},
{
name: 'Video Uploads',
value: 'graph-video.facebook.com',
},
],
default: 'graph.facebook.com',
description:
'The Host URL of the request. Almost all requests are passed to the graph.facebook.com host URL. The single exception is video uploads, which use graph-video.facebook.com.',
required: true,
},
{
displayName: 'HTTP Request Method',
name: 'httpRequestMethod',
type: 'options',
options: [
{
name: 'GET',
value: 'GET',
},
{
name: 'POST',
value: 'POST',
},
{
name: 'DELETE',
value: 'DELETE',
},
],
default: 'GET',
description: 'The HTTP Method to be used for the request',
required: true,
},
{
displayName: 'Graph API Version',
name: 'graphApiVersion',
type: 'options',
options: [
{
name: 'Default',
value: '',
},
{
name: 'v17.0',
value: 'v17.0',
},
{
name: 'v16.0',
value: 'v16.0',
},
{
name: 'v15.0',
value: 'v15.0',
},
{
name: 'v14.0',
value: 'v14.0',
},
{
name: 'v13.0',
value: 'v13.0',
},
{
name: 'v12.0',
value: 'v12.0',
},
{
name: 'v11.0',
value: 'v11.0',
},
{
name: 'v10.0',
value: 'v10.0',
},
{
name: 'v9.0',
value: 'v9.0',
},
{
name: 'v8.0',
value: 'v8.0',
},
{
name: 'v7.0',
value: 'v7.0',
},
{
name: 'v6.0',
value: 'v6.0',
},
{
name: 'v5.0',
value: 'v5.0',
},
{
name: 'v4.0',
value: 'v4.0',
},
{
name: 'v3.3',
value: 'v3.3',
},
{
name: 'v3.2',
value: 'v3.2',
},
{
name: 'v3.1',
value: 'v3.1',
},
{
name: 'v3.0',
value: 'v3.0',
},
],
default: '',
description: 'The version of the Graph API to be used in the request',
required: true,
},
{
displayName: 'Node',
name: 'node',
type: 'string',
default: '',
description:
'The node on which to operate. A node is an individual object with a unique ID. For example, there are many User node objects, each with a unique ID representing a person on Facebook.',
placeholder: 'me',
required: true,
},
{
displayName: 'Edge',
name: 'edge',
type: 'string',
default: '',
description:
'Edge of the node on which to operate. Edges represent collections of objects which are attached to the node.',
placeholder: 'videos',
},
{
displayName: 'Ignore SSL Issues',
name: 'allowUnauthorizedCerts',
type: 'boolean',
default: false,
description: 'Whether to connect even if SSL certificate validation is not possible',
},
{
displayName: 'Send Binary File',
name: 'sendBinaryData',
type: 'boolean',
displayOptions: {
show: {
httpRequestMethod: ['POST', 'PUT'],
},
},
default: false,
required: true,
description: 'Whether binary data should be sent as body',
},
{
displayName: 'Input Binary Field',
name: 'binaryPropertyName',
type: 'string',
default: '',
placeholder: 'file:data',
displayOptions: {
hide: {
sendBinaryData: [false],
},
show: {
httpRequestMethod: ['POST', 'PUT'],
},
},
hint: 'The name of the input binary field containing the file to be uploaded',
description:
'For Form-Data Multipart, they can be provided in the format: <code>"sendKey1:binaryProperty1,sendKey2:binaryProperty2</code>',
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
options: [
{
displayName: 'Fields',
name: 'fields',
placeholder: 'Add Field',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
displayOptions: {
show: {
'/httpRequestMethod': ['GET'],
},
},
description: 'The list of fields to request in the GET request',
default: {},
options: [
{
name: 'field',
displayName: 'Field',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'Name of the field',
},
],
},
],
},
{
displayName: 'Query Parameters',
name: 'queryParameters',
placeholder: 'Add Parameter',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
description: 'The query parameters to send',
default: {},
options: [
{
name: 'parameter',
displayName: 'Parameter',
values: [
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
description: 'Name of the parameter',
},
{
displayName: 'Value',
name: 'value',
type: 'string',
default: '',
description: 'Value of the parameter',
},
],
},
],
},
{
displayName: 'Query Parameters JSON',
name: 'queryParametersJson',
type: 'json',
default: '{}',
placeholder: '{"field_name": "field_value"}',
description: 'The query parameters to send, defined as a JSON object',
},
],
},
],
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
let response: any;
const returnItems: INodeExecutionData[] = [];
for (let itemIndex = 0; itemIndex < items.length; itemIndex++) {
const graphApiCredentials = await this.getCredentials('facebookGraphApi');
const hostUrl = this.getNodeParameter('hostUrl', itemIndex) as string;
const httpRequestMethod = this.getNodeParameter(
'httpRequestMethod',
itemIndex,
) as IHttpRequestMethods;
let graphApiVersion = this.getNodeParameter('graphApiVersion', itemIndex) as string;
const node = this.getNodeParameter('node', itemIndex) as string;
const edge = this.getNodeParameter('edge', itemIndex) as string;
const options = this.getNodeParameter('options', itemIndex, {});
if (graphApiVersion !== '') {
graphApiVersion += '/';
}
let uri = `https://${hostUrl}/${graphApiVersion}${node}`;
if (edge) {
uri = `${uri}/${edge}`;
}
const qs: IDataObject = {
access_token: graphApiCredentials.accessToken,
};
const requestOptions: IRequestOptions = {
headers: {
accept: 'application/json,text/*;q=0.99',
},
method: httpRequestMethod,
uri,
json: true,
gzip: true,
rejectUnauthorized: !this.getNodeParameter('allowUnauthorizedCerts', itemIndex, false),
};
if (options !== undefined) {
// Build fields query parameter as a comma separated list
if (options.fields !== undefined) {
const fields = options.fields as IDataObject;
if (fields.field !== undefined) {
const fieldsCsv = (fields.field as IDataObject[]).map((field) => field.name).join(',');
qs.fields = fieldsCsv;
}
}
// Add the query parameters defined in the UI
if (options.queryParameters !== undefined) {
const queryParameters = options.queryParameters as IDataObject;
if (queryParameters.parameter !== undefined) {
for (const queryParameter of queryParameters.parameter as IDataObject[]) {
qs[queryParameter.name as string] = queryParameter.value;
}
}
}
requestOptions.qs = qs;
// Add the query parameters defined as a JSON object
if (options.queryParametersJson) {
let queryParametersJsonObj = {};
try {
queryParametersJsonObj = JSON.parse(options.queryParametersJson as string);
} catch {
/* Do nothing, at least for now */
}
requestOptions.qs = {
...qs,
...queryParametersJsonObj,
};
}
}
const sendBinaryData = this.getNodeParameter('sendBinaryData', itemIndex, false) as boolean;
if (sendBinaryData) {
const binaryPropertyNameFull = this.getNodeParameter('binaryPropertyName', itemIndex);
let propertyName = 'file';
let binaryPropertyName = binaryPropertyNameFull;
if (binaryPropertyNameFull.includes(':')) {
const binaryPropertyNameParts = binaryPropertyNameFull.split(':');
propertyName = binaryPropertyNameParts[0];
binaryPropertyName = binaryPropertyNameParts[1];
}
const binaryData = this.helpers.assertBinaryData(itemIndex, binaryPropertyName);
const binaryDataBuffer = await this.helpers.getBinaryDataBuffer(
itemIndex,
binaryPropertyName,
);
requestOptions.formData = {
[propertyName]: {
value: binaryDataBuffer,
options: {
filename: binaryData.fileName,
contentType: binaryData.mimeType,
},
},
};
}
try {
// Now that the options are all set make the actual http request
response = await this.helpers.request(requestOptions);
} catch (error) {
if (!this.continueOnFail()) {
throw new NodeApiError(this.getNode(), error as JsonObject);
}
let errorItem;
if (error.response !== undefined) {
// Since this is a Graph API node and we already know the request was
// not successful, we'll go straight to the error details.
const graphApiErrors = error.response.body?.error ?? {};
errorItem = {
statusCode: error.statusCode,
...graphApiErrors,
headers: error.response.headers,
};
} else {
// Unknown Graph API response, we'll dump everything in the response item
errorItem = error;
}
returnItems.push({ json: { ...errorItem } });
continue;
}
if (typeof response === 'string') {
if (!this.continueOnFail()) {
throw new NodeOperationError(this.getNode(), 'Response body is not valid JSON.', {
itemIndex,
});
}
returnItems.push({ json: { message: response } });
continue;
}
returnItems.push({ json: response });
}
return [returnItems];
}
}