first commit

packages/nodes-base/nodes/Salesforce/GenericFunctions.ts

@@ -0,0 +1,287 @@
+import jwt from 'jsonwebtoken';
+import moment from 'moment-timezone';
+import { DateTime } from 'luxon';
+import type {
+	IExecuteFunctions,
+	ILoadOptionsFunctions,
+	IDataObject,
+	INodePropertyOptions,
+	JsonObject,
+	IHttpRequestMethods,
+	IRequestOptions,
+	IPollFunctions,
+} from 'n8n-workflow';
+import { NodeApiError } from 'n8n-workflow';
+
+function getOptions(
+	this: IExecuteFunctions | ILoadOptionsFunctions | IPollFunctions,
+	method: IHttpRequestMethods,
+	endpoint: string,
+
+	body: any,
+	qs: IDataObject,
+	instanceUrl: string,
+): IRequestOptions {
+	const options: IRequestOptions = {
+		headers: {
+			'Content-Type': 'application/json',
+		},
+		method,
+		body,
+		qs,
+		uri: `${instanceUrl}/services/data/v59.0${endpoint}`,
+		json: true,
+	};
+
+	if (!Object.keys(options.body as IDataObject).length) {
+		delete options.body;
+	}
+
+	return options;
+}
+
+async function getAccessToken(
+	this: IExecuteFunctions | ILoadOptionsFunctions | IPollFunctions,
+	credentials: IDataObject,
+): Promise<IDataObject> {
+	const now = moment().unix();
+	const authUrl =
+		credentials.environment === 'sandbox'
+			? 'https://test.salesforce.com'
+			: 'https://login.salesforce.com';
+
+	const signature = jwt.sign(
+		{
+			iss: credentials.clientId as string,
+			sub: credentials.username as string,
+			aud: authUrl,
+			exp: now + 3 * 60,
+		},
+		credentials.privateKey as string,
+		{
+			algorithm: 'RS256',
+			header: {
+				alg: 'RS256',
+			},
+		},
+	);
+
+	const options: IRequestOptions = {
+		headers: {
+			'Content-Type': 'application/x-www-form-urlencoded',
+		},
+		method: 'POST',
+		form: {
+			grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer',
+			assertion: signature,
+		},
+		uri: `${authUrl}/services/oauth2/token`,
+		json: true,
+	};
+
+	return await this.helpers.request(options);
+}
+
+export async function salesforceApiRequest(
+	this: IExecuteFunctions | ILoadOptionsFunctions | IPollFunctions,
+	method: IHttpRequestMethods,
+	endpoint: string,
+
+	body: any = {},
+	qs: IDataObject = {},
+	uri?: string,
+	option: IDataObject = {},
+): Promise<any> {
+	const authenticationMethod = this.getNodeParameter('authentication', 0, 'oAuth2') as string;
+	try {
+		if (authenticationMethod === 'jwt') {
+			// https://help.salesforce.com/articleView?id=remoteaccess_oauth_jwt_flow.htm&type=5
+			const credentialsType = 'salesforceJwtApi';
+			const credentials = await this.getCredentials(credentialsType);
+			const response = await getAccessToken.call(this, credentials);
+			const { instance_url, access_token } = response;
+			const options = getOptions.call(
+				this,
+				method,
+				uri || endpoint,
+				body,
+				qs,
+				instance_url as string,
+			);
+			this.logger.debug(
+				`Authentication for "Salesforce" node is using "jwt". Invoking URI ${options.uri}`,
+			);
+			options.headers!.Authorization = `Bearer ${access_token}`;
+			Object.assign(options, option);
+			return await this.helpers.request(options);
+		} else {
+			// https://help.salesforce.com/articleView?id=remoteaccess_oauth_web_server_flow.htm&type=5
+			const credentialsType = 'salesforceOAuth2Api';
+			const credentials = await this.getCredentials<{
+				oauthTokenData: { instance_url: string };
+			}>(credentialsType);
+			const options = getOptions.call(
+				this,
+				method,
+				uri || endpoint,
+				body,
+				qs,
+				credentials.oauthTokenData.instance_url,
+			);
+			this.logger.debug(
+				`Authentication for "Salesforce" node is using "OAuth2". Invoking URI ${options.uri}`,
+			);
+			Object.assign(options, option);
+
+			return await this.helpers.requestOAuth2.call(this, credentialsType, options);
+		}
+	} catch (error) {
+		throw new NodeApiError(this.getNode(), error as JsonObject);
+	}
+}
+
+export async function salesforceApiRequestAllItems(
+	this: IExecuteFunctions | ILoadOptionsFunctions | IPollFunctions,
+	propertyName: string,
+	method: IHttpRequestMethods,
+	endpoint: string,
+
+	body: any = {},
+	query: IDataObject = {},
+): Promise<any> {
+	const returnData: IDataObject[] = [];
+
+	let responseData;
+	let uri: string | undefined;
+
+	do {
+		responseData = await salesforceApiRequest.call(this, method, endpoint, body, query, uri);
+		uri = `${endpoint}/${responseData.nextRecordsUrl?.split('/')?.pop()}`;
+		returnData.push.apply(returnData, responseData[propertyName] as IDataObject[]);
+	} while (responseData.nextRecordsUrl !== undefined && responseData.nextRecordsUrl !== null);
+
+	return returnData;
+}
+
+/**
+ * Sorts the given options alphabetically
+ *
+ */
+export function sortOptions(options: INodePropertyOptions[]): void {
+	options.sort((a, b) => {
+		if (a.name < b.name) {
+			return -1;
+		}
+		if (a.name > b.name) {
+			return 1;
+		}
+		return 0;
+	});
+}
+
+export function getValue(value: any) {
+	if (moment(value as string).isValid()) {
+		return value;
+	} else if (typeof value === 'string') {
+		return `'${value}'`;
+	} else {
+		return value;
+	}
+}
+
+export function getConditions(options: IDataObject) {
+	const conditions = (options.conditionsUi as IDataObject)?.conditionValues as IDataObject[];
+	let data = undefined;
+	if (Array.isArray(conditions) && conditions.length !== 0) {
+		data = conditions.map(
+			(condition: IDataObject) =>
+				`${condition.field} ${
+					condition.operation === 'equal' ? '=' : condition.operation
+				} ${getValue(condition.value)}`,
+		);
+		data = `WHERE ${data.join(' AND ')}`;
+	}
+	return data;
+}
+
+export function getDefaultFields(sobject: string) {
+	return (
+		{
+			Account: 'id,name,type',
+			Lead: 'id,company,firstname,lastname,street,postalCode,city,email,status',
+			Contact: 'id,firstname,lastname,email',
+			Opportunity: 'id,accountId,amount,probability,type',
+			Case: 'id,accountId,contactId,priority,status,subject,type',
+			Task: 'id,subject,status,priority',
+			Attachment: 'id,name',
+			User: 'id,name,email',
+		} as IDataObject
+	)[sobject];
+}
+
+export function getQuery(options: IDataObject, sobject: string, returnAll: boolean, limit = 0) {
+	const fields: string[] = [];
+	if (options.fields) {
+		// options.fields is comma separated in standard Salesforce objects and array in custom Salesforce objects -- handle both cases
+		if (typeof options.fields === 'string') {
+			fields.push.apply(fields, options.fields.split(','));
+		} else {
+			fields.push.apply(fields, options.fields as string[]);
+		}
+	} else {
+		fields.push.apply(fields, ((getDefaultFields(sobject) as string) || 'id').split(','));
+	}
+	const conditions = getConditions(options);
+
+	let query = `SELECT ${fields.join(',')} FROM ${sobject} ${conditions ? conditions : ''}`;
+
+	if (!returnAll) {
+		query = `SELECT ${fields.join(',')} FROM ${sobject} ${
+			conditions ? conditions : ''
+		} LIMIT ${limit}`;
+	}
+
+	return query;
+}
+
+/**
+ * Calculates the polling start date with safety margin to account for Salesforce indexing delays
+ */
+export function getPollStartDate(lastTimeChecked: string | undefined): string {
+	if (!lastTimeChecked) {
+		return DateTime.now().toISO();
+	}
+	const safetyMarginMinutes = 15;
+	return DateTime.fromISO(lastTimeChecked).minus({ minutes: safetyMarginMinutes }).toISO();
+}
+
+/**
+ * Filters out already processed items and manages the processed IDs list
+ */
+export function filterAndManageProcessedItems(
+	responseData: IDataObject[],
+	processedIds: string[],
+): { newItems: IDataObject[]; updatedProcessedIds: string[] } {
+	const processedIdsSet = new Set(processedIds);
+
+	const newItems: IDataObject[] = [];
+	const newItemIds: string[] = [];
+
+	for (const item of responseData) {
+		if (typeof item.Id !== 'string') continue;
+
+		const itemId = item.Id;
+		if (!processedIdsSet.has(itemId)) {
+			newItems.push(item);
+			newItemIds.push(itemId);
+		}
+	}
+
+	const remainingProcessedIds = Array.from(processedIdsSet);
+	const updatedProcessedIds = remainingProcessedIds.concat(newItemIds);
+
+	const MAX_IDS = 10000;
+	const trimmedProcessedIds = updatedProcessedIds.slice(-MAX_IDS);
+
+	return { newItems, updatedProcessedIds: trimmedProcessedIds };
+}