mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-26 21:19:43 -08:00
d3fecb9f6d
* Centralized error throwing for encryption key * Unifying the error message used by cli and core packages * Improvements to error messages to make it more DRY * Removed unnecessary throw * Throwing error when credential does not exist to simplify node behavior (#3112) Co-authored-by: Iván Ovejero <ivov.src@gmail.com>
380 lines
10 KiB
TypeScript
380 lines
10 KiB
TypeScript
import {
|
|
IExecuteFunctions,
|
|
IExecuteSingleFunctions,
|
|
ILoadOptionsFunctions,
|
|
} from 'n8n-core';
|
|
|
|
import {
|
|
IDataObject, INodePropertyOptions, NodeApiError, NodeOperationError,
|
|
} from 'n8n-workflow';
|
|
|
|
import {OptionsWithUri} from 'request';
|
|
|
|
interface ScriptsOptions {
|
|
script?: any; //tslint:disable-line:no-any
|
|
'script.param'?: any; //tslint:disable-line:no-any
|
|
'script.prerequest'?: any; //tslint:disable-line:no-any
|
|
'script.prerequest.param'?: any; //tslint:disable-line:no-any
|
|
'script.presort'?: any; //tslint:disable-line:no-any
|
|
'script.presort.param'?: any; //tslint:disable-line:no-any
|
|
}
|
|
interface LayoutObject {
|
|
name: string;
|
|
isFolder?: boolean;
|
|
folderLayoutNames?:LayoutObject[];
|
|
}
|
|
|
|
interface ScriptObject {
|
|
name: string;
|
|
isFolder?: boolean;
|
|
folderScriptNames?:LayoutObject[];
|
|
}
|
|
|
|
/**
|
|
* Make an API request to ActiveCampaign
|
|
*
|
|
* @param {IHookFunctions} this
|
|
* @param {string} method
|
|
* @returns {Promise<any>}
|
|
*/
|
|
export async function layoutsApiRequest(this: ILoadOptionsFunctions | IExecuteFunctions | IExecuteSingleFunctions): Promise<INodePropertyOptions[]> { // tslint:disable-line:no-any
|
|
const token = await getToken.call(this);
|
|
const credentials = await this.getCredentials('fileMaker');
|
|
|
|
const host = credentials.host as string;
|
|
const db = credentials.db as string;
|
|
|
|
const url = `https://${host}/fmi/data/v1/databases/${db}/layouts`;
|
|
const options: OptionsWithUri = {
|
|
headers: {
|
|
'Authorization': `Bearer ${token}`,
|
|
},
|
|
method: 'GET',
|
|
uri: url,
|
|
json: true,
|
|
};
|
|
|
|
try {
|
|
const responseData = await this.helpers.request!(options);
|
|
const items = parseLayouts(responseData.response.layouts);
|
|
items.sort((a, b) => a.name > b.name ? 0 : 1);
|
|
return items;
|
|
} catch (error) {
|
|
throw new NodeApiError(this.getNode(), error);
|
|
}
|
|
}
|
|
|
|
function parseLayouts(layouts: LayoutObject[]): INodePropertyOptions[] {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
for (const layout of layouts) {
|
|
if (layout.isFolder!) {
|
|
returnData.push(...parseLayouts(layout.folderLayoutNames!));
|
|
} else {
|
|
returnData.push({
|
|
name: layout.name,
|
|
value: layout.name,
|
|
});
|
|
}
|
|
}
|
|
return returnData;
|
|
}
|
|
|
|
/**
|
|
* Make an API request to ActiveCampaign
|
|
*
|
|
* @returns {Promise<any>}
|
|
*/
|
|
export async function getFields(this: ILoadOptionsFunctions): Promise<any> { // tslint:disable-line:no-any
|
|
const token = await getToken.call(this);
|
|
const credentials = await this.getCredentials('fileMaker');
|
|
const layout = this.getCurrentNodeParameter('layout') as string;
|
|
|
|
const host = credentials.host as string;
|
|
const db = credentials.db as string;
|
|
|
|
const url = `https://${host}/fmi/data/v1/databases/${db}/layouts/${layout}`;
|
|
const options: OptionsWithUri = {
|
|
headers: {
|
|
'Authorization': `Bearer ${token}`,
|
|
},
|
|
method: 'GET',
|
|
uri: url,
|
|
json: true,
|
|
};
|
|
|
|
try {
|
|
const responseData = await this.helpers.request!(options);
|
|
return responseData.response.fieldMetaData;
|
|
} catch (error) {
|
|
// If that data does not exist for some reason return the actual error
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Make an API request to ActiveCampaign
|
|
*
|
|
* @returns {Promise<any>}
|
|
*/
|
|
export async function getPortals(this: ILoadOptionsFunctions): Promise<any> { // tslint:disable-line:no-any
|
|
const token = await getToken.call(this);
|
|
const credentials = await this.getCredentials('fileMaker');
|
|
const layout = this.getCurrentNodeParameter('layout') as string;
|
|
|
|
const host = credentials.host as string;
|
|
const db = credentials.db as string;
|
|
|
|
const url = `https://${host}/fmi/data/v1/databases/${db}/layouts/${layout}`;
|
|
const options: OptionsWithUri = {
|
|
headers: {
|
|
'Authorization': `Bearer ${token}`,
|
|
},
|
|
method: 'GET',
|
|
uri: url,
|
|
json: true,
|
|
};
|
|
|
|
try {
|
|
const responseData = await this.helpers.request!(options);
|
|
return responseData.response.portalMetaData;
|
|
|
|
} catch (error) {
|
|
// If that data does not exist for some reason return the actual error
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Make an API request to ActiveCampaign
|
|
*
|
|
* @returns {Promise<any>}
|
|
*/
|
|
export async function getScripts(this: ILoadOptionsFunctions): Promise<any> { // tslint:disable-line:no-any
|
|
const token = await getToken.call(this);
|
|
const credentials = await this.getCredentials('fileMaker');
|
|
|
|
const host = credentials.host as string;
|
|
const db = credentials.db as string;
|
|
|
|
const url = `https://${host}/fmi/data/v1/databases/${db}/scripts`;
|
|
const options: OptionsWithUri = {
|
|
headers: {
|
|
'Authorization': `Bearer ${token}`,
|
|
},
|
|
method: 'GET',
|
|
uri: url,
|
|
json: true,
|
|
};
|
|
|
|
try {
|
|
const responseData = await this.helpers.request!(options);
|
|
const items = parseScriptsList(responseData.response.scripts);
|
|
items.sort((a, b) => a.name > b.name ? 0 : 1);
|
|
return items;
|
|
|
|
} catch (error) {
|
|
// If that data does not exist for some reason return the actual error
|
|
throw error;
|
|
}
|
|
}
|
|
|
|
function parseScriptsList(scripts: ScriptObject[]): INodePropertyOptions[] {
|
|
const returnData: INodePropertyOptions[] = [];
|
|
for (const script of scripts) {
|
|
if (script.isFolder!) {
|
|
returnData.push(...parseScriptsList(script.folderScriptNames!));
|
|
} else if (script.name !== '-') {
|
|
returnData.push({
|
|
name: script.name,
|
|
value: script.name,
|
|
});
|
|
}
|
|
}
|
|
return returnData;
|
|
}
|
|
|
|
export async function getToken(this: ILoadOptionsFunctions | IExecuteFunctions | IExecuteSingleFunctions): Promise<any> { // tslint:disable-line:no-any
|
|
const credentials = await this.getCredentials('fileMaker');
|
|
|
|
const host = credentials.host as string;
|
|
const db = credentials.db as string;
|
|
const login = credentials.login as string;
|
|
const password = credentials.password as string;
|
|
|
|
const url = `https://${host}/fmi/data/v1/databases/${db}/sessions`;
|
|
|
|
let requestOptions: OptionsWithUri;
|
|
// Reset all values
|
|
requestOptions = {
|
|
uri: url,
|
|
headers: {},
|
|
method: 'POST',
|
|
json: true,
|
|
//rejectUnauthorized: !this.getNodeParameter('allowUnauthorizedCerts', itemIndex, false) as boolean,
|
|
};
|
|
requestOptions.auth = {
|
|
user: login as string,
|
|
pass: password as string,
|
|
};
|
|
requestOptions.body = {
|
|
'fmDataSource': [
|
|
{
|
|
'database': host,
|
|
'username': login as string,
|
|
'password': password as string,
|
|
},
|
|
],
|
|
};
|
|
|
|
try {
|
|
const response = await this.helpers.request!(requestOptions);
|
|
|
|
if (typeof response === 'string') {
|
|
throw new NodeOperationError(this.getNode(), 'Response body is not valid JSON. Change "Response Format" to "String"');
|
|
}
|
|
|
|
return response.response.token;
|
|
} catch (error) {
|
|
throw new NodeApiError(this.getNode(), error);
|
|
}
|
|
}
|
|
|
|
export async function logout(this: ILoadOptionsFunctions | IExecuteFunctions | IExecuteSingleFunctions, token: string): Promise<any> { // tslint:disable-line:no-any
|
|
const credentials = await this.getCredentials('fileMaker');
|
|
|
|
const host = credentials.host as string;
|
|
const db = credentials.db as string;
|
|
|
|
const url = `https://${host}/fmi/data/v1/databases/${db}/sessions/${token}`;
|
|
|
|
let requestOptions: OptionsWithUri;
|
|
// Reset all values
|
|
requestOptions = {
|
|
uri: url,
|
|
headers: {},
|
|
method: 'DELETE',
|
|
json: true,
|
|
//rejectUnauthorized: !this.getNodeParameter('allowUnauthorizedCerts', itemIndex, false) as boolean,
|
|
};
|
|
|
|
try {
|
|
const response = await this.helpers.request!(requestOptions);
|
|
|
|
if (typeof response === 'string') {
|
|
throw new NodeOperationError(this.getNode(), 'Response body is not valid JSON. Change "Response Format" to "String"');
|
|
}
|
|
|
|
return response;
|
|
} catch (error) {
|
|
const errorMessage = error.response.body.messages[0].message + '(' + error.response.body.messages[0].message + ')';
|
|
|
|
if (errorMessage !== undefined) {
|
|
throw errorMessage;
|
|
}
|
|
throw error.response.body;
|
|
}
|
|
}
|
|
|
|
export function parseSort(this: IExecuteFunctions, i: number): object | null {
|
|
let sort;
|
|
const setSort = this.getNodeParameter('setSort', i, false);
|
|
if (!setSort) {
|
|
sort = null;
|
|
} else {
|
|
sort = [];
|
|
const sortParametersUi = this.getNodeParameter('sortParametersUi', i, {}) as IDataObject;
|
|
if (sortParametersUi.rules !== undefined) {
|
|
// @ts-ignore
|
|
for (const parameterData of sortParametersUi!.rules as IDataObject[]) {
|
|
// @ts-ignore
|
|
sort.push({
|
|
'fieldName': parameterData!.name as string,
|
|
'sortOrder': parameterData!.value,
|
|
});
|
|
}
|
|
}
|
|
}
|
|
return sort;
|
|
}
|
|
|
|
|
|
export function parseScripts(this: IExecuteFunctions, i: number): object | null {
|
|
const setScriptAfter = this.getNodeParameter('setScriptAfter', i, false);
|
|
const setScriptBefore = this.getNodeParameter('setScriptBefore', i, false);
|
|
const setScriptSort = this.getNodeParameter('setScriptSort', i, false);
|
|
|
|
if (!setScriptAfter && setScriptBefore && setScriptSort) {
|
|
return {};
|
|
} else {
|
|
const scripts = {} as ScriptsOptions;
|
|
if (setScriptAfter) {
|
|
scripts.script = this.getNodeParameter('scriptAfter', i);
|
|
scripts!['script.param'] = this.getNodeParameter('scriptAfter', i);
|
|
}
|
|
if (setScriptBefore) {
|
|
scripts['script.prerequest'] = this.getNodeParameter('scriptBefore', i);
|
|
scripts['script.prerequest.param'] = this.getNodeParameter('scriptBeforeParam', i);
|
|
}
|
|
if (setScriptSort) {
|
|
scripts['script.presort'] = this.getNodeParameter('scriptSort', i);
|
|
scripts['script.presort.param'] = this.getNodeParameter('scriptSortParam', i);
|
|
}
|
|
return scripts;
|
|
}
|
|
}
|
|
|
|
export function parsePortals(this: IExecuteFunctions, i: number): object | null {
|
|
let portals;
|
|
const getPortals = this.getNodeParameter('getPortals', i);
|
|
if (!getPortals) {
|
|
portals = [];
|
|
} else {
|
|
portals = this.getNodeParameter('portals', i);
|
|
}
|
|
// @ts-ignore
|
|
return portals;
|
|
}
|
|
|
|
|
|
export function parseQuery(this: IExecuteFunctions, i: number): object | null {
|
|
let queries;
|
|
const queriesParamUi = this.getNodeParameter('queries', i, {}) as IDataObject;
|
|
if (queriesParamUi.query !== undefined) {
|
|
// @ts-ignore
|
|
queries = [];
|
|
for (const queryParam of queriesParamUi!.query as IDataObject[]) {
|
|
const query = {
|
|
'omit': queryParam.omit ? 'true' : 'false',
|
|
};
|
|
// @ts-ignore
|
|
for (const field of queryParam!.fields!.field as IDataObject[]) {
|
|
// @ts-ignore
|
|
query[field.name] = field!.value;
|
|
}
|
|
queries.push(query);
|
|
}
|
|
} else {
|
|
queries = null;
|
|
}
|
|
// @ts-ignore
|
|
return queries;
|
|
}
|
|
|
|
export function parseFields(this: IExecuteFunctions, i: number): object | null {
|
|
let fieldData;
|
|
const fieldsParametersUi = this.getNodeParameter('fieldsParametersUi', i, {}) as IDataObject;
|
|
if (fieldsParametersUi.fields !== undefined) {
|
|
// @ts-ignore
|
|
fieldData = {};
|
|
for (const field of fieldsParametersUi!.fields as IDataObject[]) {
|
|
// @ts-ignore
|
|
fieldData[field.name] = field!.value;
|
|
}
|
|
} else {
|
|
fieldData = null;
|
|
}
|
|
// @ts-ignore
|
|
return fieldData;
|
|
}
|