n8n/packages/nodes-base/nodes/TheHive/GenericFunctions.ts
Ricardo Espinoza c983603306
Add custom fields to TheHive (#1985)
* Add custom fields support to TheHive node

*  Improvements to #1527

* 🐛 Make it also work without custom fields set

Co-authored-by: Mika Luhta <12100880+mluhta@users.noreply.github.com>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-07-14 19:18:46 +02:00

193 lines
5.9 KiB
TypeScript

import {
OptionsWithUri,
} from 'request';
import {
IExecuteFunctions,
IHookFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
import {
IDataObject, NodeApiError, NodeOperationError,
} from 'n8n-workflow';
import * as moment from 'moment';
import { Eq } from './QueryFunctions';
export async function theHiveApiRequest(this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions, method: string, resource: string, body: any = {}, query: IDataObject = {}, uri?: string, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
const credentials = this.getCredentials('theHiveApi');
if (credentials === undefined) {
throw new NodeOperationError(this.getNode(), 'No credentials got returned!');
}
const headerWithAuthentication = Object.assign({}, { Authorization: `Bearer ${credentials.ApiKey}` });
let options: OptionsWithUri = {
headers: headerWithAuthentication,
method,
qs: query,
uri: uri || `${credentials.url}/api${resource}`,
body,
rejectUnauthorized: credentials.allowUnauthorizedCerts as boolean,
json: true,
};
if (Object.keys(option).length !== 0) {
options = Object.assign({}, options, option);
}
if (Object.keys(body).length === 0) {
delete options.body;
}
if (Object.keys(query).length === 0) {
delete options.qs;
}
try {
return await this.helpers.request!(options);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
// Helpers functions
export function mapResource(resource: string): string {
switch (resource) {
case 'alert':
return 'alert';
case 'case':
return 'case';
case 'observable':
return 'case_artifact';
case 'task':
return 'case_task';
case 'log':
return 'case_task_log';
default:
return '';
}
}
export function splitTags(tags: string): string[] {
return tags.split(',').filter(tag => tag !== ' ' && tag);
}
export function prepareOptional(optionals: IDataObject): IDataObject {
const response: IDataObject = {};
for (const key in optionals) {
if (optionals[key] !== undefined && optionals[key] !== null && optionals[key] !== '') {
if (['customFieldsJson', 'customFieldsUi'].indexOf(key) > -1) {
continue; // Ignore customFields, they need special treatment
}
else if (moment(optionals[key] as string, moment.ISO_8601).isValid()) {
response[key] = Date.parse(optionals[key] as string);
} else if (key === 'artifacts') {
response[key] = JSON.parse(optionals[key] as string);
} else if (key === 'tags') {
response[key] = splitTags(optionals[key] as string);
} else {
response[key] = optionals[key];
}
}
}
return response;
}
export async function prepareCustomFields(this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions, additionalFields: IDataObject, jsonParameters = false): Promise<IDataObject | undefined> {
// Check if the additionalFields object contains customFields
if (jsonParameters === true) {
const customFieldsJson = additionalFields.customFieldsJson;
// Delete from additionalFields as some operations (e.g. alert:update) do not run prepareOptional
// which would remove the extra fields
delete additionalFields.customFieldsJson;
if (typeof customFieldsJson === 'string') {
return JSON.parse(customFieldsJson);
} else if (typeof customFieldsJson === 'object') {
return customFieldsJson as IDataObject;
} else if (customFieldsJson) {
throw Error('customFieldsJson value is invalid');
}
} else if (additionalFields.customFieldsUi) {
// Get Custom Field Types from TheHive
const version = this.getCredentials('theHiveApi')?.apiVersion;
const endpoint = version === 'v1' ? '/customField' : '/list/custom_fields';
const requestResult = await theHiveApiRequest.call(
this,
'GET',
endpoint as string,
);
// Convert TheHive3 response to the same format as TheHive 4
// [{name, reference, type}]
const hiveCustomFields = version === 'v1' ? requestResult : Object.keys(requestResult).map(key => requestResult[key]);
// Build reference to type mapping object
const referenceTypeMapping = hiveCustomFields.reduce((acc: IDataObject, curr: IDataObject) => (acc[curr.reference as string] = curr.type, acc), {});
// Build "fieldName": {"type": "value"} objects
const customFieldsUi = (additionalFields.customFieldsUi as IDataObject);
const customFields : IDataObject = (customFieldsUi?.customFields as IDataObject[]).reduce((acc: IDataObject, curr: IDataObject) => {
const fieldName = curr.field as string;
// Might be able to do some type conversions here if needed, TODO
acc[fieldName] = {
[referenceTypeMapping[fieldName]]: curr.value,
};
return acc;
}, {} as IDataObject);
delete additionalFields.customFieldsUi;
return customFields;
}
return undefined;
}
export function buildCustomFieldSearch(customFields: IDataObject): IDataObject[] {
const customFieldTypes = ['boolean', 'date', 'float', 'integer', 'number', 'string'];
const searchQueries: IDataObject[] = [];
Object.keys(customFields).forEach(customFieldName => {
const customField = customFields[customFieldName] as IDataObject;
// Figure out the field type from the object's keys
const fieldType = Object.keys(customField)
.filter(key => customFieldTypes.indexOf(key) > -1)[0];
const fieldValue = customField[fieldType];
searchQueries.push(Eq(`customFields.${customFieldName}.${fieldType}`, fieldValue));
});
return searchQueries;
}
export function prepareSortQuery(sort: string, body: { query: [IDataObject] }) {
if (sort) {
const field = sort.substring(1);
const value = sort.charAt(0) === '+' ? 'asc' : 'desc';
const sortOption: IDataObject = {};
sortOption[field] = value;
body.query.push(
{
'_name': 'sort',
'_fields': [
sortOption,
],
},
);
}
}
export function prepareRangeQuery(range: string, body: { 'query': Array<{}> }) {
if (range && range !== 'all') {
body['query'].push(
{
'_name': 'page',
'from': parseInt(range.split('-')[0], 10),
'to': parseInt(range.split('-')[1], 10),
},
);
}
}