n8n/packages/nodes-base/nodes/HaloPSA/GenericFunctions.ts
Michael Kret 61e26804ba
refactor(core): Remove linting exceptions in nodes-base (#4794)
*  enabled array-type

*  await-thenable on

*  ban-types on

*  default-param-last on

*  dot-notation on

*  member-delimiter-style on

*  no-duplicate-imports on

*  no-empty-interface on

*  no-floating-promises on

*  no-for-in-array on

*  no-invalid-void-type on

*  no-loop-func on

*  no-shadow on

*  ban-ts-comment re enabled

*  @typescript-eslint/lines-between-class-members on

* address my own comment

* @typescript-eslint/return-await on

* @typescript-eslint/promise-function-async on

* @typescript-eslint/no-unnecessary-boolean-literal-compare on

* @typescript-eslint/no-unnecessary-type-assertion on

* prefer-const on

* @typescript-eslint/prefer-optional-chain on

Co-authored-by: कारतोफ्फेलस्क्रिप्ट™ <aditya@netroy.in>
2022-12-02 21:54:28 +01:00

251 lines
6.2 KiB
TypeScript

import { IExecuteFunctions, IHookFunctions } from 'n8n-core';
import {
ICredentialDataDecryptedObject,
ICredentialTestFunctions,
IDataObject,
IExecuteSingleFunctions,
ILoadOptionsFunctions,
IPollFunctions,
JsonObject,
NodeApiError,
} from 'n8n-workflow';
import { OptionsWithUri } from 'request';
// Interfaces and Types -------------------------------------------------------------
interface IHaloPSATokens {
scope: string;
token_type: string;
access_token: string;
expires_in: number;
refresh_token: string;
id_token: string;
}
// API Requests ---------------------------------------------------------------------
export async function getAccessTokens(
this: IExecuteFunctions | ILoadOptionsFunctions,
): Promise<IHaloPSATokens> {
const credentials = await this.getCredentials('haloPSAApi');
const options: OptionsWithUri = {
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
},
method: 'POST',
form: {
client_id: credentials.client_id,
client_secret: credentials.client_secret,
grant_type: 'client_credentials',
scope: credentials.scope,
},
uri: getAuthUrl(credentials),
json: true,
};
try {
const tokens = await this.helpers.request!(options);
return tokens;
} catch (error) {
throw new NodeApiError(this.getNode(), error as JsonObject);
}
}
export async function haloPSAApiRequest(
this:
| IHookFunctions
| IExecuteFunctions
| IExecuteSingleFunctions
| ILoadOptionsFunctions
| IPollFunctions,
method: string,
resource: string,
accessToken: string,
body: IDataObject | IDataObject[] = {},
qs: IDataObject = {},
option: IDataObject = {},
): Promise<any> {
const resourceApiUrl = (await this.getCredentials('haloPSAApi')).resourceApiUrl as string;
try {
let options: OptionsWithUri = {
headers: {
Authorization: `Bearer ${accessToken}`,
'User-Agent': 'https://n8n.io',
Connection: 'keep-alive',
Accept: '*/*',
'Accept-Encoding': 'gzip, deflate, br',
'Content-Type': 'application/json',
},
method,
qs,
body,
uri: `${resourceApiUrl}${resource}`,
json: true,
};
options = Object.assign({}, options, option);
if (Object.keys(body).length === 0) {
delete options.body;
}
const result = await this.helpers.request!(options);
if (method === 'DELETE' && result.id) {
return { success: true };
}
return result;
} catch (error) {
const message = (error as JsonObject).message as string;
if (method === 'DELETE' || 'GET' || ('UPDATE' && message)) {
let newErrorMessage;
if (message.includes('400')) {
console.log(message);
newErrorMessage = JSON.parse(message.split(' - ')[1]);
(error as JsonObject).message = `For field ID, ${
newErrorMessage.id || newErrorMessage['[0].id']
}`;
}
if (message.includes('403')) {
(
error as JsonObject
).message = `You don\'t have permissions to ${method.toLowerCase()} ${resource
.split('/')[1]
.toLowerCase()}.`;
}
}
throw new NodeApiError(this.getNode(), error as JsonObject);
}
}
// export async function reasignTickets(
// this:
// | IHookFunctions
// | IExecuteFunctions
// | IExecuteSingleFunctions
// | ILoadOptionsFunctions
// | IPollFunctions,
// clientId: string,
// reasigmentCliendId: string,
// accessToken: string,
// ): Promise<any> {
// const response = (await haloPSAApiRequest.call(
// this,
// 'GET',
// `/tickets`,
// accessToken,
// {},
// { client_id: reasigmentCliendId },
// )) as IDataObject;
// const { tickets } = response;
// console.log((tickets as IDataObject[]).map(t => t.id));
// const body: IDataObject = {
// id: clientId,
// client_id: reasigmentCliendId,
// };
// for (const ticket of (tickets as IDataObject[])) {
// console.log(ticket.id);
// await haloPSAApiRequest.call(this, 'DELETE', `/tickets/${ticket.id}`, accessToken);
// }
// }
export async function haloPSAApiRequestAllItems(
this: IExecuteFunctions | ILoadOptionsFunctions | IHookFunctions,
propertyName: string,
method: string,
endpoint: string,
accessToken: string,
body = {},
query: IDataObject = {},
): Promise<any> {
const returnData: IDataObject[] = [];
let responseData: IDataObject;
query.page_size = 100;
query.page_no = 1;
query.pageinate = true;
do {
responseData = (await haloPSAApiRequest.call(
this,
method,
endpoint,
accessToken,
body,
query,
)) as IDataObject;
returnData.push.apply(returnData, responseData[propertyName] as IDataObject[]);
query.page_no++;
//@ts-ignore
} while (returnData.length < responseData.record_count);
return returnData;
}
// Utilities ------------------------------------------------------------------------
function getAuthUrl(credentials: IDataObject) {
return credentials.hostingType === 'on-premise'
? `${credentials.appUrl}/auth/token`
: `${credentials.authUrl}/token?tenant=${credentials.tenant}`;
}
export function simplifyHaloPSAGetOutput(
response: IDataObject[],
fieldsList: string[],
): IDataObject[] {
const output = [];
for (const item of response) {
const simplifiedItem: IDataObject = {};
Object.keys(item).forEach((key: string) => {
if (fieldsList.includes(key)) {
simplifiedItem[key] = item[key];
}
});
output.push(simplifiedItem);
}
return output;
}
export function qsSetStatus(status: string) {
if (!status) return {};
const qs: IDataObject = {};
if (status === 'all') {
qs.includeinactive = true;
qs.includeactive = true;
} else if (status === 'active') {
qs.includeinactive = false;
qs.includeactive = true;
} else {
qs.includeinactive = true;
qs.includeactive = false;
}
return qs;
}
// Validation -----------------------------------------------------------------------
export async function validateCredentials(
this: ICredentialTestFunctions,
decryptedCredentials: ICredentialDataDecryptedObject,
): Promise<IHaloPSATokens> {
const credentials = decryptedCredentials;
const options: OptionsWithUri = {
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
},
method: 'POST',
form: {
client_id: credentials.client_id,
client_secret: credentials.client_secret,
grant_type: 'client_credentials',
scope: credentials.scope,
},
uri: getAuthUrl(credentials),
json: true,
};
return (await this.helpers.request!(options)) as IHaloPSATokens;
}